PresentationManager Class
Frontend Presentation manager which basically just forwards all calls to the backend implementation.
Implements
Methods
| Name | Description | |
|---|---|---|
| dispose(): void | ||
| getContent(requestOptions: Paged<ContentRequestOptions<IModelConnection>>, descriptorOrOverrides: Descriptor | DescriptorOverrides, keys: KeySet): Promise<Content | undefined> | Retrieves the content based on the supplied content descriptor override. | |
| getContentAndSize(requestOptions: Paged<ContentRequestOptions<IModelConnection>>, descriptorOrOverrides: Descriptor | DescriptorOverrides, keys: KeySet): Promise<object> | Retrieves the content and content set size based on the supplied content descriptor override. | |
| getContentDescriptor(requestOptions: ContentRequestOptions<IModelConnection>, displayType: string, keys: KeySet, selection: SelectionInfo | undefined): Promise<Descriptor | undefined> | Retrieves the content descriptor which can be used to get content. | |
| getContentSetSize(requestOptions: ContentRequestOptions<IModelConnection>, descriptorOrOverrides: Descriptor | DescriptorOverrides, keys: KeySet): Promise<number> | Retrieves the content set size based on the supplied content descriptor override. | |
| getDisplayLabel(requestOptions: LabelRequestOptions<IModelConnection>, key: InstanceKey): Promise<string> | Retrieves display label of specific item | |
| getDisplayLabels(requestOptions: LabelRequestOptions<IModelConnection>, keys: InstanceKey[]): Promise<string[]> | Retrieves display label of specific items | |
| getDistinctValues(requestOptions: ContentRequestOptions<IModelConnection>, descriptor: Descriptor, keys: KeySet, fieldName: string, maximumValueCount: number = 0): Promise<string[]> | Retrieves distinct values of specific field from the content based on the supplied content descriptor override. | |
| getFilteredNodePaths(requestOptions: HierarchyRequestOptions<IModelConnection>, filterText: string): Promise<NodePathElement[]> | Retrieves paths from root nodes to nodes containing filter text in their label. | |
| getNodePaths(requestOptions: HierarchyRequestOptions<IModelConnection>, paths: InstanceKey[][], markedIndex: number): Promise<NodePathElement[]> | Retrieves paths from root nodes to children nodes according to specified keys. | |
| getNodes(requestOptions: Paged<HierarchyRequestOptions<IModelConnection>>, parentKey?: NodeKey): Promise<Node[]> | Retrieves nodes | |
| getNodesAndCount(requestOptions: Paged<HierarchyRequestOptions<IModelConnection>>, parentKey?: NodeKey): Promise<object> | Retrieves nodes. | |
| getNodesCount(requestOptions: HierarchyRequestOptions<IModelConnection>, parentKey?: NodeKey): Promise<number> | Retrieves nodes count. | |
| loadHierarchy(requestOptions: HierarchyRequestOptions<IModelConnection>): Promise<void> | Loads the whole hierarchy. | Beta |
| onNewiModelConnection(_: IModelConnection): Promise<void> | Function that is called when a new IModelConnection is used to retrieve data. | |
| rulesets(): RulesetManager | Get rulesets manager | |
| vars(rulesetId: string): RulesetVariablesManager | Get ruleset variables manager for specific ruleset | |
| create(props?: PresentationManagerProps): PresentationManager Static | Create a new PresentationManager instance |
Properties
| Name | Type | Description | |
|---|---|---|---|
| activeLocale | string | undefined | Get / set active locale used for localizing presentation data |
Defined in
Last Updated: 08 January, 2020