IAttributeHierarchiesService
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production.
Service for handle workspace attribute hierarchies
export interface IAttributeHierarchiesService
Methods
Method | Description |
|---|---|
(ALPHA) Creates attribute hierarchy | |
(ALPHA) Deletes attribute hierarchy | |
(ALPHA) Gets hierarchy template for date dataset | |
(ALPHA) Gets valid descendants for given attributes | |
(ALPHA) Updates attribute hierarchy |
Method details
IAttributeHierarchiesService.createAttributeHierarchy()methodAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production.
Creates attribute hierarchy
createAttributeHierarchy(title: string, attributes: ObjRef[]): Promise<ICatalogAttributeHierarchy>;
Parameters
Parameter | Type | Description |
|---|---|---|
title | string | |
attributes | ObjRef[] |
Returns
Promise<ICatalogAttributeHierarchy>
IAttributeHierarchiesService.deleteAttributeHierarchy()methodAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production.
Deletes attribute hierarchy
deleteAttributeHierarchy(attributeHierarchyId: string): Promise<void>;
Parameters
Parameter | Type | Description |
|---|---|---|
attributeHierarchyId | string |
Returns
Promise<void>
IAttributeHierarchiesService.getDateHierarchyTemplates()methodAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production.
Gets hierarchy template for date dataset
getDateHierarchyTemplates(): Promise<IDateHierarchyTemplate[]>;
Returns
Promise<IDateHierarchyTemplate[]>
IAttributeHierarchiesService.getValidDescendants()methodAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production.
Gets valid descendants for given attributes
getValidDescendants(attributes: ObjRef[]): Promise<ObjRef[]>;
Parameters
Parameter | Type | Description |
|---|---|---|
attributes | ObjRef[] |
Returns
Promise<ObjRef[]>
IAttributeHierarchiesService.updateAttributeHierarchy()methodAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production.
Updates attribute hierarchy
updateAttributeHierarchy(catalogAttributeHierarchy: ICatalogAttributeHierarchy): Promise<ICatalogAttributeHierarchy>;
Parameters
Parameter | Type | Description |
|---|---|---|
catalogAttributeHierarchy |
Returns
Promise<ICatalogAttributeHierarchy>