PresentationManager Class
Backend Presentation manager which pulls the presentation data from an iModel using native platform.
Methods
| Name | Description | |
|---|---|---|
| constructor(props?: PresentationManagerProps): PresentationManager | Creates an instance of PresentationManager. | |
| compareHierarchies(requestOptions: HierarchyCompareOptions<IModelDb, NodeKey, RulesetVariable>): Promise<HierarchyCompareInfo> | Compares two hierarchies specified in the request options | |
| computeSelection(requestOptions: ComputeSelectionRequestOptions<IModelDb> & BackendDiagnosticsAttribute): Promise<KeySet> | Computes selection based on provided element IDs and selection scope. | |
| computeSelection(requestOptions: SelectionScopeRequestOptions<IModelDb> & { ids: string[], scopeId: string } & BackendDiagnosticsAttribute): Promise<KeySet> | Computes selection set based on provided selection scope. | Deprecated |
| dispose(): void | Dispose the presentation manager. | |
| getContent(requestOptions: ContentRequestOptions<IModelDb, Descriptor | DescriptorOverrides, KeySet, RulesetVariable> & { paging?: PageOptions } & { priority?: number } & { cancelEvent?: BeEvent<() => void> } & BackendDiagnosticsAttribute): Promise<undefined | Content> | Retrieves the content based on the supplied content descriptor override. | |
| getContentDescriptor(requestOptions: ContentDescriptorRequestOptions<IModelDb, KeySet, RulesetVariable> & { priority?: number } & { cancelEvent?: BeEvent<() => void> } & BackendDiagnosticsAttribute): Promise<undefined | Descriptor> | Retrieves the content descriptor which can be used to get content | |
| getContentSetSize(requestOptions: ContentRequestOptions<IModelDb, Descriptor | DescriptorOverrides, KeySet, RulesetVariable> & { priority?: number } & { cancelEvent?: BeEvent<() => void> } & BackendDiagnosticsAttribute): Promise<number> | Retrieves the content set size based on the supplied content descriptor override | |
| getContentSources(requestOptions: ContentSourcesRequestOptions<IModelDb> & { priority?: number } & { cancelEvent?: BeEvent<() => void> } & BackendDiagnosticsAttribute): Promise<SelectClassInfo[]> | Get information about the sources of content when building it for specific ECClasses. | |
| getDisplayLabelDefinition(requestOptions: DisplayLabelRequestOptions<IModelDb, InstanceKey> & { priority?: number } & { cancelEvent?: BeEvent<() => void> } & BackendDiagnosticsAttribute): Promise<LabelDefinition> | Retrieves display label definition of specific item | |
| getDisplayLabelDefinitions(requestOptions: DisplayLabelsRequestOptions<IModelDb, InstanceKey> & { paging?: PageOptions } & { priority?: number } & { cancelEvent?: BeEvent<() => void> } & BackendDiagnosticsAttribute): Promise<LabelDefinition[]> | Retrieves display label definitions of specific items | |
| getElementProperties(requestOptions: SingleElementPropertiesRequestOptions<IModelDb> & { priority?: number } & { cancelEvent?: BeEvent<() => void> } & BackendDiagnosticsAttribute): Promise<undefined | ElementProperties> | Retrieves property data in a simplified format for a single element specified by ID. | |
| getElementProperties(requestOptions: MultiElementPropertiesRequestOptions<IModelDb> & { priority?: number } & { cancelEvent?: BeEvent<() => void> } & BackendDiagnosticsAttribute): Promise<MultiElementPropertiesResponse> | Retrieves property data in simplified format for multiple elements specified by class or all element. | |
| getFilteredNodePaths(requestOptions: FilterByTextHierarchyRequestOptions<IModelDb, RulesetVariable> & { priority?: number } & { cancelEvent?: BeEvent<() => void> } & BackendDiagnosticsAttribute): Promise<NodePathElement[]> | Retrieves paths from root nodes to nodes containing filter text in their label. | |
| getNodePaths(requestOptions: FilterByInstancePathsHierarchyRequestOptions<IModelDb, RulesetVariable> & { priority?: number } & { cancelEvent?: BeEvent<() => void> } & BackendDiagnosticsAttribute): Promise<NodePathElement[]> | Retrieves paths from root nodes to children nodes according to specified instance key paths. | |
| getNodes(requestOptions: HierarchyRequestOptions<IModelDb, NodeKey, RulesetVariable> & { paging?: PageOptions } & { priority?: number } & { cancelEvent?: BeEvent<() => void> } & BackendDiagnosticsAttribute): Promise<Node[]> | Retrieves nodes | |
| getNodesCount(requestOptions: HierarchyRequestOptions<IModelDb, NodeKey, RulesetVariable> & { priority?: number } & { cancelEvent?: BeEvent<() => void> } & BackendDiagnosticsAttribute): Promise<number> | Retrieves nodes count | |
| getNodesDescriptor(requestOptions: HierarchyLevelDescriptorRequestOptions<IModelDb, NodeKey, RulesetVariable> & { priority?: number } & { cancelEvent?: BeEvent<() => void> } & BackendDiagnosticsAttribute): Promise<undefined | Descriptor> | Retrieves hierarchy level descriptor | Beta |
| getPagedDistinctValues(requestOptions: DistinctValuesRequestOptions<IModelDb, Descriptor | DescriptorOverrides, KeySet, RulesetVariable> & { priority?: number } & { cancelEvent?: BeEvent<() => void> } & BackendDiagnosticsAttribute): Promise<PagedResponse<DisplayValueGroup>> | Retrieves distinct values of specific field from the content based on the supplied content descriptor override. | |
| getSelectionScopes(_requestOptions: SelectionScopeRequestOptions<IModelDb> & BackendDiagnosticsAttribute): Promise<SelectionScope[]> | Retrieves available selection scopes. | |
| rulesets(): RulesetManager | Get rulesets manager | |
| vars(rulesetId: string): RulesetVariablesManager | Get ruleset variables manager for specific ruleset |
Properties
| Name | Type | Description | |
|---|---|---|---|
| activeLocale | undefined | string | Get / set active locale used for localizing presentation data | Deprecated |
| activeUnitSystem Accessor | undefined | UnitSystemKey | Get / set active unit system used to format property values with units | |
| props Accessor ReadOnly | PresentationManagerProps | Properties used to initialize the manager |
Defined in
Last Updated: 20 June, 2023