@itwin/presentation-common 4.0.0-dev.8 → 4.0.0-dev.80
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +51 -1
- package/Ruleset.schema.json +11 -0
- package/lib/cjs/assets/locales/en/Presentation.json +15 -0
- package/lib/cjs/assets/locales/en-PSEUDO/Presentation.json +15 -0
- package/lib/cjs/presentation-common/AsyncTasks.d.ts +22 -22
- package/lib/cjs/presentation-common/AsyncTasks.js +38 -38
- package/lib/cjs/presentation-common/CommonLoggerCategory.d.ts +12 -12
- package/lib/cjs/presentation-common/CommonLoggerCategory.js +20 -20
- package/lib/cjs/presentation-common/Diagnostics.d.ts +125 -125
- package/lib/cjs/presentation-common/Diagnostics.d.ts.map +1 -1
- package/lib/cjs/presentation-common/Diagnostics.js +72 -72
- package/lib/cjs/presentation-common/EC.d.ts +347 -350
- package/lib/cjs/presentation-common/EC.d.ts.map +1 -1
- package/lib/cjs/presentation-common/EC.js +290 -290
- package/lib/cjs/presentation-common/EC.js.map +1 -1
- package/lib/cjs/presentation-common/ElementProperties.d.ts +123 -123
- package/lib/cjs/presentation-common/ElementProperties.d.ts.map +1 -1
- package/lib/cjs/presentation-common/ElementProperties.js +9 -9
- package/lib/cjs/presentation-common/Error.d.ts +47 -45
- package/lib/cjs/presentation-common/Error.d.ts.map +1 -1
- package/lib/cjs/presentation-common/Error.js +64 -62
- package/lib/cjs/presentation-common/Error.js.map +1 -1
- package/lib/cjs/presentation-common/InstanceFilterDefinition.d.ts +93 -93
- package/lib/cjs/presentation-common/InstanceFilterDefinition.d.ts.map +1 -1
- package/lib/cjs/presentation-common/InstanceFilterDefinition.js +9 -9
- package/lib/cjs/presentation-common/KeySet.d.ts +146 -146
- package/lib/cjs/presentation-common/KeySet.d.ts.map +1 -1
- package/lib/cjs/presentation-common/KeySet.js +428 -428
- package/lib/cjs/presentation-common/LabelDefinition.d.ts +93 -87
- package/lib/cjs/presentation-common/LabelDefinition.d.ts.map +1 -1
- package/lib/cjs/presentation-common/LabelDefinition.js +78 -73
- package/lib/cjs/presentation-common/LabelDefinition.js.map +1 -1
- package/lib/cjs/presentation-common/LocalizationHelper.d.ts +29 -29
- package/lib/cjs/presentation-common/LocalizationHelper.js +110 -110
- package/lib/cjs/presentation-common/PresentationIpcInterface.d.ts +40 -40
- package/lib/cjs/presentation-common/PresentationIpcInterface.js +12 -12
- package/lib/cjs/presentation-common/PresentationManagerOptions.d.ts +273 -261
- package/lib/cjs/presentation-common/PresentationManagerOptions.d.ts.map +1 -1
- package/lib/cjs/presentation-common/PresentationManagerOptions.js +23 -23
- package/lib/cjs/presentation-common/PresentationManagerOptions.js.map +1 -1
- package/lib/cjs/presentation-common/PresentationRpcInterface.d.ts +186 -186
- package/lib/cjs/presentation-common/PresentationRpcInterface.d.ts.map +1 -1
- package/lib/cjs/presentation-common/PresentationRpcInterface.js +108 -104
- package/lib/cjs/presentation-common/PresentationRpcInterface.js.map +1 -1
- package/lib/cjs/presentation-common/PropertyFormatter.d.ts +31 -0
- package/lib/cjs/presentation-common/PropertyFormatter.d.ts.map +1 -0
- package/lib/cjs/presentation-common/PropertyFormatter.js +199 -0
- package/lib/cjs/presentation-common/PropertyFormatter.js.map +1 -0
- package/lib/cjs/presentation-common/RegisteredRuleset.d.ts +26 -26
- package/lib/cjs/presentation-common/RegisteredRuleset.js +33 -33
- package/lib/cjs/presentation-common/RpcRequestsHandler.d.ts +82 -83
- package/lib/cjs/presentation-common/RpcRequestsHandler.d.ts.map +1 -1
- package/lib/cjs/presentation-common/RpcRequestsHandler.js +166 -171
- package/lib/cjs/presentation-common/RpcRequestsHandler.js.map +1 -1
- package/lib/cjs/presentation-common/RulesetVariables.d.ts +171 -171
- package/lib/cjs/presentation-common/RulesetVariables.d.ts.map +1 -1
- package/lib/cjs/presentation-common/RulesetVariables.js +55 -55
- package/lib/cjs/presentation-common/RulesetsFactory.d.ts +44 -44
- package/lib/cjs/presentation-common/RulesetsFactory.d.ts.map +1 -1
- package/lib/cjs/presentation-common/RulesetsFactory.js +223 -223
- package/lib/cjs/presentation-common/RulesetsFactory.js.map +1 -1
- package/lib/cjs/presentation-common/Update.d.ts +213 -213
- package/lib/cjs/presentation-common/Update.d.ts.map +1 -1
- package/lib/cjs/presentation-common/Update.js +226 -226
- package/lib/cjs/presentation-common/Utils.d.ts +62 -62
- package/lib/cjs/presentation-common/Utils.d.ts.map +1 -1
- package/lib/cjs/presentation-common/Utils.js +43 -43
- package/lib/cjs/presentation-common/content/Category.d.ts +49 -49
- package/lib/cjs/presentation-common/content/Category.js +48 -48
- package/lib/cjs/presentation-common/content/Content.d.ts +38 -38
- package/lib/cjs/presentation-common/content/Content.js +56 -56
- package/lib/cjs/presentation-common/content/ContentTraverser.d.ts +271 -271
- package/lib/cjs/presentation-common/content/ContentTraverser.js +437 -439
- package/lib/cjs/presentation-common/content/ContentTraverser.js.map +1 -1
- package/lib/cjs/presentation-common/content/Descriptor.d.ts +328 -328
- package/lib/cjs/presentation-common/content/Descriptor.js +191 -193
- package/lib/cjs/presentation-common/content/Descriptor.js.map +1 -1
- package/lib/cjs/presentation-common/content/DisplayTypes.d.ts +21 -21
- package/lib/cjs/presentation-common/content/DisplayTypes.js +29 -29
- package/lib/cjs/presentation-common/content/Editor.d.ts +15 -15
- package/lib/cjs/presentation-common/content/Editor.js +9 -9
- package/lib/cjs/presentation-common/content/Fields.d.ts +298 -301
- package/lib/cjs/presentation-common/content/Fields.d.ts.map +1 -1
- package/lib/cjs/presentation-common/content/Fields.js +393 -397
- package/lib/cjs/presentation-common/content/Fields.js.map +1 -1
- package/lib/cjs/presentation-common/content/Item.d.ts +85 -85
- package/lib/cjs/presentation-common/content/Item.d.ts.map +1 -1
- package/lib/cjs/presentation-common/content/Item.js +84 -84
- package/lib/cjs/presentation-common/content/Item.js.map +1 -1
- package/lib/cjs/presentation-common/content/Property.d.ts +57 -57
- package/lib/cjs/presentation-common/content/Property.d.ts.map +1 -1
- package/lib/cjs/presentation-common/content/Property.js +40 -40
- package/lib/cjs/presentation-common/content/Renderer.d.ts +11 -11
- package/lib/cjs/presentation-common/content/Renderer.js +9 -9
- package/lib/cjs/presentation-common/content/TypeDescription.d.ts +72 -72
- package/lib/cjs/presentation-common/content/TypeDescription.d.ts.map +1 -1
- package/lib/cjs/presentation-common/content/TypeDescription.js +23 -23
- package/lib/cjs/presentation-common/content/Value.d.ts +189 -189
- package/lib/cjs/presentation-common/content/Value.d.ts.map +1 -1
- package/lib/cjs/presentation-common/content/Value.js +273 -273
- package/lib/cjs/presentation-common/hierarchy/HierarchyLevel.d.ts +37 -37
- package/lib/cjs/presentation-common/hierarchy/HierarchyLevel.js +31 -31
- package/lib/cjs/presentation-common/hierarchy/Key.d.ts +246 -246
- package/lib/cjs/presentation-common/hierarchy/Key.d.ts.map +1 -1
- package/lib/cjs/presentation-common/hierarchy/Key.js +121 -121
- package/lib/cjs/presentation-common/hierarchy/Key.js.map +1 -1
- package/lib/cjs/presentation-common/hierarchy/Node.d.ts +154 -154
- package/lib/cjs/presentation-common/hierarchy/Node.d.ts.map +1 -1
- package/lib/cjs/presentation-common/hierarchy/Node.js +106 -106
- package/lib/cjs/presentation-common/hierarchy/Node.js.map +1 -1
- package/lib/cjs/presentation-common/hierarchy/NodePathElement.d.ts +96 -96
- package/lib/cjs/presentation-common/hierarchy/NodePathElement.js +122 -122
- package/lib/cjs/presentation-common/rules/ClassSpecifications.d.ts +45 -45
- package/lib/cjs/presentation-common/rules/ClassSpecifications.js +9 -9
- package/lib/cjs/presentation-common/rules/RelatedInstanceSpecification.d.ts +31 -31
- package/lib/cjs/presentation-common/rules/RelatedInstanceSpecification.js +9 -9
- package/lib/cjs/presentation-common/rules/RelationshipDirection.d.ts +13 -13
- package/lib/cjs/presentation-common/rules/RelationshipDirection.js +21 -21
- package/lib/cjs/presentation-common/rules/RelationshipPathSpecification.d.ts +56 -56
- package/lib/cjs/presentation-common/rules/RelationshipPathSpecification.d.ts.map +1 -1
- package/lib/cjs/presentation-common/rules/RelationshipPathSpecification.js +9 -9
- package/lib/cjs/presentation-common/rules/Rule.d.ts +76 -76
- package/lib/cjs/presentation-common/rules/Rule.js +35 -35
- package/lib/cjs/presentation-common/rules/Ruleset.d.ts +65 -65
- package/lib/cjs/presentation-common/rules/Ruleset.js +9 -9
- package/lib/cjs/presentation-common/rules/SchemasSpecification.d.ts +41 -41
- package/lib/cjs/presentation-common/rules/SchemasSpecification.js +9 -9
- package/lib/cjs/presentation-common/rules/Variables.d.ts +58 -58
- package/lib/cjs/presentation-common/rules/Variables.js +25 -25
- package/lib/cjs/presentation-common/rules/content/ContentInstancesOfSpecificClassesSpecification.d.ts +41 -41
- package/lib/cjs/presentation-common/rules/content/ContentInstancesOfSpecificClassesSpecification.js +9 -9
- package/lib/cjs/presentation-common/rules/content/ContentRelatedInstancesSpecification.d.ts +25 -25
- package/lib/cjs/presentation-common/rules/content/ContentRelatedInstancesSpecification.js +9 -9
- package/lib/cjs/presentation-common/rules/content/ContentRule.d.ts +30 -30
- package/lib/cjs/presentation-common/rules/content/ContentRule.js +9 -9
- package/lib/cjs/presentation-common/rules/content/ContentSpecification.d.ts +58 -58
- package/lib/cjs/presentation-common/rules/content/ContentSpecification.js +20 -20
- package/lib/cjs/presentation-common/rules/content/DefaultPropertyCategoryOverride.d.ts +19 -19
- package/lib/cjs/presentation-common/rules/content/DefaultPropertyCategoryOverride.js +9 -9
- package/lib/cjs/presentation-common/rules/content/PropertySpecification.d.ts +86 -86
- package/lib/cjs/presentation-common/rules/content/PropertySpecification.js +9 -9
- package/lib/cjs/presentation-common/rules/content/SelectedNodeInstancesSpecification.d.ts +28 -28
- package/lib/cjs/presentation-common/rules/content/SelectedNodeInstancesSpecification.js +9 -9
- package/lib/cjs/presentation-common/rules/content/modifiers/CalculatedPropertiesSpecification.d.ts +25 -25
- package/lib/cjs/presentation-common/rules/content/modifiers/CalculatedPropertiesSpecification.js +9 -9
- package/lib/cjs/presentation-common/rules/content/modifiers/ContentModifier.d.ts +57 -57
- package/lib/cjs/presentation-common/rules/content/modifiers/ContentModifier.js +9 -9
- package/lib/cjs/presentation-common/rules/content/modifiers/CustomRendererSpecification.d.ts +17 -17
- package/lib/cjs/presentation-common/rules/content/modifiers/CustomRendererSpecification.js +9 -9
- package/lib/cjs/presentation-common/rules/content/modifiers/PropertyCategorySpecification.d.ts +107 -107
- package/lib/cjs/presentation-common/rules/content/modifiers/PropertyCategorySpecification.d.ts.map +1 -1
- package/lib/cjs/presentation-common/rules/content/modifiers/PropertyCategorySpecification.js +9 -9
- package/lib/cjs/presentation-common/rules/content/modifiers/PropertyEditorsSpecification.d.ts +108 -108
- package/lib/cjs/presentation-common/rules/content/modifiers/PropertyEditorsSpecification.js +21 -21
- package/lib/cjs/presentation-common/rules/content/modifiers/RelatedPropertiesSpecification.d.ts +96 -96
- package/lib/cjs/presentation-common/rules/content/modifiers/RelatedPropertiesSpecification.js +43 -43
- package/lib/cjs/presentation-common/rules/customization/CheckBoxRule.d.ts +44 -44
- package/lib/cjs/presentation-common/rules/customization/CheckBoxRule.js +9 -9
- package/lib/cjs/presentation-common/rules/customization/CustomizationRule.d.ts +36 -36
- package/lib/cjs/presentation-common/rules/customization/CustomizationRule.js +9 -9
- package/lib/cjs/presentation-common/rules/customization/ExtendedDataRule.d.ts +27 -27
- package/lib/cjs/presentation-common/rules/customization/ExtendedDataRule.js +9 -9
- package/lib/cjs/presentation-common/rules/customization/GroupingRule.d.ts +207 -207
- package/lib/cjs/presentation-common/rules/customization/GroupingRule.js +51 -51
- package/lib/cjs/presentation-common/rules/customization/ImageIdOverride.d.ts +29 -29
- package/lib/cjs/presentation-common/rules/customization/ImageIdOverride.js +9 -9
- package/lib/cjs/presentation-common/rules/customization/InstanceLabelOverride.d.ts +158 -158
- package/lib/cjs/presentation-common/rules/customization/InstanceLabelOverride.d.ts.map +1 -1
- package/lib/cjs/presentation-common/rules/customization/InstanceLabelOverride.js +25 -25
- package/lib/cjs/presentation-common/rules/customization/LabelOverride.d.ts +40 -40
- package/lib/cjs/presentation-common/rules/customization/LabelOverride.js +9 -9
- package/lib/cjs/presentation-common/rules/customization/SortingRule.d.ts +58 -58
- package/lib/cjs/presentation-common/rules/customization/SortingRule.d.ts.map +1 -1
- package/lib/cjs/presentation-common/rules/customization/SortingRule.js +9 -9
- package/lib/cjs/presentation-common/rules/customization/StyleOverride.d.ts +48 -48
- package/lib/cjs/presentation-common/rules/customization/StyleOverride.js +9 -9
- package/lib/cjs/presentation-common/rules/hierarchy/ChildNodeRule.d.ts +14 -14
- package/lib/cjs/presentation-common/rules/hierarchy/ChildNodeRule.js +9 -9
- package/lib/cjs/presentation-common/rules/hierarchy/ChildNodeSpecification.d.ts +98 -98
- package/lib/cjs/presentation-common/rules/hierarchy/ChildNodeSpecification.d.ts.map +1 -1
- package/lib/cjs/presentation-common/rules/hierarchy/ChildNodeSpecification.js +21 -21
- package/lib/cjs/presentation-common/rules/hierarchy/CustomNodeSpecification.d.ts +31 -31
- package/lib/cjs/presentation-common/rules/hierarchy/CustomNodeSpecification.js +9 -9
- package/lib/cjs/presentation-common/rules/hierarchy/CustomQueryInstanceNodesSpecification.d.ts +79 -79
- package/lib/cjs/presentation-common/rules/hierarchy/CustomQueryInstanceNodesSpecification.js +19 -19
- package/lib/cjs/presentation-common/rules/hierarchy/InstanceNodesOfSpecificClassesSpecification.d.ts +39 -39
- package/lib/cjs/presentation-common/rules/hierarchy/InstanceNodesOfSpecificClassesSpecification.js +9 -9
- package/lib/cjs/presentation-common/rules/hierarchy/NavigationRule.d.ts +50 -50
- package/lib/cjs/presentation-common/rules/hierarchy/NavigationRule.d.ts.map +1 -1
- package/lib/cjs/presentation-common/rules/hierarchy/NavigationRule.js +9 -9
- package/lib/cjs/presentation-common/rules/hierarchy/NodeArtifactsRule.d.ts +27 -27
- package/lib/cjs/presentation-common/rules/hierarchy/NodeArtifactsRule.js +9 -9
- package/lib/cjs/presentation-common/rules/hierarchy/RelatedInstanceNodesSpecification.d.ts +27 -27
- package/lib/cjs/presentation-common/rules/hierarchy/RelatedInstanceNodesSpecification.js +9 -9
- package/lib/cjs/presentation-common/rules/hierarchy/RootNodeRule.d.ts +16 -16
- package/lib/cjs/presentation-common/rules/hierarchy/RootNodeRule.js +9 -9
- package/lib/cjs/presentation-common/rules/hierarchy/SubCondition.d.ts +35 -35
- package/lib/cjs/presentation-common/rules/hierarchy/SubCondition.js +9 -9
- package/lib/cjs/presentation-common/selection/SelectionScope.d.ts +38 -38
- package/lib/cjs/presentation-common/selection/SelectionScope.d.ts.map +1 -1
- package/lib/cjs/presentation-common/selection/SelectionScope.js +9 -9
- package/lib/cjs/presentation-common.d.ts +113 -112
- package/lib/cjs/presentation-common.d.ts.map +1 -1
- package/lib/cjs/presentation-common.js +133 -128
- package/lib/cjs/presentation-common.js.map +1 -1
- package/lib/esm/presentation-common/AsyncTasks.d.ts +22 -22
- package/lib/esm/presentation-common/AsyncTasks.js +34 -34
- package/lib/esm/presentation-common/CommonLoggerCategory.d.ts +12 -12
- package/lib/esm/presentation-common/CommonLoggerCategory.js +17 -17
- package/lib/esm/presentation-common/Diagnostics.d.ts +125 -125
- package/lib/esm/presentation-common/Diagnostics.d.ts.map +1 -1
- package/lib/esm/presentation-common/Diagnostics.js +67 -67
- package/lib/esm/presentation-common/EC.d.ts +347 -350
- package/lib/esm/presentation-common/EC.d.ts.map +1 -1
- package/lib/esm/presentation-common/EC.js +287 -287
- package/lib/esm/presentation-common/EC.js.map +1 -1
- package/lib/esm/presentation-common/ElementProperties.d.ts +123 -123
- package/lib/esm/presentation-common/ElementProperties.d.ts.map +1 -1
- package/lib/esm/presentation-common/ElementProperties.js +8 -8
- package/lib/esm/presentation-common/Error.d.ts +47 -45
- package/lib/esm/presentation-common/Error.d.ts.map +1 -1
- package/lib/esm/presentation-common/Error.js +60 -58
- package/lib/esm/presentation-common/Error.js.map +1 -1
- package/lib/esm/presentation-common/InstanceFilterDefinition.d.ts +93 -93
- package/lib/esm/presentation-common/InstanceFilterDefinition.d.ts.map +1 -1
- package/lib/esm/presentation-common/InstanceFilterDefinition.js +8 -8
- package/lib/esm/presentation-common/KeySet.d.ts +146 -146
- package/lib/esm/presentation-common/KeySet.d.ts.map +1 -1
- package/lib/esm/presentation-common/KeySet.js +424 -424
- package/lib/esm/presentation-common/LabelDefinition.d.ts +93 -87
- package/lib/esm/presentation-common/LabelDefinition.d.ts.map +1 -1
- package/lib/esm/presentation-common/LabelDefinition.js +75 -70
- package/lib/esm/presentation-common/LabelDefinition.js.map +1 -1
- package/lib/esm/presentation-common/LocalizationHelper.d.ts +29 -29
- package/lib/esm/presentation-common/LocalizationHelper.js +106 -106
- package/lib/esm/presentation-common/PresentationIpcInterface.d.ts +40 -40
- package/lib/esm/presentation-common/PresentationIpcInterface.js +9 -9
- package/lib/esm/presentation-common/PresentationManagerOptions.d.ts +273 -261
- package/lib/esm/presentation-common/PresentationManagerOptions.d.ts.map +1 -1
- package/lib/esm/presentation-common/PresentationManagerOptions.js +18 -18
- package/lib/esm/presentation-common/PresentationManagerOptions.js.map +1 -1
- package/lib/esm/presentation-common/PresentationRpcInterface.d.ts +186 -186
- package/lib/esm/presentation-common/PresentationRpcInterface.d.ts.map +1 -1
- package/lib/esm/presentation-common/PresentationRpcInterface.js +105 -100
- package/lib/esm/presentation-common/PresentationRpcInterface.js.map +1 -1
- package/lib/esm/presentation-common/PropertyFormatter.d.ts +31 -0
- package/lib/esm/presentation-common/PropertyFormatter.d.ts.map +1 -0
- package/lib/esm/presentation-common/PropertyFormatter.js +194 -0
- package/lib/esm/presentation-common/PropertyFormatter.js.map +1 -0
- package/lib/esm/presentation-common/RegisteredRuleset.d.ts +26 -26
- package/lib/esm/presentation-common/RegisteredRuleset.js +29 -29
- package/lib/esm/presentation-common/RpcRequestsHandler.d.ts +82 -83
- package/lib/esm/presentation-common/RpcRequestsHandler.d.ts.map +1 -1
- package/lib/esm/presentation-common/RpcRequestsHandler.js +162 -167
- package/lib/esm/presentation-common/RpcRequestsHandler.js.map +1 -1
- package/lib/esm/presentation-common/RulesetVariables.d.ts +171 -171
- package/lib/esm/presentation-common/RulesetVariables.d.ts.map +1 -1
- package/lib/esm/presentation-common/RulesetVariables.js +52 -52
- package/lib/esm/presentation-common/RulesetsFactory.d.ts +44 -44
- package/lib/esm/presentation-common/RulesetsFactory.d.ts.map +1 -1
- package/lib/esm/presentation-common/RulesetsFactory.js +219 -219
- package/lib/esm/presentation-common/RulesetsFactory.js.map +1 -1
- package/lib/esm/presentation-common/Update.d.ts +213 -213
- package/lib/esm/presentation-common/Update.d.ts.map +1 -1
- package/lib/esm/presentation-common/Update.js +223 -223
- package/lib/esm/presentation-common/Utils.d.ts +62 -62
- package/lib/esm/presentation-common/Utils.d.ts.map +1 -1
- package/lib/esm/presentation-common/Utils.js +39 -39
- package/lib/esm/presentation-common/content/Category.d.ts +49 -49
- package/lib/esm/presentation-common/content/Category.js +45 -45
- package/lib/esm/presentation-common/content/Content.d.ts +38 -38
- package/lib/esm/presentation-common/content/Content.js +52 -52
- package/lib/esm/presentation-common/content/ContentTraverser.d.ts +271 -271
- package/lib/esm/presentation-common/content/ContentTraverser.js +427 -429
- package/lib/esm/presentation-common/content/ContentTraverser.js.map +1 -1
- package/lib/esm/presentation-common/content/Descriptor.d.ts +328 -328
- package/lib/esm/presentation-common/content/Descriptor.js +187 -189
- package/lib/esm/presentation-common/content/Descriptor.js.map +1 -1
- package/lib/esm/presentation-common/content/DisplayTypes.d.ts +21 -21
- package/lib/esm/presentation-common/content/DisplayTypes.js +26 -26
- package/lib/esm/presentation-common/content/Editor.d.ts +15 -15
- package/lib/esm/presentation-common/content/Editor.js +8 -8
- package/lib/esm/presentation-common/content/Fields.d.ts +298 -301
- package/lib/esm/presentation-common/content/Fields.d.ts.map +1 -1
- package/lib/esm/presentation-common/content/Fields.js +386 -390
- package/lib/esm/presentation-common/content/Fields.js.map +1 -1
- package/lib/esm/presentation-common/content/Item.d.ts +85 -85
- package/lib/esm/presentation-common/content/Item.d.ts.map +1 -1
- package/lib/esm/presentation-common/content/Item.js +80 -80
- package/lib/esm/presentation-common/content/Item.js.map +1 -1
- package/lib/esm/presentation-common/content/Property.d.ts +57 -57
- package/lib/esm/presentation-common/content/Property.d.ts.map +1 -1
- package/lib/esm/presentation-common/content/Property.js +37 -37
- package/lib/esm/presentation-common/content/Renderer.d.ts +11 -11
- package/lib/esm/presentation-common/content/Renderer.js +8 -8
- package/lib/esm/presentation-common/content/TypeDescription.d.ts +72 -72
- package/lib/esm/presentation-common/content/TypeDescription.d.ts.map +1 -1
- package/lib/esm/presentation-common/content/TypeDescription.js +20 -20
- package/lib/esm/presentation-common/content/Value.d.ts +189 -189
- package/lib/esm/presentation-common/content/Value.d.ts.map +1 -1
- package/lib/esm/presentation-common/content/Value.js +270 -270
- package/lib/esm/presentation-common/hierarchy/HierarchyLevel.d.ts +37 -37
- package/lib/esm/presentation-common/hierarchy/HierarchyLevel.js +28 -28
- package/lib/esm/presentation-common/hierarchy/Key.d.ts +246 -246
- package/lib/esm/presentation-common/hierarchy/Key.d.ts.map +1 -1
- package/lib/esm/presentation-common/hierarchy/Key.js +118 -118
- package/lib/esm/presentation-common/hierarchy/Key.js.map +1 -1
- package/lib/esm/presentation-common/hierarchy/Node.d.ts +154 -154
- package/lib/esm/presentation-common/hierarchy/Node.d.ts.map +1 -1
- package/lib/esm/presentation-common/hierarchy/Node.js +103 -103
- package/lib/esm/presentation-common/hierarchy/Node.js.map +1 -1
- package/lib/esm/presentation-common/hierarchy/NodePathElement.d.ts +96 -96
- package/lib/esm/presentation-common/hierarchy/NodePathElement.js +119 -119
- package/lib/esm/presentation-common/rules/ClassSpecifications.d.ts +45 -45
- package/lib/esm/presentation-common/rules/ClassSpecifications.js +8 -8
- package/lib/esm/presentation-common/rules/RelatedInstanceSpecification.d.ts +31 -31
- package/lib/esm/presentation-common/rules/RelatedInstanceSpecification.js +8 -8
- package/lib/esm/presentation-common/rules/RelationshipDirection.d.ts +13 -13
- package/lib/esm/presentation-common/rules/RelationshipDirection.js +18 -18
- package/lib/esm/presentation-common/rules/RelationshipPathSpecification.d.ts +56 -56
- package/lib/esm/presentation-common/rules/RelationshipPathSpecification.d.ts.map +1 -1
- package/lib/esm/presentation-common/rules/RelationshipPathSpecification.js +8 -8
- package/lib/esm/presentation-common/rules/Rule.d.ts +76 -76
- package/lib/esm/presentation-common/rules/Rule.js +32 -32
- package/lib/esm/presentation-common/rules/Ruleset.d.ts +65 -65
- package/lib/esm/presentation-common/rules/Ruleset.js +8 -8
- package/lib/esm/presentation-common/rules/SchemasSpecification.d.ts +41 -41
- package/lib/esm/presentation-common/rules/SchemasSpecification.js +8 -8
- package/lib/esm/presentation-common/rules/Variables.d.ts +58 -58
- package/lib/esm/presentation-common/rules/Variables.js +22 -22
- package/lib/esm/presentation-common/rules/content/ContentInstancesOfSpecificClassesSpecification.d.ts +41 -41
- package/lib/esm/presentation-common/rules/content/ContentInstancesOfSpecificClassesSpecification.js +8 -8
- package/lib/esm/presentation-common/rules/content/ContentRelatedInstancesSpecification.d.ts +25 -25
- package/lib/esm/presentation-common/rules/content/ContentRelatedInstancesSpecification.js +8 -8
- package/lib/esm/presentation-common/rules/content/ContentRule.d.ts +30 -30
- package/lib/esm/presentation-common/rules/content/ContentRule.js +8 -8
- package/lib/esm/presentation-common/rules/content/ContentSpecification.d.ts +58 -58
- package/lib/esm/presentation-common/rules/content/ContentSpecification.js +17 -17
- package/lib/esm/presentation-common/rules/content/DefaultPropertyCategoryOverride.d.ts +19 -19
- package/lib/esm/presentation-common/rules/content/DefaultPropertyCategoryOverride.js +8 -8
- package/lib/esm/presentation-common/rules/content/PropertySpecification.d.ts +86 -86
- package/lib/esm/presentation-common/rules/content/PropertySpecification.js +8 -8
- package/lib/esm/presentation-common/rules/content/SelectedNodeInstancesSpecification.d.ts +28 -28
- package/lib/esm/presentation-common/rules/content/SelectedNodeInstancesSpecification.js +8 -8
- package/lib/esm/presentation-common/rules/content/modifiers/CalculatedPropertiesSpecification.d.ts +25 -25
- package/lib/esm/presentation-common/rules/content/modifiers/CalculatedPropertiesSpecification.js +8 -8
- package/lib/esm/presentation-common/rules/content/modifiers/ContentModifier.d.ts +57 -57
- package/lib/esm/presentation-common/rules/content/modifiers/ContentModifier.js +8 -8
- package/lib/esm/presentation-common/rules/content/modifiers/CustomRendererSpecification.d.ts +17 -17
- package/lib/esm/presentation-common/rules/content/modifiers/CustomRendererSpecification.js +8 -8
- package/lib/esm/presentation-common/rules/content/modifiers/PropertyCategorySpecification.d.ts +107 -107
- package/lib/esm/presentation-common/rules/content/modifiers/PropertyCategorySpecification.d.ts.map +1 -1
- package/lib/esm/presentation-common/rules/content/modifiers/PropertyCategorySpecification.js +8 -8
- package/lib/esm/presentation-common/rules/content/modifiers/PropertyEditorsSpecification.d.ts +108 -108
- package/lib/esm/presentation-common/rules/content/modifiers/PropertyEditorsSpecification.js +18 -18
- package/lib/esm/presentation-common/rules/content/modifiers/RelatedPropertiesSpecification.d.ts +96 -96
- package/lib/esm/presentation-common/rules/content/modifiers/RelatedPropertiesSpecification.js +40 -40
- package/lib/esm/presentation-common/rules/customization/CheckBoxRule.d.ts +44 -44
- package/lib/esm/presentation-common/rules/customization/CheckBoxRule.js +8 -8
- package/lib/esm/presentation-common/rules/customization/CustomizationRule.d.ts +36 -36
- package/lib/esm/presentation-common/rules/customization/CustomizationRule.js +8 -8
- package/lib/esm/presentation-common/rules/customization/ExtendedDataRule.d.ts +27 -27
- package/lib/esm/presentation-common/rules/customization/ExtendedDataRule.js +8 -8
- package/lib/esm/presentation-common/rules/customization/GroupingRule.d.ts +207 -207
- package/lib/esm/presentation-common/rules/customization/GroupingRule.js +48 -48
- package/lib/esm/presentation-common/rules/customization/ImageIdOverride.d.ts +29 -29
- package/lib/esm/presentation-common/rules/customization/ImageIdOverride.js +8 -8
- package/lib/esm/presentation-common/rules/customization/InstanceLabelOverride.d.ts +158 -158
- package/lib/esm/presentation-common/rules/customization/InstanceLabelOverride.d.ts.map +1 -1
- package/lib/esm/presentation-common/rules/customization/InstanceLabelOverride.js +22 -22
- package/lib/esm/presentation-common/rules/customization/LabelOverride.d.ts +40 -40
- package/lib/esm/presentation-common/rules/customization/LabelOverride.js +8 -8
- package/lib/esm/presentation-common/rules/customization/SortingRule.d.ts +58 -58
- package/lib/esm/presentation-common/rules/customization/SortingRule.d.ts.map +1 -1
- package/lib/esm/presentation-common/rules/customization/SortingRule.js +8 -8
- package/lib/esm/presentation-common/rules/customization/StyleOverride.d.ts +48 -48
- package/lib/esm/presentation-common/rules/customization/StyleOverride.js +8 -8
- package/lib/esm/presentation-common/rules/hierarchy/ChildNodeRule.d.ts +14 -14
- package/lib/esm/presentation-common/rules/hierarchy/ChildNodeRule.js +8 -8
- package/lib/esm/presentation-common/rules/hierarchy/ChildNodeSpecification.d.ts +98 -98
- package/lib/esm/presentation-common/rules/hierarchy/ChildNodeSpecification.d.ts.map +1 -1
- package/lib/esm/presentation-common/rules/hierarchy/ChildNodeSpecification.js +18 -18
- package/lib/esm/presentation-common/rules/hierarchy/CustomNodeSpecification.d.ts +31 -31
- package/lib/esm/presentation-common/rules/hierarchy/CustomNodeSpecification.js +8 -8
- package/lib/esm/presentation-common/rules/hierarchy/CustomQueryInstanceNodesSpecification.d.ts +79 -79
- package/lib/esm/presentation-common/rules/hierarchy/CustomQueryInstanceNodesSpecification.js +16 -16
- package/lib/esm/presentation-common/rules/hierarchy/InstanceNodesOfSpecificClassesSpecification.d.ts +39 -39
- package/lib/esm/presentation-common/rules/hierarchy/InstanceNodesOfSpecificClassesSpecification.js +8 -8
- package/lib/esm/presentation-common/rules/hierarchy/NavigationRule.d.ts +50 -50
- package/lib/esm/presentation-common/rules/hierarchy/NavigationRule.d.ts.map +1 -1
- package/lib/esm/presentation-common/rules/hierarchy/NavigationRule.js +8 -8
- package/lib/esm/presentation-common/rules/hierarchy/NodeArtifactsRule.d.ts +27 -27
- package/lib/esm/presentation-common/rules/hierarchy/NodeArtifactsRule.js +8 -8
- package/lib/esm/presentation-common/rules/hierarchy/RelatedInstanceNodesSpecification.d.ts +27 -27
- package/lib/esm/presentation-common/rules/hierarchy/RelatedInstanceNodesSpecification.js +8 -8
- package/lib/esm/presentation-common/rules/hierarchy/RootNodeRule.d.ts +16 -16
- package/lib/esm/presentation-common/rules/hierarchy/RootNodeRule.js +8 -8
- package/lib/esm/presentation-common/rules/hierarchy/SubCondition.d.ts +35 -35
- package/lib/esm/presentation-common/rules/hierarchy/SubCondition.js +8 -8
- package/lib/esm/presentation-common/selection/SelectionScope.d.ts +38 -38
- package/lib/esm/presentation-common/selection/SelectionScope.d.ts.map +1 -1
- package/lib/esm/presentation-common/selection/SelectionScope.js +8 -8
- package/lib/esm/presentation-common.d.ts +113 -112
- package/lib/esm/presentation-common.d.ts.map +1 -1
- package/lib/esm/presentation-common.js +117 -116
- package/lib/esm/presentation-common.js.map +1 -1
- package/lib/public/locales/en/Presentation.json +15 -0
- package/package.json +17 -15
- package/lib/cjs/assets/locales/en/BisCore.json +0 -18
- package/lib/cjs/assets/locales/en/ECPresentation.json +0 -9
- package/lib/cjs/assets/locales/en/RulesEngine.json +0 -6
- package/lib/cjs/assets/locales/en-PSEUDO/BisCore.json +0 -18
- package/lib/cjs/assets/locales/en-PSEUDO/ECPresentation.json +0 -9
- package/lib/cjs/assets/locales/en-PSEUDO/RulesEngine.json +0 -6
- package/lib/public/locales/en/BisCore.json +0 -18
- package/lib/public/locales/en/ECPresentation.json +0 -9
- package/lib/public/locales/en/RulesEngine.json +0 -6
|
@@ -1,59 +1,61 @@
|
|
|
1
|
-
/*---------------------------------------------------------------------------------------------
|
|
2
|
-
* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
|
|
3
|
-
* See LICENSE.md in the project root for license terms and full copyright notice.
|
|
4
|
-
*--------------------------------------------------------------------------------------------*/
|
|
5
|
-
/** @packageDocumentation
|
|
6
|
-
* @module Core
|
|
7
|
-
*/
|
|
8
|
-
import { BentleyError } from "@itwin/core-bentley";
|
|
9
|
-
/**
|
|
10
|
-
* Status codes used by Presentation APIs.
|
|
11
|
-
* @public
|
|
12
|
-
*/
|
|
13
|
-
export var PresentationStatus;
|
|
14
|
-
(function (PresentationStatus) {
|
|
15
|
-
/** Success result. */
|
|
16
|
-
PresentationStatus[PresentationStatus["Success"] = 0] = "Success";
|
|
17
|
-
/** Request was cancelled. */
|
|
18
|
-
PresentationStatus[PresentationStatus["Canceled"] = 1] = "Canceled";
|
|
19
|
-
/** Error: Unknown */
|
|
20
|
-
PresentationStatus[PresentationStatus["Error"] = 65536] = "Error";
|
|
21
|
-
/** Error: Backend is not initialized. */
|
|
22
|
-
PresentationStatus[PresentationStatus["NotInitialized"] = 65537] = "NotInitialized";
|
|
23
|
-
/** Error:
|
|
24
|
-
PresentationStatus[PresentationStatus["
|
|
25
|
-
/**
|
|
26
|
-
|
|
27
|
-
|
|
28
|
-
|
|
29
|
-
|
|
30
|
-
|
|
31
|
-
|
|
32
|
-
|
|
33
|
-
|
|
34
|
-
|
|
35
|
-
|
|
36
|
-
|
|
37
|
-
|
|
38
|
-
|
|
39
|
-
*
|
|
40
|
-
*
|
|
41
|
-
* @param
|
|
42
|
-
*
|
|
43
|
-
|
|
44
|
-
|
|
45
|
-
|
|
46
|
-
|
|
47
|
-
|
|
48
|
-
|
|
49
|
-
|
|
50
|
-
|
|
51
|
-
|
|
52
|
-
|
|
53
|
-
|
|
54
|
-
|
|
55
|
-
|
|
56
|
-
|
|
57
|
-
|
|
58
|
-
|
|
1
|
+
/*---------------------------------------------------------------------------------------------
|
|
2
|
+
* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
|
|
3
|
+
* See LICENSE.md in the project root for license terms and full copyright notice.
|
|
4
|
+
*--------------------------------------------------------------------------------------------*/
|
|
5
|
+
/** @packageDocumentation
|
|
6
|
+
* @module Core
|
|
7
|
+
*/
|
|
8
|
+
import { BentleyError } from "@itwin/core-bentley";
|
|
9
|
+
/**
|
|
10
|
+
* Status codes used by Presentation APIs.
|
|
11
|
+
* @public
|
|
12
|
+
*/
|
|
13
|
+
export var PresentationStatus;
|
|
14
|
+
(function (PresentationStatus) {
|
|
15
|
+
/** Success result. */
|
|
16
|
+
PresentationStatus[PresentationStatus["Success"] = 0] = "Success";
|
|
17
|
+
/** Request was cancelled. */
|
|
18
|
+
PresentationStatus[PresentationStatus["Canceled"] = 1] = "Canceled";
|
|
19
|
+
/** Error: Unknown */
|
|
20
|
+
PresentationStatus[PresentationStatus["Error"] = 65536] = "Error";
|
|
21
|
+
/** Error: Backend is not initialized. */
|
|
22
|
+
PresentationStatus[PresentationStatus["NotInitialized"] = 65537] = "NotInitialized";
|
|
23
|
+
/** Error: Result set is too large. */
|
|
24
|
+
PresentationStatus[PresentationStatus["ResultSetTooLarge"] = 65538] = "ResultSetTooLarge";
|
|
25
|
+
/** Error: Argument is invalid. */
|
|
26
|
+
PresentationStatus[PresentationStatus["InvalidArgument"] = 65539] = "InvalidArgument";
|
|
27
|
+
/**
|
|
28
|
+
* Timeout for the request was reached which prevented it from being fulfilled. Frontend may
|
|
29
|
+
* repeat the request.
|
|
30
|
+
*/
|
|
31
|
+
PresentationStatus[PresentationStatus["BackendTimeout"] = 65543] = "BackendTimeout";
|
|
32
|
+
})(PresentationStatus || (PresentationStatus = {}));
|
|
33
|
+
/**
|
|
34
|
+
* An error type thrown by Presentation APIs.
|
|
35
|
+
* @public
|
|
36
|
+
*/
|
|
37
|
+
export class PresentationError extends BentleyError {
|
|
38
|
+
/**
|
|
39
|
+
* Creates an instance of Error.
|
|
40
|
+
* @param errorNumber Error code
|
|
41
|
+
* @param message Optional brief description of the error. The `message` property combined with the `name`
|
|
42
|
+
* property is used by the `Error.prototype.toString()` method to create a string representation of the Error.
|
|
43
|
+
* @param log Optional log function which logs the error.
|
|
44
|
+
* @param getMetaData Optional function that returns meta-data related to an error.
|
|
45
|
+
*/
|
|
46
|
+
constructor(errorNumber, message, getMetaData) {
|
|
47
|
+
super(errorNumber, message, getMetaData);
|
|
48
|
+
}
|
|
49
|
+
/**
|
|
50
|
+
* Returns the name of each error status. The name is used by the `Error.prototype.toString()`
|
|
51
|
+
* method to create a string representation of the error.
|
|
52
|
+
*/
|
|
53
|
+
// eslint-disable-next-line @typescript-eslint/naming-convention
|
|
54
|
+
_initName() {
|
|
55
|
+
let value = PresentationStatus[this.errorNumber];
|
|
56
|
+
if (!value)
|
|
57
|
+
value = `Unknown Error (${this.errorNumber})`;
|
|
58
|
+
return value;
|
|
59
|
+
}
|
|
60
|
+
}
|
|
59
61
|
//# sourceMappingURL=Error.js.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"Error.js","sourceRoot":"","sources":["../../../src/presentation-common/Error.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG;AAEH,OAAO,EAAE,YAAY,EAAuB,MAAM,qBAAqB,CAAC;AAExE;;;GAGG;AACH,MAAM,CAAN,IAAY,
|
|
1
|
+
{"version":3,"file":"Error.js","sourceRoot":"","sources":["../../../src/presentation-common/Error.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG;AAEH,OAAO,EAAE,YAAY,EAAuB,MAAM,qBAAqB,CAAC;AAExE;;;GAGG;AACH,MAAM,CAAN,IAAY,kBAwBX;AAxBD,WAAY,kBAAkB;IAC5B,sBAAsB;IACtB,iEAAW,CAAA;IAEX,6BAA6B;IAC7B,mEAAY,CAAA;IAEZ,qBAAqB;IACrB,iEAAe,CAAA;IAEf,yCAAyC;IACzC,mFAA0B,CAAA;IAE1B,sCAAsC;IACtC,yFAA6B,CAAA;IAE7B,kCAAkC;IAClC,qFAA2B,CAAA;IAE3B;;;OAGG;IACH,mFAA0B,CAAA;AAC5B,CAAC,EAxBW,kBAAkB,KAAlB,kBAAkB,QAwB7B;AAED;;;GAGG;AACH,MAAM,OAAO,iBAAkB,SAAQ,YAAY;IAEjD;;;;;;;OAOG;IACH,YAAmB,WAA+B,EAAE,OAAgB,EAAE,WAAiC;QACrG,KAAK,CAAC,WAAW,EAAE,OAAO,EAAE,WAAW,CAAC,CAAC;IAC3C,CAAC;IAED;;;OAGG;IACH,gEAAgE;IAC7C,SAAS;QAC1B,IAAI,KAAK,GAAG,kBAAkB,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;QACjD,IAAI,CAAC,KAAK;YACR,KAAK,GAAG,kBAAkB,IAAI,CAAC,WAAW,GAAG,CAAC;QAChD,OAAO,KAAK,CAAC;IACf,CAAC;CACF","sourcesContent":["/*---------------------------------------------------------------------------------------------\r\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\r\n* See LICENSE.md in the project root for license terms and full copyright notice.\r\n*--------------------------------------------------------------------------------------------*/\r\n/** @packageDocumentation\r\n * @module Core\r\n */\r\n\r\nimport { BentleyError, GetMetaDataFunction } from \"@itwin/core-bentley\";\r\n\r\n/**\r\n * Status codes used by Presentation APIs.\r\n * @public\r\n */\r\nexport enum PresentationStatus {\r\n /** Success result. */\r\n Success = 0,\r\n\r\n /** Request was cancelled. */\r\n Canceled = 1,\r\n\r\n /** Error: Unknown */\r\n Error = 0x10000,\r\n\r\n /** Error: Backend is not initialized. */\r\n NotInitialized = Error + 1,\r\n\r\n /** Error: Result set is too large. */\r\n ResultSetTooLarge = Error + 2,\r\n\r\n /** Error: Argument is invalid. */\r\n InvalidArgument = Error + 3,\r\n\r\n /**\r\n * Timeout for the request was reached which prevented it from being fulfilled. Frontend may\r\n * repeat the request.\r\n */\r\n BackendTimeout = Error + 7,\r\n}\r\n\r\n/**\r\n * An error type thrown by Presentation APIs.\r\n * @public\r\n */\r\nexport class PresentationError extends BentleyError {\r\n\r\n /**\r\n * Creates an instance of Error.\r\n * @param errorNumber Error code\r\n * @param message Optional brief description of the error. The `message` property combined with the `name`\r\n * property is used by the `Error.prototype.toString()` method to create a string representation of the Error.\r\n * @param log Optional log function which logs the error.\r\n * @param getMetaData Optional function that returns meta-data related to an error.\r\n */\r\n public constructor(errorNumber: PresentationStatus, message?: string, getMetaData?: GetMetaDataFunction) {\r\n super(errorNumber, message, getMetaData);\r\n }\r\n\r\n /**\r\n * Returns the name of each error status. The name is used by the `Error.prototype.toString()`\r\n * method to create a string representation of the error.\r\n */\r\n // eslint-disable-next-line @typescript-eslint/naming-convention\r\n protected override _initName(): string {\r\n let value = PresentationStatus[this.errorNumber];\r\n if (!value)\r\n value = `Unknown Error (${this.errorNumber})`;\r\n return value;\r\n }\r\n}\r\n"]}
|
|
@@ -1,94 +1,94 @@
|
|
|
1
|
-
/** @packageDocumentation
|
|
2
|
-
* @module Core
|
|
3
|
-
*/
|
|
4
|
-
import { StrippedRelationshipPath } from "./EC";
|
|
5
|
-
/**
|
|
6
|
-
* Definition of an instance filter that can be used to filter content or hierarchy levels.
|
|
7
|
-
*
|
|
8
|
-
* Example:
|
|
9
|
-
*
|
|
10
|
-
* ```json
|
|
11
|
-
* {
|
|
12
|
-
* selectClassName: "MySchema:MyClass",
|
|
13
|
-
* expression: "this.MyProperty = 1 AND other.OtherProperty = 2",
|
|
14
|
-
* relatedInstances: [{
|
|
15
|
-
* pathFromSelectToPropertyClass: [{
|
|
16
|
-
* sourceClassName: "MySchema:MyClass",
|
|
17
|
-
* relationshipName: "MySchema:RelationshipFromMyToOtherClass",
|
|
18
|
-
* isForwardRelationship: true,
|
|
19
|
-
* targetClassName: "MySchema:OtherClass",
|
|
20
|
-
* }],
|
|
21
|
-
* alias: "other",
|
|
22
|
-
* }],
|
|
23
|
-
* }
|
|
24
|
-
* ```
|
|
25
|
-
*
|
|
26
|
-
* @beta
|
|
27
|
-
*/
|
|
28
|
-
export interface InstanceFilterDefinition {
|
|
29
|
-
/**
|
|
30
|
-
* Select class filter used to select only instances of specific class.
|
|
31
|
-
* The [[relatedInstances]] attribute, when used, should specify paths from this class.
|
|
32
|
-
* Also, the [[expression]] attribute's `this` symbol points to instances of this class.
|
|
33
|
-
*
|
|
34
|
-
* The format is full class name: `SchemaName:ClassName`.
|
|
35
|
-
*/
|
|
36
|
-
selectClassName: string;
|
|
37
|
-
/**
|
|
38
|
-
* Specifies relationship paths pointing to related instances used in the [[expression]] attribute.
|
|
39
|
-
*
|
|
40
|
-
* Sometimes there's a need to filter on a related instance property. In that case, the relationship
|
|
41
|
-
* needs to be named by specifying the path and alias for the target (or the relationship). Then, the
|
|
42
|
-
* related instance's symbol context can be accessed through the root symbol named as specified in the
|
|
43
|
-
* [[alias]] (or [[relationshipAlias]]) attribute.
|
|
44
|
-
*/
|
|
45
|
-
relatedInstances?: InstanceFilterRelatedInstanceDefinition[];
|
|
46
|
-
/**
|
|
47
|
-
* [ECExpression]($docs/presentation/advanced/ECExpressions.md) for filtering the select instances.
|
|
48
|
-
*/
|
|
49
|
-
expression: string;
|
|
50
|
-
}
|
|
51
|
-
/**
|
|
52
|
-
* Related instance definition for accessing properties of a related instance in [[InstanceFilterDefinition.expression]].
|
|
53
|
-
* @beta
|
|
54
|
-
*/
|
|
55
|
-
export
|
|
56
|
-
/**
|
|
57
|
-
* Partial definition of common attributes for [[InstanceFilterRelatedInstanceDefinition]].
|
|
58
|
-
* @beta
|
|
59
|
-
*/
|
|
60
|
-
export interface InstanceFilterRelatedInstancePath {
|
|
61
|
-
/**
|
|
62
|
-
* A relationship path from select class (either specified through [[InstanceFilterDefinition.selectClassName]] or taken from context)
|
|
63
|
-
* to the target related instance containing the properties used in [[InstanceFilterDefinition.expression]].
|
|
64
|
-
*/
|
|
65
|
-
pathFromSelectToPropertyClass: StrippedRelationshipPath;
|
|
66
|
-
/**
|
|
67
|
-
* An optional flag indicating that the target instance must exist. Setting this allows to filter out all
|
|
68
|
-
* select instances that don't have a related instance by following the [[pathFromSelectToPropertyClass]] path.
|
|
69
|
-
*/
|
|
70
|
-
isRequired?: boolean;
|
|
71
|
-
}
|
|
72
|
-
/**
|
|
73
|
-
* Partial definition of [[InstanceFilterRelatedInstanceDefinition]] for the case when referencing the target class.
|
|
74
|
-
* @beta
|
|
75
|
-
*/
|
|
76
|
-
export interface InstanceFilterRelatedInstanceTargetAlias {
|
|
77
|
-
/**
|
|
78
|
-
* An alias for the target class in the [[InstanceFilterRelatedInstancePath.pathFromSelectToPropertyClass]] path. This alias can be used to
|
|
79
|
-
* access related instance symbols context in the [[InstanceFilterDefinition.expression]].
|
|
80
|
-
*/
|
|
81
|
-
alias: string;
|
|
82
|
-
}
|
|
83
|
-
/**
|
|
84
|
-
* Partial definition of [[InstanceFilterRelatedInstanceDefinition]] for the case when referencing the relationship class.
|
|
85
|
-
* @beta
|
|
86
|
-
*/
|
|
87
|
-
export interface InstanceFilterRelatedInstanceRelationshipAlias {
|
|
88
|
-
/**
|
|
89
|
-
* An alias for the relationship in the last step of the [[InstanceFilterRelatedInstancePath.pathFromSelectToPropertyClass]] path. This alias can be
|
|
90
|
-
* used to access the relationship instance symbols context in the [[InstanceFilterDefinition.expression]].
|
|
91
|
-
*/
|
|
92
|
-
relationshipAlias: string;
|
|
93
|
-
}
|
|
1
|
+
/** @packageDocumentation
|
|
2
|
+
* @module Core
|
|
3
|
+
*/
|
|
4
|
+
import { StrippedRelationshipPath } from "./EC";
|
|
5
|
+
/**
|
|
6
|
+
* Definition of an instance filter that can be used to filter content or hierarchy levels.
|
|
7
|
+
*
|
|
8
|
+
* Example:
|
|
9
|
+
*
|
|
10
|
+
* ```json
|
|
11
|
+
* {
|
|
12
|
+
* selectClassName: "MySchema:MyClass",
|
|
13
|
+
* expression: "this.MyProperty = 1 AND other.OtherProperty = 2",
|
|
14
|
+
* relatedInstances: [{
|
|
15
|
+
* pathFromSelectToPropertyClass: [{
|
|
16
|
+
* sourceClassName: "MySchema:MyClass",
|
|
17
|
+
* relationshipName: "MySchema:RelationshipFromMyToOtherClass",
|
|
18
|
+
* isForwardRelationship: true,
|
|
19
|
+
* targetClassName: "MySchema:OtherClass",
|
|
20
|
+
* }],
|
|
21
|
+
* alias: "other",
|
|
22
|
+
* }],
|
|
23
|
+
* }
|
|
24
|
+
* ```
|
|
25
|
+
*
|
|
26
|
+
* @beta
|
|
27
|
+
*/
|
|
28
|
+
export interface InstanceFilterDefinition {
|
|
29
|
+
/**
|
|
30
|
+
* Select class filter used to select only instances of specific class.
|
|
31
|
+
* The [[relatedInstances]] attribute, when used, should specify paths from this class.
|
|
32
|
+
* Also, the [[expression]] attribute's `this` symbol points to instances of this class.
|
|
33
|
+
*
|
|
34
|
+
* The format is full class name: `SchemaName:ClassName`.
|
|
35
|
+
*/
|
|
36
|
+
selectClassName: string;
|
|
37
|
+
/**
|
|
38
|
+
* Specifies relationship paths pointing to related instances used in the [[expression]] attribute.
|
|
39
|
+
*
|
|
40
|
+
* Sometimes there's a need to filter on a related instance property. In that case, the relationship
|
|
41
|
+
* needs to be named by specifying the path and alias for the target (or the relationship). Then, the
|
|
42
|
+
* related instance's symbol context can be accessed through the root symbol named as specified in the
|
|
43
|
+
* [[alias]] (or [[relationshipAlias]]) attribute.
|
|
44
|
+
*/
|
|
45
|
+
relatedInstances?: InstanceFilterRelatedInstanceDefinition[];
|
|
46
|
+
/**
|
|
47
|
+
* [ECExpression]($docs/presentation/advanced/ECExpressions.md) for filtering the select instances.
|
|
48
|
+
*/
|
|
49
|
+
expression: string;
|
|
50
|
+
}
|
|
51
|
+
/**
|
|
52
|
+
* Related instance definition for accessing properties of a related instance in [[InstanceFilterDefinition.expression]].
|
|
53
|
+
* @beta
|
|
54
|
+
*/
|
|
55
|
+
export type InstanceFilterRelatedInstanceDefinition = InstanceFilterRelatedInstancePath & (InstanceFilterRelatedInstanceTargetAlias | InstanceFilterRelatedInstanceRelationshipAlias);
|
|
56
|
+
/**
|
|
57
|
+
* Partial definition of common attributes for [[InstanceFilterRelatedInstanceDefinition]].
|
|
58
|
+
* @beta
|
|
59
|
+
*/
|
|
60
|
+
export interface InstanceFilterRelatedInstancePath {
|
|
61
|
+
/**
|
|
62
|
+
* A relationship path from select class (either specified through [[InstanceFilterDefinition.selectClassName]] or taken from context)
|
|
63
|
+
* to the target related instance containing the properties used in [[InstanceFilterDefinition.expression]].
|
|
64
|
+
*/
|
|
65
|
+
pathFromSelectToPropertyClass: StrippedRelationshipPath;
|
|
66
|
+
/**
|
|
67
|
+
* An optional flag indicating that the target instance must exist. Setting this allows to filter out all
|
|
68
|
+
* select instances that don't have a related instance by following the [[pathFromSelectToPropertyClass]] path.
|
|
69
|
+
*/
|
|
70
|
+
isRequired?: boolean;
|
|
71
|
+
}
|
|
72
|
+
/**
|
|
73
|
+
* Partial definition of [[InstanceFilterRelatedInstanceDefinition]] for the case when referencing the target class.
|
|
74
|
+
* @beta
|
|
75
|
+
*/
|
|
76
|
+
export interface InstanceFilterRelatedInstanceTargetAlias {
|
|
77
|
+
/**
|
|
78
|
+
* An alias for the target class in the [[InstanceFilterRelatedInstancePath.pathFromSelectToPropertyClass]] path. This alias can be used to
|
|
79
|
+
* access related instance symbols context in the [[InstanceFilterDefinition.expression]].
|
|
80
|
+
*/
|
|
81
|
+
alias: string;
|
|
82
|
+
}
|
|
83
|
+
/**
|
|
84
|
+
* Partial definition of [[InstanceFilterRelatedInstanceDefinition]] for the case when referencing the relationship class.
|
|
85
|
+
* @beta
|
|
86
|
+
*/
|
|
87
|
+
export interface InstanceFilterRelatedInstanceRelationshipAlias {
|
|
88
|
+
/**
|
|
89
|
+
* An alias for the relationship in the last step of the [[InstanceFilterRelatedInstancePath.pathFromSelectToPropertyClass]] path. This alias can be
|
|
90
|
+
* used to access the relationship instance symbols context in the [[InstanceFilterDefinition.expression]].
|
|
91
|
+
*/
|
|
92
|
+
relationshipAlias: string;
|
|
93
|
+
}
|
|
94
94
|
//# sourceMappingURL=InstanceFilterDefinition.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"InstanceFilterDefinition.d.ts","sourceRoot":"","sources":["../../../src/presentation-common/InstanceFilterDefinition.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,EAAE,wBAAwB,EAAE,MAAM,MAAM,CAAC;AAEhD;;;;;;;;;;;;;;;;;;;;;;GAsBG;AACH,MAAM,WAAW,wBAAwB;IACvC;;;;;;OAMG;IACH,eAAe,EAAE,MAAM,CAAC;IAExB;;;;;;;OAOG;IACH,gBAAgB,CAAC,EAAE,uCAAuC,EAAE,CAAC;IAE7D;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;CACpB;AAED;;;GAGG;AACH,
|
|
1
|
+
{"version":3,"file":"InstanceFilterDefinition.d.ts","sourceRoot":"","sources":["../../../src/presentation-common/InstanceFilterDefinition.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,EAAE,wBAAwB,EAAE,MAAM,MAAM,CAAC;AAEhD;;;;;;;;;;;;;;;;;;;;;;GAsBG;AACH,MAAM,WAAW,wBAAwB;IACvC;;;;;;OAMG;IACH,eAAe,EAAE,MAAM,CAAC;IAExB;;;;;;;OAOG;IACH,gBAAgB,CAAC,EAAE,uCAAuC,EAAE,CAAC;IAE7D;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;CACpB;AAED;;;GAGG;AACH,MAAM,MAAM,uCAAuC,GACjD,iCAAiC,GAC/B,CAAC,wCAAwC,GAAG,8CAA8C,CAAC,CAAC;AAEhG;;;GAGG;AACH,MAAM,WAAW,iCAAiC;IAChD;;;OAGG;IACH,6BAA6B,EAAE,wBAAwB,CAAC;IACxD;;;OAGG;IACH,UAAU,CAAC,EAAE,OAAO,CAAC;CACtB;AAED;;;GAGG;AACH,MAAM,WAAW,wCAAwC;IACvD;;;OAGG;IACH,KAAK,EAAE,MAAM,CAAC;CACf;AAED;;;GAGG;AACH,MAAM,WAAW,8CAA8C;IAC7D;;;OAGG;IACH,iBAAiB,EAAE,MAAM,CAAC;CAC3B"}
|
|
@@ -1,9 +1,9 @@
|
|
|
1
|
-
/*---------------------------------------------------------------------------------------------
|
|
2
|
-
* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
|
|
3
|
-
* See LICENSE.md in the project root for license terms and full copyright notice.
|
|
4
|
-
*--------------------------------------------------------------------------------------------*/
|
|
5
|
-
/** @packageDocumentation
|
|
6
|
-
* @module Core
|
|
7
|
-
*/
|
|
8
|
-
export {};
|
|
1
|
+
/*---------------------------------------------------------------------------------------------
|
|
2
|
+
* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
|
|
3
|
+
* See LICENSE.md in the project root for license terms and full copyright notice.
|
|
4
|
+
*--------------------------------------------------------------------------------------------*/
|
|
5
|
+
/** @packageDocumentation
|
|
6
|
+
* @module Core
|
|
7
|
+
*/
|
|
8
|
+
export {};
|
|
9
9
|
//# sourceMappingURL=InstanceFilterDefinition.js.map
|
|
@@ -1,147 +1,147 @@
|
|
|
1
|
-
/** @packageDocumentation
|
|
2
|
-
* @module Core
|
|
3
|
-
*/
|
|
4
|
-
import { GuidString } from "@itwin/core-bentley";
|
|
5
|
-
import { EntityProps } from "@itwin/core-common";
|
|
6
|
-
import { InstanceId, InstanceKey } from "./EC";
|
|
7
|
-
import { NodeKey, NodeKeyJSON } from "./hierarchy/Key";
|
|
8
|
-
/**
|
|
9
|
-
* A single key that identifies something in an iTwin.js application
|
|
10
|
-
* @public
|
|
11
|
-
*/
|
|
12
|
-
export
|
|
13
|
-
/** @public */
|
|
14
|
-
export declare namespace Key {
|
|
15
|
-
/** Check if the supplied key is a `NodeKey` */
|
|
16
|
-
function isNodeKey(key: Key): key is NodeKey;
|
|
17
|
-
/** Check if the supplied key is an `InstanceKey` */
|
|
18
|
-
function isInstanceKey(key: Key): key is InstanceKey;
|
|
19
|
-
/** Check if the supplied key is an `EntityProps` */
|
|
20
|
-
function isEntityProps(key: Key): key is EntityProps;
|
|
21
|
-
}
|
|
22
|
-
/**
|
|
23
|
-
* A type for multiple keys that identify something in iModel.js application
|
|
24
|
-
* @public
|
|
25
|
-
*/
|
|
26
|
-
export
|
|
27
|
-
/**
|
|
28
|
-
* A data structure of serialized [[KeySet]]
|
|
29
|
-
* @public
|
|
30
|
-
*/
|
|
31
|
-
export interface KeySetJSON {
|
|
32
|
-
/** JSON representation of a list of instance keys */
|
|
33
|
-
instanceKeys: Array<[string, string]>;
|
|
34
|
-
/** An array of serialized node keys */
|
|
35
|
-
nodeKeys: NodeKeyJSON[];
|
|
36
|
-
}
|
|
37
|
-
/**
|
|
38
|
-
* A class that holds multiple [[Key]] objects. It's basically
|
|
39
|
-
* used as a container that holds multiple keys of different types.
|
|
40
|
-
*
|
|
41
|
-
* @public
|
|
42
|
-
*/
|
|
43
|
-
export declare class KeySet {
|
|
44
|
-
private _instanceKeys;
|
|
45
|
-
private _lowerCaseMap;
|
|
46
|
-
private _nodeKeys;
|
|
47
|
-
private _guid;
|
|
48
|
-
/**
|
|
49
|
-
* Creates an instance of KeySet.
|
|
50
|
-
* @param source Optional source to initialize from.
|
|
51
|
-
*/
|
|
52
|
-
constructor(source?: Keys);
|
|
53
|
-
private recalculateGuid;
|
|
54
|
-
/**
|
|
55
|
-
* Get a GUID that identifies changes in this keyset. The value
|
|
56
|
-
* does not uniquely identify contents of the keyset, but it can be
|
|
57
|
-
* used to check whether keyset has changed.
|
|
58
|
-
*/
|
|
59
|
-
get guid(): GuidString;
|
|
60
|
-
/**
|
|
61
|
-
* Get a map of instance keys stored in this KeySet
|
|
62
|
-
*
|
|
63
|
-
* **Warning**: getting instance keys might be expensive for
|
|
64
|
-
* large KeySets.
|
|
65
|
-
*/
|
|
66
|
-
get instanceKeys(): Map<string, Set<InstanceId>>;
|
|
67
|
-
/**
|
|
68
|
-
* Get instance keys count
|
|
69
|
-
*/
|
|
70
|
-
get instanceKeysCount(): number;
|
|
71
|
-
/**
|
|
72
|
-
* Get a set of node keys stored in this KeySet
|
|
73
|
-
*
|
|
74
|
-
* **Warning**: getting node keys might be expensive for
|
|
75
|
-
* large KeySets.
|
|
76
|
-
*/
|
|
77
|
-
get nodeKeys(): Set<NodeKey>;
|
|
78
|
-
/**
|
|
79
|
-
* Get node keys count
|
|
80
|
-
*/
|
|
81
|
-
get nodeKeysCount(): number;
|
|
82
|
-
private isKeySet;
|
|
83
|
-
private isKeysArray;
|
|
84
|
-
/**
|
|
85
|
-
* Clear this KeySet.
|
|
86
|
-
* @returns itself
|
|
87
|
-
*/
|
|
88
|
-
clear(): KeySet;
|
|
89
|
-
private addKeySet;
|
|
90
|
-
private addKeySetJSON;
|
|
91
|
-
/**
|
|
92
|
-
* Add a key or keys to this KeySet.
|
|
93
|
-
* @param value A key or keys to add.
|
|
94
|
-
* @param pred An optional predicate function that indicates whether a key should be added
|
|
95
|
-
* @returns itself
|
|
96
|
-
*/
|
|
97
|
-
add(value: Keys | Key, pred?: (key: Key) => boolean): KeySet;
|
|
98
|
-
private deleteKeySet;
|
|
99
|
-
/**
|
|
100
|
-
* Deletes a key or keys from this KeySet.
|
|
101
|
-
* @param value A key or keys to delete.
|
|
102
|
-
* @returns itself
|
|
103
|
-
*/
|
|
104
|
-
delete(value: Keys | Key): KeySet;
|
|
105
|
-
/**
|
|
106
|
-
* Check if this KeySet contains the specified key.
|
|
107
|
-
* @param value The key to check.
|
|
108
|
-
*/
|
|
109
|
-
has(value: Key): boolean;
|
|
110
|
-
private hasKeySet;
|
|
111
|
-
private hasKeysArray;
|
|
112
|
-
/**
|
|
113
|
-
* Check if this KeySet contains all the specified keys.
|
|
114
|
-
* @param keys The keys to check.
|
|
115
|
-
*/
|
|
116
|
-
hasAll(keys: Keys): boolean;
|
|
117
|
-
/**
|
|
118
|
-
* Check if this KeySet contains any of the specified keys.
|
|
119
|
-
* @param keys The keys to check.
|
|
120
|
-
*/
|
|
121
|
-
hasAny(keys: Keys): boolean;
|
|
122
|
-
/**
|
|
123
|
-
* Get the number of keys stored in this KeySet.
|
|
124
|
-
*/
|
|
125
|
-
get size(): number;
|
|
126
|
-
/**
|
|
127
|
-
* Is this KeySet currently empty.
|
|
128
|
-
*/
|
|
129
|
-
get isEmpty(): boolean;
|
|
130
|
-
/** Iterate over all keys in this keyset. */
|
|
131
|
-
some(callback: (key: Key) => boolean): boolean;
|
|
132
|
-
/** Iterate over all keys in this keyset. */
|
|
133
|
-
forEach(callback: (key: InstanceKey | NodeKey, index: number) => void): void;
|
|
134
|
-
/** Iterate over all keys in this keyset in batches */
|
|
135
|
-
forEachBatch(batchSize: number, callback: (batch: KeySet, index: number) => void): void;
|
|
136
|
-
/**
|
|
137
|
-
* Serializes this KeySet to JSON
|
|
138
|
-
* @public
|
|
139
|
-
*/
|
|
140
|
-
toJSON(): KeySetJSON;
|
|
141
|
-
/**
|
|
142
|
-
* Creates a KeySet from JSON
|
|
143
|
-
* @public
|
|
144
|
-
*/
|
|
145
|
-
static fromJSON(json: KeySetJSON): KeySet;
|
|
146
|
-
}
|
|
1
|
+
/** @packageDocumentation
|
|
2
|
+
* @module Core
|
|
3
|
+
*/
|
|
4
|
+
import { GuidString } from "@itwin/core-bentley";
|
|
5
|
+
import { EntityProps } from "@itwin/core-common";
|
|
6
|
+
import { InstanceId, InstanceKey } from "./EC";
|
|
7
|
+
import { NodeKey, NodeKeyJSON } from "./hierarchy/Key";
|
|
8
|
+
/**
|
|
9
|
+
* A single key that identifies something in an iTwin.js application
|
|
10
|
+
* @public
|
|
11
|
+
*/
|
|
12
|
+
export type Key = Readonly<NodeKey> | Readonly<InstanceKey> | Readonly<EntityProps>;
|
|
13
|
+
/** @public */
|
|
14
|
+
export declare namespace Key {
|
|
15
|
+
/** Check if the supplied key is a `NodeKey` */
|
|
16
|
+
function isNodeKey(key: Key): key is NodeKey;
|
|
17
|
+
/** Check if the supplied key is an `InstanceKey` */
|
|
18
|
+
function isInstanceKey(key: Key): key is InstanceKey;
|
|
19
|
+
/** Check if the supplied key is an `EntityProps` */
|
|
20
|
+
function isEntityProps(key: Key): key is EntityProps;
|
|
21
|
+
}
|
|
22
|
+
/**
|
|
23
|
+
* A type for multiple keys that identify something in iModel.js application
|
|
24
|
+
* @public
|
|
25
|
+
*/
|
|
26
|
+
export type Keys = ReadonlyArray<Key> | Readonly<KeySet>;
|
|
27
|
+
/**
|
|
28
|
+
* A data structure of serialized [[KeySet]]
|
|
29
|
+
* @public
|
|
30
|
+
*/
|
|
31
|
+
export interface KeySetJSON {
|
|
32
|
+
/** JSON representation of a list of instance keys */
|
|
33
|
+
instanceKeys: Array<[string, string]>;
|
|
34
|
+
/** An array of serialized node keys */
|
|
35
|
+
nodeKeys: NodeKeyJSON[];
|
|
36
|
+
}
|
|
37
|
+
/**
|
|
38
|
+
* A class that holds multiple [[Key]] objects. It's basically
|
|
39
|
+
* used as a container that holds multiple keys of different types.
|
|
40
|
+
*
|
|
41
|
+
* @public
|
|
42
|
+
*/
|
|
43
|
+
export declare class KeySet {
|
|
44
|
+
private _instanceKeys;
|
|
45
|
+
private _lowerCaseMap;
|
|
46
|
+
private _nodeKeys;
|
|
47
|
+
private _guid;
|
|
48
|
+
/**
|
|
49
|
+
* Creates an instance of KeySet.
|
|
50
|
+
* @param source Optional source to initialize from.
|
|
51
|
+
*/
|
|
52
|
+
constructor(source?: Keys);
|
|
53
|
+
private recalculateGuid;
|
|
54
|
+
/**
|
|
55
|
+
* Get a GUID that identifies changes in this keyset. The value
|
|
56
|
+
* does not uniquely identify contents of the keyset, but it can be
|
|
57
|
+
* used to check whether keyset has changed.
|
|
58
|
+
*/
|
|
59
|
+
get guid(): GuidString;
|
|
60
|
+
/**
|
|
61
|
+
* Get a map of instance keys stored in this KeySet
|
|
62
|
+
*
|
|
63
|
+
* **Warning**: getting instance keys might be expensive for
|
|
64
|
+
* large KeySets.
|
|
65
|
+
*/
|
|
66
|
+
get instanceKeys(): Map<string, Set<InstanceId>>;
|
|
67
|
+
/**
|
|
68
|
+
* Get instance keys count
|
|
69
|
+
*/
|
|
70
|
+
get instanceKeysCount(): number;
|
|
71
|
+
/**
|
|
72
|
+
* Get a set of node keys stored in this KeySet
|
|
73
|
+
*
|
|
74
|
+
* **Warning**: getting node keys might be expensive for
|
|
75
|
+
* large KeySets.
|
|
76
|
+
*/
|
|
77
|
+
get nodeKeys(): Set<NodeKey>;
|
|
78
|
+
/**
|
|
79
|
+
* Get node keys count
|
|
80
|
+
*/
|
|
81
|
+
get nodeKeysCount(): number;
|
|
82
|
+
private isKeySet;
|
|
83
|
+
private isKeysArray;
|
|
84
|
+
/**
|
|
85
|
+
* Clear this KeySet.
|
|
86
|
+
* @returns itself
|
|
87
|
+
*/
|
|
88
|
+
clear(): KeySet;
|
|
89
|
+
private addKeySet;
|
|
90
|
+
private addKeySetJSON;
|
|
91
|
+
/**
|
|
92
|
+
* Add a key or keys to this KeySet.
|
|
93
|
+
* @param value A key or keys to add.
|
|
94
|
+
* @param pred An optional predicate function that indicates whether a key should be added
|
|
95
|
+
* @returns itself
|
|
96
|
+
*/
|
|
97
|
+
add(value: Keys | Key, pred?: (key: Key) => boolean): KeySet;
|
|
98
|
+
private deleteKeySet;
|
|
99
|
+
/**
|
|
100
|
+
* Deletes a key or keys from this KeySet.
|
|
101
|
+
* @param value A key or keys to delete.
|
|
102
|
+
* @returns itself
|
|
103
|
+
*/
|
|
104
|
+
delete(value: Keys | Key): KeySet;
|
|
105
|
+
/**
|
|
106
|
+
* Check if this KeySet contains the specified key.
|
|
107
|
+
* @param value The key to check.
|
|
108
|
+
*/
|
|
109
|
+
has(value: Key): boolean;
|
|
110
|
+
private hasKeySet;
|
|
111
|
+
private hasKeysArray;
|
|
112
|
+
/**
|
|
113
|
+
* Check if this KeySet contains all the specified keys.
|
|
114
|
+
* @param keys The keys to check.
|
|
115
|
+
*/
|
|
116
|
+
hasAll(keys: Keys): boolean;
|
|
117
|
+
/**
|
|
118
|
+
* Check if this KeySet contains any of the specified keys.
|
|
119
|
+
* @param keys The keys to check.
|
|
120
|
+
*/
|
|
121
|
+
hasAny(keys: Keys): boolean;
|
|
122
|
+
/**
|
|
123
|
+
* Get the number of keys stored in this KeySet.
|
|
124
|
+
*/
|
|
125
|
+
get size(): number;
|
|
126
|
+
/**
|
|
127
|
+
* Is this KeySet currently empty.
|
|
128
|
+
*/
|
|
129
|
+
get isEmpty(): boolean;
|
|
130
|
+
/** Iterate over all keys in this keyset. */
|
|
131
|
+
some(callback: (key: Key) => boolean): boolean;
|
|
132
|
+
/** Iterate over all keys in this keyset. */
|
|
133
|
+
forEach(callback: (key: InstanceKey | NodeKey, index: number) => void): void;
|
|
134
|
+
/** Iterate over all keys in this keyset in batches */
|
|
135
|
+
forEachBatch(batchSize: number, callback: (batch: KeySet, index: number) => void): void;
|
|
136
|
+
/**
|
|
137
|
+
* Serializes this KeySet to JSON
|
|
138
|
+
* @public
|
|
139
|
+
*/
|
|
140
|
+
toJSON(): KeySetJSON;
|
|
141
|
+
/**
|
|
142
|
+
* Creates a KeySet from JSON
|
|
143
|
+
* @public
|
|
144
|
+
*/
|
|
145
|
+
static fromJSON(json: KeySetJSON): KeySet;
|
|
146
|
+
}
|
|
147
147
|
//# sourceMappingURL=KeySet.d.ts.map
|