Interface DataCubeAPI

This is the API exposed externally by DataCube to restrict access to certain internal components and functionalities.

interface DataCubeAPI {
    applySpecification(specification: DataCubeSpecification): Promise<void>;
    generateSpecification(): Promise<DataCubeSpecification>;
    getProcessedSource(): undefined | DataCubeSource;
    reload(): void;
    retryFailedDataFetches(): void;
    updateName(name: string): void;
}

Index

Methods

applySpecification generateSpecification getProcessedSource reload retryFailedDataFetches updateName

Methods

applySpecification

applySpecification(specification: DataCubeSpecification): Promise<void>
Applies the specification to the DataCube, i.e. update the query, configuration.

Note that source cannot be updated via this method, providing a different source than the one the DataCube has will result in an error.
Parameters
- specification: DataCubeSpecification
Returns Promise<void>
- Defined in packages/legend-data-cube/src/stores/DataCubeAPI.ts:46

generateSpecification

generateSpecification(): Promise<DataCubeSpecification>
Generates the specification (including the query, configuration, and source) from the latest state of the DataCube.

Returns Promise<DataCubeSpecification>
- Defined in packages/legend-data-cube/src/stores/DataCubeAPI.ts:35

getProcessedSource

getProcessedSource(): undefined | DataCubeSource
Get the processed source of the DataCube.

Returns undefined | DataCubeSource
- Defined in packages/legend-data-cube/src/stores/DataCubeAPI.ts:30

reload

reload(): void
(Force) reload/rerender the DataCube component.

This is often used when updating settings that requires a restart.

Returns void
- Defined in packages/legend-data-cube/src/stores/DataCubeAPI.ts:56

retryFailedDataFetches

retryFailedDataFetches(): void
Retries all failed data fetches and rerender the grid.

Returns void
- Defined in packages/legend-data-cube/src/stores/DataCubeAPI.ts:50

updateName

updateName(name: string): void
Updates the name of the DataCube main view.
Parameters
- name: string
Returns void
- Defined in packages/legend-data-cube/src/stores/DataCubeAPI.ts:39