Type Alias DataCubeOptions

DataCubeOptions: {
    enableCache?: boolean;
    getHeaderMenuItems?: () => (DataCubeMenuItem | DataCubeNativeMenuItem)[];
    gridClientLicense?: string;
    innerHeaderRenderer?: (
        params: DataCubeInnerHeaderComponentParams,
    ) => React.ReactNode;
    layoutManager?: LayoutManager;
    onInitialized?: (event: DataCubeInitializedEvent) => void;
    onNameChanged?: (event: DataCubeNameChangedEvent) => void;
    onSettingsChanged?: (event: DataCubeSettingsChangedEvent) => void;
    onViewInitialized?: (event: DataCubeViewInitializedEvent) => void;
    settingsData?: DataCubeSettingsData;
    taskManager?: TaskManager;
}

Type declaration

  • OptionalenableCache?: boolean

    Enables caching to suppport local query execution.

  • OptionalgetHeaderMenuItems?: () => (DataCubeMenuItem | DataCubeNativeMenuItem)[]

    Provides a list of items to be displayed in the header dropdown menu.

  • OptionalgridClientLicense?: string

    License key for the grid client (i.e. ag-grid) as DataCube makes use of fair number of advanced/enterprise features.

  • OptionalinnerHeaderRenderer?: (params: DataCubeInnerHeaderComponentParams) => React.ReactNode

    Custom renderer for the inner header area, next to the title.

  • OptionallayoutManager?: LayoutManager

    Provides a layout manager that can be used by DataCube layout service.

    This is useful when creating a seamless integration between DataCube and the application.

  • OptionalonInitialized?: (event: DataCubeInitializedEvent) => void

    DataCube has initialized and is ready for most API calls, but may not be fully rendered yet.

  • OptionalonNameChanged?: (event: DataCubeNameChangedEvent) => void

    The name of the DataCube main view is updated.

  • OptionalonSettingsChanged?: (event: DataCubeSettingsChangedEvent) => void

    Settings are changed and saved.

    This is useful when the application needs to persist the new settings values.

  • OptionalonViewInitialized?: (event: DataCubeViewInitializedEvent) => void

    DataCube main view has initialized, and is ready for most API calls, but may not be fully rendered yet. The query source has been fully resolved and analyzed, grid view is to be rendered right after.

  • OptionalsettingsData?: DataCubeSettingsData

    DataCube settings values (retrieved externally), which would be set as initial values, and extra setting configurations that would be rendered in the settings panel.

  • OptionaltaskManager?: TaskManager

    Provides a task manager that can be used by DataCube task service.

    This is useful when creating a seamless integration between DataCube and the application.

Settings

Member Visibility