Core

Common types used all across Presentation packages.

Classes

Name	Description
KeySet	A class that holds multiple Key objects.
KoqPropertyValueFormatter	An utility for formatting property values based on KindOfQuantity and unit system.
PresentationError	An error type thrown by Presentation APIs.
RegisteredRuleset	A ruleset that is registered in a ruleset manager.
RulesetsFactory	A factory class that can be used to create presentation rulesets targeted towards

Constants

Name	Description
DEFAULT_KEYS_BATCH_SIZE	Default (recommended) keyset batch size for cases when it needs to be sent
UPDATE_FULL	A constant for indicating that a full update is required.

Enumerations

Name	Description
PresentationCommonLoggerCategory	Logger categories used by this package
PresentationStatus	Status codes used by Presentation APIs.
VariableValueTypes	Possible variable value types

Global Functions

Name	Description
getInstancesCount

Interfaces

Name	Description
ArrayPropertyValueConstraints	Describes constraints for array type ECProperty values
BooleanRulesetVariable	Data structure for representing boolean ruleset variables.
ClassInfo	Information about an ECClass
ClientDiagnostics	Data structure with client diagnostics information.
ClientDiagnosticsAttribute	Data structure which contains client diagnostics options.
ClientDiagnosticsOptions	Data structure for client diagnostics options.
CompressedClassInfoJSON	A serialized and compressed version of ClassInfo
ComputeSelectionRequestOptions	Request options used for calculating selection based on given instance keys and selection scope.
ContentDescriptorRequestOptions	Request type for content descriptor requests.
ContentInstanceKeysRequestOptions	Request type for content instance keys' requests.
ContentRequestOptions	Request type for content requests.
ContentSourcesRequestOptions	Request type for content sources requests.
Diagnostics	Data structure for diagnostics information.
DiagnosticsLogMessage	Data structure for diagnostics log message information.
DiagnosticsOptions	Data structure for diagnostics options.
DiagnosticsScopeLogs	Data structure for diagnostics scope information.
DisplayLabelRequestOptions	Request type for label requests
DisplayLabelsRequestOptions	Request type for labels requests
DistinctValuesRequestOptions	Request type for distinct values' requests.
EnumerationChoice	A single choice in enumeration
EnumerationInfo	Enumeration information
FilterByInstancePathsHierarchyRequestOptions	Request type of filtering hierarchies by given ECInstance paths.
FilterByTextHierarchyRequestOptions	Request type of filtering hierarchies by given text.
FormatOptions	Options for finding a formatter spec to use in KoqPropertyValueFormatter.
FormatsMap	A data structure that associates specific phenomenon with one or more formatting props for specific unit system.
HierarchyCompareInfo	Information about hierarchy modification / differences.
HierarchyCompareOptions	Data structure for comparing a hierarchy after ruleset or ruleset variable changes.
HierarchyLevelDescriptorRequestOptions	Params for hierarchy level descriptor requests.
HierarchyRequestOptions	Request type for hierarchy requests.
Id64RulesetVariable	Data structure for representing ID ruleset variables.
Id64sRulesetVariable	Data structure for representing ID array ruleset variables.
Id64sRulesetVariableJSON	JSON representation of Id64sRulesetVariable.
InstanceFilterDefinition	Definition of an instance filter that can be used to filter content or hierarchy levels.
InstanceFilterRelatedInstancePath	Partial definition of common attributes for InstanceFilterRelatedInstanceDefinition.
InstanceFilterRelatedInstanceRelationshipAlias	Partial definition of InstanceFilterRelatedInstanceDefinition for the case when referencing the relationship class.
InstanceFilterRelatedInstanceTargetAlias	Partial definition of InstanceFilterRelatedInstanceDefinition for the case when referencing the target class.
InstanceKey	A key that uniquely identifies an instance in an iModel
IntRulesetVariable	Data structure for representing int ruleset variables.
IntsRulesetVariable	Data structure for representing int array ruleset variables.
KeySetJSON	A data structure of serialized KeySet
KindOfQuantityInfo	Kind of quantity information
MultiElementPropertiesBaseRequestOptions	Base request type for multiple elements properties requests.
MultiElementPropertiesByClassRequestOptions	Request type for multiple elements properties requests, where elements are specified by class.
MultiElementPropertiesByIdsRequestOptions	Request type for multiple elements properties requests, where elements are specified by element id.
NavigationPropertyInfo	A data structure for storing navigation property information.
NavigationPropertyInfoJSON	A serialized version of NavigationPropertyInfo
NodeDeletionInfo	Information about node deletion.
NodeInsertionInfo	Information about node insertion.
NodeUpdateInfo	Information about node update.
NumericPropertyValueConstraints	Describes constraints for int
PagedResponse	A structure for paged responses
PageOptions	Paging options
PropertyInfo	A structure that describes an ECProperty
PropertyInfoJSON	A serialized version of PropertyInfo
RelatedClassInfo	A structure that describes a related class and the properties of that relationship.
RelatedClassInfoJSON	A serialized version of RelatedClassInfo
RequestOptions	A generic request options type used for both hierarchy and content requests.
RequestOptionsWithRuleset	Options for requests that require presentation ruleset.
RulesetVariableBase	Base data structure for representing ruleset variables.
RulesetVariableBaseJSON	JSON representation of RulesetVariableBase.
SelectionScopeRequestOptions	Request options used for selection scope related requests
SingleElementPropertiesRequestOptions	Request type for single element properties requests.
StringPropertyValueConstraints	Describes constraints for string type ECProperty values
StringRulesetVariable	Data structure for representing string ruleset variables.
StrippedRelatedClassInfo	Data structure that contains a subset of RelatedClassInfo required to
UnitSystemFormat	A data structure that associates unit systems with property value formatting props.
UpdateInfo	A data structure that describes changes that need to be applied to the hierarchy and
ValuesDictionary	A dictionary data structure.

Namespaces

Name	Description
DiagnosticsLogEntry	Functions related to diagnostics log entry.
InstanceKey
Key
NavigationPropertyInfo	Contains utilities for working with objects of NavigationPropertyInfo type.
PropertyInfo
RelatedClassInfo
RelatedClassInfoWithOptionalRelationship
RelationshipPath
RulesetVariable

Type Aliases

Name	Description
ClassId	Type of an ECClass ID.
ClientDiagnosticsHandler	A function that can be called after receiving diagnostics.
ComputeDisplayValueCallback	Definition of a function for calculating a display value.
ContentUpdateInfo	Information about a required content update.
DiagnosticsLogEntry	Data structure for diagnostics log entry.
DiagnosticsLoggerSeverity	Type of diagnostics logger severity.
ElementPropertiesRequestOptions	Request type for element properties requests
HierarchyUpdateInfo	Information about a required hierarchy update.
InstanceFilterRelatedInstanceDefinition	Related instance definition for accessing properties of a related instance in expression.
InstanceId	Type of an ECInstance ID.
Key	A single key that identifies something in an iTwin.js application
Keys	A type for multiple keys that identify something in iModel.js application
MultiElementPropertiesRequestOptions	Request type for multiple elements properties requests.
Omit	Create a type with T properties excluding properties listed in K.
Paged	A wrapper type that injects PageOptions into supplied type
PartialBy	Create a type from given type T and make specified properties optional.
PartialHierarchyModification	Information about a hierarchy change: insertion, deletion or node update.
PrimitivePropertyValue	Value of a primitive property.
Prioritized	A wrapper type that injects priority into supplied type.
PropertyValueConstraints	Constraints for values of ECProperty
RelatedClassInfoWithOptionalRelationship	A structure that describes a relationship between source and target classes where
RelatedClassInfoWithOptionalRelationshipJSON
RelationshipPath	A structure that describes a related class path.
RelationshipPathJSON	Serialized RelationshipPath
RulesetVariable	Data structure for representing ruleset variables.
RulesetVariableJSON	JSON representation of RulesetVariable.
StrippedRelationshipPath	Data structure that contains a subset of RelationshipPath required to
Subtract	Create a type with T properties excluding all properties in type K.
VariableValue	Union of all supported variable value types
VariableValueJSON	JSON representation of VariableValue
WithCancelEvent	A wrapper type that injects cancelEvent into supplied type.