IWorkspaceCatalogAvailableItemsFactory
Service to obtain only valid items for a particular execution or insight.
export interface IWorkspaceCatalogAvailableItemsFactory extends IWorkspaceCatalogFactoryMethods<IWorkspaceCatalogAvailableItemsFactory, IWorkspaceCatalogWithAvailableItemsFactoryOptions>
Extends: IWorkspaceCatalogFactoryMethods<IWorkspaceCatalogAvailableItemsFactory, IWorkspaceCatalogWithAvailableItemsFactoryOptions>
Remarks
This is useful for interactive insight/execution creation. (catalog will offer you only valid items that you can add to your insight/execution)
Methods
Method | Description |
|---|---|
Setup catalog to fetch only items that are valid for the provided insight definition | |
Setup catalog to fetch only items that are valid for the provided execution items | |
Fetch available catalog items for the current setup |
Method details
IWorkspaceCatalogAvailableItemsFactory.forInsight()method
Setup catalog to fetch only items that are valid for the provided insight definition
forInsight(insight: IInsightDefinition): IWorkspaceCatalogAvailableItemsFactory;
Parameters
Parameter | Type | Description |
|---|---|---|
insight | insight definition |
Returns
IWorkspaceCatalogAvailableItemsFactory
catalog available items factory
IWorkspaceCatalogAvailableItemsFactory.forItems()method
Setup catalog to fetch only items that are valid for the provided execution items
forItems(items: IAttributeOrMeasure[]): IWorkspaceCatalogAvailableItemsFactory;
Parameters
Parameter | Type | Description |
|---|---|---|
items | execution items |
Returns
IWorkspaceCatalogAvailableItemsFactory
catalog available items factory
IWorkspaceCatalogAvailableItemsFactory.load()method
Fetch available catalog items for the current setup
load(): Promise<IWorkspaceCatalogWithAvailableItems>;
Returns
Promise<IWorkspaceCatalogWithAvailableItems>
promise of catalog with loaded available items