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?: Dimension[] | Measure[] | IGetDataSortable[];
    success?: RequestSuccess<any>;
}

Hierarchy (view full)

Properties

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

Properties

OptionalcontainerPath

containerPath?: string

Optionalendpoint

endpoint?: string

Optionalfailure

failure?: RequestFailure<any>

This will be called upon failure to complete a request.

OptionalfilterQuery

filterQuery?: string

OptionalfilterUrl

filterUrl?: string

OptionalgroupBys

groupBys?: any

OptionaljoinToFirst

joinToFirst?: boolean

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

Optionallimit

limit?: any

measures

measures: IMeasureable[]

OptionalmetaDataOnly

metaDataOnly?: boolean

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

Optionalparameters

parameters?: any

Optionalscope

scope?: any

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

Optionalsorts

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

Generally an array of augmented Dimension or Measure objects

Optionalsuccess

success?: RequestSuccess<any>

This will be called upon successfully completing a request.

Settings

Member Visibility

On This Page

Properties