Class DataCubeState

Implements

DataCubeAPI

Index

Constructors

Properties

currentActionAlert? currentDocumentationEntry? documentationDisplay engine initState innerHeaderComponent? onNameChanged? onSettingChanged? settings settingsDisplay view

Methods

alertAction getSettings initialize openDocumentationEntry refreshFailedDataFetches runTaskForEachView

Constructors

constructor

new DataCubeState(
engine: DataCubeEngine,
options?: DataCubeOptions,
): DataCubeState
Parameters
- engine: DataCubeEngine
- Optionaloptions: DataCubeOptions
Returns DataCubeState
- Defined in packages/legend-data-cube/src/stores/DataCubeState.tsx:61

Properties

`Optional`currentActionAlert

currentActionAlert?: ActionAlert

`Optional`currentDocumentationEntry

currentDocumentationEntry?: DocumentationEntry

`Readonly`documentationDisplay

documentationDisplay: DisplayState

`Readonly`engine

engine: DataCubeEngine

`Readonly`initState

initState: ActionState = ...

`Optional`innerHeaderComponent

innerHeaderComponent?: (dataCube: DataCubeState) => ReactNode

`Optional`onNameChanged

onNameChanged?: (name: string, source: DataCubeSource) => void

`Optional`onSettingChanged

onSettingChanged?: (
key: string,
value: undefined | string | number | boolean | object,
) => void

`Readonly`settings

settings: DataCubeSettings

`Readonly`settingsDisplay

settingsDisplay: DisplayState

`Readonly`view

view: DataCubeViewState

Methods

alertAction

alertAction(alert: undefined | ActionAlert): void
Parameters
- alert: undefined | ActionAlert
Returns void
- Defined in packages/legend-data-cube/src/stores/DataCubeState.tsx:131

getSettings

getSettings(): DataCubeSettings
Returns DataCubeSettings
Implementation of DataCubeAPI.getSettings
- Defined in packages/legend-data-cube/src/stores/DataCubeState.tsx:123

initialize

initialize(): Promise<void>
Returns Promise<void>
- Defined in packages/legend-data-cube/src/stores/DataCubeState.tsx:147

openDocumentationEntry

openDocumentationEntry(entry: undefined | DocumentationEntry): void
Parameters
- entry: undefined | DocumentationEntry
Returns void
- Defined in packages/legend-data-cube/src/stores/DataCubeState.tsx:127

refreshFailedDataFetches

refreshFailedDataFetches(): void
Returns void
Implementation of DataCubeAPI.refreshFailedDataFetches
- Defined in packages/legend-data-cube/src/stores/DataCubeState.tsx:135

runTaskForEachView

runTaskForEachView(runner: (view: DataCubeViewState) => void): void
Parameters
- runner: (view: DataCubeViewState) => void
Returns void
- Defined in packages/legend-data-cube/src/stores/DataCubeState.tsx:141