IDataView

IDataView.clusteringConfigpropertyBeta

Beta API. Mostly stable, but details may change in a minor release, outside SemVer. See API maturity.

Configuration for the clustering, if available.

readonly clusteringConfig?: IClusteringConfig;

IDataView.clusteringResultpropertyBeta

Beta API. Mostly stable, but details may change in a minor release, outside SemVer. See API maturity.

Clustering result, if available.

readonly clusteringResult?: IClusteringResult;

IDataView.contextproperty

Execution context metadata available on this data view.

readonly context?: IExecutionContext;

IDataView.countproperty

Count of data in each dimension.

readonly count: number[];

IDataView.dataproperty

The calculated data. Dimensionality of the data matches the dimensions requested at execution time.

readonly data: DataValue[][] | DataValue[];

IDataView.definitionproperty

Full definition of execution that computed data included in this DataView.

readonly definition: IExecutionDefinition;

IDataView.forecastConfigpropertyBeta

Beta API. Mostly stable, but details may change in a minor release, outside SemVer. See API maturity.

Configuration for the forecasting, if available.

readonly forecastConfig?: IForecastConfig;

IDataView.forecastResultpropertyBeta

Beta API. Mostly stable, but details may change in a minor release, outside SemVer. See API maturity.

Forecasting result, if available.

readonly forecastResult?: IForecastResult;

IDataView.headerItemsproperty

Headers are metadata for the data in this view.

readonly headerItems: IResultHeader[][][];

Remarks

There are headers for each dimension and in each dimension headers are further sliced by the attribute or measure or total to which the data belongs.

Thus:

• Top array contains 0 to N per-dimension arrays, one for each requested dimension (if any) - The per-dimension arrays then contain per-slice array, one for each attribute or measure in the dimension - The per-slice-array then contains the actual result header which includes information such as attribute element or measure name

IDataView.metadatapropertyAlpha

Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.

Additional metadata for the particular execution result.

readonly metadata: IExecutionResultMetadata;

IDataView.offsetproperty

Coordinates of where this data view starts. One coordinate per result dimension.

readonly offset: number[];

IDataView.outliersConfigpropertyAlpha

Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.

Configuration for the outliers, if available.

readonly outliersConfig?: IOutliersConfig;

IDataView.outliersResultpropertyAlpha

Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.

Outliers result, if available.

readonly outliersResult?: IOutliersResult;

IDataView.resultproperty

Result of the execution that calculated data for this view.

readonly result: IExecutionResult;

IDataView.totalCountproperty

Total size of data in each dimension.

readonly totalCount: number[];

IDataView.totalsproperty

Grand totals included in this data view.

readonly totals?: DataValue[][][];

Remarks

Grand totals are included for each dimension; within each dimension there is one entry per requested total and for each requested total there are list of values.

Thus:

• Top array contains 0 to N per-dimension arrays - Each per-dimension array contains one per-total entry for each requested total - Each per-total entry contains array of calculated values, cardinality of this matches the cardinality of the data in the respective dimension.

IDataView.totalTotalsproperty

Totals of grand totals included in this data view.

readonly totalTotals?: DataValue[][][];

IDataView.warningsproperty

Result warnings.

readonly warnings?: IResultWarning[];

Remarks

Backend MAY return warnings to indicate that the result is different compared to what the caller can expect. For example, the caller executes a definition with particular filter, but the backend determines that the filter has no effect on the computation. Backend runs the execution and communicates by warning that the filter was useless.

IDataView.clustering()methodBeta

Beta API. Mostly stable, but details may change in a minor release, outside SemVer. See API maturity.

Return clustering data view. This object is empty if withClustering was not called

clustering(): IClusteringResult;

Returns

IClusteringResult

IDataView.equals()method

Tests if this data view is same as the other data view.

equals(other: IDataView): boolean;

Parameters

Returns

boolean

true if equal, false if not

IDataView.fingerprint()method

Unique fingerprint of this data view.

fingerprint(): string;

Returns

string

Remarks

The fingerprint is influenced by the execution result and the offset and limit of the data view.

Thus, two data views on the same result, with same offset and limit will have the same fingerprint.

IDataView.forecast()methodBeta

Beta API. Mostly stable, but details may change in a minor release, outside SemVer. See API maturity.

Return forecast data view. This object is empty if not withForecast was called

forecast(): IForecastView;

Returns

IForecastView

IDataView.outliers()methodAlpha

Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.

Return outliers data view. This object is empty if not withOutliers was called

outliers(): IOutliersView;

Returns

IOutliersView

IDataView.readCollectionItems()methodAlpha

Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.

Retrieves collection items (geospatial features) using provided configuration.

readCollectionItems(config: ICollectionItemsConfig): Promise<ICollectionItemsResult>;

Parameters

Returns

Promise<ICollectionItemsResult>

promise of collection items result with GeoJSON features

IDataView.withClustering()methodBeta

Beta API. Mostly stable, but details may change in a minor release, outside SemVer. See API maturity.

Adds clustering for this data view.

withClustering(config?: IClusteringConfig, result?: IClusteringResult): IDataView;

Parameters

Returns

IDataView

new data view with clustering enabled

IDataView.withForecast()methodBeta

Beta API. Mostly stable, but details may change in a minor release, outside SemVer. See API maturity.

Adds forecast for this data view.

withForecast(config?: IForecastConfig, result?: IForecastResult): IDataView;

Parameters

Returns

IDataView

new data view with forecasting enabled

IDataView.withOutliers()methodAlpha

Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.

Adds outliers for this data view.

withOutliers(config?: IOutliersConfig, result?: IOutliersResult): IDataView;

Parameters

Returns

IDataView

new data view with outliers enabled