Interface DataCubeAPI

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

interface DataCubeAPI {
    generateDataCubeQuery(): Promise<DataCubeQuery>;
    reload(): void;
    retryFailedDataFetches(): void;
}

Index

Methods

generateDataCubeQuery reload retryFailedDataFetches

Methods

generateDataCubeQuery

generateDataCubeQuery(): Promise<DataCubeQuery>
Generates the data cube query (including the query, configuration, and source) from the latest state of the DataCube.

Returns Promise<DataCubeQuery>
- Defined in packages/legend-data-cube/lib/stores/DataCubeAPI.d.ts:28

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/lib/stores/DataCubeAPI.d.ts:38

retryFailedDataFetches

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

Returns void
- Defined in packages/legend-data-cube/lib/stores/DataCubeAPI.d.ts:32