IWorkspaceCatalogFactoryMethods
Common methods for catalog configuration
export interface IWorkspaceCatalogFactoryMethods<TFactory, TOptions>
Methods
Method | Description |
|---|---|
Setup catalog to fetch only items without provided tags | |
Setup catalog to fetch only items of the provided dataset | |
Setup catalog to fetch only items of the provided types (attribute, measure, fact or dateDataset) | |
Setup catalog to fetch only items with provided tags | |
Setup whether catalog should fetch groups. Default: true | |
Setup catalog to fetch only items for specific options | |
Setup whether catalog should fetch production ready items. Default: 250 | |
Setup to use abort signal |
Method details
IWorkspaceCatalogFactoryMethods.excludeTags()method
Setup catalog to fetch only items without provided tags
excludeTags(tags: ObjRef[]): TFactory;
Parameters
Parameter | Type | Description |
|---|---|---|
tags | ObjRef[] | tags references |
Returns
TFactory
catalog factory
IWorkspaceCatalogFactoryMethods.forDataset()method
Setup catalog to fetch only items of the provided dataset
forDataset(dataset: ObjRef): TFactory;
Parameters
Parameter | Type | Description |
|---|---|---|
dataset | dataset reference |
Returns
TFactory
catalog factory
IWorkspaceCatalogFactoryMethods.forTypes()method
Setup catalog to fetch only items of the provided types (attribute, measure, fact or dateDataset)
forTypes(types: CatalogItemType[]): TFactory;
Parameters
Parameter | Type | Description |
|---|---|---|
types | catalog item types |
Returns
TFactory
catalog factory
IWorkspaceCatalogFactoryMethods.includeTags()method
Setup catalog to fetch only items with provided tags
includeTags(tags: ObjRef[]): TFactory;
Parameters
Parameter | Type | Description |
|---|---|---|
tags | ObjRef[] | tags references |
Returns
TFactory
catalog factory
IWorkspaceCatalogFactoryMethods.withGroups()method
Setup whether catalog should fetch groups. Default: true
withGroups(loadGroups: boolean): TFactory;
Parameters
Parameter | Type | Description |
|---|---|---|
loadGroups | boolean | should fetch groups |
Returns
TFactory
catalog factory
IWorkspaceCatalogFactoryMethods.withOptions()method
Setup catalog to fetch only items for specific options
withOptions(options: Partial<TOptions>): TFactory;
Parameters
Parameter | Type | Description |
|---|---|---|
options | Partial<TOptions> | catalog options |
Returns
TFactory
catalog factory
IWorkspaceCatalogFactoryMethods.withPageSize()method
Setup whether catalog should fetch production ready items. Default: 250
withPageSize(pageSize: number): TFactory;
Parameters
Parameter | Type | Description |
|---|---|---|
pageSize | number | page size of items |
Returns
TFactory
IWorkspaceCatalogFactoryMethods.withSignal()method
Setup to use abort signal
withSignal(signal: AbortSignal): TFactory;
Parameters
Parameter | Type | Description |
|---|---|---|
signal | AbortSignal | abort signal |
Returns
TFactory
catalog factory