@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,159 +1,159 @@
|
|
|
1
|
-
/** @packageDocumentation
|
|
2
|
-
* @module PresentationRules
|
|
3
|
-
*/
|
|
4
|
-
import { SingleSchemaClassSpecification } from "../ClassSpecifications";
|
|
5
|
-
import { RelationshipPathSpecification } from "../RelationshipPathSpecification";
|
|
6
|
-
import { RuleBase } from "../Rule";
|
|
7
|
-
/**
|
|
8
|
-
* Instance label override rule provides a way to set instance label to one of its property values,
|
|
9
|
-
* other attributes and/or combination of them.
|
|
10
|
-
*
|
|
11
|
-
* @see [Instance label override reference documentation page]($docs/presentation/customization/InstanceLabelOverride.md)
|
|
12
|
-
* @public
|
|
13
|
-
*/
|
|
14
|
-
export interface InstanceLabelOverride extends RuleBase {
|
|
15
|
-
/** Used for serializing to JSON. */
|
|
16
|
-
ruleType: "InstanceLabelOverride";
|
|
17
|
-
/**
|
|
18
|
-
* Specifies the ECClass to apply this rule to.
|
|
19
|
-
*/
|
|
20
|
-
class: SingleSchemaClassSpecification;
|
|
21
|
-
/**
|
|
22
|
-
* Specifications of values used to override label. The first non-empty value is used as the actual label.
|
|
23
|
-
*/
|
|
24
|
-
values: InstanceLabelOverrideValueSpecification[];
|
|
25
|
-
}
|
|
26
|
-
/**
|
|
27
|
-
* Types of possible [[InstanceLabelOverride]] label values.
|
|
28
|
-
* @public
|
|
29
|
-
*/
|
|
30
|
-
export declare enum InstanceLabelOverrideValueSpecificationType {
|
|
31
|
-
Composite = "Composite",
|
|
32
|
-
Property = "Property",
|
|
33
|
-
ClassName = "ClassName",
|
|
34
|
-
ClassLabel = "ClassLabel",
|
|
35
|
-
BriefcaseId = "BriefcaseId",
|
|
36
|
-
LocalId = "LocalId",
|
|
37
|
-
String = "String",
|
|
38
|
-
RelatedInstanceLabel = "RelatedInstanceLabel"
|
|
39
|
-
}
|
|
40
|
-
/**
|
|
41
|
-
* Base interface for all [[InstanceLabelOverrideValueSpecification]] implementations.
|
|
42
|
-
* @public
|
|
43
|
-
*/
|
|
44
|
-
export interface InstanceLabelOverrideValueSpecificationBase {
|
|
45
|
-
/**
|
|
46
|
-
* Type of the specification
|
|
47
|
-
* @see InstanceLabelOverrideValueSpecificationType
|
|
48
|
-
*/
|
|
49
|
-
specType: `${InstanceLabelOverrideValueSpecificationType}`;
|
|
50
|
-
}
|
|
51
|
-
/**
|
|
52
|
-
* Specification allows creating a label value composited using multiple other specifications.
|
|
53
|
-
*
|
|
54
|
-
* @see [Composite value specification reference documentation page]($docs/presentation/customization/InstanceLabelOverride.md#composite-value-specification)
|
|
55
|
-
* @public
|
|
56
|
-
*/
|
|
57
|
-
export interface InstanceLabelOverrideCompositeValueSpecification extends InstanceLabelOverrideValueSpecificationBase {
|
|
58
|
-
specType: "Composite";
|
|
59
|
-
/**
|
|
60
|
-
* Parts of the value.
|
|
61
|
-
*
|
|
62
|
-
* If any of the parts with `isRequired` flag evaluate to an empty string, the
|
|
63
|
-
* result of this specification is also an empty string.
|
|
64
|
-
*/
|
|
65
|
-
parts: Array<{
|
|
66
|
-
spec: InstanceLabelOverrideValueSpecification;
|
|
67
|
-
isRequired?: boolean;
|
|
68
|
-
}>;
|
|
69
|
-
/** Separator to use when joining the parts. Defaults to a space character. */
|
|
70
|
-
separator?: string;
|
|
71
|
-
}
|
|
72
|
-
/**
|
|
73
|
-
* Specification uses property value as the label content.
|
|
74
|
-
*
|
|
75
|
-
* @see [Property value specification reference documentation page]($docs/presentation/customization/InstanceLabelOverride.md#property-value-specification)
|
|
76
|
-
* @public
|
|
77
|
-
*/
|
|
78
|
-
export interface InstanceLabelOverridePropertyValueSpecification extends InstanceLabelOverrideValueSpecificationBase {
|
|
79
|
-
specType: "Property";
|
|
80
|
-
/**
|
|
81
|
-
* Name of the property whose value should be used.
|
|
82
|
-
* @note A property with this name must exist on the property class (see [[propertySource]]).
|
|
83
|
-
*/
|
|
84
|
-
propertyName: string;
|
|
85
|
-
/**
|
|
86
|
-
* [Specification of the relationship path]($docs/presentation/RelationshipPathSpecification.md) from [[InstanceLabelOverride.class]]
|
|
87
|
-
* to class of the property. If omitted, [[InstanceLabelOverride.class]] is used as property class.
|
|
88
|
-
*/
|
|
89
|
-
propertySource?: RelationshipPathSpecification;
|
|
90
|
-
}
|
|
91
|
-
/**
|
|
92
|
-
* Specification uses ECClass name as the label content.
|
|
93
|
-
*
|
|
94
|
-
* @see [Class name value specification reference documentation page]($docs/presentation/customization/InstanceLabelOverride.md#class-name-value-specification)
|
|
95
|
-
* @public
|
|
96
|
-
*/
|
|
97
|
-
export interface InstanceLabelOverrideClassNameSpecification extends InstanceLabelOverrideValueSpecificationBase {
|
|
98
|
-
specType: "ClassName";
|
|
99
|
-
/** Should full (`{schemaName}.{className}`) class name be used */
|
|
100
|
-
full?: boolean;
|
|
101
|
-
}
|
|
102
|
-
/**
|
|
103
|
-
* Specification uses ECClass display label as the label content.
|
|
104
|
-
*
|
|
105
|
-
* @see [Class label value specification reference documentation page]($docs/presentation/customization/InstanceLabelOverride.md#class-label-value-specification)
|
|
106
|
-
* @public
|
|
107
|
-
*/
|
|
108
|
-
export interface InstanceLabelOverrideClassLabelSpecification extends InstanceLabelOverrideValueSpecificationBase {
|
|
109
|
-
specType: "ClassLabel";
|
|
110
|
-
}
|
|
111
|
-
/**
|
|
112
|
-
* Specification returns ECInstance's briefcase ID in base36 format.
|
|
113
|
-
*
|
|
114
|
-
* @see [BriefcaseId value specification reference documentation page]($docs/presentation/customization/InstanceLabelOverride.md#briefcaseid-value-specification)
|
|
115
|
-
* @public
|
|
116
|
-
*/
|
|
117
|
-
export interface InstanceLabelOverrideBriefcaseIdSpecification extends InstanceLabelOverrideValueSpecificationBase {
|
|
118
|
-
specType: "BriefcaseId";
|
|
119
|
-
}
|
|
120
|
-
/**
|
|
121
|
-
* Specification returns ECInstance's local ID in base36 format.
|
|
122
|
-
*
|
|
123
|
-
* @see [LocalId value specification reference documentation page]($docs/presentation/customization/InstanceLabelOverride.md#localid-value-specification)
|
|
124
|
-
* @public
|
|
125
|
-
*/
|
|
126
|
-
export interface InstanceLabelOverrideLocalIdSpecification extends InstanceLabelOverrideValueSpecificationBase {
|
|
127
|
-
specType: "LocalId";
|
|
128
|
-
}
|
|
129
|
-
/**
|
|
130
|
-
* Specification uses the specified value as the label content.
|
|
131
|
-
*
|
|
132
|
-
* @see [String value specification reference documentation page]($docs/presentation/customization/InstanceLabelOverride.md#string-value-specification)
|
|
133
|
-
* @public
|
|
134
|
-
*/
|
|
135
|
-
export interface InstanceLabelOverrideStringValueSpecification extends InstanceLabelOverrideValueSpecificationBase {
|
|
136
|
-
specType: "String";
|
|
137
|
-
/** The value to use as the label content. */
|
|
138
|
-
value: string;
|
|
139
|
-
}
|
|
140
|
-
/**
|
|
141
|
-
* Specification uses label of another related instance as the label content.
|
|
142
|
-
*
|
|
143
|
-
* @see [Related instance label value specification reference documentation page]($docs/presentation/customization/InstanceLabelOverride.md#related-instance-label-value-specification)
|
|
144
|
-
* @public
|
|
145
|
-
*/
|
|
146
|
-
export interface InstanceLabelOverrideRelatedInstanceLabelSpecification extends InstanceLabelOverrideValueSpecificationBase {
|
|
147
|
-
specType: "RelatedInstanceLabel";
|
|
148
|
-
/**
|
|
149
|
-
* [Specification of the relationship path]($docs/presentation/RelationshipPathSpecification.md) from `InstanceLabelOverride.class`
|
|
150
|
-
* to class of the related instance.
|
|
151
|
-
*/
|
|
152
|
-
pathToRelatedInstance: RelationshipPathSpecification;
|
|
153
|
-
}
|
|
154
|
-
/**
|
|
155
|
-
* Specification to define how the label for [[InstanceLabelOverride]] should be created.
|
|
156
|
-
* @public
|
|
157
|
-
*/
|
|
158
|
-
export
|
|
1
|
+
/** @packageDocumentation
|
|
2
|
+
* @module PresentationRules
|
|
3
|
+
*/
|
|
4
|
+
import { SingleSchemaClassSpecification } from "../ClassSpecifications";
|
|
5
|
+
import { RelationshipPathSpecification } from "../RelationshipPathSpecification";
|
|
6
|
+
import { RuleBase } from "../Rule";
|
|
7
|
+
/**
|
|
8
|
+
* Instance label override rule provides a way to set instance label to one of its property values,
|
|
9
|
+
* other attributes and/or combination of them.
|
|
10
|
+
*
|
|
11
|
+
* @see [Instance label override reference documentation page]($docs/presentation/customization/InstanceLabelOverride.md)
|
|
12
|
+
* @public
|
|
13
|
+
*/
|
|
14
|
+
export interface InstanceLabelOverride extends RuleBase {
|
|
15
|
+
/** Used for serializing to JSON. */
|
|
16
|
+
ruleType: "InstanceLabelOverride";
|
|
17
|
+
/**
|
|
18
|
+
* Specifies the ECClass to apply this rule to.
|
|
19
|
+
*/
|
|
20
|
+
class: SingleSchemaClassSpecification;
|
|
21
|
+
/**
|
|
22
|
+
* Specifications of values used to override label. The first non-empty value is used as the actual label.
|
|
23
|
+
*/
|
|
24
|
+
values: InstanceLabelOverrideValueSpecification[];
|
|
25
|
+
}
|
|
26
|
+
/**
|
|
27
|
+
* Types of possible [[InstanceLabelOverride]] label values.
|
|
28
|
+
* @public
|
|
29
|
+
*/
|
|
30
|
+
export declare enum InstanceLabelOverrideValueSpecificationType {
|
|
31
|
+
Composite = "Composite",
|
|
32
|
+
Property = "Property",
|
|
33
|
+
ClassName = "ClassName",
|
|
34
|
+
ClassLabel = "ClassLabel",
|
|
35
|
+
BriefcaseId = "BriefcaseId",
|
|
36
|
+
LocalId = "LocalId",
|
|
37
|
+
String = "String",
|
|
38
|
+
RelatedInstanceLabel = "RelatedInstanceLabel"
|
|
39
|
+
}
|
|
40
|
+
/**
|
|
41
|
+
* Base interface for all [[InstanceLabelOverrideValueSpecification]] implementations.
|
|
42
|
+
* @public
|
|
43
|
+
*/
|
|
44
|
+
export interface InstanceLabelOverrideValueSpecificationBase {
|
|
45
|
+
/**
|
|
46
|
+
* Type of the specification
|
|
47
|
+
* @see InstanceLabelOverrideValueSpecificationType
|
|
48
|
+
*/
|
|
49
|
+
specType: `${InstanceLabelOverrideValueSpecificationType}`;
|
|
50
|
+
}
|
|
51
|
+
/**
|
|
52
|
+
* Specification allows creating a label value composited using multiple other specifications.
|
|
53
|
+
*
|
|
54
|
+
* @see [Composite value specification reference documentation page]($docs/presentation/customization/InstanceLabelOverride.md#composite-value-specification)
|
|
55
|
+
* @public
|
|
56
|
+
*/
|
|
57
|
+
export interface InstanceLabelOverrideCompositeValueSpecification extends InstanceLabelOverrideValueSpecificationBase {
|
|
58
|
+
specType: "Composite";
|
|
59
|
+
/**
|
|
60
|
+
* Parts of the value.
|
|
61
|
+
*
|
|
62
|
+
* If any of the parts with `isRequired` flag evaluate to an empty string, the
|
|
63
|
+
* result of this specification is also an empty string.
|
|
64
|
+
*/
|
|
65
|
+
parts: Array<{
|
|
66
|
+
spec: InstanceLabelOverrideValueSpecification;
|
|
67
|
+
isRequired?: boolean;
|
|
68
|
+
}>;
|
|
69
|
+
/** Separator to use when joining the parts. Defaults to a space character. */
|
|
70
|
+
separator?: string;
|
|
71
|
+
}
|
|
72
|
+
/**
|
|
73
|
+
* Specification uses property value as the label content.
|
|
74
|
+
*
|
|
75
|
+
* @see [Property value specification reference documentation page]($docs/presentation/customization/InstanceLabelOverride.md#property-value-specification)
|
|
76
|
+
* @public
|
|
77
|
+
*/
|
|
78
|
+
export interface InstanceLabelOverridePropertyValueSpecification extends InstanceLabelOverrideValueSpecificationBase {
|
|
79
|
+
specType: "Property";
|
|
80
|
+
/**
|
|
81
|
+
* Name of the property whose value should be used.
|
|
82
|
+
* @note A property with this name must exist on the property class (see [[propertySource]]).
|
|
83
|
+
*/
|
|
84
|
+
propertyName: string;
|
|
85
|
+
/**
|
|
86
|
+
* [Specification of the relationship path]($docs/presentation/RelationshipPathSpecification.md) from [[InstanceLabelOverride.class]]
|
|
87
|
+
* to class of the property. If omitted, [[InstanceLabelOverride.class]] is used as property class.
|
|
88
|
+
*/
|
|
89
|
+
propertySource?: RelationshipPathSpecification;
|
|
90
|
+
}
|
|
91
|
+
/**
|
|
92
|
+
* Specification uses ECClass name as the label content.
|
|
93
|
+
*
|
|
94
|
+
* @see [Class name value specification reference documentation page]($docs/presentation/customization/InstanceLabelOverride.md#class-name-value-specification)
|
|
95
|
+
* @public
|
|
96
|
+
*/
|
|
97
|
+
export interface InstanceLabelOverrideClassNameSpecification extends InstanceLabelOverrideValueSpecificationBase {
|
|
98
|
+
specType: "ClassName";
|
|
99
|
+
/** Should full (`{schemaName}.{className}`) class name be used */
|
|
100
|
+
full?: boolean;
|
|
101
|
+
}
|
|
102
|
+
/**
|
|
103
|
+
* Specification uses ECClass display label as the label content.
|
|
104
|
+
*
|
|
105
|
+
* @see [Class label value specification reference documentation page]($docs/presentation/customization/InstanceLabelOverride.md#class-label-value-specification)
|
|
106
|
+
* @public
|
|
107
|
+
*/
|
|
108
|
+
export interface InstanceLabelOverrideClassLabelSpecification extends InstanceLabelOverrideValueSpecificationBase {
|
|
109
|
+
specType: "ClassLabel";
|
|
110
|
+
}
|
|
111
|
+
/**
|
|
112
|
+
* Specification returns ECInstance's briefcase ID in base36 format.
|
|
113
|
+
*
|
|
114
|
+
* @see [BriefcaseId value specification reference documentation page]($docs/presentation/customization/InstanceLabelOverride.md#briefcaseid-value-specification)
|
|
115
|
+
* @public
|
|
116
|
+
*/
|
|
117
|
+
export interface InstanceLabelOverrideBriefcaseIdSpecification extends InstanceLabelOverrideValueSpecificationBase {
|
|
118
|
+
specType: "BriefcaseId";
|
|
119
|
+
}
|
|
120
|
+
/**
|
|
121
|
+
* Specification returns ECInstance's local ID in base36 format.
|
|
122
|
+
*
|
|
123
|
+
* @see [LocalId value specification reference documentation page]($docs/presentation/customization/InstanceLabelOverride.md#localid-value-specification)
|
|
124
|
+
* @public
|
|
125
|
+
*/
|
|
126
|
+
export interface InstanceLabelOverrideLocalIdSpecification extends InstanceLabelOverrideValueSpecificationBase {
|
|
127
|
+
specType: "LocalId";
|
|
128
|
+
}
|
|
129
|
+
/**
|
|
130
|
+
* Specification uses the specified value as the label content.
|
|
131
|
+
*
|
|
132
|
+
* @see [String value specification reference documentation page]($docs/presentation/customization/InstanceLabelOverride.md#string-value-specification)
|
|
133
|
+
* @public
|
|
134
|
+
*/
|
|
135
|
+
export interface InstanceLabelOverrideStringValueSpecification extends InstanceLabelOverrideValueSpecificationBase {
|
|
136
|
+
specType: "String";
|
|
137
|
+
/** The value to use as the label content. */
|
|
138
|
+
value: string;
|
|
139
|
+
}
|
|
140
|
+
/**
|
|
141
|
+
* Specification uses label of another related instance as the label content.
|
|
142
|
+
*
|
|
143
|
+
* @see [Related instance label value specification reference documentation page]($docs/presentation/customization/InstanceLabelOverride.md#related-instance-label-value-specification)
|
|
144
|
+
* @public
|
|
145
|
+
*/
|
|
146
|
+
export interface InstanceLabelOverrideRelatedInstanceLabelSpecification extends InstanceLabelOverrideValueSpecificationBase {
|
|
147
|
+
specType: "RelatedInstanceLabel";
|
|
148
|
+
/**
|
|
149
|
+
* [Specification of the relationship path]($docs/presentation/RelationshipPathSpecification.md) from `InstanceLabelOverride.class`
|
|
150
|
+
* to class of the related instance.
|
|
151
|
+
*/
|
|
152
|
+
pathToRelatedInstance: RelationshipPathSpecification;
|
|
153
|
+
}
|
|
154
|
+
/**
|
|
155
|
+
* Specification to define how the label for [[InstanceLabelOverride]] should be created.
|
|
156
|
+
* @public
|
|
157
|
+
*/
|
|
158
|
+
export type InstanceLabelOverrideValueSpecification = InstanceLabelOverrideCompositeValueSpecification | InstanceLabelOverridePropertyValueSpecification | InstanceLabelOverrideStringValueSpecification | InstanceLabelOverrideClassNameSpecification | InstanceLabelOverrideClassLabelSpecification | InstanceLabelOverrideBriefcaseIdSpecification | InstanceLabelOverrideLocalIdSpecification | InstanceLabelOverrideRelatedInstanceLabelSpecification;
|
|
159
159
|
//# sourceMappingURL=InstanceLabelOverride.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"InstanceLabelOverride.d.ts","sourceRoot":"","sources":["../../../../../src/presentation-common/rules/customization/InstanceLabelOverride.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,EAAE,8BAA8B,EAAE,MAAM,wBAAwB,CAAC;AACxE,OAAO,EAAE,6BAA6B,EAAE,MAAM,kCAAkC,CAAC;AACjF,OAAO,EAAE,QAAQ,EAAE,MAAM,SAAS,CAAC;AAEnC;;;;;;GAMG;AACH,MAAM,WAAW,qBAAsB,SAAQ,QAAQ;IACrD,oCAAoC;IACpC,QAAQ,EAAE,uBAAuB,CAAC;IAElC;;OAEG;IACH,KAAK,EAAE,8BAA8B,CAAC;IAEtC;;OAEG;IACH,MAAM,EAAE,uCAAuC,EAAE,CAAC;CACnD;AAED;;;GAGG;AACH,oBAAY,2CAA2C;IACrD,SAAS,cAAc;IACvB,QAAQ,aAAa;IACrB,SAAS,cAAc;IACvB,UAAU,eAAe;IACzB,WAAW,gBAAgB;IAC3B,OAAO,YAAY;IACnB,MAAM,WAAW;IACjB,oBAAoB,yBAAyB;CAC9C;AAED;;;GAGG;AACH,MAAM,WAAW,2CAA2C;IAC1D;;;OAGG;IACH,QAAQ,EAAE,GAAG,2CAA2C,EAAE,CAAC;CAC5D;AAED;;;;;GAKG;AACH,MAAM,WAAW,gDAAiD,SAAQ,2CAA2C;IACnH,QAAQ,EAAE,WAAW,CAAC;IAEtB;;;;;OAKG;IACH,KAAK,EAAE,KAAK,CAAC;QAAE,IAAI,EAAE,uCAAuC,CAAC;QAAC,UAAU,CAAC,EAAE,OAAO,CAAA;KAAE,CAAC,CAAC;IAEtF,8EAA8E;IAC9E,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB;AAED;;;;;GAKG;AACH,MAAM,WAAW,+CAAgD,SAAQ,2CAA2C;IAClH,QAAQ,EAAE,UAAU,CAAC;IAErB;;;OAGG;IACH,YAAY,EAAE,MAAM,CAAC;IAErB;;;OAGG;IACH,cAAc,CAAC,EAAE,6BAA6B,CAAC;CAChD;AAED;;;;;GAKG;AACH,MAAM,WAAW,2CAA4C,SAAQ,2CAA2C;IAC9G,QAAQ,EAAE,WAAW,CAAC;IAEtB,kEAAkE;IAClE,IAAI,CAAC,EAAE,OAAO,CAAC;CAChB;AAED;;;;;GAKG;AACH,MAAM,WAAW,4CAA6C,SAAQ,2CAA2C;IAC/G,QAAQ,EAAE,YAAY,CAAC;CACxB;AAED;;;;;GAKG;AACH,MAAM,WAAW,6CAA8C,SAAQ,2CAA2C;IAChH,QAAQ,EAAE,aAAa,CAAC;CACzB;AAED;;;;;GAKG;AACH,MAAM,WAAW,yCAA0C,SAAQ,2CAA2C;IAC5G,QAAQ,EAAE,SAAS,CAAC;CACrB;AAED;;;;;GAKG;AACH,MAAM,WAAW,6CAA8C,SAAQ,2CAA2C;IAChH,QAAQ,EAAE,QAAQ,CAAC;IAEnB,6CAA6C;IAC7C,KAAK,EAAE,MAAM,CAAC;CACf;AAED;;;;;GAKG;AACH,MAAM,WAAW,sDAAuD,SAAQ,2CAA2C;IACzH,QAAQ,EAAE,sBAAsB,CAAC;IAEjC;;;OAGG;IACH,qBAAqB,EAAE,6BAA6B,CAAC;CACtD;AAED;;;GAGG;AACH,
|
|
1
|
+
{"version":3,"file":"InstanceLabelOverride.d.ts","sourceRoot":"","sources":["../../../../../src/presentation-common/rules/customization/InstanceLabelOverride.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,EAAE,8BAA8B,EAAE,MAAM,wBAAwB,CAAC;AACxE,OAAO,EAAE,6BAA6B,EAAE,MAAM,kCAAkC,CAAC;AACjF,OAAO,EAAE,QAAQ,EAAE,MAAM,SAAS,CAAC;AAEnC;;;;;;GAMG;AACH,MAAM,WAAW,qBAAsB,SAAQ,QAAQ;IACrD,oCAAoC;IACpC,QAAQ,EAAE,uBAAuB,CAAC;IAElC;;OAEG;IACH,KAAK,EAAE,8BAA8B,CAAC;IAEtC;;OAEG;IACH,MAAM,EAAE,uCAAuC,EAAE,CAAC;CACnD;AAED;;;GAGG;AACH,oBAAY,2CAA2C;IACrD,SAAS,cAAc;IACvB,QAAQ,aAAa;IACrB,SAAS,cAAc;IACvB,UAAU,eAAe;IACzB,WAAW,gBAAgB;IAC3B,OAAO,YAAY;IACnB,MAAM,WAAW;IACjB,oBAAoB,yBAAyB;CAC9C;AAED;;;GAGG;AACH,MAAM,WAAW,2CAA2C;IAC1D;;;OAGG;IACH,QAAQ,EAAE,GAAG,2CAA2C,EAAE,CAAC;CAC5D;AAED;;;;;GAKG;AACH,MAAM,WAAW,gDAAiD,SAAQ,2CAA2C;IACnH,QAAQ,EAAE,WAAW,CAAC;IAEtB;;;;;OAKG;IACH,KAAK,EAAE,KAAK,CAAC;QAAE,IAAI,EAAE,uCAAuC,CAAC;QAAC,UAAU,CAAC,EAAE,OAAO,CAAA;KAAE,CAAC,CAAC;IAEtF,8EAA8E;IAC9E,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB;AAED;;;;;GAKG;AACH,MAAM,WAAW,+CAAgD,SAAQ,2CAA2C;IAClH,QAAQ,EAAE,UAAU,CAAC;IAErB;;;OAGG;IACH,YAAY,EAAE,MAAM,CAAC;IAErB;;;OAGG;IACH,cAAc,CAAC,EAAE,6BAA6B,CAAC;CAChD;AAED;;;;;GAKG;AACH,MAAM,WAAW,2CAA4C,SAAQ,2CAA2C;IAC9G,QAAQ,EAAE,WAAW,CAAC;IAEtB,kEAAkE;IAClE,IAAI,CAAC,EAAE,OAAO,CAAC;CAChB;AAED;;;;;GAKG;AACH,MAAM,WAAW,4CAA6C,SAAQ,2CAA2C;IAC/G,QAAQ,EAAE,YAAY,CAAC;CACxB;AAED;;;;;GAKG;AACH,MAAM,WAAW,6CAA8C,SAAQ,2CAA2C;IAChH,QAAQ,EAAE,aAAa,CAAC;CACzB;AAED;;;;;GAKG;AACH,MAAM,WAAW,yCAA0C,SAAQ,2CAA2C;IAC5G,QAAQ,EAAE,SAAS,CAAC;CACrB;AAED;;;;;GAKG;AACH,MAAM,WAAW,6CAA8C,SAAQ,2CAA2C;IAChH,QAAQ,EAAE,QAAQ,CAAC;IAEnB,6CAA6C;IAC7C,KAAK,EAAE,MAAM,CAAC;CACf;AAED;;;;;GAKG;AACH,MAAM,WAAW,sDAAuD,SAAQ,2CAA2C;IACzH,QAAQ,EAAE,sBAAsB,CAAC;IAEjC;;;OAGG;IACH,qBAAqB,EAAE,6BAA6B,CAAC;CACtD;AAED;;;GAGG;AACH,MAAM,MAAM,uCAAuC,GACjD,gDAAgD,GAAG,+CAA+C,GAClG,6CAA6C,GAAG,2CAA2C,GAC3F,4CAA4C,GAAG,6CAA6C,GAC5F,yCAAyC,GAAG,sDAAsD,CAAC"}
|
|
@@ -1,23 +1,23 @@
|
|
|
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 PresentationRules
|
|
7
|
-
*/
|
|
8
|
-
/**
|
|
9
|
-
* Types of possible [[InstanceLabelOverride]] label values.
|
|
10
|
-
* @public
|
|
11
|
-
*/
|
|
12
|
-
export var InstanceLabelOverrideValueSpecificationType;
|
|
13
|
-
(function (InstanceLabelOverrideValueSpecificationType) {
|
|
14
|
-
InstanceLabelOverrideValueSpecificationType["Composite"] = "Composite";
|
|
15
|
-
InstanceLabelOverrideValueSpecificationType["Property"] = "Property";
|
|
16
|
-
InstanceLabelOverrideValueSpecificationType["ClassName"] = "ClassName";
|
|
17
|
-
InstanceLabelOverrideValueSpecificationType["ClassLabel"] = "ClassLabel";
|
|
18
|
-
InstanceLabelOverrideValueSpecificationType["BriefcaseId"] = "BriefcaseId";
|
|
19
|
-
InstanceLabelOverrideValueSpecificationType["LocalId"] = "LocalId";
|
|
20
|
-
InstanceLabelOverrideValueSpecificationType["String"] = "String";
|
|
21
|
-
InstanceLabelOverrideValueSpecificationType["RelatedInstanceLabel"] = "RelatedInstanceLabel";
|
|
22
|
-
})(InstanceLabelOverrideValueSpecificationType || (InstanceLabelOverrideValueSpecificationType = {}));
|
|
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 PresentationRules
|
|
7
|
+
*/
|
|
8
|
+
/**
|
|
9
|
+
* Types of possible [[InstanceLabelOverride]] label values.
|
|
10
|
+
* @public
|
|
11
|
+
*/
|
|
12
|
+
export var InstanceLabelOverrideValueSpecificationType;
|
|
13
|
+
(function (InstanceLabelOverrideValueSpecificationType) {
|
|
14
|
+
InstanceLabelOverrideValueSpecificationType["Composite"] = "Composite";
|
|
15
|
+
InstanceLabelOverrideValueSpecificationType["Property"] = "Property";
|
|
16
|
+
InstanceLabelOverrideValueSpecificationType["ClassName"] = "ClassName";
|
|
17
|
+
InstanceLabelOverrideValueSpecificationType["ClassLabel"] = "ClassLabel";
|
|
18
|
+
InstanceLabelOverrideValueSpecificationType["BriefcaseId"] = "BriefcaseId";
|
|
19
|
+
InstanceLabelOverrideValueSpecificationType["LocalId"] = "LocalId";
|
|
20
|
+
InstanceLabelOverrideValueSpecificationType["String"] = "String";
|
|
21
|
+
InstanceLabelOverrideValueSpecificationType["RelatedInstanceLabel"] = "RelatedInstanceLabel";
|
|
22
|
+
})(InstanceLabelOverrideValueSpecificationType || (InstanceLabelOverrideValueSpecificationType = {}));
|
|
23
23
|
//# sourceMappingURL=InstanceLabelOverride.js.map
|
|
@@ -1,41 +1,41 @@
|
|
|
1
|
-
/** @packageDocumentation
|
|
2
|
-
* @module PresentationRules
|
|
3
|
-
*/
|
|
4
|
-
import { RuleBase } from "../Rule";
|
|
5
|
-
/**
|
|
6
|
-
* Label override rules provide advanced ways to override instance labels and descriptions in
|
|
7
|
-
* exchange of some performance penalty.
|
|
8
|
-
*
|
|
9
|
-
* @see [Label override reference documentation page]($docs/presentation/customization/LabelOverride.md)
|
|
10
|
-
* @public
|
|
11
|
-
* @deprecated in 3.x. Use [[InstanceLabelOverride]] rule instead.
|
|
12
|
-
*/
|
|
13
|
-
export interface LabelOverride extends RuleBase {
|
|
14
|
-
/** Used for serializing to JSON. */
|
|
15
|
-
ruleType: "LabelOverride";
|
|
16
|
-
/**
|
|
17
|
-
* Defines a condition for the rule, which needs to be met in order to execute it. Condition
|
|
18
|
-
* is an [ECExpression]($docs/presentation/advanced/ECExpressions.md), which can use
|
|
19
|
-
* a [limited set of symbols]($docs/presentation/customization/ECExpressions.md#rule-condition).
|
|
20
|
-
*/
|
|
21
|
-
condition?: string;
|
|
22
|
-
/**
|
|
23
|
-
* An expression whose result becomes the label. This is
|
|
24
|
-
* an [ECExpression]($docs/presentation/customization/ECExpressions.md), so label
|
|
25
|
-
* can be defined/formatted dynamically based on the context - for example
|
|
26
|
-
* ECInstance property value. May be [localized]($docs/presentation/advanced/Localization.md).
|
|
27
|
-
*
|
|
28
|
-
* @minLength 1
|
|
29
|
-
*/
|
|
30
|
-
label?: string;
|
|
31
|
-
/**
|
|
32
|
-
* An expression whose result becomes the description. This is
|
|
33
|
-
* an [ECExpression]($docs/presentation/customization/ECExpressions.md), so
|
|
34
|
-
* description can be defined/formatted dynamically based on the context - for example
|
|
35
|
-
* ECInstance property value. May be [localized]($docs/presentation/advanced/Localization.md).
|
|
36
|
-
*
|
|
37
|
-
* @minLength 1
|
|
38
|
-
*/
|
|
39
|
-
description?: string;
|
|
40
|
-
}
|
|
1
|
+
/** @packageDocumentation
|
|
2
|
+
* @module PresentationRules
|
|
3
|
+
*/
|
|
4
|
+
import { RuleBase } from "../Rule";
|
|
5
|
+
/**
|
|
6
|
+
* Label override rules provide advanced ways to override instance labels and descriptions in
|
|
7
|
+
* exchange of some performance penalty.
|
|
8
|
+
*
|
|
9
|
+
* @see [Label override reference documentation page]($docs/presentation/customization/LabelOverride.md)
|
|
10
|
+
* @public
|
|
11
|
+
* @deprecated in 3.x. Use [[InstanceLabelOverride]] rule instead.
|
|
12
|
+
*/
|
|
13
|
+
export interface LabelOverride extends RuleBase {
|
|
14
|
+
/** Used for serializing to JSON. */
|
|
15
|
+
ruleType: "LabelOverride";
|
|
16
|
+
/**
|
|
17
|
+
* Defines a condition for the rule, which needs to be met in order to execute it. Condition
|
|
18
|
+
* is an [ECExpression]($docs/presentation/advanced/ECExpressions.md), which can use
|
|
19
|
+
* a [limited set of symbols]($docs/presentation/customization/ECExpressions.md#rule-condition).
|
|
20
|
+
*/
|
|
21
|
+
condition?: string;
|
|
22
|
+
/**
|
|
23
|
+
* An expression whose result becomes the label. This is
|
|
24
|
+
* an [ECExpression]($docs/presentation/customization/ECExpressions.md), so label
|
|
25
|
+
* can be defined/formatted dynamically based on the context - for example
|
|
26
|
+
* ECInstance property value. May be [localized]($docs/presentation/advanced/Localization.md).
|
|
27
|
+
*
|
|
28
|
+
* @minLength 1
|
|
29
|
+
*/
|
|
30
|
+
label?: string;
|
|
31
|
+
/**
|
|
32
|
+
* An expression whose result becomes the description. This is
|
|
33
|
+
* an [ECExpression]($docs/presentation/customization/ECExpressions.md), so
|
|
34
|
+
* description can be defined/formatted dynamically based on the context - for example
|
|
35
|
+
* ECInstance property value. May be [localized]($docs/presentation/advanced/Localization.md).
|
|
36
|
+
*
|
|
37
|
+
* @minLength 1
|
|
38
|
+
*/
|
|
39
|
+
description?: string;
|
|
40
|
+
}
|
|
41
41
|
//# sourceMappingURL=LabelOverride.d.ts.map
|
|
@@ -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 PresentationRules
|
|
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 PresentationRules
|
|
7
|
+
*/
|
|
8
|
+
export {};
|
|
9
9
|
//# sourceMappingURL=LabelOverride.js.map
|
|
@@ -1,59 +1,59 @@
|
|
|
1
|
-
/** @packageDocumentation
|
|
2
|
-
* @module PresentationRules
|
|
3
|
-
*/
|
|
4
|
-
import { SingleSchemaClassSpecification } from "../ClassSpecifications";
|
|
5
|
-
import { RuleBase } from "../Rule";
|
|
6
|
-
/**
|
|
7
|
-
* Sorting rules provide a way to either disable sorting or sort instances by specific properties.
|
|
8
|
-
*
|
|
9
|
-
* @see [Sorting rule reference documentation page]($docs/presentation/customization/SortingRule.md)
|
|
10
|
-
* @public
|
|
11
|
-
*/
|
|
12
|
-
export interface SortingRuleBase extends RuleBase {
|
|
13
|
-
/**
|
|
14
|
-
* Defines a condition which needs to be met in order for the rule to be used. The condition is an
|
|
15
|
-
* [ECExpression]($docs/presentation/customization/ECExpressions.md#rule-condition) which has to
|
|
16
|
-
* evaluate to a boolean value.
|
|
17
|
-
*/
|
|
18
|
-
condition?: string;
|
|
19
|
-
/** Specifies ECClass whose ECInstances should be sorted. */
|
|
20
|
-
class?: SingleSchemaClassSpecification;
|
|
21
|
-
/** Specifies that [[class]] attribute defined in this rule should be handled polymorphically. */
|
|
22
|
-
isPolymorphic?: boolean;
|
|
23
|
-
}
|
|
24
|
-
/**
|
|
25
|
-
* Sorting rules provide a way to either disable sorting or sort instances by specific properties.
|
|
26
|
-
*
|
|
27
|
-
* @see [Sorting rule reference documentation page]($docs/presentation/customization/SortingRule.md)
|
|
28
|
-
* @public
|
|
29
|
-
*/
|
|
30
|
-
export
|
|
31
|
-
/**
|
|
32
|
-
* Rule to configure sorting for certain ECInstances in the hierarchy and/or content. It is possible to configure different sorting for different types of ECInstances.
|
|
33
|
-
*
|
|
34
|
-
* @see [Property sorting rule reference documentation section]($docs/presentation/customization/SortingRule.md#property-sorting-rule)
|
|
35
|
-
* @public
|
|
36
|
-
*/
|
|
37
|
-
export interface PropertySortingRule extends SortingRuleBase {
|
|
38
|
-
/** Used for serializing to JSON. */
|
|
39
|
-
ruleType: "PropertySorting";
|
|
40
|
-
/**
|
|
41
|
-
* Specifies name of the property which should be used for sorting.
|
|
42
|
-
*
|
|
43
|
-
* @minLength 1
|
|
44
|
-
*/
|
|
45
|
-
propertyName: string;
|
|
46
|
-
/** Specifies whether instances should be sorted in ascending order or descending. */
|
|
47
|
-
sortAscending?: boolean;
|
|
48
|
-
}
|
|
49
|
-
/**
|
|
50
|
-
* Rule to disable sorting for certain ECInstances in the hierarchy and/or content.
|
|
51
|
-
*
|
|
52
|
-
* @see [Disabled sorting rule reference documentation section]($docs/presentation/customization/SortingRule.md#disabled-sorting-rule)
|
|
53
|
-
* @public
|
|
54
|
-
*/
|
|
55
|
-
export interface DisabledSortingRule extends SortingRuleBase {
|
|
56
|
-
/** Used for serializing to JSON. */
|
|
57
|
-
ruleType: "DisabledSorting";
|
|
58
|
-
}
|
|
1
|
+
/** @packageDocumentation
|
|
2
|
+
* @module PresentationRules
|
|
3
|
+
*/
|
|
4
|
+
import { SingleSchemaClassSpecification } from "../ClassSpecifications";
|
|
5
|
+
import { RuleBase } from "../Rule";
|
|
6
|
+
/**
|
|
7
|
+
* Sorting rules provide a way to either disable sorting or sort instances by specific properties.
|
|
8
|
+
*
|
|
9
|
+
* @see [Sorting rule reference documentation page]($docs/presentation/customization/SortingRule.md)
|
|
10
|
+
* @public
|
|
11
|
+
*/
|
|
12
|
+
export interface SortingRuleBase extends RuleBase {
|
|
13
|
+
/**
|
|
14
|
+
* Defines a condition which needs to be met in order for the rule to be used. The condition is an
|
|
15
|
+
* [ECExpression]($docs/presentation/customization/ECExpressions.md#rule-condition) which has to
|
|
16
|
+
* evaluate to a boolean value.
|
|
17
|
+
*/
|
|
18
|
+
condition?: string;
|
|
19
|
+
/** Specifies ECClass whose ECInstances should be sorted. */
|
|
20
|
+
class?: SingleSchemaClassSpecification;
|
|
21
|
+
/** Specifies that [[class]] attribute defined in this rule should be handled polymorphically. */
|
|
22
|
+
isPolymorphic?: boolean;
|
|
23
|
+
}
|
|
24
|
+
/**
|
|
25
|
+
* Sorting rules provide a way to either disable sorting or sort instances by specific properties.
|
|
26
|
+
*
|
|
27
|
+
* @see [Sorting rule reference documentation page]($docs/presentation/customization/SortingRule.md)
|
|
28
|
+
* @public
|
|
29
|
+
*/
|
|
30
|
+
export type SortingRule = PropertySortingRule | DisabledSortingRule;
|
|
31
|
+
/**
|
|
32
|
+
* Rule to configure sorting for certain ECInstances in the hierarchy and/or content. It is possible to configure different sorting for different types of ECInstances.
|
|
33
|
+
*
|
|
34
|
+
* @see [Property sorting rule reference documentation section]($docs/presentation/customization/SortingRule.md#property-sorting-rule)
|
|
35
|
+
* @public
|
|
36
|
+
*/
|
|
37
|
+
export interface PropertySortingRule extends SortingRuleBase {
|
|
38
|
+
/** Used for serializing to JSON. */
|
|
39
|
+
ruleType: "PropertySorting";
|
|
40
|
+
/**
|
|
41
|
+
* Specifies name of the property which should be used for sorting.
|
|
42
|
+
*
|
|
43
|
+
* @minLength 1
|
|
44
|
+
*/
|
|
45
|
+
propertyName: string;
|
|
46
|
+
/** Specifies whether instances should be sorted in ascending order or descending. */
|
|
47
|
+
sortAscending?: boolean;
|
|
48
|
+
}
|
|
49
|
+
/**
|
|
50
|
+
* Rule to disable sorting for certain ECInstances in the hierarchy and/or content.
|
|
51
|
+
*
|
|
52
|
+
* @see [Disabled sorting rule reference documentation section]($docs/presentation/customization/SortingRule.md#disabled-sorting-rule)
|
|
53
|
+
* @public
|
|
54
|
+
*/
|
|
55
|
+
export interface DisabledSortingRule extends SortingRuleBase {
|
|
56
|
+
/** Used for serializing to JSON. */
|
|
57
|
+
ruleType: "DisabledSorting";
|
|
58
|
+
}
|
|
59
59
|
//# sourceMappingURL=SortingRule.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"SortingRule.d.ts","sourceRoot":"","sources":["../../../../../src/presentation-common/rules/customization/SortingRule.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,EAAE,8BAA8B,EAAE,MAAM,wBAAwB,CAAC;AACxE,OAAO,EAAE,QAAQ,EAAE,MAAM,SAAS,CAAC;AAEnC;;;;;GAKG;AACH,MAAM,WAAW,eAAgB,SAAQ,QAAQ;IAC/C;;;;OAIG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB,4DAA4D;IAC5D,KAAK,CAAC,EAAE,8BAA8B,CAAC;IAEvC,iGAAiG;IACjG,aAAa,CAAC,EAAE,OAAO,CAAC;CACzB;AAED;;;;;GAKG;AACH,
|
|
1
|
+
{"version":3,"file":"SortingRule.d.ts","sourceRoot":"","sources":["../../../../../src/presentation-common/rules/customization/SortingRule.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,EAAE,8BAA8B,EAAE,MAAM,wBAAwB,CAAC;AACxE,OAAO,EAAE,QAAQ,EAAE,MAAM,SAAS,CAAC;AAEnC;;;;;GAKG;AACH,MAAM,WAAW,eAAgB,SAAQ,QAAQ;IAC/C;;;;OAIG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB,4DAA4D;IAC5D,KAAK,CAAC,EAAE,8BAA8B,CAAC;IAEvC,iGAAiG;IACjG,aAAa,CAAC,EAAE,OAAO,CAAC;CACzB;AAED;;;;;GAKG;AACH,MAAM,MAAM,WAAW,GAAG,mBAAmB,GAAG,mBAAmB,CAAC;AAEpE;;;;;GAKG;AACH,MAAM,WAAW,mBAAoB,SAAQ,eAAe;IAC1D,oCAAoC;IACpC,QAAQ,EAAE,iBAAiB,CAAC;IAE5B;;;;OAIG;IACH,YAAY,EAAE,MAAM,CAAC;IAErB,qFAAqF;IACrF,aAAa,CAAC,EAAE,OAAO,CAAC;CACzB;AAED;;;;;GAKG;AACH,MAAM,WAAW,mBAAoB,SAAQ,eAAe;IAC1D,oCAAoC;IACpC,QAAQ,EAAE,iBAAiB,CAAC;CAC7B"}
|
|
@@ -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 PresentationRules
|
|
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 PresentationRules
|
|
7
|
+
*/
|
|
8
|
+
export {};
|
|
9
9
|
//# sourceMappingURL=SortingRule.js.map
|