Interface DataSourceOptions

interface DataSourceOptions {
    attributes?: Attribute[];
    dimensionsFiltersConfig?: {};
    id: number;
    identifierAttribute?: string;
    inRange?: boolean;
    maxResolution?: number;
    minResolution?: number;
    name: string;
    visible?: boolean;
}

Properties

attributes? dimensionsFiltersConfig? id identifierAttribute? inRange? maxResolution? minResolution? name visible?

Properties

Optionalattributes

attributes?: Attribute[]

The attributes of the data source.

OptionaldimensionsFiltersConfig

dimensionsFiltersConfig?: {}

The dimensions filters configuration, which determines dimensions supported by this data source using filters and give the corresponding field and whether they should use a static value or the one defined in the dimensions.

id

id: number

The data source id.

OptionalidentifierAttribute

identifierAttribute?: string

The name of an attribute among the attributes of the data source. The value of that attribute, in records, can be used to identify each record individually.

OptionalinRange

inRange?: boolean

A data source is considered 'in range' when it is synchronized to a map view and the resolution of that view is within the range of the maxResolution and minResolution. These 2 properties are required for the inRange property to be dynamic, otherwise its value is always true by default.

OptionalmaxResolution

maxResolution?: number

Maximum resolution where the data source can be displayed or queried.

OptionalminResolution

minResolution?: number

Minimum resolution where the data source can be displayed or queried.

name

name: string

A human-readable name for the data source.

Optionalvisible

visible?: boolean

Whether the data source is visible or not, i.e. whether its is ON or OFF.

Settings

Member Visibility

On This Page

Properties