@labkey/api
    Preparing search index...

    Interface IGetDataOptions

    interface IGetDataOptions {
        containerPath?: string;
        endpoint?: string;
        failure?: RequestFailure<any>;
        filterQuery?: string;
        filterUrl?: string;
        groupBys?: any;
        joinToFirst?: boolean;
        limit?: any;
        measures: IMeasureable[];
        metaDataOnly?: boolean;
        parameters?: any;
        scope?: any;
        sorts?:
            | Visualization.Dimension[]
            | Visualization.Measure[]
            | IGetDataSortable[];
        success?: RequestSuccess<any>;
    }

    Hierarchy (View Summary)

    Index

    Properties

    containerPath? endpoint? failure? filterQuery? filterUrl? groupBys? joinToFirst? limit? measures metaDataOnly? parameters? scope? sorts? success?

    Properties

    containerPath?: string
    endpoint?: string
    failure?: RequestFailure<any>

    This will be called upon failure to complete a request.

    filterQuery?: string
    filterUrl?: string
    groupBys?: any
    joinToFirst?: boolean

    Default false. If true, all measures will be joined to the first measure in the array instead of to the previous measure.

    limit?: any
    measures: IMeasureable[]
    metaDataOnly?: boolean

    Default false. If true, response will no include the actual data rows, just metadata.

    parameters?: any
    scope?: any

    A scoping object for the success and failure callback functions (default to this).

    sorts?: Visualization.Dimension[] | Visualization.Measure[] | IGetDataSortable[]

    Generally an array of augmented Dimension or Measure objects

    success?: RequestSuccess<any>

    This will be called upon successfully completing a request.

    Settings

    Member Visibility

    On This Page

    Properties