@itwin/presentation-common 3.2.0-dev.9 → 3.2.0
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 +36 -1
- package/Ruleset.schema.json +304 -289
- package/lib/cjs/presentation-common/CommonLoggerCategory.d.ts +13 -0
- package/lib/cjs/presentation-common/CommonLoggerCategory.d.ts.map +1 -0
- package/lib/cjs/presentation-common/CommonLoggerCategory.js +21 -0
- package/lib/cjs/presentation-common/CommonLoggerCategory.js.map +1 -0
- package/lib/cjs/presentation-common/EC.d.ts +36 -0
- package/lib/cjs/presentation-common/EC.d.ts.map +1 -1
- package/lib/cjs/presentation-common/EC.js +38 -4
- package/lib/cjs/presentation-common/EC.js.map +1 -1
- package/lib/cjs/presentation-common/RpcRequestsHandler.d.ts.map +1 -1
- package/lib/cjs/presentation-common/RpcRequestsHandler.js +26 -0
- package/lib/cjs/presentation-common/RpcRequestsHandler.js.map +1 -1
- package/lib/cjs/presentation-common/Utils.d.ts +0 -2
- package/lib/cjs/presentation-common/Utils.d.ts.map +1 -1
- package/lib/cjs/presentation-common/Utils.js +1 -25
- package/lib/cjs/presentation-common/Utils.js.map +1 -1
- package/lib/cjs/presentation-common/content/Descriptor.d.ts +6 -6
- package/lib/cjs/presentation-common/content/Descriptor.js +1 -1
- package/lib/cjs/presentation-common/content/Descriptor.js.map +1 -1
- package/lib/cjs/presentation-common/content/Fields.d.ts +3 -3
- package/lib/cjs/presentation-common/content/Fields.d.ts.map +1 -1
- package/lib/cjs/presentation-common/content/Fields.js +11 -3
- package/lib/cjs/presentation-common/content/Fields.js.map +1 -1
- package/lib/cjs/presentation-common/content/Item.d.ts +3 -3
- package/lib/cjs/presentation-common/content/Item.js +1 -1
- package/lib/cjs/presentation-common/content/Item.js.map +1 -1
- package/lib/cjs/presentation-common/hierarchy/Node.d.ts +7 -7
- package/lib/cjs/presentation-common/hierarchy/Node.js.map +1 -1
- package/lib/cjs/presentation-common/rules/ClassSpecifications.d.ts +10 -8
- package/lib/cjs/presentation-common/rules/ClassSpecifications.d.ts.map +1 -1
- package/lib/cjs/presentation-common/rules/ClassSpecifications.js.map +1 -1
- package/lib/cjs/presentation-common/rules/RelatedInstanceSpecification.d.ts +10 -62
- package/lib/cjs/presentation-common/rules/RelatedInstanceSpecification.d.ts.map +1 -1
- package/lib/cjs/presentation-common/rules/RelatedInstanceSpecification.js.map +1 -1
- package/lib/cjs/presentation-common/rules/RelationshipPathSpecification.d.ts +20 -13
- package/lib/cjs/presentation-common/rules/RelationshipPathSpecification.d.ts.map +1 -1
- package/lib/cjs/presentation-common/rules/RelationshipPathSpecification.js.map +1 -1
- package/lib/cjs/presentation-common/rules/Rule.d.ts +11 -12
- package/lib/cjs/presentation-common/rules/Rule.d.ts.map +1 -1
- package/lib/cjs/presentation-common/rules/Rule.js.map +1 -1
- package/lib/cjs/presentation-common/rules/Ruleset.d.ts +6 -5
- package/lib/cjs/presentation-common/rules/Ruleset.d.ts.map +1 -1
- package/lib/cjs/presentation-common/rules/Ruleset.js.map +1 -1
- package/lib/cjs/presentation-common/rules/SchemasSpecification.d.ts +5 -2
- package/lib/cjs/presentation-common/rules/SchemasSpecification.d.ts.map +1 -1
- package/lib/cjs/presentation-common/rules/SchemasSpecification.js.map +1 -1
- package/lib/cjs/presentation-common/rules/Variables.d.ts +3 -3
- package/lib/cjs/presentation-common/rules/Variables.js.map +1 -1
- package/lib/cjs/presentation-common/rules/content/ContentInstancesOfSpecificClassesSpecification.d.ts +12 -14
- package/lib/cjs/presentation-common/rules/content/ContentInstancesOfSpecificClassesSpecification.d.ts.map +1 -1
- package/lib/cjs/presentation-common/rules/content/ContentInstancesOfSpecificClassesSpecification.js.map +1 -1
- package/lib/cjs/presentation-common/rules/content/ContentRelatedInstancesSpecification.d.ts +6 -8
- package/lib/cjs/presentation-common/rules/content/ContentRelatedInstancesSpecification.d.ts.map +1 -1
- package/lib/cjs/presentation-common/rules/content/ContentRelatedInstancesSpecification.js.map +1 -1
- package/lib/cjs/presentation-common/rules/content/ContentRule.d.ts +15 -10
- package/lib/cjs/presentation-common/rules/content/ContentRule.d.ts.map +1 -1
- package/lib/cjs/presentation-common/rules/content/ContentRule.js.map +1 -1
- package/lib/cjs/presentation-common/rules/content/ContentSpecification.d.ts +9 -6
- package/lib/cjs/presentation-common/rules/content/ContentSpecification.d.ts.map +1 -1
- package/lib/cjs/presentation-common/rules/content/ContentSpecification.js.map +1 -1
- package/lib/cjs/presentation-common/rules/content/DefaultPropertyCategoryOverride.d.ts +3 -4
- package/lib/cjs/presentation-common/rules/content/DefaultPropertyCategoryOverride.d.ts.map +1 -1
- package/lib/cjs/presentation-common/rules/content/DefaultPropertyCategoryOverride.js.map +1 -1
- package/lib/cjs/presentation-common/rules/content/PropertySpecification.d.ts +56 -21
- package/lib/cjs/presentation-common/rules/content/PropertySpecification.d.ts.map +1 -1
- package/lib/cjs/presentation-common/rules/content/PropertySpecification.js.map +1 -1
- package/lib/cjs/presentation-common/rules/content/SelectedNodeInstancesSpecification.d.ts +5 -10
- package/lib/cjs/presentation-common/rules/content/SelectedNodeInstancesSpecification.d.ts.map +1 -1
- package/lib/cjs/presentation-common/rules/content/SelectedNodeInstancesSpecification.js.map +1 -1
- package/lib/cjs/presentation-common/rules/content/modifiers/CalculatedPropertiesSpecification.d.ts +7 -10
- package/lib/cjs/presentation-common/rules/content/modifiers/CalculatedPropertiesSpecification.d.ts.map +1 -1
- package/lib/cjs/presentation-common/rules/content/modifiers/CalculatedPropertiesSpecification.js.map +1 -1
- package/lib/cjs/presentation-common/rules/content/modifiers/ContentModifier.d.ts +22 -12
- package/lib/cjs/presentation-common/rules/content/modifiers/ContentModifier.d.ts.map +1 -1
- package/lib/cjs/presentation-common/rules/content/modifiers/ContentModifier.js.map +1 -1
- package/lib/cjs/presentation-common/rules/content/modifiers/CustomRendererSpecification.d.ts +8 -2
- package/lib/cjs/presentation-common/rules/content/modifiers/CustomRendererSpecification.d.ts.map +1 -1
- package/lib/cjs/presentation-common/rules/content/modifiers/CustomRendererSpecification.js.map +1 -1
- package/lib/cjs/presentation-common/rules/content/modifiers/PropertyCategorySpecification.d.ts +30 -10
- package/lib/cjs/presentation-common/rules/content/modifiers/PropertyCategorySpecification.d.ts.map +1 -1
- package/lib/cjs/presentation-common/rules/content/modifiers/PropertyCategorySpecification.js.map +1 -1
- package/lib/cjs/presentation-common/rules/content/modifiers/PropertyEditorsSpecification.d.ts +9 -4
- package/lib/cjs/presentation-common/rules/content/modifiers/PropertyEditorsSpecification.d.ts.map +1 -1
- package/lib/cjs/presentation-common/rules/content/modifiers/PropertyEditorsSpecification.js.map +1 -1
- package/lib/cjs/presentation-common/rules/content/modifiers/RelatedPropertiesSpecification.d.ts +25 -21
- package/lib/cjs/presentation-common/rules/content/modifiers/RelatedPropertiesSpecification.d.ts.map +1 -1
- package/lib/cjs/presentation-common/rules/content/modifiers/RelatedPropertiesSpecification.js +5 -7
- package/lib/cjs/presentation-common/rules/content/modifiers/RelatedPropertiesSpecification.js.map +1 -1
- package/lib/cjs/presentation-common/rules/customization/CheckBoxRule.d.ts +8 -11
- package/lib/cjs/presentation-common/rules/customization/CheckBoxRule.d.ts.map +1 -1
- package/lib/cjs/presentation-common/rules/customization/CheckBoxRule.js.map +1 -1
- package/lib/cjs/presentation-common/rules/customization/CustomizationRule.d.ts +1 -1
- package/lib/cjs/presentation-common/rules/customization/CustomizationRule.js.map +1 -1
- package/lib/cjs/presentation-common/rules/customization/ExtendedDataRule.d.ts +9 -24
- package/lib/cjs/presentation-common/rules/customization/ExtendedDataRule.d.ts.map +1 -1
- package/lib/cjs/presentation-common/rules/customization/ExtendedDataRule.js.map +1 -1
- package/lib/cjs/presentation-common/rules/customization/GroupingRule.d.ts +55 -72
- package/lib/cjs/presentation-common/rules/customization/GroupingRule.d.ts.map +1 -1
- package/lib/cjs/presentation-common/rules/customization/GroupingRule.js +1 -1
- package/lib/cjs/presentation-common/rules/customization/GroupingRule.js.map +1 -1
- package/lib/cjs/presentation-common/rules/customization/ImageIdOverride.d.ts +9 -10
- package/lib/cjs/presentation-common/rules/customization/ImageIdOverride.d.ts.map +1 -1
- package/lib/cjs/presentation-common/rules/customization/ImageIdOverride.js.map +1 -1
- package/lib/cjs/presentation-common/rules/customization/InstanceLabelOverride.d.ts +33 -22
- package/lib/cjs/presentation-common/rules/customization/InstanceLabelOverride.d.ts.map +1 -1
- package/lib/cjs/presentation-common/rules/customization/InstanceLabelOverride.js +1 -1
- package/lib/cjs/presentation-common/rules/customization/InstanceLabelOverride.js.map +1 -1
- package/lib/cjs/presentation-common/rules/customization/LabelOverride.d.ts +13 -16
- package/lib/cjs/presentation-common/rules/customization/LabelOverride.d.ts.map +1 -1
- package/lib/cjs/presentation-common/rules/customization/LabelOverride.js.map +1 -1
- package/lib/cjs/presentation-common/rules/customization/SortingRule.d.ts +16 -29
- package/lib/cjs/presentation-common/rules/customization/SortingRule.d.ts.map +1 -1
- package/lib/cjs/presentation-common/rules/customization/SortingRule.js.map +1 -1
- package/lib/cjs/presentation-common/rules/customization/StyleOverride.d.ts +11 -12
- package/lib/cjs/presentation-common/rules/customization/StyleOverride.d.ts.map +1 -1
- package/lib/cjs/presentation-common/rules/customization/StyleOverride.js.map +1 -1
- package/lib/cjs/presentation-common/rules/hierarchy/ChildNodeRule.d.ts +4 -5
- package/lib/cjs/presentation-common/rules/hierarchy/ChildNodeRule.d.ts.map +1 -1
- package/lib/cjs/presentation-common/rules/hierarchy/ChildNodeRule.js.map +1 -1
- package/lib/cjs/presentation-common/rules/hierarchy/ChildNodeSpecification.d.ts +30 -32
- package/lib/cjs/presentation-common/rules/hierarchy/ChildNodeSpecification.d.ts.map +1 -1
- package/lib/cjs/presentation-common/rules/hierarchy/ChildNodeSpecification.js.map +1 -1
- package/lib/cjs/presentation-common/rules/hierarchy/CustomNodeSpecification.d.ts +11 -6
- package/lib/cjs/presentation-common/rules/hierarchy/CustomNodeSpecification.d.ts.map +1 -1
- package/lib/cjs/presentation-common/rules/hierarchy/CustomNodeSpecification.js.map +1 -1
- package/lib/cjs/presentation-common/rules/hierarchy/CustomQueryInstanceNodesSpecification.d.ts +19 -20
- package/lib/cjs/presentation-common/rules/hierarchy/CustomQueryInstanceNodesSpecification.d.ts.map +1 -1
- package/lib/cjs/presentation-common/rules/hierarchy/CustomQueryInstanceNodesSpecification.js.map +1 -1
- package/lib/cjs/presentation-common/rules/hierarchy/InstanceNodesOfSpecificClassesSpecification.d.ts +14 -10
- package/lib/cjs/presentation-common/rules/hierarchy/InstanceNodesOfSpecificClassesSpecification.d.ts.map +1 -1
- package/lib/cjs/presentation-common/rules/hierarchy/InstanceNodesOfSpecificClassesSpecification.js.map +1 -1
- package/lib/cjs/presentation-common/rules/hierarchy/NavigationRule.d.ts +16 -15
- package/lib/cjs/presentation-common/rules/hierarchy/NavigationRule.d.ts.map +1 -1
- package/lib/cjs/presentation-common/rules/hierarchy/NavigationRule.js.map +1 -1
- package/lib/cjs/presentation-common/rules/hierarchy/NodeArtifactsRule.d.ts +9 -28
- package/lib/cjs/presentation-common/rules/hierarchy/NodeArtifactsRule.d.ts.map +1 -1
- package/lib/cjs/presentation-common/rules/hierarchy/NodeArtifactsRule.js.map +1 -1
- package/lib/cjs/presentation-common/rules/hierarchy/RelatedInstanceNodesSpecification.d.ts +8 -9
- package/lib/cjs/presentation-common/rules/hierarchy/RelatedInstanceNodesSpecification.d.ts.map +1 -1
- package/lib/cjs/presentation-common/rules/hierarchy/RelatedInstanceNodesSpecification.js.map +1 -1
- package/lib/cjs/presentation-common/rules/hierarchy/RootNodeRule.d.ts +3 -4
- package/lib/cjs/presentation-common/rules/hierarchy/RootNodeRule.d.ts.map +1 -1
- package/lib/cjs/presentation-common/rules/hierarchy/RootNodeRule.js.map +1 -1
- package/lib/cjs/presentation-common/rules/hierarchy/SubCondition.d.ts +17 -10
- package/lib/cjs/presentation-common/rules/hierarchy/SubCondition.d.ts.map +1 -1
- package/lib/cjs/presentation-common/rules/hierarchy/SubCondition.js.map +1 -1
- package/lib/cjs/presentation-common/selection/SelectionScope.d.ts +1 -1
- package/lib/cjs/presentation-common/selection/SelectionScope.js.map +1 -1
- package/lib/cjs/presentation-common.d.ts +3 -3
- package/lib/cjs/presentation-common.js +3 -3
- package/lib/cjs/presentation-common.js.map +1 -1
- package/lib/esm/presentation-common/CommonLoggerCategory.d.ts +13 -0
- package/lib/esm/presentation-common/CommonLoggerCategory.d.ts.map +1 -0
- package/lib/esm/presentation-common/CommonLoggerCategory.js +18 -0
- package/lib/esm/presentation-common/CommonLoggerCategory.js.map +1 -0
- package/lib/esm/presentation-common/EC.d.ts +36 -0
- package/lib/esm/presentation-common/EC.d.ts.map +1 -1
- package/lib/esm/presentation-common/EC.js +37 -3
- package/lib/esm/presentation-common/EC.js.map +1 -1
- package/lib/esm/presentation-common/RpcRequestsHandler.d.ts.map +1 -1
- package/lib/esm/presentation-common/RpcRequestsHandler.js +27 -1
- package/lib/esm/presentation-common/RpcRequestsHandler.js.map +1 -1
- package/lib/esm/presentation-common/Utils.d.ts +0 -2
- package/lib/esm/presentation-common/Utils.d.ts.map +1 -1
- package/lib/esm/presentation-common/Utils.js +0 -4
- package/lib/esm/presentation-common/Utils.js.map +1 -1
- package/lib/esm/presentation-common/content/Descriptor.d.ts +6 -6
- package/lib/esm/presentation-common/content/Descriptor.js +1 -1
- package/lib/esm/presentation-common/content/Descriptor.js.map +1 -1
- package/lib/esm/presentation-common/content/Fields.d.ts +3 -3
- package/lib/esm/presentation-common/content/Fields.d.ts.map +1 -1
- package/lib/esm/presentation-common/content/Fields.js +11 -3
- package/lib/esm/presentation-common/content/Fields.js.map +1 -1
- package/lib/esm/presentation-common/content/Item.d.ts +3 -3
- package/lib/esm/presentation-common/content/Item.js +1 -1
- package/lib/esm/presentation-common/content/Item.js.map +1 -1
- package/lib/esm/presentation-common/hierarchy/Node.d.ts +7 -7
- package/lib/esm/presentation-common/hierarchy/Node.js.map +1 -1
- package/lib/esm/presentation-common/rules/ClassSpecifications.d.ts +10 -8
- package/lib/esm/presentation-common/rules/ClassSpecifications.d.ts.map +1 -1
- package/lib/esm/presentation-common/rules/ClassSpecifications.js.map +1 -1
- package/lib/esm/presentation-common/rules/RelatedInstanceSpecification.d.ts +10 -62
- package/lib/esm/presentation-common/rules/RelatedInstanceSpecification.d.ts.map +1 -1
- package/lib/esm/presentation-common/rules/RelatedInstanceSpecification.js.map +1 -1
- package/lib/esm/presentation-common/rules/RelationshipPathSpecification.d.ts +20 -13
- package/lib/esm/presentation-common/rules/RelationshipPathSpecification.d.ts.map +1 -1
- package/lib/esm/presentation-common/rules/RelationshipPathSpecification.js.map +1 -1
- package/lib/esm/presentation-common/rules/Rule.d.ts +11 -12
- package/lib/esm/presentation-common/rules/Rule.d.ts.map +1 -1
- package/lib/esm/presentation-common/rules/Rule.js.map +1 -1
- package/lib/esm/presentation-common/rules/Ruleset.d.ts +6 -5
- package/lib/esm/presentation-common/rules/Ruleset.d.ts.map +1 -1
- package/lib/esm/presentation-common/rules/Ruleset.js.map +1 -1
- package/lib/esm/presentation-common/rules/SchemasSpecification.d.ts +5 -2
- package/lib/esm/presentation-common/rules/SchemasSpecification.d.ts.map +1 -1
- package/lib/esm/presentation-common/rules/SchemasSpecification.js.map +1 -1
- package/lib/esm/presentation-common/rules/Variables.d.ts +3 -3
- package/lib/esm/presentation-common/rules/Variables.js.map +1 -1
- package/lib/esm/presentation-common/rules/content/ContentInstancesOfSpecificClassesSpecification.d.ts +12 -14
- package/lib/esm/presentation-common/rules/content/ContentInstancesOfSpecificClassesSpecification.d.ts.map +1 -1
- package/lib/esm/presentation-common/rules/content/ContentInstancesOfSpecificClassesSpecification.js.map +1 -1
- package/lib/esm/presentation-common/rules/content/ContentRelatedInstancesSpecification.d.ts +6 -8
- package/lib/esm/presentation-common/rules/content/ContentRelatedInstancesSpecification.d.ts.map +1 -1
- package/lib/esm/presentation-common/rules/content/ContentRelatedInstancesSpecification.js.map +1 -1
- package/lib/esm/presentation-common/rules/content/ContentRule.d.ts +15 -10
- package/lib/esm/presentation-common/rules/content/ContentRule.d.ts.map +1 -1
- package/lib/esm/presentation-common/rules/content/ContentRule.js.map +1 -1
- package/lib/esm/presentation-common/rules/content/ContentSpecification.d.ts +9 -6
- package/lib/esm/presentation-common/rules/content/ContentSpecification.d.ts.map +1 -1
- package/lib/esm/presentation-common/rules/content/ContentSpecification.js.map +1 -1
- package/lib/esm/presentation-common/rules/content/DefaultPropertyCategoryOverride.d.ts +3 -4
- package/lib/esm/presentation-common/rules/content/DefaultPropertyCategoryOverride.d.ts.map +1 -1
- package/lib/esm/presentation-common/rules/content/DefaultPropertyCategoryOverride.js.map +1 -1
- package/lib/esm/presentation-common/rules/content/PropertySpecification.d.ts +56 -21
- package/lib/esm/presentation-common/rules/content/PropertySpecification.d.ts.map +1 -1
- package/lib/esm/presentation-common/rules/content/PropertySpecification.js.map +1 -1
- package/lib/esm/presentation-common/rules/content/SelectedNodeInstancesSpecification.d.ts +5 -10
- package/lib/esm/presentation-common/rules/content/SelectedNodeInstancesSpecification.d.ts.map +1 -1
- package/lib/esm/presentation-common/rules/content/SelectedNodeInstancesSpecification.js.map +1 -1
- package/lib/esm/presentation-common/rules/content/modifiers/CalculatedPropertiesSpecification.d.ts +7 -10
- package/lib/esm/presentation-common/rules/content/modifiers/CalculatedPropertiesSpecification.d.ts.map +1 -1
- package/lib/esm/presentation-common/rules/content/modifiers/CalculatedPropertiesSpecification.js.map +1 -1
- package/lib/esm/presentation-common/rules/content/modifiers/ContentModifier.d.ts +22 -12
- package/lib/esm/presentation-common/rules/content/modifiers/ContentModifier.d.ts.map +1 -1
- package/lib/esm/presentation-common/rules/content/modifiers/ContentModifier.js.map +1 -1
- package/lib/esm/presentation-common/rules/content/modifiers/CustomRendererSpecification.d.ts +8 -2
- package/lib/esm/presentation-common/rules/content/modifiers/CustomRendererSpecification.d.ts.map +1 -1
- package/lib/esm/presentation-common/rules/content/modifiers/CustomRendererSpecification.js.map +1 -1
- package/lib/esm/presentation-common/rules/content/modifiers/PropertyCategorySpecification.d.ts +30 -10
- package/lib/esm/presentation-common/rules/content/modifiers/PropertyCategorySpecification.d.ts.map +1 -1
- package/lib/esm/presentation-common/rules/content/modifiers/PropertyCategorySpecification.js.map +1 -1
- package/lib/esm/presentation-common/rules/content/modifiers/PropertyEditorsSpecification.d.ts +9 -4
- package/lib/esm/presentation-common/rules/content/modifiers/PropertyEditorsSpecification.d.ts.map +1 -1
- package/lib/esm/presentation-common/rules/content/modifiers/PropertyEditorsSpecification.js.map +1 -1
- package/lib/esm/presentation-common/rules/content/modifiers/RelatedPropertiesSpecification.d.ts +25 -21
- package/lib/esm/presentation-common/rules/content/modifiers/RelatedPropertiesSpecification.d.ts.map +1 -1
- package/lib/esm/presentation-common/rules/content/modifiers/RelatedPropertiesSpecification.js +5 -7
- package/lib/esm/presentation-common/rules/content/modifiers/RelatedPropertiesSpecification.js.map +1 -1
- package/lib/esm/presentation-common/rules/customization/CheckBoxRule.d.ts +8 -11
- package/lib/esm/presentation-common/rules/customization/CheckBoxRule.d.ts.map +1 -1
- package/lib/esm/presentation-common/rules/customization/CheckBoxRule.js.map +1 -1
- package/lib/esm/presentation-common/rules/customization/CustomizationRule.d.ts +1 -1
- package/lib/esm/presentation-common/rules/customization/CustomizationRule.js.map +1 -1
- package/lib/esm/presentation-common/rules/customization/ExtendedDataRule.d.ts +9 -24
- package/lib/esm/presentation-common/rules/customization/ExtendedDataRule.d.ts.map +1 -1
- package/lib/esm/presentation-common/rules/customization/ExtendedDataRule.js.map +1 -1
- package/lib/esm/presentation-common/rules/customization/GroupingRule.d.ts +55 -72
- package/lib/esm/presentation-common/rules/customization/GroupingRule.d.ts.map +1 -1
- package/lib/esm/presentation-common/rules/customization/GroupingRule.js +1 -1
- package/lib/esm/presentation-common/rules/customization/GroupingRule.js.map +1 -1
- package/lib/esm/presentation-common/rules/customization/ImageIdOverride.d.ts +9 -10
- package/lib/esm/presentation-common/rules/customization/ImageIdOverride.d.ts.map +1 -1
- package/lib/esm/presentation-common/rules/customization/ImageIdOverride.js.map +1 -1
- package/lib/esm/presentation-common/rules/customization/InstanceLabelOverride.d.ts +33 -22
- package/lib/esm/presentation-common/rules/customization/InstanceLabelOverride.d.ts.map +1 -1
- package/lib/esm/presentation-common/rules/customization/InstanceLabelOverride.js +1 -1
- package/lib/esm/presentation-common/rules/customization/InstanceLabelOverride.js.map +1 -1
- package/lib/esm/presentation-common/rules/customization/LabelOverride.d.ts +13 -16
- package/lib/esm/presentation-common/rules/customization/LabelOverride.d.ts.map +1 -1
- package/lib/esm/presentation-common/rules/customization/LabelOverride.js.map +1 -1
- package/lib/esm/presentation-common/rules/customization/SortingRule.d.ts +16 -29
- package/lib/esm/presentation-common/rules/customization/SortingRule.d.ts.map +1 -1
- package/lib/esm/presentation-common/rules/customization/SortingRule.js.map +1 -1
- package/lib/esm/presentation-common/rules/customization/StyleOverride.d.ts +11 -12
- package/lib/esm/presentation-common/rules/customization/StyleOverride.d.ts.map +1 -1
- package/lib/esm/presentation-common/rules/customization/StyleOverride.js.map +1 -1
- package/lib/esm/presentation-common/rules/hierarchy/ChildNodeRule.d.ts +4 -5
- package/lib/esm/presentation-common/rules/hierarchy/ChildNodeRule.d.ts.map +1 -1
- package/lib/esm/presentation-common/rules/hierarchy/ChildNodeRule.js.map +1 -1
- package/lib/esm/presentation-common/rules/hierarchy/ChildNodeSpecification.d.ts +30 -32
- package/lib/esm/presentation-common/rules/hierarchy/ChildNodeSpecification.d.ts.map +1 -1
- package/lib/esm/presentation-common/rules/hierarchy/ChildNodeSpecification.js.map +1 -1
- package/lib/esm/presentation-common/rules/hierarchy/CustomNodeSpecification.d.ts +11 -6
- package/lib/esm/presentation-common/rules/hierarchy/CustomNodeSpecification.d.ts.map +1 -1
- package/lib/esm/presentation-common/rules/hierarchy/CustomNodeSpecification.js.map +1 -1
- package/lib/esm/presentation-common/rules/hierarchy/CustomQueryInstanceNodesSpecification.d.ts +19 -20
- package/lib/esm/presentation-common/rules/hierarchy/CustomQueryInstanceNodesSpecification.d.ts.map +1 -1
- package/lib/esm/presentation-common/rules/hierarchy/CustomQueryInstanceNodesSpecification.js.map +1 -1
- package/lib/esm/presentation-common/rules/hierarchy/InstanceNodesOfSpecificClassesSpecification.d.ts +14 -10
- package/lib/esm/presentation-common/rules/hierarchy/InstanceNodesOfSpecificClassesSpecification.d.ts.map +1 -1
- package/lib/esm/presentation-common/rules/hierarchy/InstanceNodesOfSpecificClassesSpecification.js.map +1 -1
- package/lib/esm/presentation-common/rules/hierarchy/NavigationRule.d.ts +16 -15
- package/lib/esm/presentation-common/rules/hierarchy/NavigationRule.d.ts.map +1 -1
- package/lib/esm/presentation-common/rules/hierarchy/NavigationRule.js.map +1 -1
- package/lib/esm/presentation-common/rules/hierarchy/NodeArtifactsRule.d.ts +9 -28
- package/lib/esm/presentation-common/rules/hierarchy/NodeArtifactsRule.d.ts.map +1 -1
- package/lib/esm/presentation-common/rules/hierarchy/NodeArtifactsRule.js.map +1 -1
- package/lib/esm/presentation-common/rules/hierarchy/RelatedInstanceNodesSpecification.d.ts +8 -9
- package/lib/esm/presentation-common/rules/hierarchy/RelatedInstanceNodesSpecification.d.ts.map +1 -1
- package/lib/esm/presentation-common/rules/hierarchy/RelatedInstanceNodesSpecification.js.map +1 -1
- package/lib/esm/presentation-common/rules/hierarchy/RootNodeRule.d.ts +3 -4
- package/lib/esm/presentation-common/rules/hierarchy/RootNodeRule.d.ts.map +1 -1
- package/lib/esm/presentation-common/rules/hierarchy/RootNodeRule.js.map +1 -1
- package/lib/esm/presentation-common/rules/hierarchy/SubCondition.d.ts +17 -10
- package/lib/esm/presentation-common/rules/hierarchy/SubCondition.d.ts.map +1 -1
- package/lib/esm/presentation-common/rules/hierarchy/SubCondition.js.map +1 -1
- package/lib/esm/presentation-common/selection/SelectionScope.d.ts +1 -1
- package/lib/esm/presentation-common/selection/SelectionScope.js.map +1 -1
- package/lib/esm/presentation-common.d.ts +3 -3
- package/lib/esm/presentation-common.js +3 -3
- package/lib/esm/presentation-common.js.map +1 -1
- package/package.json +9 -10
package/Ruleset.schema.json
CHANGED
|
@@ -4,18 +4,18 @@
|
|
|
4
4
|
"definitions": {
|
|
5
5
|
"CalculatedPropertiesSpecification": {
|
|
6
6
|
"additionalProperties": false,
|
|
7
|
-
"description": "
|
|
7
|
+
"description": "This content modifier allows including additional calculated properties into the content.",
|
|
8
8
|
"properties": {
|
|
9
9
|
"label": {
|
|
10
|
-
"description": "
|
|
10
|
+
"description": "Specifies label of the calculated property. Supports localization.",
|
|
11
11
|
"type": "string"
|
|
12
12
|
},
|
|
13
13
|
"priority": {
|
|
14
|
-
"description": "
|
|
14
|
+
"description": "Assign a custom `Field.priority` to the property. It's up to the UI component to make sure that priority\nis respected - properties with higher priority should appear before or above properties with lower priority.",
|
|
15
15
|
"type": "integer"
|
|
16
16
|
},
|
|
17
17
|
"value": {
|
|
18
|
-
"description": "
|
|
18
|
+
"description": "Defines an expression to calculate the value. The expression can use ECInstance\nand Ruleset Variables symbol contexts.",
|
|
19
19
|
"type": "string"
|
|
20
20
|
}
|
|
21
21
|
},
|
|
@@ -27,7 +27,7 @@
|
|
|
27
27
|
},
|
|
28
28
|
"CheckBoxRule": {
|
|
29
29
|
"additionalProperties": false,
|
|
30
|
-
"description": "
|
|
30
|
+
"description": "CheckBox rules provide a way to create a checkbox for specific types of ECInstance's.",
|
|
31
31
|
"properties": {
|
|
32
32
|
"condition": {
|
|
33
33
|
"description": "Defines a condition for the rule, which needs to be met in order to execute it. Condition\nis an ECExpression, which can use\na limited set of symbols.",
|
|
@@ -45,20 +45,20 @@
|
|
|
45
45
|
]
|
|
46
46
|
},
|
|
47
47
|
"onlyIfNotHandled": {
|
|
48
|
-
"description": "
|
|
48
|
+
"description": "Tells the library that the rule should only be handled if no other rule of the same type was handled previously (based on rule\npriorities and definition order). This allows adding fallback rules which can be overriden by higher-priority rules.",
|
|
49
49
|
"type": "boolean"
|
|
50
50
|
},
|
|
51
51
|
"priority": {
|
|
52
|
-
"description": "Defines the order in which
|
|
52
|
+
"description": "Defines the order in which rules are handled, higher number means the rule is handled first. If priorities are\nequal, the rules are handled in the order they're defined.",
|
|
53
53
|
"type": "integer"
|
|
54
54
|
},
|
|
55
55
|
"propertyName": {
|
|
56
|
-
"description": "Name of boolean type ECProperty which is bound with the check box state. When set
|
|
56
|
+
"description": "Name of boolean type ECProperty which is bound with the check box state. When set, property\nvalue gets bound to checkbox state.",
|
|
57
57
|
"minLength": 1,
|
|
58
58
|
"type": "string"
|
|
59
59
|
},
|
|
60
60
|
"requiredSchemas": {
|
|
61
|
-
"description": "
|
|
61
|
+
"description": "A list of ECSchema requirements that need to be met for the rule to be used.",
|
|
62
62
|
"items": {
|
|
63
63
|
"$ref": "#/definitions/RequiredSchemaSpecification"
|
|
64
64
|
},
|
|
@@ -83,14 +83,14 @@
|
|
|
83
83
|
},
|
|
84
84
|
"ChildNodeRule": {
|
|
85
85
|
"additionalProperties": false,
|
|
86
|
-
"description": "Child node rules
|
|
86
|
+
"description": "Child node rules are used to define child nodes in a hierarchy.",
|
|
87
87
|
"properties": {
|
|
88
88
|
"condition": {
|
|
89
|
-
"description": "Defines a condition
|
|
89
|
+
"description": "Defines a condition which needs to be met in order for the rule to be used. The condition is an\nECExpression which has to evaluate\nto a boolean value.",
|
|
90
90
|
"type": "string"
|
|
91
91
|
},
|
|
92
92
|
"customizationRules": {
|
|
93
|
-
"description": "
|
|
93
|
+
"description": "A list of customization rules that\napply only to nodes produced by this rule.",
|
|
94
94
|
"items": {
|
|
95
95
|
"anyOf": [
|
|
96
96
|
{
|
|
@@ -128,15 +128,15 @@
|
|
|
128
128
|
"type": "array"
|
|
129
129
|
},
|
|
130
130
|
"onlyIfNotHandled": {
|
|
131
|
-
"description": "
|
|
131
|
+
"description": "Tells the library that the rule should only be handled if no other rule of the same type was handled previously (based on rule\npriorities and definition order). This allows adding fallback rules which can be overriden by higher-priority rules.",
|
|
132
132
|
"type": "boolean"
|
|
133
133
|
},
|
|
134
134
|
"priority": {
|
|
135
|
-
"description": "Defines the order in which
|
|
135
|
+
"description": "Defines the order in which rules are handled, higher number means the rule is handled first. If priorities are\nequal, the rules are handled in the order they're defined.",
|
|
136
136
|
"type": "integer"
|
|
137
137
|
},
|
|
138
138
|
"requiredSchemas": {
|
|
139
|
-
"description": "
|
|
139
|
+
"description": "A list of ECSchema requirements that need to be met for the rule to be used.",
|
|
140
140
|
"items": {
|
|
141
141
|
"$ref": "#/definitions/RequiredSchemaSpecification"
|
|
142
142
|
},
|
|
@@ -150,7 +150,7 @@
|
|
|
150
150
|
"type": "string"
|
|
151
151
|
},
|
|
152
152
|
"specifications": {
|
|
153
|
-
"description": "
|
|
153
|
+
"description": "A list of hierarchy specifications that define what nodes are going to be returned.",
|
|
154
154
|
"items": {
|
|
155
155
|
"anyOf": [
|
|
156
156
|
{
|
|
@@ -170,11 +170,11 @@
|
|
|
170
170
|
"type": "array"
|
|
171
171
|
},
|
|
172
172
|
"stopFurtherProcessing": {
|
|
173
|
-
"description": "Stop processing rules that have lower priority. Used in cases when recursion
|
|
173
|
+
"description": "Stop processing rules that have lower priority. Used in cases when recursion suppression is needed.",
|
|
174
174
|
"type": "boolean"
|
|
175
175
|
},
|
|
176
176
|
"subConditions": {
|
|
177
|
-
"description": "
|
|
177
|
+
"description": "A list of sub-rules which share *placement attributes* and\nnested customization rules\nof the hierarchy rule. This means the attributes of hierarchy rule are still in effect and the sub-rules\ncan add additional condition of their own.",
|
|
178
178
|
"items": {
|
|
179
179
|
"$ref": "#/definitions/SubCondition"
|
|
180
180
|
},
|
|
@@ -188,14 +188,14 @@
|
|
|
188
188
|
},
|
|
189
189
|
"ClassGroup": {
|
|
190
190
|
"additionalProperties": false,
|
|
191
|
-
"description": "
|
|
191
|
+
"description": "Base class grouping allows grouping ECInstance nodes by their base class (as opposed to the hierarchy\nspecifications' `groupByClass` attribute, which always groups by direct class).",
|
|
192
192
|
"properties": {
|
|
193
193
|
"baseClass": {
|
|
194
194
|
"$ref": "#/definitions/SingleSchemaClassSpecification",
|
|
195
|
-
"description": "Specification of the base ECClass to group by.
|
|
195
|
+
"description": "Specification of the base ECClass to group by. If specified, allows grouping by a subclass of the class\nspecified by rule's `class` attribute."
|
|
196
196
|
},
|
|
197
197
|
"createGroupForSingleItem": {
|
|
198
|
-
"description": "
|
|
198
|
+
"description": "Specifies whether a grouping node should be created if there is only one item in that group.",
|
|
199
199
|
"type": "boolean"
|
|
200
200
|
},
|
|
201
201
|
"specType": {
|
|
@@ -213,10 +213,10 @@
|
|
|
213
213
|
},
|
|
214
214
|
"ContentInstancesOfSpecificClassesSpecification": {
|
|
215
215
|
"additionalProperties": false,
|
|
216
|
-
"description": "
|
|
216
|
+
"description": "This specification creates content for all instances of specific ECClasses.",
|
|
217
217
|
"properties": {
|
|
218
218
|
"calculatedProperties": {
|
|
219
|
-
"description": "Specifications
|
|
219
|
+
"description": "Specifications of calculated properties whose values are\ngenerated using provided ECExpressions.",
|
|
220
220
|
"items": {
|
|
221
221
|
"$ref": "#/definitions/CalculatedPropertiesSpecification"
|
|
222
222
|
},
|
|
@@ -234,7 +234,7 @@
|
|
|
234
234
|
"type": "array"
|
|
235
235
|
}
|
|
236
236
|
],
|
|
237
|
-
"description": "
|
|
237
|
+
"description": "Defines a set of multi schema classes that specify which\nECClasses need to be selected to form the result."
|
|
238
238
|
},
|
|
239
239
|
"excludedClasses": {
|
|
240
240
|
"anyOf": [
|
|
@@ -248,58 +248,58 @@
|
|
|
248
248
|
"type": "array"
|
|
249
249
|
}
|
|
250
250
|
],
|
|
251
|
-
"description": "
|
|
251
|
+
"description": "Defines a set of multi schema classes that prevents specified\nECClasses and subclasses from being selected by `classes` attribute."
|
|
252
252
|
},
|
|
253
253
|
"handleInstancesPolymorphically": {
|
|
254
|
-
"description": "
|
|
254
|
+
"description": "Tells whether selecting instances from ECClasses specified in `classes` and `excludedClasses`\nattributes should be polymorphic or not.",
|
|
255
255
|
"type": "boolean"
|
|
256
256
|
},
|
|
257
257
|
"handlePropertiesPolymorphically": {
|
|
258
|
-
"description": "
|
|
258
|
+
"description": "Specifies whether properties of derived `classes` should be included in the content.",
|
|
259
259
|
"type": "boolean"
|
|
260
260
|
},
|
|
261
261
|
"instanceFilter": {
|
|
262
|
-
"description": "
|
|
262
|
+
"description": "Specifies an ECExpression for filtering instances\nof ECClasses specified through the `classes` attribute.",
|
|
263
263
|
"type": "string"
|
|
264
264
|
},
|
|
265
265
|
"onlyIfNotHandled": {
|
|
266
|
-
"description": "
|
|
266
|
+
"description": "Specifies whether this specification should be ignored if another specification was handled before as\ndetermined by rule and specification priorities. This provides a mechanism for defining a fallback specification.",
|
|
267
267
|
"type": "boolean"
|
|
268
268
|
},
|
|
269
269
|
"priority": {
|
|
270
|
-
"description": "
|
|
270
|
+
"description": "Controls the order in which specifications are handled — specification with higher priority value is handled\nfirst. If priorities are equal, the specifications are handled in the order they appear in the ruleset.",
|
|
271
271
|
"type": "integer"
|
|
272
272
|
},
|
|
273
273
|
"propertyCategories": {
|
|
274
|
-
"description": "Specifications for custom categories. Simply defining the categories does\nnothing - they have to be referenced from
|
|
274
|
+
"description": "Specifications for custom categories. Simply defining the categories does\nnothing - they have to be referenced from property specification defined in\n`propertyOverrides` by `id`.",
|
|
275
275
|
"items": {
|
|
276
276
|
"$ref": "#/definitions/PropertyCategorySpecification"
|
|
277
277
|
},
|
|
278
278
|
"type": "array"
|
|
279
279
|
},
|
|
280
280
|
"propertyOverrides": {
|
|
281
|
-
"description": "Specifications for various property overrides.",
|
|
281
|
+
"description": "Specifications for various property overrides that allow customizing property display.",
|
|
282
282
|
"items": {
|
|
283
283
|
"$ref": "#/definitions/PropertySpecification"
|
|
284
284
|
},
|
|
285
285
|
"type": "array"
|
|
286
286
|
},
|
|
287
287
|
"relatedInstances": {
|
|
288
|
-
"description": "Specifications
|
|
288
|
+
"description": "Specifications of related instances that can be used when creating the content.",
|
|
289
289
|
"items": {
|
|
290
290
|
"$ref": "#/definitions/RelatedInstanceSpecification"
|
|
291
291
|
},
|
|
292
292
|
"type": "array"
|
|
293
293
|
},
|
|
294
294
|
"relatedProperties": {
|
|
295
|
-
"description": "Specifications
|
|
295
|
+
"description": "Specifications of related properties which are\nincluded in the generated content.",
|
|
296
296
|
"items": {
|
|
297
297
|
"$ref": "#/definitions/RelatedPropertiesSpecification"
|
|
298
298
|
},
|
|
299
299
|
"type": "array"
|
|
300
300
|
},
|
|
301
301
|
"showImages": {
|
|
302
|
-
"description": "Should
|
|
302
|
+
"description": "Should image IDs be calculated for the returned instances. When `true`, `ImageIdOverride` rules get applied when\ncreating the content.",
|
|
303
303
|
"type": "boolean"
|
|
304
304
|
},
|
|
305
305
|
"specType": {
|
|
@@ -318,10 +318,10 @@
|
|
|
318
318
|
},
|
|
319
319
|
"ContentModifier": {
|
|
320
320
|
"additionalProperties": false,
|
|
321
|
-
"description": "
|
|
321
|
+
"description": "Content modifiers are used to modify how instances of specified ECClasses are displayed in content which is\nproduced using content rules. They do not produce any content\nby themselves.",
|
|
322
322
|
"properties": {
|
|
323
323
|
"calculatedProperties": {
|
|
324
|
-
"description": "Specifications
|
|
324
|
+
"description": "Specifications of calculated properties whose values are\ngenerated using provided ECExpressions.",
|
|
325
325
|
"items": {
|
|
326
326
|
"$ref": "#/definitions/CalculatedPropertiesSpecification"
|
|
327
327
|
},
|
|
@@ -329,39 +329,39 @@
|
|
|
329
329
|
},
|
|
330
330
|
"class": {
|
|
331
331
|
"$ref": "#/definitions/SingleSchemaClassSpecification",
|
|
332
|
-
"description": "Specification of ECClass whose content should be
|
|
332
|
+
"description": "Specification of ECClass whose content should be modified. The modifier is applied to all content\nif this attribute is not specified."
|
|
333
333
|
},
|
|
334
334
|
"onlyIfNotHandled": {
|
|
335
|
-
"description": "
|
|
335
|
+
"description": "Tells the library that the rule should only be handled if no other rule of the same type was handled previously (based on rule\npriorities and definition order). This allows adding fallback rules which can be overriden by higher-priority rules.",
|
|
336
336
|
"type": "boolean"
|
|
337
337
|
},
|
|
338
338
|
"priority": {
|
|
339
|
-
"description": "Defines the order in which
|
|
339
|
+
"description": "Defines the order in which rules are handled, higher number means the rule is handled first. If priorities are\nequal, the rules are handled in the order they're defined.",
|
|
340
340
|
"type": "integer"
|
|
341
341
|
},
|
|
342
342
|
"propertyCategories": {
|
|
343
|
-
"description": "Specifications for custom categories. Simply defining the categories does\nnothing - they have to be referenced from
|
|
343
|
+
"description": "Specifications for custom categories. Simply defining the categories does\nnothing - they have to be referenced from property specification defined in\n`propertyOverrides` by `id`.",
|
|
344
344
|
"items": {
|
|
345
345
|
"$ref": "#/definitions/PropertyCategorySpecification"
|
|
346
346
|
},
|
|
347
347
|
"type": "array"
|
|
348
348
|
},
|
|
349
349
|
"propertyOverrides": {
|
|
350
|
-
"description": "Specifications for various property overrides.",
|
|
350
|
+
"description": "Specifications for various property overrides that allow customizing property display.",
|
|
351
351
|
"items": {
|
|
352
352
|
"$ref": "#/definitions/PropertySpecification"
|
|
353
353
|
},
|
|
354
354
|
"type": "array"
|
|
355
355
|
},
|
|
356
356
|
"relatedProperties": {
|
|
357
|
-
"description": "Specifications
|
|
357
|
+
"description": "Specifications of related properties which are\nincluded in the generated content.",
|
|
358
358
|
"items": {
|
|
359
359
|
"$ref": "#/definitions/RelatedPropertiesSpecification"
|
|
360
360
|
},
|
|
361
361
|
"type": "array"
|
|
362
362
|
},
|
|
363
363
|
"requiredSchemas": {
|
|
364
|
-
"description": "
|
|
364
|
+
"description": "A list of ECSchema requirements that need to be met for the rule to be used.",
|
|
365
365
|
"items": {
|
|
366
366
|
"$ref": "#/definitions/RequiredSchemaSpecification"
|
|
367
367
|
},
|
|
@@ -382,57 +382,57 @@
|
|
|
382
382
|
},
|
|
383
383
|
"ContentRelatedInstancesSpecification": {
|
|
384
384
|
"additionalProperties": false,
|
|
385
|
-
"description": "
|
|
385
|
+
"description": "Returns content for instances related to the selected (input) instances.",
|
|
386
386
|
"properties": {
|
|
387
387
|
"calculatedProperties": {
|
|
388
|
-
"description": "Specifications
|
|
388
|
+
"description": "Specifications of calculated properties whose values are\ngenerated using provided ECExpressions.",
|
|
389
389
|
"items": {
|
|
390
390
|
"$ref": "#/definitions/CalculatedPropertiesSpecification"
|
|
391
391
|
},
|
|
392
392
|
"type": "array"
|
|
393
393
|
},
|
|
394
394
|
"instanceFilter": {
|
|
395
|
-
"description": "
|
|
395
|
+
"description": "Specifies an ECExpression for filtering instances\nof ECClasses targeted through the `relationshipPaths` attribute.",
|
|
396
396
|
"type": "string"
|
|
397
397
|
},
|
|
398
398
|
"onlyIfNotHandled": {
|
|
399
|
-
"description": "
|
|
399
|
+
"description": "Specifies whether this specification should be ignored if another specification was handled before as\ndetermined by rule and specification priorities. This provides a mechanism for defining a fallback specification.",
|
|
400
400
|
"type": "boolean"
|
|
401
401
|
},
|
|
402
402
|
"priority": {
|
|
403
|
-
"description": "
|
|
403
|
+
"description": "Controls the order in which specifications are handled — specification with higher priority value is handled\nfirst. If priorities are equal, the specifications are handled in the order they appear in the ruleset.",
|
|
404
404
|
"type": "integer"
|
|
405
405
|
},
|
|
406
406
|
"propertyCategories": {
|
|
407
|
-
"description": "Specifications for custom categories. Simply defining the categories does\nnothing - they have to be referenced from
|
|
407
|
+
"description": "Specifications for custom categories. Simply defining the categories does\nnothing - they have to be referenced from property specification defined in\n`propertyOverrides` by `id`.",
|
|
408
408
|
"items": {
|
|
409
409
|
"$ref": "#/definitions/PropertyCategorySpecification"
|
|
410
410
|
},
|
|
411
411
|
"type": "array"
|
|
412
412
|
},
|
|
413
413
|
"propertyOverrides": {
|
|
414
|
-
"description": "Specifications for various property overrides.",
|
|
414
|
+
"description": "Specifications for various property overrides that allow customizing property display.",
|
|
415
415
|
"items": {
|
|
416
416
|
"$ref": "#/definitions/PropertySpecification"
|
|
417
417
|
},
|
|
418
418
|
"type": "array"
|
|
419
419
|
},
|
|
420
420
|
"relatedInstances": {
|
|
421
|
-
"description": "Specifications
|
|
421
|
+
"description": "Specifications of related instances that can be used when creating the content.",
|
|
422
422
|
"items": {
|
|
423
423
|
"$ref": "#/definitions/RelatedInstanceSpecification"
|
|
424
424
|
},
|
|
425
425
|
"type": "array"
|
|
426
426
|
},
|
|
427
427
|
"relatedProperties": {
|
|
428
|
-
"description": "Specifications
|
|
428
|
+
"description": "Specifications of related properties which are\nincluded in the generated content.",
|
|
429
429
|
"items": {
|
|
430
430
|
"$ref": "#/definitions/RelatedPropertiesSpecification"
|
|
431
431
|
},
|
|
432
432
|
"type": "array"
|
|
433
433
|
},
|
|
434
434
|
"relationshipPaths": {
|
|
435
|
-
"description": "
|
|
435
|
+
"description": "Specifies a chain of relationship path specifications that\nforms a path from an input instance to the output instances. When this array is empty, the specification produces no results.",
|
|
436
436
|
"items": {
|
|
437
437
|
"anyOf": [
|
|
438
438
|
{
|
|
@@ -449,7 +449,7 @@
|
|
|
449
449
|
"type": "array"
|
|
450
450
|
},
|
|
451
451
|
"showImages": {
|
|
452
|
-
"description": "Should
|
|
452
|
+
"description": "Should image IDs be calculated for the returned instances. When `true`, `ImageIdOverride` rules get applied when\ncreating the content.",
|
|
453
453
|
"type": "boolean"
|
|
454
454
|
},
|
|
455
455
|
"specType": {
|
|
@@ -468,22 +468,22 @@
|
|
|
468
468
|
},
|
|
469
469
|
"ContentRule": {
|
|
470
470
|
"additionalProperties": false,
|
|
471
|
-
"description": "
|
|
471
|
+
"description": "Content rules are used to define content that is displayed for specific type of input.\nInput consists of either ECInstances or nodes and to make things\nsimpler everything is considered a node - instances get converted to\n*ECInstance nodes* (thus the `SelectedNode` symbol in `condition` ECExpression).",
|
|
472
472
|
"properties": {
|
|
473
473
|
"condition": {
|
|
474
|
-
"description": "Defines a condition
|
|
474
|
+
"description": "Defines a condition which needs to be met in order for the rule to be used. The condition is an\nECExpression which has to evaluate to\na boolean value.",
|
|
475
475
|
"type": "string"
|
|
476
476
|
},
|
|
477
477
|
"onlyIfNotHandled": {
|
|
478
|
-
"description": "
|
|
478
|
+
"description": "Tells the library that the rule should only be handled if no other rule of the same type was handled previously (based on rule\npriorities and definition order). This allows adding fallback rules which can be overriden by higher-priority rules.",
|
|
479
479
|
"type": "boolean"
|
|
480
480
|
},
|
|
481
481
|
"priority": {
|
|
482
|
-
"description": "Defines the order in which
|
|
482
|
+
"description": "Defines the order in which rules are handled, higher number means the rule is handled first. If priorities are\nequal, the rules are handled in the order they're defined.",
|
|
483
483
|
"type": "integer"
|
|
484
484
|
},
|
|
485
485
|
"requiredSchemas": {
|
|
486
|
-
"description": "
|
|
486
|
+
"description": "A list of ECSchema requirements that need to be met for the rule to be used.",
|
|
487
487
|
"items": {
|
|
488
488
|
"$ref": "#/definitions/RequiredSchemaSpecification"
|
|
489
489
|
},
|
|
@@ -497,7 +497,7 @@
|
|
|
497
497
|
"type": "string"
|
|
498
498
|
},
|
|
499
499
|
"specifications": {
|
|
500
|
-
"description": "
|
|
500
|
+
"description": "A list of content specifications that define what content is going to be returned. This is the most\nimportant attribute which is responsible for defining what instances' properties are included in the\nreturned content.",
|
|
501
501
|
"items": {
|
|
502
502
|
"anyOf": [
|
|
503
503
|
{
|
|
@@ -522,18 +522,18 @@
|
|
|
522
522
|
},
|
|
523
523
|
"CustomNodeSpecification": {
|
|
524
524
|
"additionalProperties": false,
|
|
525
|
-
"description": "
|
|
525
|
+
"description": "Returns a static custom-defined node that's not based on an ECInstance.",
|
|
526
526
|
"properties": {
|
|
527
527
|
"description": {
|
|
528
|
-
"description": "
|
|
528
|
+
"description": "Specifies the value of `Node.description` property, which is a string that may\nbe localized. UI component displaying the node may choose\nwhether and how to surface this information to users.",
|
|
529
529
|
"type": "string"
|
|
530
530
|
},
|
|
531
531
|
"doNotSort": {
|
|
532
|
-
"description": "
|
|
532
|
+
"description": "Suppress sorting of nodes returned by this specification. With this attribute set to `true`, the order\nof returned nodes is undefined.",
|
|
533
533
|
"type": "boolean"
|
|
534
534
|
},
|
|
535
535
|
"hasChildren": {
|
|
536
|
-
"description": "This
|
|
536
|
+
"description": "This attribute allows telling the engine that nodes created by this specification always or never have children.",
|
|
537
537
|
"enum": [
|
|
538
538
|
"Always",
|
|
539
539
|
"Never",
|
|
@@ -542,38 +542,38 @@
|
|
|
542
542
|
"type": "string"
|
|
543
543
|
},
|
|
544
544
|
"hideExpression": {
|
|
545
|
-
"description": "
|
|
545
|
+
"description": "When specified ECExpression evaluates\nto `true`, nodes produced by this specification are omitted and their children appear one hierarchy level\nhigher.",
|
|
546
546
|
"type": "string"
|
|
547
547
|
},
|
|
548
548
|
"hideIfNoChildren": {
|
|
549
|
-
"description": "
|
|
549
|
+
"description": "Specifies whether nodes created through this specification should be hidden if they have no child nodes.",
|
|
550
550
|
"type": "boolean"
|
|
551
551
|
},
|
|
552
552
|
"hideNodesInHierarchy": {
|
|
553
|
-
"description": "
|
|
553
|
+
"description": "When `true`, instances nodes produced by this specification are omitted and their children appear one\nhierarchy level higher.",
|
|
554
554
|
"type": "boolean"
|
|
555
555
|
},
|
|
556
556
|
"imageId": {
|
|
557
|
-
"description": "
|
|
557
|
+
"description": "Specifies node's image ID. If set, the ID is assigned to `Node.imageId` and it's\nup to the UI component to decide what to do with it.",
|
|
558
558
|
"type": "string"
|
|
559
559
|
},
|
|
560
560
|
"label": {
|
|
561
|
-
"description": "
|
|
561
|
+
"description": "Specifies node label. This is a string value that may be localized.",
|
|
562
562
|
"type": "string"
|
|
563
563
|
},
|
|
564
564
|
"nestedRules": {
|
|
565
|
-
"description": "
|
|
565
|
+
"description": "Specifications of nested child node rules that\nallow creating child nodes without the need of supplying a condition to match the parent node.",
|
|
566
566
|
"items": {
|
|
567
567
|
"$ref": "#/definitions/ChildNodeRule"
|
|
568
568
|
},
|
|
569
569
|
"type": "array"
|
|
570
570
|
},
|
|
571
571
|
"priority": {
|
|
572
|
-
"description": "
|
|
572
|
+
"description": "Controls the order in which specifications are handled — specification with higher priority value is\nhandled first. If priorities are equal, the specifications are handled in the order they appear in the\nruleset.",
|
|
573
573
|
"type": "integer"
|
|
574
574
|
},
|
|
575
575
|
"relatedInstances": {
|
|
576
|
-
"description": "Specifications of related instances that can be used
|
|
576
|
+
"description": "Specifications of related instances that can be used\nwhen creating the nodes.",
|
|
577
577
|
"items": {
|
|
578
578
|
"$ref": "#/definitions/RelatedInstanceSpecification"
|
|
579
579
|
},
|
|
@@ -587,11 +587,11 @@
|
|
|
587
587
|
"type": "string"
|
|
588
588
|
},
|
|
589
589
|
"suppressSimilarAncestorsCheck": {
|
|
590
|
-
"description": "
|
|
590
|
+
"description": "Specifies whether similar ancestor nodes' checking should be suppressed when creating nodes based on this\nspecification. See more in infinite hierarchies prevention page.",
|
|
591
591
|
"type": "boolean"
|
|
592
592
|
},
|
|
593
593
|
"type": {
|
|
594
|
-
"description": "
|
|
594
|
+
"description": "Specifies node type, which is assigned to node's key.",
|
|
595
595
|
"type": "string"
|
|
596
596
|
}
|
|
597
597
|
},
|
|
@@ -604,22 +604,22 @@
|
|
|
604
604
|
},
|
|
605
605
|
"CustomQueryInstanceNodesSpecification": {
|
|
606
606
|
"additionalProperties": false,
|
|
607
|
-
"description": "
|
|
607
|
+
"description": "Returns nodes for instances returned by a provided ECSQL query.",
|
|
608
608
|
"properties": {
|
|
609
609
|
"doNotSort": {
|
|
610
|
-
"description": "
|
|
610
|
+
"description": "Suppress sorting of nodes returned by this specification. With this attribute set to `true`, the order\nof returned nodes is undefined.",
|
|
611
611
|
"type": "boolean"
|
|
612
612
|
},
|
|
613
613
|
"groupByClass": {
|
|
614
|
-
"description": "
|
|
614
|
+
"description": "Controls whether returned instances should be grouped by ECClass. Defaults to `true`.",
|
|
615
615
|
"type": "boolean"
|
|
616
616
|
},
|
|
617
617
|
"groupByLabel": {
|
|
618
|
-
"description": "
|
|
618
|
+
"description": "Controls whether returned instances should be grouped by label. Defaults to `true`.",
|
|
619
619
|
"type": "boolean"
|
|
620
620
|
},
|
|
621
621
|
"hasChildren": {
|
|
622
|
-
"description": "This
|
|
622
|
+
"description": "This attribute allows telling the engine that nodes created by this specification always or never have children.",
|
|
623
623
|
"enum": [
|
|
624
624
|
"Always",
|
|
625
625
|
"Never",
|
|
@@ -628,30 +628,30 @@
|
|
|
628
628
|
"type": "string"
|
|
629
629
|
},
|
|
630
630
|
"hideExpression": {
|
|
631
|
-
"description": "
|
|
631
|
+
"description": "When specified ECExpression evaluates\nto `true`, nodes produced by this specification are omitted and their children appear one hierarchy level\nhigher.",
|
|
632
632
|
"type": "string"
|
|
633
633
|
},
|
|
634
634
|
"hideIfNoChildren": {
|
|
635
|
-
"description": "
|
|
635
|
+
"description": "Specifies whether nodes created through this specification should be hidden if they have no child nodes.",
|
|
636
636
|
"type": "boolean"
|
|
637
637
|
},
|
|
638
638
|
"hideNodesInHierarchy": {
|
|
639
|
-
"description": "
|
|
639
|
+
"description": "When `true`, instances nodes produced by this specification are omitted and their children appear one\nhierarchy level higher.",
|
|
640
640
|
"type": "boolean"
|
|
641
641
|
},
|
|
642
642
|
"nestedRules": {
|
|
643
|
-
"description": "
|
|
643
|
+
"description": "Specifications of nested child node rules that\nallow creating child nodes without the need of supplying a condition to match the parent node.",
|
|
644
644
|
"items": {
|
|
645
645
|
"$ref": "#/definitions/ChildNodeRule"
|
|
646
646
|
},
|
|
647
647
|
"type": "array"
|
|
648
648
|
},
|
|
649
649
|
"priority": {
|
|
650
|
-
"description": "
|
|
650
|
+
"description": "Controls the order in which specifications are handled — specification with higher priority value is\nhandled first. If priorities are equal, the specifications are handled in the order they appear in the\nruleset.",
|
|
651
651
|
"type": "integer"
|
|
652
652
|
},
|
|
653
653
|
"queries": {
|
|
654
|
-
"description": "Specifications of queries used to create the content
|
|
654
|
+
"description": "Specifications of queries used to create the content. Query specifications define the actual\nresults of the specification.",
|
|
655
655
|
"items": {
|
|
656
656
|
"anyOf": [
|
|
657
657
|
{
|
|
@@ -665,7 +665,7 @@
|
|
|
665
665
|
"type": "array"
|
|
666
666
|
},
|
|
667
667
|
"relatedInstances": {
|
|
668
|
-
"description": "Specifications of related instances that can be used
|
|
668
|
+
"description": "Specifications of related instances that can be used\nwhen creating the nodes.",
|
|
669
669
|
"items": {
|
|
670
670
|
"$ref": "#/definitions/RelatedInstanceSpecification"
|
|
671
671
|
},
|
|
@@ -679,7 +679,7 @@
|
|
|
679
679
|
"type": "string"
|
|
680
680
|
},
|
|
681
681
|
"suppressSimilarAncestorsCheck": {
|
|
682
|
-
"description": "
|
|
682
|
+
"description": "Specifies whether similar ancestor nodes' checking should be suppressed when creating nodes based on this\nspecification. See more in infinite hierarchies prevention page.",
|
|
683
683
|
"type": "boolean"
|
|
684
684
|
}
|
|
685
685
|
},
|
|
@@ -690,10 +690,10 @@
|
|
|
690
690
|
},
|
|
691
691
|
"CustomRendererSpecification": {
|
|
692
692
|
"additionalProperties": false,
|
|
693
|
-
"description": "
|
|
693
|
+
"description": "This specification allows defining a custom renderer, which can be used to render properties or categories.",
|
|
694
694
|
"properties": {
|
|
695
695
|
"rendererName": {
|
|
696
|
-
"description": "Name of the
|
|
696
|
+
"description": "Name of the renderer that's going to be used in UI components. Value of this attribute corresponds\nto `RendererDescription.name` attribute that gets assigned to whatever the renderer\nis set on.",
|
|
697
697
|
"type": "string"
|
|
698
698
|
}
|
|
699
699
|
},
|
|
@@ -704,18 +704,18 @@
|
|
|
704
704
|
},
|
|
705
705
|
"DefaultPropertyCategoryOverride": {
|
|
706
706
|
"additionalProperties": false,
|
|
707
|
-
"description": "A rule that allows overriding the default property category.\n\nThe default property category is a category that gets assigned to properties
|
|
707
|
+
"description": "A rule that allows overriding the default property category.\n\nThe default property category is a category that gets assigned to properties that otherwise have no category.",
|
|
708
708
|
"properties": {
|
|
709
709
|
"onlyIfNotHandled": {
|
|
710
|
-
"description": "
|
|
710
|
+
"description": "Tells the library that the rule should only be handled if no other rule of the same type was handled previously (based on rule\npriorities and definition order). This allows adding fallback rules which can be overriden by higher-priority rules.",
|
|
711
711
|
"type": "boolean"
|
|
712
712
|
},
|
|
713
713
|
"priority": {
|
|
714
|
-
"description": "Defines the order in which
|
|
714
|
+
"description": "Defines the order in which rules are handled, higher number means the rule is handled first. If priorities are\nequal, the rules are handled in the order they're defined.",
|
|
715
715
|
"type": "integer"
|
|
716
716
|
},
|
|
717
717
|
"requiredSchemas": {
|
|
718
|
-
"description": "
|
|
718
|
+
"description": "A list of ECSchema requirements that need to be met for the rule to be used.",
|
|
719
719
|
"items": {
|
|
720
720
|
"$ref": "#/definitions/RequiredSchemaSpecification"
|
|
721
721
|
},
|
|
@@ -730,7 +730,7 @@
|
|
|
730
730
|
},
|
|
731
731
|
"specification": {
|
|
732
732
|
"$ref": "#/definitions/PropertyCategorySpecification",
|
|
733
|
-
"description": "Specification
|
|
733
|
+
"description": "Specification for the custom property category."
|
|
734
734
|
}
|
|
735
735
|
},
|
|
736
736
|
"required": [
|
|
@@ -741,30 +741,30 @@
|
|
|
741
741
|
},
|
|
742
742
|
"DisabledSortingRule": {
|
|
743
743
|
"additionalProperties": false,
|
|
744
|
-
"description": "Rule to disable sorting for certain ECInstances in the hierarchy and/or content
|
|
744
|
+
"description": "Rule to disable sorting for certain ECInstances in the hierarchy and/or content.",
|
|
745
745
|
"properties": {
|
|
746
746
|
"class": {
|
|
747
747
|
"$ref": "#/definitions/SingleSchemaClassSpecification",
|
|
748
|
-
"description": "
|
|
748
|
+
"description": "Specifies ECClass whose ECInstances should be sorted."
|
|
749
749
|
},
|
|
750
750
|
"condition": {
|
|
751
|
-
"description": "Defines a condition
|
|
751
|
+
"description": "Defines a condition which needs to be met in order for the rule to be used. The condition is an\nECExpression which has to\nevaluate to a boolean value.",
|
|
752
752
|
"type": "string"
|
|
753
753
|
},
|
|
754
754
|
"isPolymorphic": {
|
|
755
|
-
"description": "
|
|
755
|
+
"description": "Specifies that `class` attribute defined in this rule should be handled polymorphically.",
|
|
756
756
|
"type": "boolean"
|
|
757
757
|
},
|
|
758
758
|
"onlyIfNotHandled": {
|
|
759
|
-
"description": "
|
|
759
|
+
"description": "Tells the library that the rule should only be handled if no other rule of the same type was handled previously (based on rule\npriorities and definition order). This allows adding fallback rules which can be overriden by higher-priority rules.",
|
|
760
760
|
"type": "boolean"
|
|
761
761
|
},
|
|
762
762
|
"priority": {
|
|
763
|
-
"description": "Defines the order in which
|
|
763
|
+
"description": "Defines the order in which rules are handled, higher number means the rule is handled first. If priorities are\nequal, the rules are handled in the order they're defined.",
|
|
764
764
|
"type": "integer"
|
|
765
765
|
},
|
|
766
766
|
"requiredSchemas": {
|
|
767
|
-
"description": "
|
|
767
|
+
"description": "A list of ECSchema requirements that need to be met for the rule to be used.",
|
|
768
768
|
"items": {
|
|
769
769
|
"$ref": "#/definitions/RequiredSchemaSpecification"
|
|
770
770
|
},
|
|
@@ -785,14 +785,14 @@
|
|
|
785
785
|
},
|
|
786
786
|
"ECPropertyValueQuerySpecification": {
|
|
787
787
|
"additionalProperties": false,
|
|
788
|
-
"description": "
|
|
788
|
+
"description": "The specification specifies the name of the parent node instance property whose value is the ECSQL\nused to query for instances.",
|
|
789
789
|
"properties": {
|
|
790
790
|
"class": {
|
|
791
791
|
"$ref": "#/definitions/SingleSchemaClassSpecification",
|
|
792
|
-
"description": "Specification of ECClass whose instances the query returns."
|
|
792
|
+
"description": "Specification of ECClass whose instances the query returns. The specification may also point to a\nbase class of instances returned by the query. If the query returns instances that are not of this\nclass, they aren't included in the result set."
|
|
793
793
|
},
|
|
794
794
|
"parentPropertyName": {
|
|
795
|
-
"description": "Specifies name of the parent instance property whose value
|
|
795
|
+
"description": "Specifies name of the parent instance property whose value contains the ECSQL query.",
|
|
796
796
|
"type": "string"
|
|
797
797
|
},
|
|
798
798
|
"specType": {
|
|
@@ -812,29 +812,29 @@
|
|
|
812
812
|
},
|
|
813
813
|
"ExtendedDataRule": {
|
|
814
814
|
"additionalProperties": false,
|
|
815
|
-
"description": "
|
|
815
|
+
"description": "Extended data rule is used to inject some arbitrary data into presentation data objects (nodes, content records).",
|
|
816
816
|
"properties": {
|
|
817
817
|
"condition": {
|
|
818
|
-
"description": "Defines a condition
|
|
818
|
+
"description": "Defines a condition which needs to be met in order for the rule to be used. The condition\nis an ECExpression which has\nto evaluate to a boolean value.",
|
|
819
819
|
"type": "string"
|
|
820
820
|
},
|
|
821
821
|
"items": {
|
|
822
822
|
"additionalProperties": {
|
|
823
823
|
"type": "string"
|
|
824
824
|
},
|
|
825
|
-
"description": "A map of
|
|
825
|
+
"description": "A map of ECExpressions whose\nevaluation results are used as extended data values.",
|
|
826
826
|
"type": "object"
|
|
827
827
|
},
|
|
828
828
|
"onlyIfNotHandled": {
|
|
829
|
-
"description": "
|
|
829
|
+
"description": "Tells the library that the rule should only be handled if no other rule of the same type was handled previously (based on rule\npriorities and definition order). This allows adding fallback rules which can be overriden by higher-priority rules.",
|
|
830
830
|
"type": "boolean"
|
|
831
831
|
},
|
|
832
832
|
"priority": {
|
|
833
|
-
"description": "Defines the order in which
|
|
833
|
+
"description": "Defines the order in which rules are handled, higher number means the rule is handled first. If priorities are\nequal, the rules are handled in the order they're defined.",
|
|
834
834
|
"type": "integer"
|
|
835
835
|
},
|
|
836
836
|
"requiredSchemas": {
|
|
837
|
-
"description": "
|
|
837
|
+
"description": "A list of ECSchema requirements that need to be met for the rule to be used.",
|
|
838
838
|
"items": {
|
|
839
839
|
"$ref": "#/definitions/RequiredSchemaSpecification"
|
|
840
840
|
},
|
|
@@ -856,18 +856,18 @@
|
|
|
856
856
|
},
|
|
857
857
|
"GroupingRule": {
|
|
858
858
|
"additionalProperties": false,
|
|
859
|
-
"description": "Grouping
|
|
859
|
+
"description": "Grouping rules provide advanced ways to group instances when creating hierarchies.",
|
|
860
860
|
"properties": {
|
|
861
861
|
"class": {
|
|
862
862
|
"$ref": "#/definitions/SingleSchemaClassSpecification",
|
|
863
|
-
"description": "Specification of ECClass which should be grouped using this rule"
|
|
863
|
+
"description": "Specification of ECClass which should be grouped using this rule."
|
|
864
864
|
},
|
|
865
865
|
"condition": {
|
|
866
|
-
"description": "
|
|
866
|
+
"description": "An ECExpression that results in\na boolean value. If specified, the grouping rule applies only to instance nodes that cause the condition\nto evaluate to `true`.",
|
|
867
867
|
"type": "string"
|
|
868
868
|
},
|
|
869
869
|
"groups": {
|
|
870
|
-
"description": "
|
|
870
|
+
"description": "Specifies a list of grouping specifications\nwhich describe the kind of grouping that should be applied.",
|
|
871
871
|
"items": {
|
|
872
872
|
"anyOf": [
|
|
873
873
|
{
|
|
@@ -884,15 +884,15 @@
|
|
|
884
884
|
"type": "array"
|
|
885
885
|
},
|
|
886
886
|
"onlyIfNotHandled": {
|
|
887
|
-
"description": "
|
|
887
|
+
"description": "Tells the library that the rule should only be handled if no other rule of the same type was handled previously (based on rule\npriorities and definition order). This allows adding fallback rules which can be overriden by higher-priority rules.",
|
|
888
888
|
"type": "boolean"
|
|
889
889
|
},
|
|
890
890
|
"priority": {
|
|
891
|
-
"description": "Defines the order in which
|
|
891
|
+
"description": "Defines the order in which rules are handled, higher number means the rule is handled first. If priorities are\nequal, the rules are handled in the order they're defined.",
|
|
892
892
|
"type": "integer"
|
|
893
893
|
},
|
|
894
894
|
"requiredSchemas": {
|
|
895
|
-
"description": "
|
|
895
|
+
"description": "A list of ECSchema requirements that need to be met for the rule to be used.",
|
|
896
896
|
"items": {
|
|
897
897
|
"$ref": "#/definitions/RequiredSchemaSpecification"
|
|
898
898
|
},
|
|
@@ -937,27 +937,27 @@
|
|
|
937
937
|
},
|
|
938
938
|
"ImageIdOverride": {
|
|
939
939
|
"additionalProperties": false,
|
|
940
|
-
"description": "
|
|
940
|
+
"description": "ImageId override rules allow setting an image ID to specific types of ECInstances.",
|
|
941
941
|
"properties": {
|
|
942
942
|
"condition": {
|
|
943
943
|
"description": "Defines a condition for the rule, which needs to be met in order to execute it. Condition\nis an ECExpression, which can use\na limited set of symbols.",
|
|
944
944
|
"type": "string"
|
|
945
945
|
},
|
|
946
946
|
"imageIdExpression": {
|
|
947
|
-
"description": "
|
|
947
|
+
"description": "An expression whose result becomes the image ID. This is\nan ECExpression, so ID can be\ndefined/formatted dynamically based on the context - for example ECInstance property value.",
|
|
948
948
|
"minLength": 1,
|
|
949
949
|
"type": "string"
|
|
950
950
|
},
|
|
951
951
|
"onlyIfNotHandled": {
|
|
952
|
-
"description": "
|
|
952
|
+
"description": "Tells the library that the rule should only be handled if no other rule of the same type was handled previously (based on rule\npriorities and definition order). This allows adding fallback rules which can be overriden by higher-priority rules.",
|
|
953
953
|
"type": "boolean"
|
|
954
954
|
},
|
|
955
955
|
"priority": {
|
|
956
|
-
"description": "Defines the order in which
|
|
956
|
+
"description": "Defines the order in which rules are handled, higher number means the rule is handled first. If priorities are\nequal, the rules are handled in the order they're defined.",
|
|
957
957
|
"type": "integer"
|
|
958
958
|
},
|
|
959
959
|
"requiredSchemas": {
|
|
960
|
-
"description": "
|
|
960
|
+
"description": "A list of ECSchema requirements that need to be met for the rule to be used.",
|
|
961
961
|
"items": {
|
|
962
962
|
"$ref": "#/definitions/RequiredSchemaSpecification"
|
|
963
963
|
},
|
|
@@ -979,22 +979,22 @@
|
|
|
979
979
|
},
|
|
980
980
|
"InstanceLabelOverride": {
|
|
981
981
|
"additionalProperties": false,
|
|
982
|
-
"description": "
|
|
982
|
+
"description": "Instance label override rule provides a way to set instance label to one of its property values,\nother attributes and/or combination of them.",
|
|
983
983
|
"properties": {
|
|
984
984
|
"class": {
|
|
985
985
|
"$ref": "#/definitions/SingleSchemaClassSpecification",
|
|
986
|
-
"description": "
|
|
986
|
+
"description": "Specifies the ECClass to apply this rule to."
|
|
987
987
|
},
|
|
988
988
|
"onlyIfNotHandled": {
|
|
989
|
-
"description": "
|
|
989
|
+
"description": "Tells the library that the rule should only be handled if no other rule of the same type was handled previously (based on rule\npriorities and definition order). This allows adding fallback rules which can be overriden by higher-priority rules.",
|
|
990
990
|
"type": "boolean"
|
|
991
991
|
},
|
|
992
992
|
"priority": {
|
|
993
|
-
"description": "Defines the order in which
|
|
993
|
+
"description": "Defines the order in which rules are handled, higher number means the rule is handled first. If priorities are\nequal, the rules are handled in the order they're defined.",
|
|
994
994
|
"type": "integer"
|
|
995
995
|
},
|
|
996
996
|
"requiredSchemas": {
|
|
997
|
-
"description": "
|
|
997
|
+
"description": "A list of ECSchema requirements that need to be met for the rule to be used.",
|
|
998
998
|
"items": {
|
|
999
999
|
"$ref": "#/definitions/RequiredSchemaSpecification"
|
|
1000
1000
|
},
|
|
@@ -1008,7 +1008,7 @@
|
|
|
1008
1008
|
"type": "string"
|
|
1009
1009
|
},
|
|
1010
1010
|
"values": {
|
|
1011
|
-
"description": "Specifications
|
|
1011
|
+
"description": "Specifications of values used to override label. The first non-empty value is used as the actual label.",
|
|
1012
1012
|
"items": {
|
|
1013
1013
|
"anyOf": [
|
|
1014
1014
|
{
|
|
@@ -1049,7 +1049,7 @@
|
|
|
1049
1049
|
},
|
|
1050
1050
|
"InstanceLabelOverrideBriefcaseIdSpecification": {
|
|
1051
1051
|
"additionalProperties": false,
|
|
1052
|
-
"description": "Specification
|
|
1052
|
+
"description": "Specification returns ECInstance's briefcase ID in base36 format.",
|
|
1053
1053
|
"properties": {
|
|
1054
1054
|
"specType": {
|
|
1055
1055
|
"description": "Type of the specification",
|
|
@@ -1066,7 +1066,7 @@
|
|
|
1066
1066
|
},
|
|
1067
1067
|
"InstanceLabelOverrideClassLabelSpecification": {
|
|
1068
1068
|
"additionalProperties": false,
|
|
1069
|
-
"description": "Specification
|
|
1069
|
+
"description": "Specification uses ECClass display label as the label content.",
|
|
1070
1070
|
"properties": {
|
|
1071
1071
|
"specType": {
|
|
1072
1072
|
"description": "Type of the specification",
|
|
@@ -1083,7 +1083,7 @@
|
|
|
1083
1083
|
},
|
|
1084
1084
|
"InstanceLabelOverrideClassNameSpecification": {
|
|
1085
1085
|
"additionalProperties": false,
|
|
1086
|
-
"description": "Specification
|
|
1086
|
+
"description": "Specification uses ECClass name as the label content.",
|
|
1087
1087
|
"properties": {
|
|
1088
1088
|
"full": {
|
|
1089
1089
|
"description": "Should full (`{schemaName}.{className}`) class name be used",
|
|
@@ -1104,7 +1104,7 @@
|
|
|
1104
1104
|
},
|
|
1105
1105
|
"InstanceLabelOverrideCompositeValueSpecification": {
|
|
1106
1106
|
"additionalProperties": false,
|
|
1107
|
-
"description": "Specification
|
|
1107
|
+
"description": "Specification allows creating a label value composited using multiple other specifications.",
|
|
1108
1108
|
"properties": {
|
|
1109
1109
|
"parts": {
|
|
1110
1110
|
"description": "Parts of the value.\n\nIf any of the parts with `isRequired` flag evaluate to an empty string, the\nresult of this specification is also an empty string.",
|
|
@@ -1171,7 +1171,7 @@
|
|
|
1171
1171
|
},
|
|
1172
1172
|
"InstanceLabelOverrideLocalIdSpecification": {
|
|
1173
1173
|
"additionalProperties": false,
|
|
1174
|
-
"description": "Specification
|
|
1174
|
+
"description": "Specification returns ECInstance's local ID in base36 format.",
|
|
1175
1175
|
"properties": {
|
|
1176
1176
|
"specType": {
|
|
1177
1177
|
"description": "Type of the specification",
|
|
@@ -1188,7 +1188,7 @@
|
|
|
1188
1188
|
},
|
|
1189
1189
|
"InstanceLabelOverridePropertyValueSpecification": {
|
|
1190
1190
|
"additionalProperties": false,
|
|
1191
|
-
"description": "Specification
|
|
1191
|
+
"description": "Specification uses property value as the label content.",
|
|
1192
1192
|
"properties": {
|
|
1193
1193
|
"propertyName": {
|
|
1194
1194
|
"description": "Name of the property whose value should be used.",
|
|
@@ -1206,7 +1206,7 @@
|
|
|
1206
1206
|
"type": "array"
|
|
1207
1207
|
}
|
|
1208
1208
|
],
|
|
1209
|
-
"description": "
|
|
1209
|
+
"description": "Specification of the relationship path from `InstanceLabelOverride.class`\nto class of the property. If omitted, `InstanceLabelOverride.class` is used as property class."
|
|
1210
1210
|
},
|
|
1211
1211
|
"specType": {
|
|
1212
1212
|
"description": "Type of the specification",
|
|
@@ -1224,7 +1224,7 @@
|
|
|
1224
1224
|
},
|
|
1225
1225
|
"InstanceLabelOverrideRelatedInstanceLabelSpecification": {
|
|
1226
1226
|
"additionalProperties": false,
|
|
1227
|
-
"description": "Specification
|
|
1227
|
+
"description": "Specification uses label of another related instance as the label content.",
|
|
1228
1228
|
"properties": {
|
|
1229
1229
|
"pathToRelatedInstance": {
|
|
1230
1230
|
"anyOf": [
|
|
@@ -1238,7 +1238,7 @@
|
|
|
1238
1238
|
"type": "array"
|
|
1239
1239
|
}
|
|
1240
1240
|
],
|
|
1241
|
-
"description": "
|
|
1241
|
+
"description": "Specification of the relationship path from `InstanceLabelOverride.class`\nto class of the related instance."
|
|
1242
1242
|
},
|
|
1243
1243
|
"specType": {
|
|
1244
1244
|
"description": "Type of the specification",
|
|
@@ -1256,7 +1256,7 @@
|
|
|
1256
1256
|
},
|
|
1257
1257
|
"InstanceLabelOverrideStringValueSpecification": {
|
|
1258
1258
|
"additionalProperties": false,
|
|
1259
|
-
"description": "Specification
|
|
1259
|
+
"description": "Specification uses the specified value as the label content.",
|
|
1260
1260
|
"properties": {
|
|
1261
1261
|
"specType": {
|
|
1262
1262
|
"description": "Type of the specification",
|
|
@@ -1278,10 +1278,10 @@
|
|
|
1278
1278
|
},
|
|
1279
1279
|
"InstanceNodesOfSpecificClassesSpecification": {
|
|
1280
1280
|
"additionalProperties": false,
|
|
1281
|
-
"description": "
|
|
1281
|
+
"description": "Returns nodes for instances of specific ECClasses.",
|
|
1282
1282
|
"properties": {
|
|
1283
1283
|
"arePolymorphic": {
|
|
1284
|
-
"description": "
|
|
1284
|
+
"description": "Tells whether selecting instances from ECClasses specified in `classes` and `excludedClasses`\nattributes should be polymorphic or not.",
|
|
1285
1285
|
"type": "boolean"
|
|
1286
1286
|
},
|
|
1287
1287
|
"classes": {
|
|
@@ -1296,10 +1296,10 @@
|
|
|
1296
1296
|
"type": "array"
|
|
1297
1297
|
}
|
|
1298
1298
|
],
|
|
1299
|
-
"description": "
|
|
1299
|
+
"description": "Defines a set of multi schema classes that\nspecify which ECClasses need to be selected to form the result."
|
|
1300
1300
|
},
|
|
1301
1301
|
"doNotSort": {
|
|
1302
|
-
"description": "
|
|
1302
|
+
"description": "Suppress sorting of nodes returned by this specification. With this attribute set to `true`, the order\nof returned nodes is undefined.",
|
|
1303
1303
|
"type": "boolean"
|
|
1304
1304
|
},
|
|
1305
1305
|
"excludedClasses": {
|
|
@@ -1314,18 +1314,18 @@
|
|
|
1314
1314
|
"type": "array"
|
|
1315
1315
|
}
|
|
1316
1316
|
],
|
|
1317
|
-
"description": "
|
|
1317
|
+
"description": "Defines a set of multi schema classes that\nprevents specified ECClasses and subclasses from being selected by `classes` attribute."
|
|
1318
1318
|
},
|
|
1319
1319
|
"groupByClass": {
|
|
1320
|
-
"description": "
|
|
1320
|
+
"description": "Controls whether returned instances should be grouped by ECClass. Defaults to `true`.",
|
|
1321
1321
|
"type": "boolean"
|
|
1322
1322
|
},
|
|
1323
1323
|
"groupByLabel": {
|
|
1324
|
-
"description": "
|
|
1324
|
+
"description": "Controls whether returned instances should be grouped by label. Defaults to `true`.",
|
|
1325
1325
|
"type": "boolean"
|
|
1326
1326
|
},
|
|
1327
1327
|
"hasChildren": {
|
|
1328
|
-
"description": "This
|
|
1328
|
+
"description": "This attribute allows telling the engine that nodes created by this specification always or never have children.",
|
|
1329
1329
|
"enum": [
|
|
1330
1330
|
"Always",
|
|
1331
1331
|
"Never",
|
|
@@ -1334,34 +1334,34 @@
|
|
|
1334
1334
|
"type": "string"
|
|
1335
1335
|
},
|
|
1336
1336
|
"hideExpression": {
|
|
1337
|
-
"description": "
|
|
1337
|
+
"description": "When specified ECExpression evaluates\nto `true`, nodes produced by this specification are omitted and their children appear one hierarchy level\nhigher.",
|
|
1338
1338
|
"type": "string"
|
|
1339
1339
|
},
|
|
1340
1340
|
"hideIfNoChildren": {
|
|
1341
|
-
"description": "
|
|
1341
|
+
"description": "Specifies whether nodes created through this specification should be hidden if they have no child nodes.",
|
|
1342
1342
|
"type": "boolean"
|
|
1343
1343
|
},
|
|
1344
1344
|
"hideNodesInHierarchy": {
|
|
1345
|
-
"description": "
|
|
1345
|
+
"description": "When `true`, instances nodes produced by this specification are omitted and their children appear one\nhierarchy level higher.",
|
|
1346
1346
|
"type": "boolean"
|
|
1347
1347
|
},
|
|
1348
1348
|
"instanceFilter": {
|
|
1349
|
-
"description": "
|
|
1349
|
+
"description": "Specifies an ECExpression for filtering\ninstances of ECClasses specified through the `classes` attribute.",
|
|
1350
1350
|
"type": "string"
|
|
1351
1351
|
},
|
|
1352
1352
|
"nestedRules": {
|
|
1353
|
-
"description": "
|
|
1353
|
+
"description": "Specifications of nested child node rules that\nallow creating child nodes without the need of supplying a condition to match the parent node.",
|
|
1354
1354
|
"items": {
|
|
1355
1355
|
"$ref": "#/definitions/ChildNodeRule"
|
|
1356
1356
|
},
|
|
1357
1357
|
"type": "array"
|
|
1358
1358
|
},
|
|
1359
1359
|
"priority": {
|
|
1360
|
-
"description": "
|
|
1360
|
+
"description": "Controls the order in which specifications are handled — specification with higher priority value is\nhandled first. If priorities are equal, the specifications are handled in the order they appear in the\nruleset.",
|
|
1361
1361
|
"type": "integer"
|
|
1362
1362
|
},
|
|
1363
1363
|
"relatedInstances": {
|
|
1364
|
-
"description": "Specifications of related instances that can be used
|
|
1364
|
+
"description": "Specifications of related instances that can be used\nwhen creating the nodes.",
|
|
1365
1365
|
"items": {
|
|
1366
1366
|
"$ref": "#/definitions/RelatedInstanceSpecification"
|
|
1367
1367
|
},
|
|
@@ -1375,7 +1375,7 @@
|
|
|
1375
1375
|
"type": "string"
|
|
1376
1376
|
},
|
|
1377
1377
|
"suppressSimilarAncestorsCheck": {
|
|
1378
|
-
"description": "
|
|
1378
|
+
"description": "Specifies whether similar ancestor nodes' checking should be suppressed when creating nodes based on this\nspecification. See more in infinite hierarchies prevention page.",
|
|
1379
1379
|
"type": "boolean"
|
|
1380
1380
|
}
|
|
1381
1381
|
},
|
|
@@ -1387,32 +1387,32 @@
|
|
|
1387
1387
|
},
|
|
1388
1388
|
"LabelOverride": {
|
|
1389
1389
|
"additionalProperties": false,
|
|
1390
|
-
"description": "
|
|
1390
|
+
"description": "Label override rules provide advanced ways to override instance labels and descriptions in\nexchange of some performance penalty.",
|
|
1391
1391
|
"properties": {
|
|
1392
1392
|
"condition": {
|
|
1393
1393
|
"description": "Defines a condition for the rule, which needs to be met in order to execute it. Condition\nis an ECExpression, which can use\na limited set of symbols.",
|
|
1394
1394
|
"type": "string"
|
|
1395
1395
|
},
|
|
1396
1396
|
"description": {
|
|
1397
|
-
"description": "
|
|
1397
|
+
"description": "An expression whose result becomes the description. This is\nan ECExpression, so\ndescription can be defined/formatted dynamically based on the context - for example\nECInstance property value. May be localized.",
|
|
1398
1398
|
"minLength": 1,
|
|
1399
1399
|
"type": "string"
|
|
1400
1400
|
},
|
|
1401
1401
|
"label": {
|
|
1402
|
-
"description": "
|
|
1402
|
+
"description": "An expression whose result becomes the label. This is\nan ECExpression, so label\ncan be defined/formatted dynamically based on the context - for example\nECInstance property value. May be localized.",
|
|
1403
1403
|
"minLength": 1,
|
|
1404
1404
|
"type": "string"
|
|
1405
1405
|
},
|
|
1406
1406
|
"onlyIfNotHandled": {
|
|
1407
|
-
"description": "
|
|
1407
|
+
"description": "Tells the library that the rule should only be handled if no other rule of the same type was handled previously (based on rule\npriorities and definition order). This allows adding fallback rules which can be overriden by higher-priority rules.",
|
|
1408
1408
|
"type": "boolean"
|
|
1409
1409
|
},
|
|
1410
1410
|
"priority": {
|
|
1411
|
-
"description": "Defines the order in which
|
|
1411
|
+
"description": "Defines the order in which rules are handled, higher number means the rule is handled first. If priorities are\nequal, the rules are handled in the order they're defined.",
|
|
1412
1412
|
"type": "integer"
|
|
1413
1413
|
},
|
|
1414
1414
|
"requiredSchemas": {
|
|
1415
|
-
"description": "
|
|
1415
|
+
"description": "A list of ECSchema requirements that need to be met for the rule to be used.",
|
|
1416
1416
|
"items": {
|
|
1417
1417
|
"$ref": "#/definitions/RequiredSchemaSpecification"
|
|
1418
1418
|
},
|
|
@@ -1433,21 +1433,21 @@
|
|
|
1433
1433
|
},
|
|
1434
1434
|
"MultiSchemaClassesSpecification": {
|
|
1435
1435
|
"additionalProperties": false,
|
|
1436
|
-
"description": "
|
|
1436
|
+
"description": "This specification lists ECClasses which should be targeted when creating content or hierarchy nodes.",
|
|
1437
1437
|
"properties": {
|
|
1438
1438
|
"arePolymorphic": {
|
|
1439
|
-
"description": "
|
|
1439
|
+
"description": "Defines whether the derived ECClasses should be included in the result.",
|
|
1440
1440
|
"type": "boolean"
|
|
1441
1441
|
},
|
|
1442
1442
|
"classNames": {
|
|
1443
|
-
"description": "
|
|
1443
|
+
"description": "An array of target ECClass names.",
|
|
1444
1444
|
"items": {
|
|
1445
1445
|
"type": "string"
|
|
1446
1446
|
},
|
|
1447
1447
|
"type": "array"
|
|
1448
1448
|
},
|
|
1449
1449
|
"schemaName": {
|
|
1450
|
-
"description": "
|
|
1450
|
+
"description": "Specifies the schema which contains the target classes.",
|
|
1451
1451
|
"pattern": "^[\\w\\d]+$",
|
|
1452
1452
|
"type": "string"
|
|
1453
1453
|
}
|
|
@@ -1477,29 +1477,29 @@
|
|
|
1477
1477
|
},
|
|
1478
1478
|
"NodeArtifactsRule": {
|
|
1479
1479
|
"additionalProperties": false,
|
|
1480
|
-
"description": "
|
|
1480
|
+
"description": "Node artifacts rules are used to create and assign artifacts to specific nodes. The artifacts can be\naccessed when evaluating parent node's `hideExpression` to decide whether it should be hidden or not.",
|
|
1481
1481
|
"properties": {
|
|
1482
1482
|
"condition": {
|
|
1483
|
-
"description": "
|
|
1483
|
+
"description": "Specifies an ECExpression that\nallows applying node artifacts based on evaluation result, e.g. by some property of the parent node.",
|
|
1484
1484
|
"type": "string"
|
|
1485
1485
|
},
|
|
1486
1486
|
"items": {
|
|
1487
1487
|
"additionalProperties": {
|
|
1488
1488
|
"type": "string"
|
|
1489
1489
|
},
|
|
1490
|
-
"description": "A map of
|
|
1490
|
+
"description": "A map of ECExpressions whose evaluation results\nare used as artifact values.",
|
|
1491
1491
|
"type": "object"
|
|
1492
1492
|
},
|
|
1493
1493
|
"onlyIfNotHandled": {
|
|
1494
|
-
"description": "
|
|
1494
|
+
"description": "Tells the library that the rule should only be handled if no other rule of the same type was handled previously (based on rule\npriorities and definition order). This allows adding fallback rules which can be overriden by higher-priority rules.",
|
|
1495
1495
|
"type": "boolean"
|
|
1496
1496
|
},
|
|
1497
1497
|
"priority": {
|
|
1498
|
-
"description": "Defines the order in which
|
|
1498
|
+
"description": "Defines the order in which rules are handled, higher number means the rule is handled first. If priorities are\nequal, the rules are handled in the order they're defined.",
|
|
1499
1499
|
"type": "integer"
|
|
1500
1500
|
},
|
|
1501
1501
|
"requiredSchemas": {
|
|
1502
|
-
"description": "
|
|
1502
|
+
"description": "A list of ECSchema requirements that need to be met for the rule to be used.",
|
|
1503
1503
|
"items": {
|
|
1504
1504
|
"$ref": "#/definitions/RequiredSchemaSpecification"
|
|
1505
1505
|
},
|
|
@@ -1538,18 +1538,18 @@
|
|
|
1538
1538
|
},
|
|
1539
1539
|
"PropertyCategorySpecification": {
|
|
1540
1540
|
"additionalProperties": false,
|
|
1541
|
-
"description": "
|
|
1541
|
+
"description": "Content modifier for defining custom property categories. Custom categories are not present in the result unless\nthey contain at least one property. One way to assign a property to the category is by using\nproperty overrides.",
|
|
1542
1542
|
"properties": {
|
|
1543
1543
|
"autoExpand": {
|
|
1544
|
-
"description": "
|
|
1544
|
+
"description": "Controls the value of `CategoryDescription.expand` which tells the UI component\ndisplaying the category to auto-expand the category.",
|
|
1545
1545
|
"type": "boolean"
|
|
1546
1546
|
},
|
|
1547
1547
|
"description": {
|
|
1548
|
-
"description": "
|
|
1548
|
+
"description": "Extensive description of the category. The description is assigned to the category object that's set\non content fields and it's up to UI component to decide how the description is displayed.",
|
|
1549
1549
|
"type": "string"
|
|
1550
1550
|
},
|
|
1551
1551
|
"id": {
|
|
1552
|
-
"description": "Category identifier
|
|
1552
|
+
"description": "Category identifier used to reference the category definition from property overrides or other category\ndefinitions. The identifier has to be unique within the list of category definitions where this\nspecification is used.",
|
|
1553
1553
|
"type": "string"
|
|
1554
1554
|
},
|
|
1555
1555
|
"label": {
|
|
@@ -1574,15 +1574,15 @@
|
|
|
1574
1574
|
"type": "string"
|
|
1575
1575
|
}
|
|
1576
1576
|
],
|
|
1577
|
-
"description": "Identifier of a parent category. When
|
|
1577
|
+
"description": "Identifier of a parent category. When specifying the parent category by ID, it has to be available in\nthe scope of this category definition."
|
|
1578
1578
|
},
|
|
1579
1579
|
"priority": {
|
|
1580
|
-
"description": "
|
|
1580
|
+
"description": "Assign a custom `CategoryDescription.priority` to the category. It's up to the\nUI component to make sure that priority is respected - categories with higher priority should appear\nbefore or above categories with lower priority.",
|
|
1581
1581
|
"type": "integer"
|
|
1582
1582
|
},
|
|
1583
1583
|
"renderer": {
|
|
1584
1584
|
"$ref": "#/definitions/CustomRendererSpecification",
|
|
1585
|
-
"description": "Custom category renderer specification."
|
|
1585
|
+
"description": "Custom category renderer specification that allows\nassigning a custom category renderer to be used in UI. This specification is used to set up\n`CategoryDescription.renderer` for this category and it's up to the UI component to\nmake sure appropriate renderer is used to render the category."
|
|
1586
1586
|
}
|
|
1587
1587
|
},
|
|
1588
1588
|
"required": [
|
|
@@ -1697,14 +1697,14 @@
|
|
|
1697
1697
|
},
|
|
1698
1698
|
"PropertyEditorSpecification": {
|
|
1699
1699
|
"additionalProperties": false,
|
|
1700
|
-
"description": "
|
|
1700
|
+
"description": "This specification allows assigning a custom property editor to specific properties.",
|
|
1701
1701
|
"properties": {
|
|
1702
1702
|
"editorName": {
|
|
1703
|
-
"description": "Name of the
|
|
1703
|
+
"description": "Name of the property editor that's going to be used in UI components. This name is carried over to\n`Field.editor` and it's up to the UI component to make sure appropriate editor\nis used to edit the property.",
|
|
1704
1704
|
"type": "string"
|
|
1705
1705
|
},
|
|
1706
1706
|
"parameters": {
|
|
1707
|
-
"description": "Parameters for the editor",
|
|
1707
|
+
"description": "Parameters for the editor.",
|
|
1708
1708
|
"items": {
|
|
1709
1709
|
"anyOf": [
|
|
1710
1710
|
{
|
|
@@ -1731,18 +1731,18 @@
|
|
|
1731
1731
|
},
|
|
1732
1732
|
"PropertyGroup": {
|
|
1733
1733
|
"additionalProperties": false,
|
|
1734
|
-
"description": "
|
|
1734
|
+
"description": "Property grouping allows grouping by a property of the instance by value or by given ranges of values.",
|
|
1735
1735
|
"properties": {
|
|
1736
1736
|
"createGroupForSingleItem": {
|
|
1737
|
-
"description": "
|
|
1737
|
+
"description": "Specifies whether a grouping node should be created if there is only one item in that group.",
|
|
1738
1738
|
"type": "boolean"
|
|
1739
1739
|
},
|
|
1740
1740
|
"createGroupForUnspecifiedValues": {
|
|
1741
|
-
"description": "Should a separate grouping node be created for nodes whose grouping value is not
|
|
1741
|
+
"description": "Should a separate grouping node be created for nodes whose grouping value is not set or is set to an empty string.",
|
|
1742
1742
|
"type": "boolean"
|
|
1743
1743
|
},
|
|
1744
1744
|
"groupingValue": {
|
|
1745
|
-
"description": "
|
|
1745
|
+
"description": "Specifies whether instances should be grouped using property's display or raw value.",
|
|
1746
1746
|
"enum": [
|
|
1747
1747
|
"DisplayLabel",
|
|
1748
1748
|
"PropertyValue"
|
|
@@ -1750,24 +1750,24 @@
|
|
|
1750
1750
|
"type": "string"
|
|
1751
1751
|
},
|
|
1752
1752
|
"imageId": {
|
|
1753
|
-
"description": "
|
|
1753
|
+
"description": "Specifies grouping node's image ID. If set, the ID is assigned to `Node.imageId` and\nit's up to the UI component to decide what to do with it.",
|
|
1754
1754
|
"minLength": 1,
|
|
1755
1755
|
"type": "string"
|
|
1756
1756
|
},
|
|
1757
1757
|
"propertyName": {
|
|
1758
|
-
"description": "Name of the ECProperty which is used for grouping.",
|
|
1758
|
+
"description": "Name of the ECProperty which is used for grouping. The property must exist on the ECClass specified by the\nrule's `class` attribute and it must be of either a primitive or a navigation type.",
|
|
1759
1759
|
"minLength": 1,
|
|
1760
1760
|
"type": "string"
|
|
1761
1761
|
},
|
|
1762
1762
|
"ranges": {
|
|
1763
|
-
"description": "Ranges into which the grouping values are divided",
|
|
1763
|
+
"description": "Ranges into which the grouping values are divided. Instances are grouped by value if no ranges are specified.",
|
|
1764
1764
|
"items": {
|
|
1765
1765
|
"$ref": "#/definitions/PropertyRangeGroupSpecification"
|
|
1766
1766
|
},
|
|
1767
1767
|
"type": "array"
|
|
1768
1768
|
},
|
|
1769
1769
|
"sortingValue": {
|
|
1770
|
-
"description": "
|
|
1770
|
+
"description": "Specifies whether nodes should be sorted by their display label or the grouping property's value. In most cases the result\nis the same, unless a label override rule is used to change node's display label.",
|
|
1771
1771
|
"enum": [
|
|
1772
1772
|
"DisplayLabel",
|
|
1773
1773
|
"PropertyValue"
|
|
@@ -1790,10 +1790,10 @@
|
|
|
1790
1790
|
},
|
|
1791
1791
|
"PropertyRangeGroupSpecification": {
|
|
1792
1792
|
"additionalProperties": false,
|
|
1793
|
-
"description": "Describes a grouping range",
|
|
1793
|
+
"description": "Describes a grouping range.",
|
|
1794
1794
|
"properties": {
|
|
1795
1795
|
"fromValue": {
|
|
1796
|
-
"description": "Value that defines the range start (inclusive)",
|
|
1796
|
+
"description": "Value that defines the range start (inclusive).",
|
|
1797
1797
|
"minLength": 1,
|
|
1798
1798
|
"type": "string"
|
|
1799
1799
|
},
|
|
@@ -1803,12 +1803,12 @@
|
|
|
1803
1803
|
"type": "string"
|
|
1804
1804
|
},
|
|
1805
1805
|
"label": {
|
|
1806
|
-
"description": "Grouping node label. May be localized.\nDefaults to `{from value} - {to value}
|
|
1806
|
+
"description": "Grouping node label. May be localized.\nDefaults to `{from value} - {to value}`.",
|
|
1807
1807
|
"minLength": 1,
|
|
1808
1808
|
"type": "string"
|
|
1809
1809
|
},
|
|
1810
1810
|
"toValue": {
|
|
1811
|
-
"description": "Value that defines the range end (inclusive)",
|
|
1811
|
+
"description": "Value that defines the range end (inclusive).",
|
|
1812
1812
|
"minLength": 1,
|
|
1813
1813
|
"type": "string"
|
|
1814
1814
|
}
|
|
@@ -1821,35 +1821,35 @@
|
|
|
1821
1821
|
},
|
|
1822
1822
|
"PropertySortingRule": {
|
|
1823
1823
|
"additionalProperties": false,
|
|
1824
|
-
"description": "Rule to configure sorting for certain ECInstances in the hierarchy and/or content
|
|
1824
|
+
"description": "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.",
|
|
1825
1825
|
"properties": {
|
|
1826
1826
|
"class": {
|
|
1827
1827
|
"$ref": "#/definitions/SingleSchemaClassSpecification",
|
|
1828
|
-
"description": "
|
|
1828
|
+
"description": "Specifies ECClass whose ECInstances should be sorted."
|
|
1829
1829
|
},
|
|
1830
1830
|
"condition": {
|
|
1831
|
-
"description": "Defines a condition
|
|
1831
|
+
"description": "Defines a condition which needs to be met in order for the rule to be used. The condition is an\nECExpression which has to\nevaluate to a boolean value.",
|
|
1832
1832
|
"type": "string"
|
|
1833
1833
|
},
|
|
1834
1834
|
"isPolymorphic": {
|
|
1835
|
-
"description": "
|
|
1835
|
+
"description": "Specifies that `class` attribute defined in this rule should be handled polymorphically.",
|
|
1836
1836
|
"type": "boolean"
|
|
1837
1837
|
},
|
|
1838
1838
|
"onlyIfNotHandled": {
|
|
1839
|
-
"description": "
|
|
1839
|
+
"description": "Tells the library that the rule should only be handled if no other rule of the same type was handled previously (based on rule\npriorities and definition order). This allows adding fallback rules which can be overriden by higher-priority rules.",
|
|
1840
1840
|
"type": "boolean"
|
|
1841
1841
|
},
|
|
1842
1842
|
"priority": {
|
|
1843
|
-
"description": "Defines the order in which
|
|
1843
|
+
"description": "Defines the order in which rules are handled, higher number means the rule is handled first. If priorities are\nequal, the rules are handled in the order they're defined.",
|
|
1844
1844
|
"type": "integer"
|
|
1845
1845
|
},
|
|
1846
1846
|
"propertyName": {
|
|
1847
|
-
"description": "
|
|
1847
|
+
"description": "Specifies name of the property which should be used for sorting.",
|
|
1848
1848
|
"minLength": 1,
|
|
1849
1849
|
"type": "string"
|
|
1850
1850
|
},
|
|
1851
1851
|
"requiredSchemas": {
|
|
1852
|
-
"description": "
|
|
1852
|
+
"description": "A list of ECSchema requirements that need to be met for the rule to be used.",
|
|
1853
1853
|
"items": {
|
|
1854
1854
|
"$ref": "#/definitions/RequiredSchemaSpecification"
|
|
1855
1855
|
},
|
|
@@ -1863,7 +1863,7 @@
|
|
|
1863
1863
|
"type": "string"
|
|
1864
1864
|
},
|
|
1865
1865
|
"sortAscending": {
|
|
1866
|
-
"description": "
|
|
1866
|
+
"description": "Specifies whether instances should be sorted in ascending order or descending.",
|
|
1867
1867
|
"type": "boolean"
|
|
1868
1868
|
}
|
|
1869
1869
|
},
|
|
@@ -1875,7 +1875,7 @@
|
|
|
1875
1875
|
},
|
|
1876
1876
|
"PropertySpecification": {
|
|
1877
1877
|
"additionalProperties": false,
|
|
1878
|
-
"description": "
|
|
1878
|
+
"description": "This specification allows overriding some attributes of specific ECProperty or define how it's displayed.",
|
|
1879
1879
|
"properties": {
|
|
1880
1880
|
"categoryId": {
|
|
1881
1881
|
"anyOf": [
|
|
@@ -1892,35 +1892,46 @@
|
|
|
1892
1892
|
"type": "string"
|
|
1893
1893
|
}
|
|
1894
1894
|
],
|
|
1895
|
-
"description": "
|
|
1895
|
+
"description": "The attribute allows moving the property into a different category."
|
|
1896
1896
|
},
|
|
1897
1897
|
"doNotHideOtherPropertiesOnDisplayOverride": {
|
|
1898
|
-
"description": "
|
|
1898
|
+
"description": "This attribute controls whether making the property visible using `isDisplayed` attribute should automatically hide\nall other properties of the same class. When `true`, this behavior is disabled.",
|
|
1899
1899
|
"type": "boolean"
|
|
1900
1900
|
},
|
|
1901
1901
|
"editor": {
|
|
1902
1902
|
"$ref": "#/definitions/PropertyEditorSpecification",
|
|
1903
|
-
"description": "Custom property editor specification."
|
|
1903
|
+
"description": "Custom property editor specification that allows assigning\na custom value editor to be used in UI."
|
|
1904
1904
|
},
|
|
1905
1905
|
"isDisplayed": {
|
|
1906
|
-
"description": "
|
|
1906
|
+
"description": "This attribute controls whether the particular property is present in the result, even when it is marked as hidden in the\nECSchema. The allowed settings are:\n\n- Omitted or `undefined`: property visibility is controlled by the ECSchema.\n\n- `true`: property is made visible. Warning: this will automatically hide all other properties of the same class.\n If this behavior is not desirable, set `doNotHideOtherPropertiesOnDisplayOverride` attribute to `true`.\n\n- `false`: property is made hidden.\n\nThe value can also be set using an ECExpression.",
|
|
1907
|
+
"type": [
|
|
1908
|
+
"string",
|
|
1909
|
+
"boolean"
|
|
1910
|
+
]
|
|
1911
|
+
},
|
|
1912
|
+
"isReadOnly": {
|
|
1913
|
+
"description": "This attribute controls whether the property field is read-only. If the attribute value is not set, the field is\nread-only when at least one of the properties is read-only.",
|
|
1907
1914
|
"type": "boolean"
|
|
1908
1915
|
},
|
|
1909
1916
|
"labelOverride": {
|
|
1910
|
-
"description": "
|
|
1917
|
+
"description": "This is an attribute that allows overriding the property label. May be localized.",
|
|
1911
1918
|
"type": "string"
|
|
1912
1919
|
},
|
|
1913
1920
|
"name": {
|
|
1914
|
-
"description": "Name of the ECProperty
|
|
1921
|
+
"description": "Name of the ECProperty to apply overrides to. A `\"*\"` may be specified to match all properties in current context.\nThe current context is determined based on where the override is specified:\n\n- When used in a content modifier, the\n properties of the ECClass specified by the `class` attribute are used.\n\n- When used in one of the content specifications,\n properties produced by that specification are used.",
|
|
1915
1922
|
"type": "string"
|
|
1916
1923
|
},
|
|
1917
1924
|
"overridesPriority": {
|
|
1918
|
-
"description": "
|
|
1925
|
+
"description": "There may be multiple property specifications that apply to a single property and there may be conflicts between\ndifferent attributes. The `overridesPriority` attribute is here to help solve the problem - if multiple specifications\nattempt to override the same attribute, the override of specification with highest `overridesPriority` value is used.\nThe order of overrides from specification with the same `overridesPriority` is defined by the order they appear in\nthe overrides list.",
|
|
1926
|
+
"type": "number"
|
|
1927
|
+
},
|
|
1928
|
+
"priority": {
|
|
1929
|
+
"description": "This attribute controls the order in which property fields should be displayed. Property fields with higher priority\nwill appear before property fields with lower priority. If the attribute value is not set, the field's priority\nwill be the maximum priority of its properties.",
|
|
1919
1930
|
"type": "number"
|
|
1920
1931
|
},
|
|
1921
1932
|
"renderer": {
|
|
1922
1933
|
"$ref": "#/definitions/CustomRendererSpecification",
|
|
1923
|
-
"description": "Custom property renderer specification."
|
|
1934
|
+
"description": "Custom property renderer specification that allows assigning a\ncustom value renderer to be used in UI. The specification is used to set up `Field.renderer` for\nthis property and it's up to the UI component to make sure appropriate renderer is used to render the property."
|
|
1924
1935
|
}
|
|
1925
1936
|
},
|
|
1926
1937
|
"required": [
|
|
@@ -1930,22 +1941,22 @@
|
|
|
1930
1941
|
},
|
|
1931
1942
|
"RelatedInstanceNodesSpecification": {
|
|
1932
1943
|
"additionalProperties": false,
|
|
1933
|
-
"description": "
|
|
1944
|
+
"description": "Produces ECInstance nodes that are related to some source ECInstance. The source instance is determined\nby traversing the hierarchy upwards until an ECInstance node is encountered.",
|
|
1934
1945
|
"properties": {
|
|
1935
1946
|
"doNotSort": {
|
|
1936
|
-
"description": "
|
|
1947
|
+
"description": "Suppress sorting of nodes returned by this specification. With this attribute set to `true`, the order\nof returned nodes is undefined.",
|
|
1937
1948
|
"type": "boolean"
|
|
1938
1949
|
},
|
|
1939
1950
|
"groupByClass": {
|
|
1940
|
-
"description": "
|
|
1951
|
+
"description": "Controls whether returned instances should be grouped by ECClass. Defaults to `true`.",
|
|
1941
1952
|
"type": "boolean"
|
|
1942
1953
|
},
|
|
1943
1954
|
"groupByLabel": {
|
|
1944
|
-
"description": "
|
|
1955
|
+
"description": "Controls whether returned instances should be grouped by label. Defaults to `true`.",
|
|
1945
1956
|
"type": "boolean"
|
|
1946
1957
|
},
|
|
1947
1958
|
"hasChildren": {
|
|
1948
|
-
"description": "This
|
|
1959
|
+
"description": "This attribute allows telling the engine that nodes created by this specification always or never have children.",
|
|
1949
1960
|
"enum": [
|
|
1950
1961
|
"Always",
|
|
1951
1962
|
"Never",
|
|
@@ -1954,41 +1965,41 @@
|
|
|
1954
1965
|
"type": "string"
|
|
1955
1966
|
},
|
|
1956
1967
|
"hideExpression": {
|
|
1957
|
-
"description": "
|
|
1968
|
+
"description": "When specified ECExpression evaluates\nto `true`, nodes produced by this specification are omitted and their children appear one hierarchy level\nhigher.",
|
|
1958
1969
|
"type": "string"
|
|
1959
1970
|
},
|
|
1960
1971
|
"hideIfNoChildren": {
|
|
1961
|
-
"description": "
|
|
1972
|
+
"description": "Specifies whether nodes created through this specification should be hidden if they have no child nodes.",
|
|
1962
1973
|
"type": "boolean"
|
|
1963
1974
|
},
|
|
1964
1975
|
"hideNodesInHierarchy": {
|
|
1965
|
-
"description": "
|
|
1976
|
+
"description": "When `true`, instances nodes produced by this specification are omitted and their children appear one\nhierarchy level higher.",
|
|
1966
1977
|
"type": "boolean"
|
|
1967
1978
|
},
|
|
1968
1979
|
"instanceFilter": {
|
|
1969
|
-
"description": "
|
|
1980
|
+
"description": "Specifies an ECExpression for filtering\ninstances of ECClasses targeted through the `relationshipPaths` attribute.",
|
|
1970
1981
|
"type": "string"
|
|
1971
1982
|
},
|
|
1972
1983
|
"nestedRules": {
|
|
1973
|
-
"description": "
|
|
1984
|
+
"description": "Specifications of nested child node rules that\nallow creating child nodes without the need of supplying a condition to match the parent node.",
|
|
1974
1985
|
"items": {
|
|
1975
1986
|
"$ref": "#/definitions/ChildNodeRule"
|
|
1976
1987
|
},
|
|
1977
1988
|
"type": "array"
|
|
1978
1989
|
},
|
|
1979
1990
|
"priority": {
|
|
1980
|
-
"description": "
|
|
1991
|
+
"description": "Controls the order in which specifications are handled — specification with higher priority value is\nhandled first. If priorities are equal, the specifications are handled in the order they appear in the\nruleset.",
|
|
1981
1992
|
"type": "integer"
|
|
1982
1993
|
},
|
|
1983
1994
|
"relatedInstances": {
|
|
1984
|
-
"description": "Specifications of related instances that can be used
|
|
1995
|
+
"description": "Specifications of related instances that can be used\nwhen creating the nodes.",
|
|
1985
1996
|
"items": {
|
|
1986
1997
|
"$ref": "#/definitions/RelatedInstanceSpecification"
|
|
1987
1998
|
},
|
|
1988
1999
|
"type": "array"
|
|
1989
2000
|
},
|
|
1990
2001
|
"relationshipPaths": {
|
|
1991
|
-
"description": "
|
|
2002
|
+
"description": "Specifies a chain of relationship path specifications\nthat forms a path from a source instance to the output instances. When this array is empty, the specification produces\nno results.",
|
|
1992
2003
|
"items": {
|
|
1993
2004
|
"anyOf": [
|
|
1994
2005
|
{
|
|
@@ -2012,7 +2023,7 @@
|
|
|
2012
2023
|
"type": "string"
|
|
2013
2024
|
},
|
|
2014
2025
|
"suppressSimilarAncestorsCheck": {
|
|
2015
|
-
"description": "
|
|
2026
|
+
"description": "Specifies whether similar ancestor nodes' checking should be suppressed when creating nodes based on this\nspecification. See more in infinite hierarchies prevention page.",
|
|
2016
2027
|
"type": "boolean"
|
|
2017
2028
|
}
|
|
2018
2029
|
},
|
|
@@ -2024,15 +2035,15 @@
|
|
|
2024
2035
|
},
|
|
2025
2036
|
"RelatedInstanceSpecification": {
|
|
2026
2037
|
"additionalProperties": false,
|
|
2027
|
-
"description": "
|
|
2038
|
+
"description": "Related instance specification is used in content\nand hierarchy specifications to \"join\" the\nprimary instance with its related instance and allow using the related instance for filtering, customization and grouping.",
|
|
2028
2039
|
"properties": {
|
|
2029
2040
|
"alias": {
|
|
2030
|
-
"description": "
|
|
2041
|
+
"description": "Specifies an an alias that given to the related instance. The alias can be used to reference the\ninstance in instance filter and customization rules.",
|
|
2031
2042
|
"pattern": "^\\w[\\w\\d]*$",
|
|
2032
2043
|
"type": "string"
|
|
2033
2044
|
},
|
|
2034
2045
|
"isRequired": {
|
|
2035
|
-
"description": "
|
|
2046
|
+
"description": "Specifies whether to omit the primary instance from the result if the other end of `relationshipPath`\ndoes not yield any related instances.",
|
|
2036
2047
|
"type": "boolean"
|
|
2037
2048
|
},
|
|
2038
2049
|
"relationshipPath": {
|
|
@@ -2047,7 +2058,7 @@
|
|
|
2047
2058
|
"type": "array"
|
|
2048
2059
|
}
|
|
2049
2060
|
],
|
|
2050
|
-
"description": "
|
|
2061
|
+
"description": "Specifies a chain of relationship path specifications\nthat forms a path from the primary instance to the related instances."
|
|
2051
2062
|
}
|
|
2052
2063
|
},
|
|
2053
2064
|
"required": [
|
|
@@ -2058,18 +2069,22 @@
|
|
|
2058
2069
|
},
|
|
2059
2070
|
"RelatedPropertiesSpecification": {
|
|
2060
2071
|
"additionalProperties": false,
|
|
2061
|
-
"description": "
|
|
2072
|
+
"description": "This specification allows including related instance properties into the content.",
|
|
2062
2073
|
"properties": {
|
|
2063
2074
|
"autoExpand": {
|
|
2064
|
-
"description": "Should field containing related properties be
|
|
2075
|
+
"description": "Should the field containing related properties be assigned the `NestedContentField.autoExpand`\nattribute. The attribute tells UI components showing the properties that they should be initially displayed in the expanded state.",
|
|
2065
2076
|
"type": "boolean"
|
|
2066
2077
|
},
|
|
2067
2078
|
"handleTargetClassPolymorphically": {
|
|
2068
|
-
"description": "
|
|
2079
|
+
"description": "The attribute tells whether the target class specified through `propertiesSource` should be handled\npolymorphically. This means properties of the concrete class are loaded in addition to properties of the\ntarget class itself.",
|
|
2069
2080
|
"type": "boolean"
|
|
2070
2081
|
},
|
|
2082
|
+
"instanceFilter": {
|
|
2083
|
+
"description": "Condition for filtering instances targeted by the `propertiesSource` attribute.\n\nSee: ECExpressions available in instance filter",
|
|
2084
|
+
"type": "string"
|
|
2085
|
+
},
|
|
2071
2086
|
"nestedRelatedProperties": {
|
|
2072
|
-
"description": "
|
|
2087
|
+
"description": "The attribute allows loading additional related properties that are related to the target instance of this specification.",
|
|
2073
2088
|
"items": {
|
|
2074
2089
|
"$ref": "#/definitions/RelatedPropertiesSpecification"
|
|
2075
2090
|
},
|
|
@@ -2098,7 +2113,7 @@
|
|
|
2098
2113
|
"type": "string"
|
|
2099
2114
|
}
|
|
2100
2115
|
],
|
|
2101
|
-
"description": "
|
|
2116
|
+
"description": "List of names or definitions of related class properties that should be included in the content."
|
|
2102
2117
|
},
|
|
2103
2118
|
"propertiesSource": {
|
|
2104
2119
|
"anyOf": [
|
|
@@ -2112,10 +2127,10 @@
|
|
|
2112
2127
|
"type": "array"
|
|
2113
2128
|
}
|
|
2114
2129
|
],
|
|
2115
|
-
"description": "
|
|
2130
|
+
"description": "Specifies a chain of relationship path specifications that\nforms a path from the content instance to the related instance(s) whose properties should additionally be loaded."
|
|
2116
2131
|
},
|
|
2117
2132
|
"relationshipMeaning": {
|
|
2118
|
-
"description": "
|
|
2133
|
+
"description": "The attribute describes what the related properties mean to the primary instance\nwhose properties are displayed.",
|
|
2119
2134
|
"enum": [
|
|
2120
2135
|
"RelatedInstance",
|
|
2121
2136
|
"SameInstance"
|
|
@@ -2123,7 +2138,7 @@
|
|
|
2123
2138
|
"type": "string"
|
|
2124
2139
|
},
|
|
2125
2140
|
"skipIfDuplicate": {
|
|
2126
|
-
"description": "
|
|
2141
|
+
"description": "Specifies whether the specification should be ignored if another higher priority specification for the same relationship already exists.",
|
|
2127
2142
|
"type": "boolean"
|
|
2128
2143
|
}
|
|
2129
2144
|
},
|
|
@@ -2134,10 +2149,10 @@
|
|
|
2134
2149
|
},
|
|
2135
2150
|
"RelationshipStepSpecification": {
|
|
2136
2151
|
"additionalProperties": false,
|
|
2137
|
-
"description": "Specification of a single
|
|
2152
|
+
"description": "Specification of a single step in `RelationshipPathSpecification`.",
|
|
2138
2153
|
"properties": {
|
|
2139
2154
|
"direction": {
|
|
2140
|
-
"description": "
|
|
2155
|
+
"description": "This attribute specifies the direction in which the `relationship` should be followed.",
|
|
2141
2156
|
"enum": [
|
|
2142
2157
|
"Backward",
|
|
2143
2158
|
"Forward"
|
|
@@ -2146,11 +2161,11 @@
|
|
|
2146
2161
|
},
|
|
2147
2162
|
"relationship": {
|
|
2148
2163
|
"$ref": "#/definitions/SingleSchemaClassSpecification",
|
|
2149
|
-
"description": "
|
|
2164
|
+
"description": "This attribute specifies the ECRelationship that should be used to traverse to target class."
|
|
2150
2165
|
},
|
|
2151
2166
|
"targetClass": {
|
|
2152
2167
|
"$ref": "#/definitions/SingleSchemaClassSpecification",
|
|
2153
|
-
"description": "
|
|
2168
|
+
"description": "This attribute may be used to specialize the target of the relationship."
|
|
2154
2169
|
}
|
|
2155
2170
|
},
|
|
2156
2171
|
"required": [
|
|
@@ -2161,7 +2176,7 @@
|
|
|
2161
2176
|
},
|
|
2162
2177
|
"RepeatableRelationshipStepSpecification": {
|
|
2163
2178
|
"additionalProperties": false,
|
|
2164
|
-
"description": "Specification of a single
|
|
2179
|
+
"description": "Specification of a single step in `RepeatableRelationshipPathSpecification`.",
|
|
2165
2180
|
"properties": {
|
|
2166
2181
|
"count": {
|
|
2167
2182
|
"anyOf": [
|
|
@@ -2175,10 +2190,10 @@
|
|
|
2175
2190
|
"type": "number"
|
|
2176
2191
|
}
|
|
2177
2192
|
],
|
|
2178
|
-
"description": "
|
|
2193
|
+
"description": "When a number is specified, the relationship is traversed recursively the specified number of times.\n\nWhen it is set to a special value `\"*\"`, the same relationship is traversed recursively unbounded number\nof times, starting from zero (the relationship is not followed). On each traversal iteration, Presentation\nrules engine accumulates all indirectly related ECInstances as defined by the remaining relationship path."
|
|
2179
2194
|
},
|
|
2180
2195
|
"direction": {
|
|
2181
|
-
"description": "
|
|
2196
|
+
"description": "This attribute specifies the direction in which the `relationship` should be followed.",
|
|
2182
2197
|
"enum": [
|
|
2183
2198
|
"Backward",
|
|
2184
2199
|
"Forward"
|
|
@@ -2187,11 +2202,11 @@
|
|
|
2187
2202
|
},
|
|
2188
2203
|
"relationship": {
|
|
2189
2204
|
"$ref": "#/definitions/SingleSchemaClassSpecification",
|
|
2190
|
-
"description": "
|
|
2205
|
+
"description": "This attribute specifies the ECRelationship that should be used to traverse to target class."
|
|
2191
2206
|
},
|
|
2192
2207
|
"targetClass": {
|
|
2193
2208
|
"$ref": "#/definitions/SingleSchemaClassSpecification",
|
|
2194
|
-
"description": "
|
|
2209
|
+
"description": "This attribute may be used to specialize the target of the relationship."
|
|
2195
2210
|
}
|
|
2196
2211
|
},
|
|
2197
2212
|
"required": [
|
|
@@ -2202,7 +2217,7 @@
|
|
|
2202
2217
|
},
|
|
2203
2218
|
"RequiredSchemaSpecification": {
|
|
2204
2219
|
"additionalProperties": false,
|
|
2205
|
-
"description": "
|
|
2220
|
+
"description": "This specification is designed for specifying schema requirements for the `Ruleset` or specific\npresentation rules.",
|
|
2206
2221
|
"properties": {
|
|
2207
2222
|
"maxVersion": {
|
|
2208
2223
|
"description": "Maximum allowed schema version (exclusive).\nFormat: `{read version}.{write version}.{minor version}`, e.g. `2.1.15`.",
|
|
@@ -2215,7 +2230,7 @@
|
|
|
2215
2230
|
"type": "string"
|
|
2216
2231
|
},
|
|
2217
2232
|
"name": {
|
|
2218
|
-
"description": "
|
|
2233
|
+
"description": "Specifies the schema to whom the requirement is being set.",
|
|
2219
2234
|
"type": "string"
|
|
2220
2235
|
}
|
|
2221
2236
|
},
|
|
@@ -2243,18 +2258,18 @@
|
|
|
2243
2258
|
},
|
|
2244
2259
|
"RootNodeRule": {
|
|
2245
2260
|
"additionalProperties": false,
|
|
2246
|
-
"description": "Root node rules define
|
|
2261
|
+
"description": "Root node rules are used to define nodes that are displayed at the root hierarchy level.",
|
|
2247
2262
|
"properties": {
|
|
2248
2263
|
"autoExpand": {
|
|
2249
|
-
"description": "
|
|
2264
|
+
"description": "Tells the library to assign produced nodes a flag, indicating that they should be automatically expanded.",
|
|
2250
2265
|
"type": "boolean"
|
|
2251
2266
|
},
|
|
2252
2267
|
"condition": {
|
|
2253
|
-
"description": "Defines a condition
|
|
2268
|
+
"description": "Defines a condition which needs to be met in order for the rule to be used. The condition is an\nECExpression which has to evaluate\nto a boolean value.",
|
|
2254
2269
|
"type": "string"
|
|
2255
2270
|
},
|
|
2256
2271
|
"customizationRules": {
|
|
2257
|
-
"description": "
|
|
2272
|
+
"description": "A list of customization rules that\napply only to nodes produced by this rule.",
|
|
2258
2273
|
"items": {
|
|
2259
2274
|
"anyOf": [
|
|
2260
2275
|
{
|
|
@@ -2292,15 +2307,15 @@
|
|
|
2292
2307
|
"type": "array"
|
|
2293
2308
|
},
|
|
2294
2309
|
"onlyIfNotHandled": {
|
|
2295
|
-
"description": "
|
|
2310
|
+
"description": "Tells the library that the rule should only be handled if no other rule of the same type was handled previously (based on rule\npriorities and definition order). This allows adding fallback rules which can be overriden by higher-priority rules.",
|
|
2296
2311
|
"type": "boolean"
|
|
2297
2312
|
},
|
|
2298
2313
|
"priority": {
|
|
2299
|
-
"description": "Defines the order in which
|
|
2314
|
+
"description": "Defines the order in which rules are handled, higher number means the rule is handled first. If priorities are\nequal, the rules are handled in the order they're defined.",
|
|
2300
2315
|
"type": "integer"
|
|
2301
2316
|
},
|
|
2302
2317
|
"requiredSchemas": {
|
|
2303
|
-
"description": "
|
|
2318
|
+
"description": "A list of ECSchema requirements that need to be met for the rule to be used.",
|
|
2304
2319
|
"items": {
|
|
2305
2320
|
"$ref": "#/definitions/RequiredSchemaSpecification"
|
|
2306
2321
|
},
|
|
@@ -2314,7 +2329,7 @@
|
|
|
2314
2329
|
"type": "string"
|
|
2315
2330
|
},
|
|
2316
2331
|
"specifications": {
|
|
2317
|
-
"description": "
|
|
2332
|
+
"description": "A list of hierarchy specifications that define what nodes are going to be returned.",
|
|
2318
2333
|
"items": {
|
|
2319
2334
|
"anyOf": [
|
|
2320
2335
|
{
|
|
@@ -2334,11 +2349,11 @@
|
|
|
2334
2349
|
"type": "array"
|
|
2335
2350
|
},
|
|
2336
2351
|
"stopFurtherProcessing": {
|
|
2337
|
-
"description": "Stop processing rules that have lower priority. Used in cases when recursion
|
|
2352
|
+
"description": "Stop processing rules that have lower priority. Used in cases when recursion suppression is needed.",
|
|
2338
2353
|
"type": "boolean"
|
|
2339
2354
|
},
|
|
2340
2355
|
"subConditions": {
|
|
2341
|
-
"description": "
|
|
2356
|
+
"description": "A list of sub-rules which share *placement attributes* and\nnested customization rules\nof the hierarchy rule. This means the attributes of hierarchy rule are still in effect and the sub-rules\ncan add additional condition of their own.",
|
|
2342
2357
|
"items": {
|
|
2343
2358
|
"$ref": "#/definitions/SubCondition"
|
|
2344
2359
|
},
|
|
@@ -2352,10 +2367,10 @@
|
|
|
2352
2367
|
},
|
|
2353
2368
|
"SameLabelInstanceGroup": {
|
|
2354
2369
|
"additionalProperties": false,
|
|
2355
|
-
"description": "Allows grouping multiple instances with the same label into one
|
|
2370
|
+
"description": "Allows grouping multiple instances with the same label into one ECInstances type of node. Similar to display label grouping,\nbut instead of showing a grouping node with multiple grouped ECInstance nodes, it shows a single ECInstances node which represents\nmultiple ECInstances.",
|
|
2356
2371
|
"properties": {
|
|
2357
2372
|
"applicationStage": {
|
|
2358
|
-
"description": "
|
|
2373
|
+
"description": "Grouping nodes by label is an expensive operation because it requires the whole hierarchy level to be created before even the first\ngrouped node can be produced. To alleviate the performance impact when this specification is used, two `applicationStage` settings have been introduced:\n\n- `\"Query\"` groups instances during ECSql query, which can often make use of database indices and is generally fairly quick. It is chosen\n as the default option, however, it fails to produce grouping nodes when certain ruleset specifications are involved.\n\n- `\"PostProcess\"` groups instances after the whole hierarchy level is built. It incurs a large performance penalty, but it will\n produce the expected result in all cases.",
|
|
2359
2374
|
"enum": [
|
|
2360
2375
|
"PostProcess",
|
|
2361
2376
|
"Query"
|
|
@@ -2377,69 +2392,69 @@
|
|
|
2377
2392
|
},
|
|
2378
2393
|
"SelectedNodeInstancesSpecification": {
|
|
2379
2394
|
"additionalProperties": false,
|
|
2380
|
-
"description": "
|
|
2395
|
+
"description": "Returns content for selected (input) instances.",
|
|
2381
2396
|
"properties": {
|
|
2382
2397
|
"acceptableClassNames": {
|
|
2383
|
-
"description": "
|
|
2398
|
+
"description": "Specifies a list of class names which the input instances have to match for the specification to be used.",
|
|
2384
2399
|
"items": {
|
|
2385
2400
|
"type": "string"
|
|
2386
2401
|
},
|
|
2387
2402
|
"type": "array"
|
|
2388
2403
|
},
|
|
2389
2404
|
"acceptablePolymorphically": {
|
|
2390
|
-
"description": "
|
|
2405
|
+
"description": "Specifies whether derived classes of `acceptableClassNames` should be included in the content.",
|
|
2391
2406
|
"type": "boolean"
|
|
2392
2407
|
},
|
|
2393
2408
|
"acceptableSchemaName": {
|
|
2394
|
-
"description": "
|
|
2409
|
+
"description": "Specifies ECSchema name which the input instances have to match for the specification to be used.",
|
|
2395
2410
|
"pattern": "^[\\w\\d]+$",
|
|
2396
2411
|
"type": "string"
|
|
2397
2412
|
},
|
|
2398
2413
|
"calculatedProperties": {
|
|
2399
|
-
"description": "Specifications
|
|
2414
|
+
"description": "Specifications of calculated properties whose values are\ngenerated using provided ECExpressions.",
|
|
2400
2415
|
"items": {
|
|
2401
2416
|
"$ref": "#/definitions/CalculatedPropertiesSpecification"
|
|
2402
2417
|
},
|
|
2403
2418
|
"type": "array"
|
|
2404
2419
|
},
|
|
2405
2420
|
"onlyIfNotHandled": {
|
|
2406
|
-
"description": "
|
|
2421
|
+
"description": "Specifies whether this specification should be ignored if another specification was handled before as\ndetermined by rule and specification priorities. This provides a mechanism for defining a fallback specification.",
|
|
2407
2422
|
"type": "boolean"
|
|
2408
2423
|
},
|
|
2409
2424
|
"priority": {
|
|
2410
|
-
"description": "
|
|
2425
|
+
"description": "Controls the order in which specifications are handled — specification with higher priority value is handled\nfirst. If priorities are equal, the specifications are handled in the order they appear in the ruleset.",
|
|
2411
2426
|
"type": "integer"
|
|
2412
2427
|
},
|
|
2413
2428
|
"propertyCategories": {
|
|
2414
|
-
"description": "Specifications for custom categories. Simply defining the categories does\nnothing - they have to be referenced from
|
|
2429
|
+
"description": "Specifications for custom categories. Simply defining the categories does\nnothing - they have to be referenced from property specification defined in\n`propertyOverrides` by `id`.",
|
|
2415
2430
|
"items": {
|
|
2416
2431
|
"$ref": "#/definitions/PropertyCategorySpecification"
|
|
2417
2432
|
},
|
|
2418
2433
|
"type": "array"
|
|
2419
2434
|
},
|
|
2420
2435
|
"propertyOverrides": {
|
|
2421
|
-
"description": "Specifications for various property overrides.",
|
|
2436
|
+
"description": "Specifications for various property overrides that allow customizing property display.",
|
|
2422
2437
|
"items": {
|
|
2423
2438
|
"$ref": "#/definitions/PropertySpecification"
|
|
2424
2439
|
},
|
|
2425
2440
|
"type": "array"
|
|
2426
2441
|
},
|
|
2427
2442
|
"relatedInstances": {
|
|
2428
|
-
"description": "Specifications
|
|
2443
|
+
"description": "Specifications of related instances that can be used when creating the content.",
|
|
2429
2444
|
"items": {
|
|
2430
2445
|
"$ref": "#/definitions/RelatedInstanceSpecification"
|
|
2431
2446
|
},
|
|
2432
2447
|
"type": "array"
|
|
2433
2448
|
},
|
|
2434
2449
|
"relatedProperties": {
|
|
2435
|
-
"description": "Specifications
|
|
2450
|
+
"description": "Specifications of related properties which are\nincluded in the generated content.",
|
|
2436
2451
|
"items": {
|
|
2437
2452
|
"$ref": "#/definitions/RelatedPropertiesSpecification"
|
|
2438
2453
|
},
|
|
2439
2454
|
"type": "array"
|
|
2440
2455
|
},
|
|
2441
2456
|
"showImages": {
|
|
2442
|
-
"description": "Should
|
|
2457
|
+
"description": "Should image IDs be calculated for the returned instances. When `true`, `ImageIdOverride` rules get applied when\ncreating the content.",
|
|
2443
2458
|
"type": "boolean"
|
|
2444
2459
|
},
|
|
2445
2460
|
"specType": {
|
|
@@ -2457,15 +2472,15 @@
|
|
|
2457
2472
|
},
|
|
2458
2473
|
"SingleSchemaClassSpecification": {
|
|
2459
2474
|
"additionalProperties": false,
|
|
2460
|
-
"description": "
|
|
2475
|
+
"description": "This specification is used to point to specific ECClass.",
|
|
2461
2476
|
"properties": {
|
|
2462
2477
|
"className": {
|
|
2463
|
-
"description": "
|
|
2478
|
+
"description": "Specifies name of the target class.",
|
|
2464
2479
|
"pattern": "^[\\w\\d]+$",
|
|
2465
2480
|
"type": "string"
|
|
2466
2481
|
},
|
|
2467
2482
|
"schemaName": {
|
|
2468
|
-
"description": "
|
|
2483
|
+
"description": "Specifies name of the schema which contains the target class.",
|
|
2469
2484
|
"pattern": "^[\\w\\d]+$",
|
|
2470
2485
|
"type": "string"
|
|
2471
2486
|
}
|
|
@@ -2478,11 +2493,11 @@
|
|
|
2478
2493
|
},
|
|
2479
2494
|
"StringQuerySpecification": {
|
|
2480
2495
|
"additionalProperties": false,
|
|
2481
|
-
"description": "
|
|
2496
|
+
"description": "The specification contains an ECSQL query which is used to query for instances.",
|
|
2482
2497
|
"properties": {
|
|
2483
2498
|
"class": {
|
|
2484
2499
|
"$ref": "#/definitions/SingleSchemaClassSpecification",
|
|
2485
|
-
"description": "Specification of ECClass whose instances the query returns."
|
|
2500
|
+
"description": "Specification of ECClass whose instances the query returns. The specification may also point to a\nbase class of instances returned by the query. If the query returns instances that are not of this\nclass, they aren't included in the result set."
|
|
2486
2501
|
},
|
|
2487
2502
|
"query": {
|
|
2488
2503
|
"description": "Specifies the search ECSQL query.",
|
|
@@ -2505,7 +2520,7 @@
|
|
|
2505
2520
|
},
|
|
2506
2521
|
"StyleOverride": {
|
|
2507
2522
|
"additionalProperties": false,
|
|
2508
|
-
"description": "
|
|
2523
|
+
"description": "Style override rules allow customizing display style of specific types of ECInstances.",
|
|
2509
2524
|
"properties": {
|
|
2510
2525
|
"backColor": {
|
|
2511
2526
|
"description": "Background color that should be used for node. The value should be an ECExpression\nwhose result would evaluate to one the following formats:\n- color name (`Red`, `Blue`, etc.)\n- `rgb(255, 255, 255)`\n- `#0F0F0F`",
|
|
@@ -2516,7 +2531,7 @@
|
|
|
2516
2531
|
"type": "string"
|
|
2517
2532
|
},
|
|
2518
2533
|
"fontStyle": {
|
|
2519
|
-
"description": "Font style that should be used for node. The value should be an ECExpression\nwhose result would evaluate to one the following values:\n- `\"Bold\"`\n- `\"Italic\"`\n- `\"Italic,Bold\"`\n- `\"Regular\"`\n\nDefaults to `\"
|
|
2534
|
+
"description": "Font style that should be used for node. The value should be an ECExpression\nwhose result would evaluate to one the following values:\n- `\"Bold\"`\n- `\"Italic\"`\n- `\"Italic,Bold\"`\n- `\"Regular\"`\n\nDefaults to `\"Regular\"`.",
|
|
2520
2535
|
"type": "string"
|
|
2521
2536
|
},
|
|
2522
2537
|
"foreColor": {
|
|
@@ -2524,15 +2539,15 @@
|
|
|
2524
2539
|
"type": "string"
|
|
2525
2540
|
},
|
|
2526
2541
|
"onlyIfNotHandled": {
|
|
2527
|
-
"description": "
|
|
2542
|
+
"description": "Tells the library that the rule should only be handled if no other rule of the same type was handled previously (based on rule\npriorities and definition order). This allows adding fallback rules which can be overriden by higher-priority rules.",
|
|
2528
2543
|
"type": "boolean"
|
|
2529
2544
|
},
|
|
2530
2545
|
"priority": {
|
|
2531
|
-
"description": "Defines the order in which
|
|
2546
|
+
"description": "Defines the order in which rules are handled, higher number means the rule is handled first. If priorities are\nequal, the rules are handled in the order they're defined.",
|
|
2532
2547
|
"type": "integer"
|
|
2533
2548
|
},
|
|
2534
2549
|
"requiredSchemas": {
|
|
2535
|
-
"description": "
|
|
2550
|
+
"description": "A list of ECSchema requirements that need to be met for the rule to be used.",
|
|
2536
2551
|
"items": {
|
|
2537
2552
|
"$ref": "#/definitions/RequiredSchemaSpecification"
|
|
2538
2553
|
},
|
|
@@ -2553,21 +2568,21 @@
|
|
|
2553
2568
|
},
|
|
2554
2569
|
"SubCondition": {
|
|
2555
2570
|
"additionalProperties": false,
|
|
2556
|
-
"description": "
|
|
2571
|
+
"description": "This is a sub-rule which shares *placement attributes* and\nnested customization rules\nof the hierarchy rule. This means the attributes of hierarchy rule are still in effect and the sub-rules\ncan add additional condition of their own.",
|
|
2557
2572
|
"properties": {
|
|
2558
2573
|
"condition": {
|
|
2559
|
-
"description": "Defines a condition
|
|
2574
|
+
"description": "Defines a condition which needs to be met in order for the rule to be used. The condition is an\nECExpression which has to evaluate\nto a boolean value.",
|
|
2560
2575
|
"type": "string"
|
|
2561
2576
|
},
|
|
2562
2577
|
"requiredSchemas": {
|
|
2563
|
-
"description": "
|
|
2578
|
+
"description": "Specifications that define ECSchema requirements for\nthe rule to take effect.",
|
|
2564
2579
|
"items": {
|
|
2565
2580
|
"$ref": "#/definitions/RequiredSchemaSpecification"
|
|
2566
2581
|
},
|
|
2567
2582
|
"type": "array"
|
|
2568
2583
|
},
|
|
2569
2584
|
"specifications": {
|
|
2570
|
-
"description": "
|
|
2585
|
+
"description": "A list of hierarchy specifications that define what nodes are going to be returned.",
|
|
2571
2586
|
"items": {
|
|
2572
2587
|
"anyOf": [
|
|
2573
2588
|
{
|
|
@@ -2587,7 +2602,7 @@
|
|
|
2587
2602
|
"type": "array"
|
|
2588
2603
|
},
|
|
2589
2604
|
"subConditions": {
|
|
2590
|
-
"description": "
|
|
2605
|
+
"description": "A list of nested sub-rules which share *placement attributes* of this sub-condition. This means the\nattributes of this sub-condition are still in effect and the sub-rules can add additional condition\nof their own.",
|
|
2591
2606
|
"items": {
|
|
2592
2607
|
"$ref": "#/definitions/SubCondition"
|
|
2593
2608
|
},
|
|
@@ -2673,7 +2688,7 @@
|
|
|
2673
2688
|
"type": "object"
|
|
2674
2689
|
}
|
|
2675
2690
|
},
|
|
2676
|
-
"description": "Presentation ruleset is a list of rules that define tree hierarchy and content provided by\nthe presentation
|
|
2691
|
+
"description": "Presentation ruleset is a list of rules that define tree hierarchy and content provided by\nthe presentation library. The ruleset consists of:\n- Ruleset options\n- Hierarchy rules:\n - Root node rules\n - Child node rules\n- Content rules for content you see in content controls like property grid and table.\n- Customization rules used for additional customizations such as styling, labeling, checkboxes, etc.\n- User-controllable variables.",
|
|
2677
2692
|
"properties": {
|
|
2678
2693
|
"id": {
|
|
2679
2694
|
"description": "Ruleset identifier. This ID is used to bind UI components with the specific rule set.",
|
|
@@ -2752,7 +2767,7 @@
|
|
|
2752
2767
|
"type": "array"
|
|
2753
2768
|
},
|
|
2754
2769
|
"version": {
|
|
2755
|
-
"description": "Version of the presentation ruleset in SemVer format: `{major}.{minor}.{patch}`.\n\nSetting the version is optional, but might be useful when ruleset is persisted\nsomewhere and evolves over time. Having a version helps choose persisting\nstrategy (keep all versions or only latest) and find the latest ruleset from a list\nof
|
|
2770
|
+
"description": "Version of the presentation ruleset in SemVer format: `{major}.{minor}.{patch}`.\n\nSetting the version is optional, but might be useful when ruleset is persisted\nsomewhere and evolves over time. Having a version helps choose persisting\nstrategy (keep all versions or only latest) and find the latest ruleset from a list\nof rulesets with the same id.\n\nDefaults to `0.0.0`.",
|
|
2756
2771
|
"pattern": "^[\\d]+\\.[\\d]+\\.[\\d]+$",
|
|
2757
2772
|
"type": "string"
|
|
2758
2773
|
}
|