IAnalyticsCatalogProps
export interface IAnalyticsCatalogProps
Properties
Property | Modifiers | Type | Description |
|---|---|---|---|
(Optional) An analytical backend to use within the analytics catalog. Can be omitted and taken from context. | |||
string | (Optional) A locale to use for translations. Can be omitted and taken from context. | ||
() => void | (Optional) Handler when closing catalog detail. | ||
(ref: ICatalogItemRef) => void | (Optional) Handler when opening catalog detail. | ||
(event: MouseEvent, ref: ICatalogItemRef) => void | (Optional) Handler for navigating to a catalog item. Consumers can handle route changes. | ||
(e: MouseEvent, linkClickEvent: OpenHandlerEvent) => void | (Optional) Handler for opening catalog items. | ||
(objectType: CatalogCreateObjectType) => void | (Optional) Handler for creating a new object from the catalog header. | ||
(Optional) Reference to the catalog item to open on initial render. | |||
string | (Optional) A workspace to use within the analytics catalog. Can be omitted and taken from context. |
Property details
IAnalyticsCatalogProps.backendproperty
An analytical backend to use within the analytics catalog. Can be omitted and taken from context.
backend?: IAnalyticalBackend;
IAnalyticsCatalogProps.localeproperty
A locale to use for translations. Can be omitted and taken from context.
locale?: string;
IAnalyticsCatalogProps.onCatalogDetailClosedproperty
Handler when closing catalog detail.
onCatalogDetailClosed?: () => void;
IAnalyticsCatalogProps.onCatalogDetailOpenedproperty
Handler when opening catalog detail.
onCatalogDetailOpened?: (ref: ICatalogItemRef) => void;
IAnalyticsCatalogProps.onCatalogItemNavigationproperty
Handler for navigating to a catalog item. Consumers can handle route changes.
onCatalogItemNavigation?: (event: MouseEvent, ref: ICatalogItemRef) => void;
IAnalyticsCatalogProps.onCatalogItemOpenClickproperty
Handler for opening catalog items.
onCatalogItemOpenClick?: (e: MouseEvent, linkClickEvent: OpenHandlerEvent) => void;
IAnalyticsCatalogProps.onCreateObjectproperty
Handler for creating a new object from the catalog header.
onCreateObject?: (objectType: CatalogCreateObjectType) => void;
IAnalyticsCatalogProps.openCatalogItemRefproperty
Reference to the catalog item to open on initial render.
openCatalogItemRef?: ICatalogItemRef;
IAnalyticsCatalogProps.workspaceproperty
A workspace to use within the analytics catalog. Can be omitted and taken from context.
workspace?: string;