@itwin/presentation-common 5.5.0-dev.2 → 5.5.0-dev.4
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 +8 -1
- package/lib/assets/locales/en/Presentation.json +19 -19
- package/lib/cjs/presentation-common/AsyncTasks.js.map +1 -1
- package/lib/cjs/presentation-common/CommonLoggerCategory.js.map +1 -1
- package/lib/cjs/presentation-common/Diagnostics.js.map +1 -1
- package/lib/cjs/presentation-common/EC.js.map +1 -1
- package/lib/cjs/presentation-common/ElementProperties.js.map +1 -1
- package/lib/cjs/presentation-common/Error.js.map +1 -1
- package/lib/cjs/presentation-common/InstanceFilterDefinition.js.map +1 -1
- package/lib/cjs/presentation-common/KeySet.js.map +1 -1
- package/lib/cjs/presentation-common/KoqPropertyValueFormatter.js.map +1 -1
- package/lib/cjs/presentation-common/LabelDefinition.js.map +1 -1
- package/lib/cjs/presentation-common/LocalizationHelper.js.map +1 -1
- package/lib/cjs/presentation-common/PresentationIpcInterface.js.map +1 -1
- package/lib/cjs/presentation-common/PresentationManagerOptions.js.map +1 -1
- package/lib/cjs/presentation-common/PresentationRpcInterface.js.map +1 -1
- package/lib/cjs/presentation-common/RegisteredRuleset.js.map +1 -1
- package/lib/cjs/presentation-common/RpcRequestsHandler.js.map +1 -1
- package/lib/cjs/presentation-common/RulesetVariables.js.map +1 -1
- package/lib/cjs/presentation-common/RulesetsFactory.js.map +1 -1
- package/lib/cjs/presentation-common/Update.js.map +1 -1
- package/lib/cjs/presentation-common/Utils.js.map +1 -1
- package/lib/cjs/presentation-common/content/Category.js.map +1 -1
- package/lib/cjs/presentation-common/content/Content.js.map +1 -1
- package/lib/cjs/presentation-common/content/ContentTraverser.d.ts +2 -2
- package/lib/cjs/presentation-common/content/ContentTraverser.js +2 -2
- package/lib/cjs/presentation-common/content/ContentTraverser.js.map +1 -1
- package/lib/cjs/presentation-common/content/Descriptor.js.map +1 -1
- package/lib/cjs/presentation-common/content/DisplayTypes.js.map +1 -1
- package/lib/cjs/presentation-common/content/Editor.js.map +1 -1
- package/lib/cjs/presentation-common/content/Fields.js.map +1 -1
- package/lib/cjs/presentation-common/content/Item.js.map +1 -1
- package/lib/cjs/presentation-common/content/Property.js.map +1 -1
- package/lib/cjs/presentation-common/content/PropertyValueFormatter.js.map +1 -1
- package/lib/cjs/presentation-common/content/Renderer.js.map +1 -1
- package/lib/cjs/presentation-common/content/TypeDescription.js.map +1 -1
- package/lib/cjs/presentation-common/content/Value.js.map +1 -1
- package/lib/cjs/presentation-common/hierarchy/HierarchyLevel.js.map +1 -1
- package/lib/cjs/presentation-common/hierarchy/Key.js.map +1 -1
- package/lib/cjs/presentation-common/hierarchy/Node.js.map +1 -1
- package/lib/cjs/presentation-common/hierarchy/NodePathElement.js.map +1 -1
- package/lib/cjs/presentation-common/rules/ClassSpecifications.js.map +1 -1
- package/lib/cjs/presentation-common/rules/RelatedInstanceSpecification.js.map +1 -1
- package/lib/cjs/presentation-common/rules/RelationshipDirection.js.map +1 -1
- package/lib/cjs/presentation-common/rules/RelationshipPathSpecification.js.map +1 -1
- package/lib/cjs/presentation-common/rules/Rule.js.map +1 -1
- package/lib/cjs/presentation-common/rules/Ruleset.js.map +1 -1
- package/lib/cjs/presentation-common/rules/SchemasSpecification.js.map +1 -1
- package/lib/cjs/presentation-common/rules/Variables.js.map +1 -1
- package/lib/cjs/presentation-common/rules/content/ContentInstancesOfSpecificClassesSpecification.js.map +1 -1
- package/lib/cjs/presentation-common/rules/content/ContentRelatedInstancesSpecification.js.map +1 -1
- package/lib/cjs/presentation-common/rules/content/ContentRule.js.map +1 -1
- package/lib/cjs/presentation-common/rules/content/ContentSpecification.js.map +1 -1
- package/lib/cjs/presentation-common/rules/content/DefaultPropertyCategoryOverride.js.map +1 -1
- package/lib/cjs/presentation-common/rules/content/PropertySpecification.js.map +1 -1
- package/lib/cjs/presentation-common/rules/content/SelectedNodeInstancesSpecification.js.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.js.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.js.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.js.map +1 -1
- package/lib/cjs/presentation-common/rules/customization/CustomizationRule.js.map +1 -1
- package/lib/cjs/presentation-common/rules/customization/ExtendedDataRule.js.map +1 -1
- package/lib/cjs/presentation-common/rules/customization/GroupingRule.js.map +1 -1
- package/lib/cjs/presentation-common/rules/customization/InstanceLabelOverride.js.map +1 -1
- package/lib/cjs/presentation-common/rules/customization/SortingRule.js.map +1 -1
- package/lib/cjs/presentation-common/rules/hierarchy/ChildNodeRule.js.map +1 -1
- package/lib/cjs/presentation-common/rules/hierarchy/ChildNodeSpecification.js.map +1 -1
- package/lib/cjs/presentation-common/rules/hierarchy/CustomNodeSpecification.js.map +1 -1
- package/lib/cjs/presentation-common/rules/hierarchy/CustomQueryInstanceNodesSpecification.js.map +1 -1
- package/lib/cjs/presentation-common/rules/hierarchy/InstanceNodesOfSpecificClassesSpecification.js.map +1 -1
- package/lib/cjs/presentation-common/rules/hierarchy/NavigationRule.js.map +1 -1
- package/lib/cjs/presentation-common/rules/hierarchy/NodeArtifactsRule.js.map +1 -1
- package/lib/cjs/presentation-common/rules/hierarchy/RelatedInstanceNodesSpecification.js.map +1 -1
- package/lib/cjs/presentation-common/rules/hierarchy/RootNodeRule.js.map +1 -1
- package/lib/cjs/presentation-common/rules/hierarchy/SubCondition.js.map +1 -1
- package/lib/cjs/presentation-common/selection/SelectionScope.js.map +1 -1
- package/lib/cjs/presentation-common-internal.js.map +1 -1
- package/lib/cjs/presentation-common.js.map +1 -1
- package/lib/esm/presentation-common/AsyncTasks.js.map +1 -1
- package/lib/esm/presentation-common/CommonLoggerCategory.js.map +1 -1
- package/lib/esm/presentation-common/Diagnostics.js.map +1 -1
- package/lib/esm/presentation-common/EC.js.map +1 -1
- package/lib/esm/presentation-common/ElementProperties.js.map +1 -1
- package/lib/esm/presentation-common/Error.js.map +1 -1
- package/lib/esm/presentation-common/InstanceFilterDefinition.js.map +1 -1
- package/lib/esm/presentation-common/KeySet.js.map +1 -1
- package/lib/esm/presentation-common/KoqPropertyValueFormatter.js.map +1 -1
- package/lib/esm/presentation-common/LabelDefinition.js.map +1 -1
- package/lib/esm/presentation-common/LocalizationHelper.js.map +1 -1
- package/lib/esm/presentation-common/PresentationIpcInterface.js.map +1 -1
- package/lib/esm/presentation-common/PresentationManagerOptions.js.map +1 -1
- package/lib/esm/presentation-common/PresentationRpcInterface.js.map +1 -1
- package/lib/esm/presentation-common/RegisteredRuleset.js.map +1 -1
- package/lib/esm/presentation-common/RpcRequestsHandler.js.map +1 -1
- package/lib/esm/presentation-common/RulesetVariables.js.map +1 -1
- package/lib/esm/presentation-common/RulesetsFactory.js.map +1 -1
- package/lib/esm/presentation-common/Update.js.map +1 -1
- package/lib/esm/presentation-common/Utils.js.map +1 -1
- package/lib/esm/presentation-common/content/Category.js.map +1 -1
- package/lib/esm/presentation-common/content/Content.js.map +1 -1
- package/lib/esm/presentation-common/content/ContentTraverser.d.ts +2 -2
- package/lib/esm/presentation-common/content/ContentTraverser.js +2 -2
- package/lib/esm/presentation-common/content/ContentTraverser.js.map +1 -1
- package/lib/esm/presentation-common/content/Descriptor.js.map +1 -1
- package/lib/esm/presentation-common/content/DisplayTypes.js.map +1 -1
- package/lib/esm/presentation-common/content/Editor.js.map +1 -1
- package/lib/esm/presentation-common/content/Fields.js.map +1 -1
- package/lib/esm/presentation-common/content/Item.js.map +1 -1
- package/lib/esm/presentation-common/content/Property.js.map +1 -1
- package/lib/esm/presentation-common/content/PropertyValueFormatter.js.map +1 -1
- package/lib/esm/presentation-common/content/Renderer.js.map +1 -1
- package/lib/esm/presentation-common/content/TypeDescription.js.map +1 -1
- package/lib/esm/presentation-common/content/Value.js.map +1 -1
- package/lib/esm/presentation-common/hierarchy/HierarchyLevel.js.map +1 -1
- package/lib/esm/presentation-common/hierarchy/Key.js.map +1 -1
- package/lib/esm/presentation-common/hierarchy/Node.js.map +1 -1
- package/lib/esm/presentation-common/hierarchy/NodePathElement.js.map +1 -1
- package/lib/esm/presentation-common/rules/ClassSpecifications.js.map +1 -1
- package/lib/esm/presentation-common/rules/RelatedInstanceSpecification.js.map +1 -1
- package/lib/esm/presentation-common/rules/RelationshipDirection.js.map +1 -1
- package/lib/esm/presentation-common/rules/RelationshipPathSpecification.js.map +1 -1
- package/lib/esm/presentation-common/rules/Rule.js.map +1 -1
- package/lib/esm/presentation-common/rules/Ruleset.js.map +1 -1
- package/lib/esm/presentation-common/rules/SchemasSpecification.js.map +1 -1
- package/lib/esm/presentation-common/rules/Variables.js.map +1 -1
- package/lib/esm/presentation-common/rules/content/ContentInstancesOfSpecificClassesSpecification.js.map +1 -1
- package/lib/esm/presentation-common/rules/content/ContentRelatedInstancesSpecification.js.map +1 -1
- package/lib/esm/presentation-common/rules/content/ContentRule.js.map +1 -1
- package/lib/esm/presentation-common/rules/content/ContentSpecification.js.map +1 -1
- package/lib/esm/presentation-common/rules/content/DefaultPropertyCategoryOverride.js.map +1 -1
- package/lib/esm/presentation-common/rules/content/PropertySpecification.js.map +1 -1
- package/lib/esm/presentation-common/rules/content/SelectedNodeInstancesSpecification.js.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.js.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.js.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.js.map +1 -1
- package/lib/esm/presentation-common/rules/customization/CustomizationRule.js.map +1 -1
- package/lib/esm/presentation-common/rules/customization/ExtendedDataRule.js.map +1 -1
- package/lib/esm/presentation-common/rules/customization/GroupingRule.js.map +1 -1
- package/lib/esm/presentation-common/rules/customization/InstanceLabelOverride.js.map +1 -1
- package/lib/esm/presentation-common/rules/customization/SortingRule.js.map +1 -1
- package/lib/esm/presentation-common/rules/hierarchy/ChildNodeRule.js.map +1 -1
- package/lib/esm/presentation-common/rules/hierarchy/ChildNodeSpecification.js.map +1 -1
- package/lib/esm/presentation-common/rules/hierarchy/CustomNodeSpecification.js.map +1 -1
- package/lib/esm/presentation-common/rules/hierarchy/CustomQueryInstanceNodesSpecification.js.map +1 -1
- package/lib/esm/presentation-common/rules/hierarchy/InstanceNodesOfSpecificClassesSpecification.js.map +1 -1
- package/lib/esm/presentation-common/rules/hierarchy/NavigationRule.js.map +1 -1
- package/lib/esm/presentation-common/rules/hierarchy/NodeArtifactsRule.js.map +1 -1
- package/lib/esm/presentation-common/rules/hierarchy/RelatedInstanceNodesSpecification.js.map +1 -1
- package/lib/esm/presentation-common/rules/hierarchy/RootNodeRule.js.map +1 -1
- package/lib/esm/presentation-common/rules/hierarchy/SubCondition.js.map +1 -1
- package/lib/esm/presentation-common/selection/SelectionScope.js.map +1 -1
- package/lib/esm/presentation-common-internal.js.map +1 -1
- package/lib/esm/presentation-common.js.map +1 -1
- package/lib/public/locales/en/Presentation.json +19 -19
- package/package.json +10 -10
package/lib/cjs/presentation-common/rules/content/modifiers/CalculatedPropertiesSpecification.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"CalculatedPropertiesSpecification.js","sourceRoot":"","sources":["../../../../../../src/presentation-common/rules/content/modifiers/CalculatedPropertiesSpecification.ts"],"names":[],"mappings":";AAAA;;;gGAGgG;AAChG;;GAEG","sourcesContent":["/*---------------------------------------------------------------------------------------------\n * Copyright (c) Bentley Systems, Incorporated. All rights reserved.\n * See LICENSE.md in the project root for license terms and full copyright notice.\n *--------------------------------------------------------------------------------------------*/\n/** @packageDocumentation\n * @module PresentationRules\n */\n\nimport { CustomRendererSpecification } from \"./CustomRendererSpecification.js\";\nimport { CategoryIdentifier } from \"./PropertyCategorySpecification.js\";\nimport { PropertyEditorSpecification } from \"./PropertyEditorsSpecification.js\";\n\n/**\n * This content modifier allows including additional calculated properties into the content.\n *\n * @see [Calculated properties specification reference documentation page]($docs/presentation/content/CalculatedPropertiesSpecification.md)\n * @public\n */\nexport interface CalculatedPropertiesSpecification {\n /** Specifies label of the calculated property. Supports [localization]($docs/presentation/advanced/Localization.md). */\n label: string;\n\n /**\n * Defines an expression to calculate the value. The expression can use [ECInstance]($docs/presentation/advanced/ECExpressions.md#ecinstance)\n * and [Ruleset Variables]($docs/presentation/advanced/ECExpressions.md#ruleset-variables-user-settings) symbol contexts.\n */\n value?: string;\n\n /** The attribute allows moving the calculated property into a different category. */\n categoryId?: string | CategoryIdentifier;\n\n /**\n * Custom property [renderer specification]($docs/presentation/content/RendererSpecification.md) that allows assigning a\n * custom value renderer to be used in UI. The specification is used to set up [[Field.renderer]] for\n * this property and it's up to the UI component to make sure appropriate renderer is used to render the property.\n */\n renderer?: CustomRendererSpecification;\n\n /**\n * Custom [property editor specification]($docs/presentation/content/PropertyEditorSpecification) that allows assigning\n * a custom value editor to be used in UI.\n */\n editor?: PropertyEditorSpecification;\n\n /**\n * Assign a custom [[Field.priority]] to the property. It's up to the UI component to make sure that priority\n * is respected - properties with higher priority should appear before or above properties with lower priority.\n *\n * @type integer\n */\n priority?: number;\n\n /**\n * Specifies return type of the calculated property. If unsupported type is provided, calculated property won't appear in the property pane.\n *\n * Type can have these values: `string`, `boolean`, `bool`, `dateTime`, `double`, `int`, `long`\n */\n type?: `string` | `boolean` | `bool` | `dateTime` | `double` | `int` | `long`;\n\n /**\n * A map of [ECExpressions]($docs/presentation/customization/ECExpressions.md) whose\n * evaluation results are used as extended data values.\n */\n extendedData?: { [key: string]: string };\n}\n"]}
|
|
1
|
+
{"version":3,"file":"CalculatedPropertiesSpecification.js","sourceRoot":"","sources":["../../../../../../src/presentation-common/rules/content/modifiers/CalculatedPropertiesSpecification.ts"],"names":[],"mappings":";AAAA;;;gGAGgG;AAChG;;GAEG","sourcesContent":["/*---------------------------------------------------------------------------------------------\r\n * Copyright (c) Bentley Systems, Incorporated. All rights reserved.\r\n * See LICENSE.md in the project root for license terms and full copyright notice.\r\n *--------------------------------------------------------------------------------------------*/\r\n/** @packageDocumentation\r\n * @module PresentationRules\r\n */\r\n\r\nimport { CustomRendererSpecification } from \"./CustomRendererSpecification.js\";\r\nimport { CategoryIdentifier } from \"./PropertyCategorySpecification.js\";\r\nimport { PropertyEditorSpecification } from \"./PropertyEditorsSpecification.js\";\r\n\r\n/**\r\n * This content modifier allows including additional calculated properties into the content.\r\n *\r\n * @see [Calculated properties specification reference documentation page]($docs/presentation/content/CalculatedPropertiesSpecification.md)\r\n * @public\r\n */\r\nexport interface CalculatedPropertiesSpecification {\r\n /** Specifies label of the calculated property. Supports [localization]($docs/presentation/advanced/Localization.md). */\r\n label: string;\r\n\r\n /**\r\n * Defines an expression to calculate the value. The expression can use [ECInstance]($docs/presentation/advanced/ECExpressions.md#ecinstance)\r\n * and [Ruleset Variables]($docs/presentation/advanced/ECExpressions.md#ruleset-variables-user-settings) symbol contexts.\r\n */\r\n value?: string;\r\n\r\n /** The attribute allows moving the calculated property into a different category. */\r\n categoryId?: string | CategoryIdentifier;\r\n\r\n /**\r\n * Custom property [renderer specification]($docs/presentation/content/RendererSpecification.md) that allows assigning a\r\n * custom value renderer to be used in UI. The specification is used to set up [[Field.renderer]] for\r\n * this property and it's up to the UI component to make sure appropriate renderer is used to render the property.\r\n */\r\n renderer?: CustomRendererSpecification;\r\n\r\n /**\r\n * Custom [property editor specification]($docs/presentation/content/PropertyEditorSpecification) that allows assigning\r\n * a custom value editor to be used in UI.\r\n */\r\n editor?: PropertyEditorSpecification;\r\n\r\n /**\r\n * Assign a custom [[Field.priority]] to the property. It's up to the UI component to make sure that priority\r\n * is respected - properties with higher priority should appear before or above properties with lower priority.\r\n *\r\n * @type integer\r\n */\r\n priority?: number;\r\n\r\n /**\r\n * Specifies return type of the calculated property. If unsupported type is provided, calculated property won't appear in the property pane.\r\n *\r\n * Type can have these values: `string`, `boolean`, `bool`, `dateTime`, `double`, `int`, `long`\r\n */\r\n type?: `string` | `boolean` | `bool` | `dateTime` | `double` | `int` | `long`;\r\n\r\n /**\r\n * A map of [ECExpressions]($docs/presentation/customization/ECExpressions.md) whose\r\n * evaluation results are used as extended data values.\r\n */\r\n extendedData?: { [key: string]: string };\r\n}\r\n"]}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"ContentModifier.js","sourceRoot":"","sources":["../../../../../../src/presentation-common/rules/content/modifiers/ContentModifier.ts"],"names":[],"mappings":";AAAA;;;gGAGgG;AAChG;;GAEG","sourcesContent":["/*---------------------------------------------------------------------------------------------\n * Copyright (c) Bentley Systems, Incorporated. All rights reserved.\n * See LICENSE.md in the project root for license terms and full copyright notice.\n *--------------------------------------------------------------------------------------------*/\n/** @packageDocumentation\n * @module PresentationRules\n */\n\nimport { SingleSchemaClassSpecification } from \"../../ClassSpecifications.js\";\nimport { RuleBase } from \"../../Rule.js\";\nimport { PropertySpecification } from \"../PropertySpecification.js\";\nimport { CalculatedPropertiesSpecification } from \"./CalculatedPropertiesSpecification.js\";\nimport { PropertyCategorySpecification } from \"./PropertyCategorySpecification.js\";\nimport { RelatedPropertiesSpecification } from \"./RelatedPropertiesSpecification.js\";\n\n/**\n * Contains various rule attributes that allow modifying returned content.\n *\n * This is not expected to be used directly - use through either [[ContentModifier]]\n * or [[ContentSpecification]].\n *\n * @see [Content modifier rule reference documentation page]($docs/presentation/content/ContentModifier.md)\n * @public\n */\nexport interface ContentModifiersList {\n /**\n * Specifications of [related properties]($docs/presentation/content/RelatedPropertiesSpecification.md) which are\n * included in the generated content.\n */\n relatedProperties?: RelatedPropertiesSpecification[];\n\n /**\n * Specifications of [calculated properties]($docs/presentation/content/CalculatedPropertiesSpecification.md) whose values are\n * generated using provided [ECExpressions]($docs/presentation/advanced/ECExpressions.md).\n */\n calculatedProperties?: CalculatedPropertiesSpecification[];\n\n /**\n * Specifications for [custom categories]($docs/presentation/content/PropertyCategorySpecification.md). Simply defining the categories does\n * nothing - they have to be referenced from [property specification]($docs/presentation/content/PropertySpecification.md) defined in\n * [[propertyOverrides]] by `id`.\n */\n propertyCategories?: PropertyCategorySpecification[];\n\n /**\n * Specifications for various [property overrides]($docs/presentation/content/PropertySpecification.md) that allow customizing property display.\n */\n propertyOverrides?: PropertySpecification[];\n}\n\n/**\n * Content modifiers are used to modify how instances of specified ECClasses are displayed in content which is\n * produced using [content rules]($docs/presentation/content/ContentRule.md). They do not produce any content\n * by themselves.\n *\n * @see [Content modifier rule reference documentation page]($docs/presentation/content/ContentModifier.md)\n * @public\n */\nexport interface ContentModifier extends RuleBase, ContentModifiersList {\n /** Used for serializing to JSON. */\n ruleType: \"ContentModifier\";\n\n /**\n * Specification of ECClass whose content should be modified. The modifier is applied to all content\n * if this attribute is not specified.\n */\n class?: SingleSchemaClassSpecification;\n\n /**\n * Specifies whether [`calculatedProperties`]($docs/presentation/content/CalculatedPropertiesSpecification.md) and\n * [`relatedProperties`]($docs/presentation/content/RelatedPropertiesSpecification.md) specifications should also be applied on\n * [nested content]($docs/presentation/content/Terminology.md#nested-content).\n */\n applyOnNestedContent?: boolean;\n}\n"]}
|
|
1
|
+
{"version":3,"file":"ContentModifier.js","sourceRoot":"","sources":["../../../../../../src/presentation-common/rules/content/modifiers/ContentModifier.ts"],"names":[],"mappings":";AAAA;;;gGAGgG;AAChG;;GAEG","sourcesContent":["/*---------------------------------------------------------------------------------------------\r\n * Copyright (c) Bentley Systems, Incorporated. All rights reserved.\r\n * See LICENSE.md in the project root for license terms and full copyright notice.\r\n *--------------------------------------------------------------------------------------------*/\r\n/** @packageDocumentation\r\n * @module PresentationRules\r\n */\r\n\r\nimport { SingleSchemaClassSpecification } from \"../../ClassSpecifications.js\";\r\nimport { RuleBase } from \"../../Rule.js\";\r\nimport { PropertySpecification } from \"../PropertySpecification.js\";\r\nimport { CalculatedPropertiesSpecification } from \"./CalculatedPropertiesSpecification.js\";\r\nimport { PropertyCategorySpecification } from \"./PropertyCategorySpecification.js\";\r\nimport { RelatedPropertiesSpecification } from \"./RelatedPropertiesSpecification.js\";\r\n\r\n/**\r\n * Contains various rule attributes that allow modifying returned content.\r\n *\r\n * This is not expected to be used directly - use through either [[ContentModifier]]\r\n * or [[ContentSpecification]].\r\n *\r\n * @see [Content modifier rule reference documentation page]($docs/presentation/content/ContentModifier.md)\r\n * @public\r\n */\r\nexport interface ContentModifiersList {\r\n /**\r\n * Specifications of [related properties]($docs/presentation/content/RelatedPropertiesSpecification.md) which are\r\n * included in the generated content.\r\n */\r\n relatedProperties?: RelatedPropertiesSpecification[];\r\n\r\n /**\r\n * Specifications of [calculated properties]($docs/presentation/content/CalculatedPropertiesSpecification.md) whose values are\r\n * generated using provided [ECExpressions]($docs/presentation/advanced/ECExpressions.md).\r\n */\r\n calculatedProperties?: CalculatedPropertiesSpecification[];\r\n\r\n /**\r\n * Specifications for [custom categories]($docs/presentation/content/PropertyCategorySpecification.md). Simply defining the categories does\r\n * nothing - they have to be referenced from [property specification]($docs/presentation/content/PropertySpecification.md) defined in\r\n * [[propertyOverrides]] by `id`.\r\n */\r\n propertyCategories?: PropertyCategorySpecification[];\r\n\r\n /**\r\n * Specifications for various [property overrides]($docs/presentation/content/PropertySpecification.md) that allow customizing property display.\r\n */\r\n propertyOverrides?: PropertySpecification[];\r\n}\r\n\r\n/**\r\n * Content modifiers are used to modify how instances of specified ECClasses are displayed in content which is\r\n * produced using [content rules]($docs/presentation/content/ContentRule.md). They do not produce any content\r\n * by themselves.\r\n *\r\n * @see [Content modifier rule reference documentation page]($docs/presentation/content/ContentModifier.md)\r\n * @public\r\n */\r\nexport interface ContentModifier extends RuleBase, ContentModifiersList {\r\n /** Used for serializing to JSON. */\r\n ruleType: \"ContentModifier\";\r\n\r\n /**\r\n * Specification of ECClass whose content should be modified. The modifier is applied to all content\r\n * if this attribute is not specified.\r\n */\r\n class?: SingleSchemaClassSpecification;\r\n\r\n /**\r\n * Specifies whether [`calculatedProperties`]($docs/presentation/content/CalculatedPropertiesSpecification.md) and\r\n * [`relatedProperties`]($docs/presentation/content/RelatedPropertiesSpecification.md) specifications should also be applied on\r\n * [nested content]($docs/presentation/content/Terminology.md#nested-content).\r\n */\r\n applyOnNestedContent?: boolean;\r\n}\r\n"]}
|
package/lib/cjs/presentation-common/rules/content/modifiers/CustomRendererSpecification.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"CustomRendererSpecification.js","sourceRoot":"","sources":["../../../../../../src/presentation-common/rules/content/modifiers/CustomRendererSpecification.ts"],"names":[],"mappings":";AAAA;;;gGAGgG;AAChG;;GAEG","sourcesContent":["/*---------------------------------------------------------------------------------------------\n * Copyright (c) Bentley Systems, Incorporated. All rights reserved.\n * See LICENSE.md in the project root for license terms and full copyright notice.\n *--------------------------------------------------------------------------------------------*/\n/** @packageDocumentation\n * @module PresentationRules\n */\n\n/**\n * This specification allows defining a custom renderer, which can be used to render properties or categories.\n *\n * @see [Renderer specification reference documentation page]($docs/presentation/content/RendererSpecification.md)\n * @public\n */\nexport interface CustomRendererSpecification {\n /**\n * Name of the renderer that's going to be used in UI components. Value of this attribute corresponds\n * to [[RendererDescription.name]] attribute that gets assigned to whatever the renderer\n * is set on.\n */\n rendererName: string;\n}\n"]}
|
|
1
|
+
{"version":3,"file":"CustomRendererSpecification.js","sourceRoot":"","sources":["../../../../../../src/presentation-common/rules/content/modifiers/CustomRendererSpecification.ts"],"names":[],"mappings":";AAAA;;;gGAGgG;AAChG;;GAEG","sourcesContent":["/*---------------------------------------------------------------------------------------------\r\n * Copyright (c) Bentley Systems, Incorporated. All rights reserved.\r\n * See LICENSE.md in the project root for license terms and full copyright notice.\r\n *--------------------------------------------------------------------------------------------*/\r\n/** @packageDocumentation\r\n * @module PresentationRules\r\n */\r\n\r\n/**\r\n * This specification allows defining a custom renderer, which can be used to render properties or categories.\r\n *\r\n * @see [Renderer specification reference documentation page]($docs/presentation/content/RendererSpecification.md)\r\n * @public\r\n */\r\nexport interface CustomRendererSpecification {\r\n /**\r\n * Name of the renderer that's going to be used in UI components. Value of this attribute corresponds\r\n * to [[RendererDescription.name]] attribute that gets assigned to whatever the renderer\r\n * is set on.\r\n */\r\n rendererName: string;\r\n}\r\n"]}
|
package/lib/cjs/presentation-common/rules/content/modifiers/PropertyCategorySpecification.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"PropertyCategorySpecification.js","sourceRoot":"","sources":["../../../../../../src/presentation-common/rules/content/modifiers/PropertyCategorySpecification.ts"],"names":[],"mappings":";AAAA;;;gGAGgG;AAChG;;GAEG","sourcesContent":["/*---------------------------------------------------------------------------------------------\n * Copyright (c) Bentley Systems, Incorporated. All rights reserved.\n * See LICENSE.md in the project root for license terms and full copyright notice.\n *--------------------------------------------------------------------------------------------*/\n/** @packageDocumentation\n * @module PresentationRules\n */\n\nimport { CustomRendererSpecification } from \"./CustomRendererSpecification.js\";\n\n/**\n * Identifier for no category. Used to make category displayed at root level by using\n * this identifier for [[PropertyCategorySpecification.parentId]].\n *\n * @public\n */\nexport interface NoCategoryIdentifier {\n /** Type of the identifier */\n type: \"None\";\n}\n\n/**\n * Identifier of the default parent category.\n *\n * For direct properties it's the default category. See [[DefaultPropertyCategoryOverride]] for overriding the default category.\n *\n * For related properties it's the category made up from the related ECClass defined by the **last**\n * [[RelatedPropertiesSpecification]] with [[RelationshipMeaning.RelatedInstance]]. If there's no such specification,\n * the default category is used.\n *\n * @public\n */\nexport interface ParentCategoryIdentifier {\n /** Type of the identifier */\n type: \"DefaultParent\";\n}\n\n/**\n * Identifier of the root category.\n *\n * For direct properties it's the default category. See [[DefaultPropertyCategoryOverride]] for overriding the default category.\n *\n * For related properties it's the category made up from the related ECClass defined by the **first**\n * [[RelatedPropertiesSpecification]] with [[RelationshipMeaning.RelatedInstance]]. If there's no such specification,\n * the default category is used.\n *\n * @public\n */\nexport interface RootCategoryIdentifier {\n /** Type of the identifier */\n type: \"Root\";\n}\n\n/**\n * Identifier of a category specified through [[PropertyCategorySpecification]] in this scope.\n * @public\n */\nexport interface IdCategoryIdentifier {\n /** Type of the identifier */\n type: \"Id\";\n\n /** ID of the category pointed to by this identifier */\n categoryId: string;\n\n /** Controls whether a class category should be included under the category pointed to by this identifier */\n createClassCategory?: boolean;\n}\n\n/**\n * Identifier of a schema-based category, referenced by its full name.\n * @public\n */\nexport interface SchemaCategoryIdentifier {\n /** Type of the identifier */\n type: \"SchemaCategory\";\n\n /** Full name of the property category, e.g. `MySchema:MyPropertyCategory`. */\n categoryName: string;\n}\n\n/**\n * Category identifier used to assign properties to a category.\n * @public\n */\nexport type CategoryIdentifier = ParentCategoryIdentifier | RootCategoryIdentifier | IdCategoryIdentifier | SchemaCategoryIdentifier;\n\n/**\n * Content modifier for defining custom property categories. Custom categories are not present in the result unless\n * they contain at least one property. One way to assign a property to the category is by using\n * [property overrides]($docs/presentation/content/PropertySpecification.md).\n *\n * @see [Property category specification reference documentation page]($docs/presentation/content/PropertyCategorySpecification.md)\n * @public\n */\nexport interface PropertyCategorySpecification {\n /**\n * Category identifier used to reference the category definition from property overrides or other category\n * definitions. The identifier has to be unique within the list of category definitions where this\n * specification is used.\n */\n id: string;\n\n /**\n * Identifier of a parent category. When specifying the parent category by ID, it has to be available in\n * the scope of this category definition.\n */\n parentId?: string | CategoryIdentifier | NoCategoryIdentifier;\n\n /** Display label of the category. May be [localized]($docs/presentation/advanced/Localization.md). */\n label: string;\n\n /**\n * Extensive description of the category. The description is assigned to the category object that's set\n * on content fields and it's up to UI component to decide how the description is displayed.\n */\n description?: string;\n\n /**\n * Assign a custom [[CategoryDescription.priority]] to the category. It's up to the\n * UI component to make sure that priority is respected - categories with higher priority should appear\n * before or above categories with lower priority.\n *\n * @type integer\n */\n priority?: number;\n\n /**\n * Controls the value of [[CategoryDescription.expand]] which tells the UI component\n * displaying the category to auto-expand the category.\n */\n autoExpand?: boolean;\n\n /**\n * Custom category [renderer specification]($docs/presentation/content/RendererSpecification.md) that allows\n * assigning 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\n * make sure appropriate renderer is used to render the category.\n */\n renderer?: CustomRendererSpecification;\n}\n"]}
|
|
1
|
+
{"version":3,"file":"PropertyCategorySpecification.js","sourceRoot":"","sources":["../../../../../../src/presentation-common/rules/content/modifiers/PropertyCategorySpecification.ts"],"names":[],"mappings":";AAAA;;;gGAGgG;AAChG;;GAEG","sourcesContent":["/*---------------------------------------------------------------------------------------------\r\n * Copyright (c) Bentley Systems, Incorporated. All rights reserved.\r\n * See LICENSE.md in the project root for license terms and full copyright notice.\r\n *--------------------------------------------------------------------------------------------*/\r\n/** @packageDocumentation\r\n * @module PresentationRules\r\n */\r\n\r\nimport { CustomRendererSpecification } from \"./CustomRendererSpecification.js\";\r\n\r\n/**\r\n * Identifier for no category. Used to make category displayed at root level by using\r\n * this identifier for [[PropertyCategorySpecification.parentId]].\r\n *\r\n * @public\r\n */\r\nexport interface NoCategoryIdentifier {\r\n /** Type of the identifier */\r\n type: \"None\";\r\n}\r\n\r\n/**\r\n * Identifier of the default parent category.\r\n *\r\n * For direct properties it's the default category. See [[DefaultPropertyCategoryOverride]] for overriding the default category.\r\n *\r\n * For related properties it's the category made up from the related ECClass defined by the **last**\r\n * [[RelatedPropertiesSpecification]] with [[RelationshipMeaning.RelatedInstance]]. If there's no such specification,\r\n * the default category is used.\r\n *\r\n * @public\r\n */\r\nexport interface ParentCategoryIdentifier {\r\n /** Type of the identifier */\r\n type: \"DefaultParent\";\r\n}\r\n\r\n/**\r\n * Identifier of the root category.\r\n *\r\n * For direct properties it's the default category. See [[DefaultPropertyCategoryOverride]] for overriding the default category.\r\n *\r\n * For related properties it's the category made up from the related ECClass defined by the **first**\r\n * [[RelatedPropertiesSpecification]] with [[RelationshipMeaning.RelatedInstance]]. If there's no such specification,\r\n * the default category is used.\r\n *\r\n * @public\r\n */\r\nexport interface RootCategoryIdentifier {\r\n /** Type of the identifier */\r\n type: \"Root\";\r\n}\r\n\r\n/**\r\n * Identifier of a category specified through [[PropertyCategorySpecification]] in this scope.\r\n * @public\r\n */\r\nexport interface IdCategoryIdentifier {\r\n /** Type of the identifier */\r\n type: \"Id\";\r\n\r\n /** ID of the category pointed to by this identifier */\r\n categoryId: string;\r\n\r\n /** Controls whether a class category should be included under the category pointed to by this identifier */\r\n createClassCategory?: boolean;\r\n}\r\n\r\n/**\r\n * Identifier of a schema-based category, referenced by its full name.\r\n * @public\r\n */\r\nexport interface SchemaCategoryIdentifier {\r\n /** Type of the identifier */\r\n type: \"SchemaCategory\";\r\n\r\n /** Full name of the property category, e.g. `MySchema:MyPropertyCategory`. */\r\n categoryName: string;\r\n}\r\n\r\n/**\r\n * Category identifier used to assign properties to a category.\r\n * @public\r\n */\r\nexport type CategoryIdentifier = ParentCategoryIdentifier | RootCategoryIdentifier | IdCategoryIdentifier | SchemaCategoryIdentifier;\r\n\r\n/**\r\n * Content modifier for defining custom property categories. Custom categories are not present in the result unless\r\n * they contain at least one property. One way to assign a property to the category is by using\r\n * [property overrides]($docs/presentation/content/PropertySpecification.md).\r\n *\r\n * @see [Property category specification reference documentation page]($docs/presentation/content/PropertyCategorySpecification.md)\r\n * @public\r\n */\r\nexport interface PropertyCategorySpecification {\r\n /**\r\n * Category identifier used to reference the category definition from property overrides or other category\r\n * definitions. The identifier has to be unique within the list of category definitions where this\r\n * specification is used.\r\n */\r\n id: string;\r\n\r\n /**\r\n * Identifier of a parent category. When specifying the parent category by ID, it has to be available in\r\n * the scope of this category definition.\r\n */\r\n parentId?: string | CategoryIdentifier | NoCategoryIdentifier;\r\n\r\n /** Display label of the category. May be [localized]($docs/presentation/advanced/Localization.md). */\r\n label: string;\r\n\r\n /**\r\n * Extensive description of the category. The description is assigned to the category object that's set\r\n * on content fields and it's up to UI component to decide how the description is displayed.\r\n */\r\n description?: string;\r\n\r\n /**\r\n * Assign a custom [[CategoryDescription.priority]] to the category. It's up to the\r\n * UI component to make sure that priority is respected - categories with higher priority should appear\r\n * before or above categories with lower priority.\r\n *\r\n * @type integer\r\n */\r\n priority?: number;\r\n\r\n /**\r\n * Controls the value of [[CategoryDescription.expand]] which tells the UI component\r\n * displaying the category to auto-expand the category.\r\n */\r\n autoExpand?: boolean;\r\n\r\n /**\r\n * Custom category [renderer specification]($docs/presentation/content/RendererSpecification.md) that allows\r\n * assigning a custom category renderer to be used in UI. This specification is used to set up\r\n * [[CategoryDescription.renderer]] for this category and it's up to the UI component to\r\n * make sure appropriate renderer is used to render the category.\r\n */\r\n renderer?: CustomRendererSpecification;\r\n}\r\n"]}
|
package/lib/cjs/presentation-common/rules/content/modifiers/PropertyEditorsSpecification.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"PropertyEditorsSpecification.js","sourceRoot":"","sources":["../../../../../../src/presentation-common/rules/content/modifiers/PropertyEditorsSpecification.ts"],"names":[],"mappings":";AAAA;;;gGAGgG;AAChG;;GAEG;;;AAkCH;;;GAGG;AACH,IAAY,4BAKX;AALD,WAAY,4BAA4B;IACtC,6CAAa,CAAA;IACb,uDAAuB,CAAA;IACvB,+CAAe,CAAA;IACf,iDAAiB,CAAA;AACnB,CAAC,EALW,4BAA4B,4CAA5B,4BAA4B,QAKvC","sourcesContent":["/*---------------------------------------------------------------------------------------------\n * Copyright (c) Bentley Systems, Incorporated. All rights reserved.\n * See LICENSE.md in the project root for license terms and full copyright notice.\n *--------------------------------------------------------------------------------------------*/\n/** @packageDocumentation\n * @module PresentationRules\n */\n\n/**\n * This specification allows assigning a custom property editor to specific properties.\n *\n * @see [Property editor specification specification reference documentation page]($docs/presentation/content/PropertyEditorSpecification.md)\n * @public\n */\nexport interface PropertyEditorSpecification {\n /**\n * 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\n * is used to edit the property.\n */\n editorName: string;\n\n /**\n * Parameters for the editor.\n * @note At this moment the attribute is not used.\n * @public\n */\n parameters?: PropertyEditorParameters[];\n}\n\n/**\n * Parameters for [[PropertyEditorSpecification]]\n * @public\n */\nexport declare type PropertyEditorParameters =\n | PropertyEditorJsonParameters\n | PropertyEditorMultilineParameters\n | PropertyEditorRangeParameters\n | PropertyEditorSliderParameters;\n\n/**\n * Used for serializing array of [[PropertyEditorParameters]] to JSON\n * @public\n */\nexport enum PropertyEditorParameterTypes {\n Json = \"Json\",\n Multiline = \"Multiline\",\n Range = \"Range\",\n Slider = \"Slider\",\n}\n\n/**\n * Base interface for [[PropertyEditorParameters]]. Not meant\n * to be used directly, see `PropertyEditorParameters`.\n * @public\n */\nexport interface PropertyEditorParametersBase {\n /**\n * Used for serializing to JSON.\n * @see PropertyEditorParameterTypes\n */\n paramsType: `${PropertyEditorParameterTypes}`;\n}\n\n/**\n * Arbitrary JSON parameters for custom property editors\n * @public\n */\nexport interface PropertyEditorJsonParameters extends PropertyEditorParametersBase {\n /** Used for serializing to JSON. */\n paramsType: \"Json\";\n\n /** Arbitrary JSON that can be handled by a property editor */\n json: any;\n}\n\n/**\n * Multiline parameters for property editors that support multiline display\n * @public\n */\nexport interface PropertyEditorMultilineParameters extends PropertyEditorParametersBase {\n /** Used for serializing to JSON. */\n paramsType: \"Multiline\";\n\n /**\n * Number of lines. Defaults to `1`.\n *\n * @type integer\n * @minimum 1\n */\n height?: number;\n}\n\n/**\n * Range parameters for property editors that support ranges\n * @public\n */\nexport interface PropertyEditorRangeParameters extends PropertyEditorParametersBase {\n /** Used for serializing to JSON. */\n paramsType: \"Range\";\n\n /** Minimum value of the range. */\n min?: number;\n\n /** Maximum value of the range. */\n max?: number;\n}\n\n/**\n * Slider parameters for property editors that support slider display\n * @public\n */\nexport interface PropertyEditorSliderParameters extends PropertyEditorParametersBase {\n /** Used for serializing to JSON. */\n paramsType: \"Slider\";\n\n /** Minimum value that can be set. */\n min: number;\n\n /** Maximum value that can be set. */\n max: number;\n\n /**\n * Count of intervals. Defaults to `1`.\n *\n * @type integer\n * @minimum 1\n */\n intervalsCount?: number;\n\n /** Is slider vertical. */\n isVertical?: boolean;\n}\n"]}
|
|
1
|
+
{"version":3,"file":"PropertyEditorsSpecification.js","sourceRoot":"","sources":["../../../../../../src/presentation-common/rules/content/modifiers/PropertyEditorsSpecification.ts"],"names":[],"mappings":";AAAA;;;gGAGgG;AAChG;;GAEG;;;AAkCH;;;GAGG;AACH,IAAY,4BAKX;AALD,WAAY,4BAA4B;IACtC,6CAAa,CAAA;IACb,uDAAuB,CAAA;IACvB,+CAAe,CAAA;IACf,iDAAiB,CAAA;AACnB,CAAC,EALW,4BAA4B,4CAA5B,4BAA4B,QAKvC","sourcesContent":["/*---------------------------------------------------------------------------------------------\r\n * Copyright (c) Bentley Systems, Incorporated. All rights reserved.\r\n * See LICENSE.md in the project root for license terms and full copyright notice.\r\n *--------------------------------------------------------------------------------------------*/\r\n/** @packageDocumentation\r\n * @module PresentationRules\r\n */\r\n\r\n/**\r\n * This specification allows assigning a custom property editor to specific properties.\r\n *\r\n * @see [Property editor specification specification reference documentation page]($docs/presentation/content/PropertyEditorSpecification.md)\r\n * @public\r\n */\r\nexport interface PropertyEditorSpecification {\r\n /**\r\n * Name of the property editor that's going to be used in UI components. This name is carried over to\r\n * [[Field.editor]] and it's up to the UI component to make sure appropriate editor\r\n * is used to edit the property.\r\n */\r\n editorName: string;\r\n\r\n /**\r\n * Parameters for the editor.\r\n * @note At this moment the attribute is not used.\r\n * @public\r\n */\r\n parameters?: PropertyEditorParameters[];\r\n}\r\n\r\n/**\r\n * Parameters for [[PropertyEditorSpecification]]\r\n * @public\r\n */\r\nexport declare type PropertyEditorParameters =\r\n | PropertyEditorJsonParameters\r\n | PropertyEditorMultilineParameters\r\n | PropertyEditorRangeParameters\r\n | PropertyEditorSliderParameters;\r\n\r\n/**\r\n * Used for serializing array of [[PropertyEditorParameters]] to JSON\r\n * @public\r\n */\r\nexport enum PropertyEditorParameterTypes {\r\n Json = \"Json\",\r\n Multiline = \"Multiline\",\r\n Range = \"Range\",\r\n Slider = \"Slider\",\r\n}\r\n\r\n/**\r\n * Base interface for [[PropertyEditorParameters]]. Not meant\r\n * to be used directly, see `PropertyEditorParameters`.\r\n * @public\r\n */\r\nexport interface PropertyEditorParametersBase {\r\n /**\r\n * Used for serializing to JSON.\r\n * @see PropertyEditorParameterTypes\r\n */\r\n paramsType: `${PropertyEditorParameterTypes}`;\r\n}\r\n\r\n/**\r\n * Arbitrary JSON parameters for custom property editors\r\n * @public\r\n */\r\nexport interface PropertyEditorJsonParameters extends PropertyEditorParametersBase {\r\n /** Used for serializing to JSON. */\r\n paramsType: \"Json\";\r\n\r\n /** Arbitrary JSON that can be handled by a property editor */\r\n json: any;\r\n}\r\n\r\n/**\r\n * Multiline parameters for property editors that support multiline display\r\n * @public\r\n */\r\nexport interface PropertyEditorMultilineParameters extends PropertyEditorParametersBase {\r\n /** Used for serializing to JSON. */\r\n paramsType: \"Multiline\";\r\n\r\n /**\r\n * Number of lines. Defaults to `1`.\r\n *\r\n * @type integer\r\n * @minimum 1\r\n */\r\n height?: number;\r\n}\r\n\r\n/**\r\n * Range parameters for property editors that support ranges\r\n * @public\r\n */\r\nexport interface PropertyEditorRangeParameters extends PropertyEditorParametersBase {\r\n /** Used for serializing to JSON. */\r\n paramsType: \"Range\";\r\n\r\n /** Minimum value of the range. */\r\n min?: number;\r\n\r\n /** Maximum value of the range. */\r\n max?: number;\r\n}\r\n\r\n/**\r\n * Slider parameters for property editors that support slider display\r\n * @public\r\n */\r\nexport interface PropertyEditorSliderParameters extends PropertyEditorParametersBase {\r\n /** Used for serializing to JSON. */\r\n paramsType: \"Slider\";\r\n\r\n /** Minimum value that can be set. */\r\n min: number;\r\n\r\n /** Maximum value that can be set. */\r\n max: number;\r\n\r\n /**\r\n * Count of intervals. Defaults to `1`.\r\n *\r\n * @type integer\r\n * @minimum 1\r\n */\r\n intervalsCount?: number;\r\n\r\n /** Is slider vertical. */\r\n isVertical?: boolean;\r\n}\r\n"]}
|
package/lib/cjs/presentation-common/rules/content/modifiers/RelatedPropertiesSpecification.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"RelatedPropertiesSpecification.js","sourceRoot":"","sources":["../../../../../../src/presentation-common/rules/content/modifiers/RelatedPropertiesSpecification.ts"],"names":[],"mappings":";AAAA;;;gGAGgG;AAChG;;GAEG;;;AAKH;;;GAGG;AACH,IAAY,mBAYX;AAZD,WAAY,mBAAmB;IAC7B;;;OAGG;IACH,oDAA6B,CAAA;IAE7B;;;OAGG;IACH,0DAAmC,CAAA;AACrC,CAAC,EAZW,mBAAmB,mCAAnB,mBAAmB,QAY9B;AAED;;;GAGG;AACH,IAAY,8BAWX;AAXD,WAAY,8BAA8B;IACxC;;;OAGG;IACH,iDAAe,CAAA;IAEf;;OAEG;IACH,2CAAS,CAAA;AACX,CAAC,EAXW,8BAA8B,8CAA9B,8BAA8B,QAWzC","sourcesContent":["/*---------------------------------------------------------------------------------------------\n * Copyright (c) Bentley Systems, Incorporated. All rights reserved.\n * See LICENSE.md in the project root for license terms and full copyright notice.\n *--------------------------------------------------------------------------------------------*/\n/** @packageDocumentation\n * @module PresentationRules\n */\n\nimport { RelationshipPathSpecification } from \"../../RelationshipPathSpecification.js\";\nimport { PropertySpecification } from \"../PropertySpecification.js\";\n\n/**\n * Meaning of the relationship.\n * @public\n */\nexport enum RelationshipMeaning {\n /**\n * The properties should be displayed as if they belonged to the [primary instance]($docs/presentation/content/Terminology.md#primary-instance).\n * Generally that means they assigned a category, that's nested under the default category.\n */\n SameInstance = \"SameInstance\",\n\n /**\n * The properties should be distinguished from properties of the [primary instance]($docs/presentation/content/Terminology.md#primary-instance)\n * and shown separately to make it clear they belong to another instance. Generally that means they're assigned a separate root category.\n */\n RelatedInstance = \"RelatedInstance\",\n}\n\n/**\n * Special values that can be used in [[RelatedPropertiesSpecification.propertyNames]]\n * @public\n */\nexport enum RelatedPropertiesSpecialValues {\n /**\n * Used to specify that no properties should be included. Usually\n * used together with [[RelatedPropertiesSpecification.nestedRelatedProperties]]\n */\n None = \"_none_\",\n\n /**\n * Used to specify that all properties should be included.\n */\n All = \"*\",\n}\n\n/**\n * This specification allows including related instance properties into the content.\n *\n * @see [Related properties specification specification reference documentation page]($docs/presentation/content/RelatedPropertiesSpecification.md)\n * @public\n */\nexport interface RelatedPropertiesSpecification {\n /**\n * Specifies a chain of [relationship path specifications]($docs/presentation/RelationshipPathSpecification.md) that\n * forms a path from the content instance to the related instance(s) whose properties should additionally be loaded.\n */\n propertiesSource: RelationshipPathSpecification;\n\n /**\n * Condition for filtering instances targeted by the [[propertiesSource]] attribute.\n *\n * **See:** [ECExpressions available in instance filter]($docs/presentation/Content/ECExpressions.md#instance-filter)\n */\n instanceFilter?: string;\n\n /**\n * The attribute tells whether the target class specified through [[propertiesSource]] should be handled\n * polymorphically. This means properties of the concrete class are loaded in addition to properties of the\n * target class itself.\n *\n * @note There's a difference between loading properties and instances polymorphically. This attribute\n * only controls polymorphism of properties, while instances are always looked up in a polymorphic fashion.\n */\n handleTargetClassPolymorphically?: boolean;\n\n /**\n * Should the field containing related properties be assigned the [[NestedContentField.autoExpand]]\n * attribute. The attribute tells UI components showing the properties that they should be initially displayed in the expanded state.\n */\n autoExpand?: boolean;\n\n /**\n * Specifies whether the specification should be ignored if another higher priority specification for the same relationship already exists.\n */\n skipIfDuplicate?: boolean;\n\n /**\n * The attribute describes what the related properties mean to the [primary instance]($docs/presentation/content/Terminology.md#primary-instance)\n * whose properties are displayed.\n * @see RelationshipMeaning\n */\n relationshipMeaning?: `${RelationshipMeaning}`;\n\n /** The attribute allows loading additional related properties that are related to the target instance of this specification. */\n nestedRelatedProperties?: RelatedPropertiesSpecification[];\n\n /**\n * List of names or definitions of related class properties that should be included in the content.\n * @see RelatedPropertiesSpecialValues\n */\n properties?: Array<string | PropertySpecification> | `${RelatedPropertiesSpecialValues}`;\n\n /**\n * List of names or definitions of relationship class properties that should be included in the content.\n * @see RelatedPropertiesSpecialValues\n */\n relationshipProperties?: Array<string | PropertySpecification> | `${RelatedPropertiesSpecialValues}`;\n\n /**\n * Specifies whether a relationship category should be created regardless of whether any relationship properties were included.\n */\n forceCreateRelationshipCategory?: boolean;\n}\n"]}
|
|
1
|
+
{"version":3,"file":"RelatedPropertiesSpecification.js","sourceRoot":"","sources":["../../../../../../src/presentation-common/rules/content/modifiers/RelatedPropertiesSpecification.ts"],"names":[],"mappings":";AAAA;;;gGAGgG;AAChG;;GAEG;;;AAKH;;;GAGG;AACH,IAAY,mBAYX;AAZD,WAAY,mBAAmB;IAC7B;;;OAGG;IACH,oDAA6B,CAAA;IAE7B;;;OAGG;IACH,0DAAmC,CAAA;AACrC,CAAC,EAZW,mBAAmB,mCAAnB,mBAAmB,QAY9B;AAED;;;GAGG;AACH,IAAY,8BAWX;AAXD,WAAY,8BAA8B;IACxC;;;OAGG;IACH,iDAAe,CAAA;IAEf;;OAEG;IACH,2CAAS,CAAA;AACX,CAAC,EAXW,8BAA8B,8CAA9B,8BAA8B,QAWzC","sourcesContent":["/*---------------------------------------------------------------------------------------------\r\n * Copyright (c) Bentley Systems, Incorporated. All rights reserved.\r\n * See LICENSE.md in the project root for license terms and full copyright notice.\r\n *--------------------------------------------------------------------------------------------*/\r\n/** @packageDocumentation\r\n * @module PresentationRules\r\n */\r\n\r\nimport { RelationshipPathSpecification } from \"../../RelationshipPathSpecification.js\";\r\nimport { PropertySpecification } from \"../PropertySpecification.js\";\r\n\r\n/**\r\n * Meaning of the relationship.\r\n * @public\r\n */\r\nexport enum RelationshipMeaning {\r\n /**\r\n * The properties should be displayed as if they belonged to the [primary instance]($docs/presentation/content/Terminology.md#primary-instance).\r\n * Generally that means they assigned a category, that's nested under the default category.\r\n */\r\n SameInstance = \"SameInstance\",\r\n\r\n /**\r\n * The properties should be distinguished from properties of the [primary instance]($docs/presentation/content/Terminology.md#primary-instance)\r\n * and shown separately to make it clear they belong to another instance. Generally that means they're assigned a separate root category.\r\n */\r\n RelatedInstance = \"RelatedInstance\",\r\n}\r\n\r\n/**\r\n * Special values that can be used in [[RelatedPropertiesSpecification.propertyNames]]\r\n * @public\r\n */\r\nexport enum RelatedPropertiesSpecialValues {\r\n /**\r\n * Used to specify that no properties should be included. Usually\r\n * used together with [[RelatedPropertiesSpecification.nestedRelatedProperties]]\r\n */\r\n None = \"_none_\",\r\n\r\n /**\r\n * Used to specify that all properties should be included.\r\n */\r\n All = \"*\",\r\n}\r\n\r\n/**\r\n * This specification allows including related instance properties into the content.\r\n *\r\n * @see [Related properties specification specification reference documentation page]($docs/presentation/content/RelatedPropertiesSpecification.md)\r\n * @public\r\n */\r\nexport interface RelatedPropertiesSpecification {\r\n /**\r\n * Specifies a chain of [relationship path specifications]($docs/presentation/RelationshipPathSpecification.md) that\r\n * forms a path from the content instance to the related instance(s) whose properties should additionally be loaded.\r\n */\r\n propertiesSource: RelationshipPathSpecification;\r\n\r\n /**\r\n * Condition for filtering instances targeted by the [[propertiesSource]] attribute.\r\n *\r\n * **See:** [ECExpressions available in instance filter]($docs/presentation/Content/ECExpressions.md#instance-filter)\r\n */\r\n instanceFilter?: string;\r\n\r\n /**\r\n * The attribute tells whether the target class specified through [[propertiesSource]] should be handled\r\n * polymorphically. This means properties of the concrete class are loaded in addition to properties of the\r\n * target class itself.\r\n *\r\n * @note There's a difference between loading properties and instances polymorphically. This attribute\r\n * only controls polymorphism of properties, while instances are always looked up in a polymorphic fashion.\r\n */\r\n handleTargetClassPolymorphically?: boolean;\r\n\r\n /**\r\n * Should the field containing related properties be assigned the [[NestedContentField.autoExpand]]\r\n * attribute. The attribute tells UI components showing the properties that they should be initially displayed in the expanded state.\r\n */\r\n autoExpand?: boolean;\r\n\r\n /**\r\n * Specifies whether the specification should be ignored if another higher priority specification for the same relationship already exists.\r\n */\r\n skipIfDuplicate?: boolean;\r\n\r\n /**\r\n * The attribute describes what the related properties mean to the [primary instance]($docs/presentation/content/Terminology.md#primary-instance)\r\n * whose properties are displayed.\r\n * @see RelationshipMeaning\r\n */\r\n relationshipMeaning?: `${RelationshipMeaning}`;\r\n\r\n /** The attribute allows loading additional related properties that are related to the target instance of this specification. */\r\n nestedRelatedProperties?: RelatedPropertiesSpecification[];\r\n\r\n /**\r\n * List of names or definitions of related class properties that should be included in the content.\r\n * @see RelatedPropertiesSpecialValues\r\n */\r\n properties?: Array<string | PropertySpecification> | `${RelatedPropertiesSpecialValues}`;\r\n\r\n /**\r\n * List of names or definitions of relationship class properties that should be included in the content.\r\n * @see RelatedPropertiesSpecialValues\r\n */\r\n relationshipProperties?: Array<string | PropertySpecification> | `${RelatedPropertiesSpecialValues}`;\r\n\r\n /**\r\n * Specifies whether a relationship category should be created regardless of whether any relationship properties were included.\r\n */\r\n forceCreateRelationshipCategory?: boolean;\r\n}\r\n"]}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"CustomizationRule.js","sourceRoot":"","sources":["../../../../../src/presentation-common/rules/customization/CustomizationRule.ts"],"names":[],"mappings":";AAAA;;;gGAGgG;AAChG,qDAAqD;AACrD;;GAEG","sourcesContent":["/*---------------------------------------------------------------------------------------------\n * Copyright (c) Bentley Systems, Incorporated. All rights reserved.\n * See LICENSE.md in the project root for license terms and full copyright notice.\n *--------------------------------------------------------------------------------------------*/\n/* eslint-disable @typescript-eslint/no-deprecated */\n/** @packageDocumentation\n * @module PresentationRules\n */\n\nimport { NodeArtifactsRule } from \"../hierarchy/NodeArtifactsRule.js\";\nimport { ExtendedDataRule } from \"./ExtendedDataRule.js\";\nimport { GroupingRule } from \"./GroupingRule.js\";\nimport { InstanceLabelOverride } from \"./InstanceLabelOverride.js\";\nimport { SortingRule } from \"./SortingRule.js\";\n\n/**\n * Customization rules allow customizing each node or content item separately.\n * Most of the rules have a `condition` property which uses [ECExpressions]($docs/presentation/customization/ECExpressions.md)\n * for conditional rule filtering.\n *\n * **Nested customization rules:**\n *\n * Customization rules may be specified at ruleset level, in which case they're\n * applied to all content produced by the ruleset, or nested under navigation rules,\n * in which case they're applied only for nodes created by those rules.\n *\n * **Customization rule priorities:**\n *\n * Customization rules have a `priority` attribute which defines the order in which they're applied. If priorities match,\n * rules engine looks at the nesting level - the deeper the rule is nested, the higher is its `priority`.\n * If the nesting levels also match, the rule defined first wins.\n *\n * @public\n */\nexport declare type CustomizationRule = InstanceLabelOverride | GroupingRule | SortingRule | ExtendedDataRule | NodeArtifactsRule;\n"]}
|
|
1
|
+
{"version":3,"file":"CustomizationRule.js","sourceRoot":"","sources":["../../../../../src/presentation-common/rules/customization/CustomizationRule.ts"],"names":[],"mappings":";AAAA;;;gGAGgG;AAChG,qDAAqD;AACrD;;GAEG","sourcesContent":["/*---------------------------------------------------------------------------------------------\r\n * Copyright (c) Bentley Systems, Incorporated. All rights reserved.\r\n * See LICENSE.md in the project root for license terms and full copyright notice.\r\n *--------------------------------------------------------------------------------------------*/\r\n/* eslint-disable @typescript-eslint/no-deprecated */\r\n/** @packageDocumentation\r\n * @module PresentationRules\r\n */\r\n\r\nimport { NodeArtifactsRule } from \"../hierarchy/NodeArtifactsRule.js\";\r\nimport { ExtendedDataRule } from \"./ExtendedDataRule.js\";\r\nimport { GroupingRule } from \"./GroupingRule.js\";\r\nimport { InstanceLabelOverride } from \"./InstanceLabelOverride.js\";\r\nimport { SortingRule } from \"./SortingRule.js\";\r\n\r\n/**\r\n * Customization rules allow customizing each node or content item separately.\r\n * Most of the rules have a `condition` property which uses [ECExpressions]($docs/presentation/customization/ECExpressions.md)\r\n * for conditional rule filtering.\r\n *\r\n * **Nested customization rules:**\r\n *\r\n * Customization rules may be specified at ruleset level, in which case they're\r\n * applied to all content produced by the ruleset, or nested under navigation rules,\r\n * in which case they're applied only for nodes created by those rules.\r\n *\r\n * **Customization rule priorities:**\r\n *\r\n * Customization rules have a `priority` attribute which defines the order in which they're applied. If priorities match,\r\n * rules engine looks at the nesting level - the deeper the rule is nested, the higher is its `priority`.\r\n * If the nesting levels also match, the rule defined first wins.\r\n *\r\n * @public\r\n */\r\nexport declare type CustomizationRule = InstanceLabelOverride | GroupingRule | SortingRule | ExtendedDataRule | NodeArtifactsRule;\r\n"]}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"ExtendedDataRule.js","sourceRoot":"","sources":["../../../../../src/presentation-common/rules/customization/ExtendedDataRule.ts"],"names":[],"mappings":";AAAA;;;gGAGgG;AAChG;;GAEG","sourcesContent":["/*---------------------------------------------------------------------------------------------\n * Copyright (c) Bentley Systems, Incorporated. All rights reserved.\n * See LICENSE.md in the project root for license terms and full copyright notice.\n *--------------------------------------------------------------------------------------------*/\n/** @packageDocumentation\n * @module PresentationRules\n */\n\nimport { RuleBase } from \"../Rule.js\";\n\n/**\n * Extended data rule is used to inject some arbitrary data into presentation data objects (nodes, content records).\n *\n * @see [Extended data rule reference documentation page]($docs/presentation/customization/ExtendedDataRule.md)\n * @public\n */\nexport interface ExtendedDataRule extends RuleBase {\n /** Used for serializing to JSON. */\n ruleType: \"ExtendedData\";\n\n /**\n * Defines a condition which needs to be met in order for the rule to be used. The condition\n * is an [ECExpression]($docs/presentation/customization/ECExpressions.md#rule-condition) which has\n * to evaluate to a boolean value.\n */\n condition?: string;\n\n /**\n * A map of [ECExpressions]($docs/presentation/customization/ECExpressions.md#rule-condition) whose\n * evaluation results are used as extended data values.\n */\n items: { [key: string]: string };\n}\n"]}
|
|
1
|
+
{"version":3,"file":"ExtendedDataRule.js","sourceRoot":"","sources":["../../../../../src/presentation-common/rules/customization/ExtendedDataRule.ts"],"names":[],"mappings":";AAAA;;;gGAGgG;AAChG;;GAEG","sourcesContent":["/*---------------------------------------------------------------------------------------------\r\n * Copyright (c) Bentley Systems, Incorporated. All rights reserved.\r\n * See LICENSE.md in the project root for license terms and full copyright notice.\r\n *--------------------------------------------------------------------------------------------*/\r\n/** @packageDocumentation\r\n * @module PresentationRules\r\n */\r\n\r\nimport { RuleBase } from \"../Rule.js\";\r\n\r\n/**\r\n * Extended data rule is used to inject some arbitrary data into presentation data objects (nodes, content records).\r\n *\r\n * @see [Extended data rule reference documentation page]($docs/presentation/customization/ExtendedDataRule.md)\r\n * @public\r\n */\r\nexport interface ExtendedDataRule extends RuleBase {\r\n /** Used for serializing to JSON. */\r\n ruleType: \"ExtendedData\";\r\n\r\n /**\r\n * Defines a condition which needs to be met in order for the rule to be used. The condition\r\n * is an [ECExpression]($docs/presentation/customization/ECExpressions.md#rule-condition) which has\r\n * to evaluate to a boolean value.\r\n */\r\n condition?: string;\r\n\r\n /**\r\n * A map of [ECExpressions]($docs/presentation/customization/ECExpressions.md#rule-condition) whose\r\n * evaluation results are used as extended data values.\r\n */\r\n items: { [key: string]: string };\r\n}\r\n"]}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"GroupingRule.js","sourceRoot":"","sources":["../../../../../src/presentation-common/rules/customization/GroupingRule.ts"],"names":[],"mappings":";AAAA;;;gGAGgG;AAChG,qDAAqD;AACrD;;GAEG;;;AA0CH;;;;;GAKG;AACH,IAAY,0BAIX;AAJD,WAAY,0BAA0B;IACpC,6CAAe,CAAA;IACf,mDAAqB,CAAA;IACrB,qEAAuC,CAAA;AACzC,CAAC,EAJW,0BAA0B,0CAA1B,0BAA0B,QAIrC;AAsED;;;;;GAKG;AACH,IAAY,sCAYX;AAZD,WAAY,sCAAsC;IAChD,qCAAqC;IACrC,yDAAe,CAAA;IAEf;;;;;;OAMG;IACH,qEAA2B,CAAA;AAC7B,CAAC,EAZW,sCAAsC,sDAAtC,sCAAsC,QAYjD","sourcesContent":["/*---------------------------------------------------------------------------------------------\n * Copyright (c) Bentley Systems, Incorporated. All rights reserved.\n * See LICENSE.md in the project root for license terms and full copyright notice.\n *--------------------------------------------------------------------------------------------*/\n/* eslint-disable @typescript-eslint/no-deprecated */\n/** @packageDocumentation\n * @module PresentationRules\n */\n\nimport { SingleSchemaClassSpecification } from \"../ClassSpecifications.js\";\nimport { RuleBase } from \"../Rule.js\";\n\n/**\n * Grouping rules provide advanced ways to group instances when creating hierarchies.\n *\n * @see [Grouping rule reference documentation page]($docs/presentation/hierarchies/GroupingRule.md)\n * @public\n * @deprecated in 5.2 - will not be removed until after 2026-10-01. Use the new [@itwin/presentation-hierarchies](https://github.com/iTwin/presentation/blob/master/packages/hierarchies/README.md)\n * package for creating hierarchies.\n */\nexport interface GroupingRule extends RuleBase {\n /** Used for serializing to JSON. */\n ruleType: \"Grouping\";\n\n /**\n * An [ECExpression]($docs/presentation/hierarchies/ECExpressions.md#rule-condition) that results in\n * a boolean value. If specified, the grouping rule applies only to instance nodes that cause the condition\n * to evaluate to `true`.\n */\n condition?: string;\n\n /** Specification of ECClass which should be grouped using this rule. */\n class: SingleSchemaClassSpecification;\n\n /**\n * Specifies a list of [grouping specifications]($docs/presentation/hierarchies/GroupingRule.md#grouping-specifications)\n * which describe the kind of grouping that should be applied.\n */\n groups: GroupingSpecification[];\n}\n\n/**\n * Grouping rule specifications.\n * @public\n * @deprecated in 5.2 - will not be removed until after 2026-10-01. Use the new [@itwin/presentation-hierarchies](https://github.com/iTwin/presentation/blob/master/packages/hierarchies/README.md)\n * package for creating hierarchies.\n */\nexport declare type GroupingSpecification = ClassGroup | PropertyGroup | SameLabelInstanceGroup;\n\n/**\n * Available types of [[GroupingSpecification]].\n * @public\n * @deprecated in 5.2 - will not be removed until after 2026-10-01. Use the new [@itwin/presentation-hierarchies](https://github.com/iTwin/presentation/blob/master/packages/hierarchies/README.md)\n * package for creating hierarchies.\n */\nexport enum GroupingSpecificationTypes {\n Class = \"Class\",\n Property = \"Property\",\n SameLabelInstance = \"SameLabelInstance\",\n}\n\n/**\n * Base interface for all [[GroupingSpecification]] implementations. Not\n * meant to be used directly, see `GroupingSpecification`.\n *\n * @public\n * @deprecated in 5.2 - will not be removed until after 2026-10-01. Use the new [@itwin/presentation-hierarchies](https://github.com/iTwin/presentation/blob/master/packages/hierarchies/README.md)\n * package for creating hierarchies.\n */\nexport interface GroupingSpecificationBase {\n /**\n * Type of the subclass\n * @see GroupingSpecificationTypes\n */\n specType: `${GroupingSpecificationTypes}`;\n}\n\n/**\n * Base class grouping allows grouping ECInstance nodes by their base class (as opposed to the hierarchy\n * specifications' `groupByClass` attribute, which always groups by direct class).\n *\n * @see [Base class grouping documentation section]($docs/presentation/hierarchies/GroupingRule.md#base-class-grouping)\n * @public\n * @deprecated in 5.2 - will not be removed until after 2026-10-01. Use the new [@itwin/presentation-hierarchies](https://github.com/iTwin/presentation/blob/master/packages/hierarchies/README.md)\n * package for creating hierarchies.\n */\nexport interface ClassGroup extends GroupingSpecificationBase {\n /** Used for serializing to JSON. */\n specType: \"Class\";\n\n /** Specifies whether a grouping node should be created if there is only one item in that group. */\n createGroupForSingleItem?: boolean;\n\n /**\n * Specification of the base ECClass to group by. If specified, allows grouping by a subclass of the class\n * specified by rule's `class` attribute.\n */\n baseClass?: SingleSchemaClassSpecification;\n}\n\n/**\n * Allows grouping multiple instances with the same label into one ECInstances type of node. Similar to display label grouping,\n * but instead of showing a grouping node with multiple grouped ECInstance nodes, it shows a single ECInstances node which represents\n * multiple ECInstances.\n *\n * @see [Same label instance grouping documentation section]($docs/presentation/hierarchies/GroupingRule.md#same-label-instance-grouping)\n * @public\n * @deprecated in 5.2 - will not be removed until after 2026-10-01. Use the new [@itwin/presentation-hierarchies](https://github.com/iTwin/presentation/blob/master/packages/hierarchies/README.md)\n * package for creating hierarchies.\n */\nexport interface SameLabelInstanceGroup extends GroupingSpecificationBase {\n /** Used for serializing to JSON. */\n specType: \"SameLabelInstance\";\n\n /**\n * Grouping nodes by label is an expensive operation because it requires the whole hierarchy level to be created before even the first\n * grouped 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.\n *\n * @see SameLabelInstanceGroupApplicationStage\n */\n applicationStage?: `${SameLabelInstanceGroupApplicationStage}`;\n}\n\n/**\n * Specifies hierarchy creation stages used to apply [[SameLabelInstanceGroup]] grouping.\n * @public\n * @deprecated in 5.2 - will not be removed until after 2026-10-01. Use the new [@itwin/presentation-hierarchies](https://github.com/iTwin/presentation/blob/master/packages/hierarchies/README.md)\n * package for creating hierarchies.\n */\nexport enum SameLabelInstanceGroupApplicationStage {\n /** Apply grouping at query stage. */\n Query = \"Query\",\n\n /**\n * Apply grouping at post-processing stage.\n *\n * This allows grouping nodes created by different hierarchy specifications at\n * a higher performance cost as it requires loading the whole hierarchy level before\n * returning even the first node - avoid using with large numbers of nodes.\n */\n PostProcess = \"PostProcess\",\n}\n\n/**\n * Property grouping allows grouping by a property of the instance by value or by given ranges of values.\n *\n * @see [Property grouping documentation section]($docs/presentation/hierarchies/GroupingRule.md#property-grouping)\n * @public\n * @deprecated in 5.2 - will not be removed until after 2026-10-01. Use the new [@itwin/presentation-hierarchies](https://github.com/iTwin/presentation/blob/master/packages/hierarchies/README.md)\n * package for creating hierarchies.\n */\nexport interface PropertyGroup extends GroupingSpecificationBase {\n /** Used for serializing to JSON. */\n specType: \"Property\";\n\n /**\n * Name of the ECProperty which is used for grouping. The property must exist on the ECClass specified by the\n * rule's `class` attribute and it must be of either a primitive or a navigation type.\n *\n * @minLength 1\n */\n propertyName: string;\n\n /**\n * Specifies grouping node's image ID. If set, the ID is assigned to [[Node.imageId]] and\n * it's up to the UI component to decide what to do with it.\n *\n * @minLength 1\n * @deprecated in 5.0 - will not be removed until after 2026-06-13. Use [[ExtendedDataRule]] instead. See [extended data usage page]($docs/presentation/customization/ExtendedDataUsage.md) for more details.\n */\n imageId?: string;\n\n /** Specifies whether a grouping node should be created if there is only one item in that group. */\n createGroupForSingleItem?: boolean;\n\n /**\n * Should a separate grouping node be created for nodes whose grouping value is not set or is set to an empty string.\n */\n createGroupForUnspecifiedValues?: boolean;\n\n /** Ranges into which the grouping values are divided. Instances are grouped by value if no ranges are specified. */\n ranges?: PropertyRangeGroupSpecification[];\n}\n\n/**\n * Describes a grouping range.\n *\n * @see [Property range group specification documentation section]($docs/presentation/hierarchies/GroupingRule.md#attribute-ranges)\n * @public\n * @deprecated in 5.2 - will not be removed until after 2026-10-01. Use the new [@itwin/presentation-hierarchies](https://github.com/iTwin/presentation/blob/master/packages/hierarchies/README.md)\n * package for creating hierarchies.\n */\nexport interface PropertyRangeGroupSpecification {\n /**\n * ID of an image to use for the grouping node. Defaults to [[PropertyGroup.imageId]] specified in [[PropertyGroup]].\n *\n * @minLength 1\n * @deprecated in 5.0 - will not be removed until after 2026-06-13. Use [[ExtendedDataRule]] instead. See [extended data usage page]($docs/presentation/customization/ExtendedDataUsage.md) for more details.\n */\n imageId?: string;\n\n /**\n * Grouping node label. May be [localized]($docs/presentation/advanced/Localization.md).\n * Defaults to `{from value} - {to value}`.\n *\n * @minLength 1\n */\n label?: string;\n\n /**\n * Value that defines the range start (inclusive).\n *\n * @minLength 1\n */\n fromValue: string;\n\n /**\n * Value that defines the range end (inclusive).\n *\n * @minLength 1\n */\n toValue: string;\n}\n"]}
|
|
1
|
+
{"version":3,"file":"GroupingRule.js","sourceRoot":"","sources":["../../../../../src/presentation-common/rules/customization/GroupingRule.ts"],"names":[],"mappings":";AAAA;;;gGAGgG;AAChG,qDAAqD;AACrD;;GAEG;;;AA0CH;;;;;GAKG;AACH,IAAY,0BAIX;AAJD,WAAY,0BAA0B;IACpC,6CAAe,CAAA;IACf,mDAAqB,CAAA;IACrB,qEAAuC,CAAA;AACzC,CAAC,EAJW,0BAA0B,0CAA1B,0BAA0B,QAIrC;AAsED;;;;;GAKG;AACH,IAAY,sCAYX;AAZD,WAAY,sCAAsC;IAChD,qCAAqC;IACrC,yDAAe,CAAA;IAEf;;;;;;OAMG;IACH,qEAA2B,CAAA;AAC7B,CAAC,EAZW,sCAAsC,sDAAtC,sCAAsC,QAYjD","sourcesContent":["/*---------------------------------------------------------------------------------------------\r\n * Copyright (c) Bentley Systems, Incorporated. All rights reserved.\r\n * See LICENSE.md in the project root for license terms and full copyright notice.\r\n *--------------------------------------------------------------------------------------------*/\r\n/* eslint-disable @typescript-eslint/no-deprecated */\r\n/** @packageDocumentation\r\n * @module PresentationRules\r\n */\r\n\r\nimport { SingleSchemaClassSpecification } from \"../ClassSpecifications.js\";\r\nimport { RuleBase } from \"../Rule.js\";\r\n\r\n/**\r\n * Grouping rules provide advanced ways to group instances when creating hierarchies.\r\n *\r\n * @see [Grouping rule reference documentation page]($docs/presentation/hierarchies/GroupingRule.md)\r\n * @public\r\n * @deprecated in 5.2 - will not be removed until after 2026-10-01. Use the new [@itwin/presentation-hierarchies](https://github.com/iTwin/presentation/blob/master/packages/hierarchies/README.md)\r\n * package for creating hierarchies.\r\n */\r\nexport interface GroupingRule extends RuleBase {\r\n /** Used for serializing to JSON. */\r\n ruleType: \"Grouping\";\r\n\r\n /**\r\n * An [ECExpression]($docs/presentation/hierarchies/ECExpressions.md#rule-condition) that results in\r\n * a boolean value. If specified, the grouping rule applies only to instance nodes that cause the condition\r\n * to evaluate to `true`.\r\n */\r\n condition?: string;\r\n\r\n /** Specification of ECClass which should be grouped using this rule. */\r\n class: SingleSchemaClassSpecification;\r\n\r\n /**\r\n * Specifies a list of [grouping specifications]($docs/presentation/hierarchies/GroupingRule.md#grouping-specifications)\r\n * which describe the kind of grouping that should be applied.\r\n */\r\n groups: GroupingSpecification[];\r\n}\r\n\r\n/**\r\n * Grouping rule specifications.\r\n * @public\r\n * @deprecated in 5.2 - will not be removed until after 2026-10-01. Use the new [@itwin/presentation-hierarchies](https://github.com/iTwin/presentation/blob/master/packages/hierarchies/README.md)\r\n * package for creating hierarchies.\r\n */\r\nexport declare type GroupingSpecification = ClassGroup | PropertyGroup | SameLabelInstanceGroup;\r\n\r\n/**\r\n * Available types of [[GroupingSpecification]].\r\n * @public\r\n * @deprecated in 5.2 - will not be removed until after 2026-10-01. Use the new [@itwin/presentation-hierarchies](https://github.com/iTwin/presentation/blob/master/packages/hierarchies/README.md)\r\n * package for creating hierarchies.\r\n */\r\nexport enum GroupingSpecificationTypes {\r\n Class = \"Class\",\r\n Property = \"Property\",\r\n SameLabelInstance = \"SameLabelInstance\",\r\n}\r\n\r\n/**\r\n * Base interface for all [[GroupingSpecification]] implementations. Not\r\n * meant to be used directly, see `GroupingSpecification`.\r\n *\r\n * @public\r\n * @deprecated in 5.2 - will not be removed until after 2026-10-01. Use the new [@itwin/presentation-hierarchies](https://github.com/iTwin/presentation/blob/master/packages/hierarchies/README.md)\r\n * package for creating hierarchies.\r\n */\r\nexport interface GroupingSpecificationBase {\r\n /**\r\n * Type of the subclass\r\n * @see GroupingSpecificationTypes\r\n */\r\n specType: `${GroupingSpecificationTypes}`;\r\n}\r\n\r\n/**\r\n * Base class grouping allows grouping ECInstance nodes by their base class (as opposed to the hierarchy\r\n * specifications' `groupByClass` attribute, which always groups by direct class).\r\n *\r\n * @see [Base class grouping documentation section]($docs/presentation/hierarchies/GroupingRule.md#base-class-grouping)\r\n * @public\r\n * @deprecated in 5.2 - will not be removed until after 2026-10-01. Use the new [@itwin/presentation-hierarchies](https://github.com/iTwin/presentation/blob/master/packages/hierarchies/README.md)\r\n * package for creating hierarchies.\r\n */\r\nexport interface ClassGroup extends GroupingSpecificationBase {\r\n /** Used for serializing to JSON. */\r\n specType: \"Class\";\r\n\r\n /** Specifies whether a grouping node should be created if there is only one item in that group. */\r\n createGroupForSingleItem?: boolean;\r\n\r\n /**\r\n * Specification of the base ECClass to group by. If specified, allows grouping by a subclass of the class\r\n * specified by rule's `class` attribute.\r\n */\r\n baseClass?: SingleSchemaClassSpecification;\r\n}\r\n\r\n/**\r\n * Allows grouping multiple instances with the same label into one ECInstances type of node. Similar to display label grouping,\r\n * but instead of showing a grouping node with multiple grouped ECInstance nodes, it shows a single ECInstances node which represents\r\n * multiple ECInstances.\r\n *\r\n * @see [Same label instance grouping documentation section]($docs/presentation/hierarchies/GroupingRule.md#same-label-instance-grouping)\r\n * @public\r\n * @deprecated in 5.2 - will not be removed until after 2026-10-01. Use the new [@itwin/presentation-hierarchies](https://github.com/iTwin/presentation/blob/master/packages/hierarchies/README.md)\r\n * package for creating hierarchies.\r\n */\r\nexport interface SameLabelInstanceGroup extends GroupingSpecificationBase {\r\n /** Used for serializing to JSON. */\r\n specType: \"SameLabelInstance\";\r\n\r\n /**\r\n * Grouping nodes by label is an expensive operation because it requires the whole hierarchy level to be created before even the first\r\n * grouped node can be produced. To alleviate the performance impact when this specification is used, two `applicationStage` settings have been introduced:\r\n *\r\n * - `\"Query\"` groups instances during ECSql query, which can often make use of database indices and is generally fairly quick. It is chosen\r\n * as the default option, however, it fails to produce grouping nodes when certain ruleset specifications are involved.\r\n *\r\n * - `\"PostProcess\"` groups instances after the whole hierarchy level is built. It incurs a large performance penalty, but it will\r\n * produce the expected result in all cases.\r\n *\r\n * @see SameLabelInstanceGroupApplicationStage\r\n */\r\n applicationStage?: `${SameLabelInstanceGroupApplicationStage}`;\r\n}\r\n\r\n/**\r\n * Specifies hierarchy creation stages used to apply [[SameLabelInstanceGroup]] grouping.\r\n * @public\r\n * @deprecated in 5.2 - will not be removed until after 2026-10-01. Use the new [@itwin/presentation-hierarchies](https://github.com/iTwin/presentation/blob/master/packages/hierarchies/README.md)\r\n * package for creating hierarchies.\r\n */\r\nexport enum SameLabelInstanceGroupApplicationStage {\r\n /** Apply grouping at query stage. */\r\n Query = \"Query\",\r\n\r\n /**\r\n * Apply grouping at post-processing stage.\r\n *\r\n * This allows grouping nodes created by different hierarchy specifications at\r\n * a higher performance cost as it requires loading the whole hierarchy level before\r\n * returning even the first node - avoid using with large numbers of nodes.\r\n */\r\n PostProcess = \"PostProcess\",\r\n}\r\n\r\n/**\r\n * Property grouping allows grouping by a property of the instance by value or by given ranges of values.\r\n *\r\n * @see [Property grouping documentation section]($docs/presentation/hierarchies/GroupingRule.md#property-grouping)\r\n * @public\r\n * @deprecated in 5.2 - will not be removed until after 2026-10-01. Use the new [@itwin/presentation-hierarchies](https://github.com/iTwin/presentation/blob/master/packages/hierarchies/README.md)\r\n * package for creating hierarchies.\r\n */\r\nexport interface PropertyGroup extends GroupingSpecificationBase {\r\n /** Used for serializing to JSON. */\r\n specType: \"Property\";\r\n\r\n /**\r\n * Name of the ECProperty which is used for grouping. The property must exist on the ECClass specified by the\r\n * rule's `class` attribute and it must be of either a primitive or a navigation type.\r\n *\r\n * @minLength 1\r\n */\r\n propertyName: string;\r\n\r\n /**\r\n * Specifies grouping node's image ID. If set, the ID is assigned to [[Node.imageId]] and\r\n * it's up to the UI component to decide what to do with it.\r\n *\r\n * @minLength 1\r\n * @deprecated in 5.0 - will not be removed until after 2026-06-13. Use [[ExtendedDataRule]] instead. See [extended data usage page]($docs/presentation/customization/ExtendedDataUsage.md) for more details.\r\n */\r\n imageId?: string;\r\n\r\n /** Specifies whether a grouping node should be created if there is only one item in that group. */\r\n createGroupForSingleItem?: boolean;\r\n\r\n /**\r\n * Should a separate grouping node be created for nodes whose grouping value is not set or is set to an empty string.\r\n */\r\n createGroupForUnspecifiedValues?: boolean;\r\n\r\n /** Ranges into which the grouping values are divided. Instances are grouped by value if no ranges are specified. */\r\n ranges?: PropertyRangeGroupSpecification[];\r\n}\r\n\r\n/**\r\n * Describes a grouping range.\r\n *\r\n * @see [Property range group specification documentation section]($docs/presentation/hierarchies/GroupingRule.md#attribute-ranges)\r\n * @public\r\n * @deprecated in 5.2 - will not be removed until after 2026-10-01. Use the new [@itwin/presentation-hierarchies](https://github.com/iTwin/presentation/blob/master/packages/hierarchies/README.md)\r\n * package for creating hierarchies.\r\n */\r\nexport interface PropertyRangeGroupSpecification {\r\n /**\r\n * ID of an image to use for the grouping node. Defaults to [[PropertyGroup.imageId]] specified in [[PropertyGroup]].\r\n *\r\n * @minLength 1\r\n * @deprecated in 5.0 - will not be removed until after 2026-06-13. Use [[ExtendedDataRule]] instead. See [extended data usage page]($docs/presentation/customization/ExtendedDataUsage.md) for more details.\r\n */\r\n imageId?: string;\r\n\r\n /**\r\n * Grouping node label. May be [localized]($docs/presentation/advanced/Localization.md).\r\n * Defaults to `{from value} - {to value}`.\r\n *\r\n * @minLength 1\r\n */\r\n label?: string;\r\n\r\n /**\r\n * Value that defines the range start (inclusive).\r\n *\r\n * @minLength 1\r\n */\r\n fromValue: string;\r\n\r\n /**\r\n * Value that defines the range end (inclusive).\r\n *\r\n * @minLength 1\r\n */\r\n toValue: string;\r\n}\r\n"]}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"InstanceLabelOverride.js","sourceRoot":"","sources":["../../../../../src/presentation-common/rules/customization/InstanceLabelOverride.ts"],"names":[],"mappings":";AAAA;;;gGAGgG;AAChG;;GAEG;;;AA4BH;;;GAGG;AACH,IAAY,2CASX;AATD,WAAY,2CAA2C;IACrD,sEAAuB,CAAA;IACvB,oEAAqB,CAAA;IACrB,sEAAuB,CAAA;IACvB,wEAAyB,CAAA;IACzB,0EAA2B,CAAA;IAC3B,kEAAmB,CAAA;IACnB,gEAAiB,CAAA;IACjB,4FAA6C,CAAA;AAC/C,CAAC,EATW,2CAA2C,2DAA3C,2CAA2C,QAStD","sourcesContent":["/*---------------------------------------------------------------------------------------------\n * Copyright (c) Bentley Systems, Incorporated. All rights reserved.\n * See LICENSE.md in the project root for license terms and full copyright notice.\n *--------------------------------------------------------------------------------------------*/\n/** @packageDocumentation\n * @module PresentationRules\n */\n\nimport { SingleSchemaClassSpecification } from \"../ClassSpecifications.js\";\nimport { RelationshipPathSpecification } from \"../RelationshipPathSpecification.js\";\nimport { RuleBase } from \"../Rule.js\";\n\n/**\n * Instance label override rule provides a way to set instance label to one of its property values,\n * other attributes and/or combination of them.\n *\n * @see [Instance label override reference documentation page]($docs/presentation/customization/InstanceLabelOverride.md)\n * @public\n */\nexport interface InstanceLabelOverride extends RuleBase {\n /** Used for serializing to JSON. */\n ruleType: \"InstanceLabelOverride\";\n\n /**\n * Specifies the ECClass to apply this rule to.\n */\n class: SingleSchemaClassSpecification;\n\n /**\n * Specifications of values used to override label. The first non-empty value is used as the actual label.\n */\n values: InstanceLabelOverrideValueSpecification[];\n}\n\n/**\n * Types of possible [[InstanceLabelOverride]] label values.\n * @public\n */\nexport enum InstanceLabelOverrideValueSpecificationType {\n Composite = \"Composite\",\n Property = \"Property\",\n ClassName = \"ClassName\",\n ClassLabel = \"ClassLabel\",\n BriefcaseId = \"BriefcaseId\",\n LocalId = \"LocalId\",\n String = \"String\",\n RelatedInstanceLabel = \"RelatedInstanceLabel\",\n}\n\n/**\n * Base interface for all [[InstanceLabelOverrideValueSpecification]] implementations.\n * @public\n */\nexport interface InstanceLabelOverrideValueSpecificationBase {\n /**\n * Type of the specification\n * @see InstanceLabelOverrideValueSpecificationType\n */\n specType: `${InstanceLabelOverrideValueSpecificationType}`;\n}\n\n/**\n * Specification allows creating a label value composited using multiple other specifications.\n *\n * @see [Composite value specification reference documentation page]($docs/presentation/customization/InstanceLabelOverride.md#composite-value-specification)\n * @public\n */\nexport interface InstanceLabelOverrideCompositeValueSpecification extends InstanceLabelOverrideValueSpecificationBase {\n specType: \"Composite\";\n\n /**\n * Parts of the value.\n *\n * If any of the parts with `isRequired` flag evaluate to an empty string, the\n * result of this specification is also an empty string.\n */\n parts: Array<{ spec: InstanceLabelOverrideValueSpecification; isRequired?: boolean }>;\n\n /** Separator to use when joining the parts. Defaults to a space character. */\n separator?: string;\n}\n\n/**\n * Specification uses property value as the label content.\n *\n * @see [Property value specification reference documentation page]($docs/presentation/customization/InstanceLabelOverride.md#property-value-specification)\n * @public\n */\nexport interface InstanceLabelOverridePropertyValueSpecification extends InstanceLabelOverrideValueSpecificationBase {\n specType: \"Property\";\n\n /**\n * Name of the property whose value should be used.\n * @note A property with this name must exist on the property class (see [[propertySource]]).\n */\n propertyName: string;\n\n /**\n * [Specification of the relationship path]($docs/presentation/RelationshipPathSpecification.md) from [[InstanceLabelOverride.class]]\n * to class of the property. If omitted, [[InstanceLabelOverride.class]] is used as property class.\n */\n propertySource?: RelationshipPathSpecification;\n}\n\n/**\n * Specification uses ECClass name as the label content.\n *\n * @see [Class name value specification reference documentation page]($docs/presentation/customization/InstanceLabelOverride.md#class-name-value-specification)\n * @public\n */\nexport interface InstanceLabelOverrideClassNameSpecification extends InstanceLabelOverrideValueSpecificationBase {\n specType: \"ClassName\";\n\n /** Should full (`{schemaName}.{className}`) class name be used */\n full?: boolean;\n}\n\n/**\n * Specification uses ECClass display label as the label content.\n *\n * @see [Class label value specification reference documentation page]($docs/presentation/customization/InstanceLabelOverride.md#class-label-value-specification)\n * @public\n */\nexport interface InstanceLabelOverrideClassLabelSpecification extends InstanceLabelOverrideValueSpecificationBase {\n specType: \"ClassLabel\";\n}\n\n/**\n * Specification returns ECInstance's briefcase ID in base36 format.\n *\n * @see [BriefcaseId value specification reference documentation page]($docs/presentation/customization/InstanceLabelOverride.md#briefcaseid-value-specification)\n * @public\n */\nexport interface InstanceLabelOverrideBriefcaseIdSpecification extends InstanceLabelOverrideValueSpecificationBase {\n specType: \"BriefcaseId\";\n}\n\n/**\n * Specification returns ECInstance's local ID in base36 format.\n *\n * @see [LocalId value specification reference documentation page]($docs/presentation/customization/InstanceLabelOverride.md#localid-value-specification)\n * @public\n */\nexport interface InstanceLabelOverrideLocalIdSpecification extends InstanceLabelOverrideValueSpecificationBase {\n specType: \"LocalId\";\n}\n\n/**\n * Specification uses the specified value as the label content.\n *\n * @see [String value specification reference documentation page]($docs/presentation/customization/InstanceLabelOverride.md#string-value-specification)\n * @public\n */\nexport interface InstanceLabelOverrideStringValueSpecification extends InstanceLabelOverrideValueSpecificationBase {\n specType: \"String\";\n\n /** The value to use as the label content. */\n value: string;\n}\n\n/**\n * Specification uses label of another related instance as the label content.\n *\n * @see [Related instance label value specification reference documentation page]($docs/presentation/customization/InstanceLabelOverride.md#related-instance-label-value-specification)\n * @public\n */\nexport interface InstanceLabelOverrideRelatedInstanceLabelSpecification extends InstanceLabelOverrideValueSpecificationBase {\n specType: \"RelatedInstanceLabel\";\n\n /**\n * [Specification of the relationship path]($docs/presentation/RelationshipPathSpecification.md) from `InstanceLabelOverride.class`\n * to class of the related instance.\n */\n pathToRelatedInstance: RelationshipPathSpecification;\n}\n\n/**\n * Specification to define how the label for [[InstanceLabelOverride]] should be created.\n * @public\n */\nexport type InstanceLabelOverrideValueSpecification =\n | InstanceLabelOverrideCompositeValueSpecification\n | InstanceLabelOverridePropertyValueSpecification\n | InstanceLabelOverrideStringValueSpecification\n | InstanceLabelOverrideClassNameSpecification\n | InstanceLabelOverrideClassLabelSpecification\n | InstanceLabelOverrideBriefcaseIdSpecification\n | InstanceLabelOverrideLocalIdSpecification\n | InstanceLabelOverrideRelatedInstanceLabelSpecification;\n"]}
|
|
1
|
+
{"version":3,"file":"InstanceLabelOverride.js","sourceRoot":"","sources":["../../../../../src/presentation-common/rules/customization/InstanceLabelOverride.ts"],"names":[],"mappings":";AAAA;;;gGAGgG;AAChG;;GAEG;;;AA4BH;;;GAGG;AACH,IAAY,2CASX;AATD,WAAY,2CAA2C;IACrD,sEAAuB,CAAA;IACvB,oEAAqB,CAAA;IACrB,sEAAuB,CAAA;IACvB,wEAAyB,CAAA;IACzB,0EAA2B,CAAA;IAC3B,kEAAmB,CAAA;IACnB,gEAAiB,CAAA;IACjB,4FAA6C,CAAA;AAC/C,CAAC,EATW,2CAA2C,2DAA3C,2CAA2C,QAStD","sourcesContent":["/*---------------------------------------------------------------------------------------------\r\n * Copyright (c) Bentley Systems, Incorporated. All rights reserved.\r\n * See LICENSE.md in the project root for license terms and full copyright notice.\r\n *--------------------------------------------------------------------------------------------*/\r\n/** @packageDocumentation\r\n * @module PresentationRules\r\n */\r\n\r\nimport { SingleSchemaClassSpecification } from \"../ClassSpecifications.js\";\r\nimport { RelationshipPathSpecification } from \"../RelationshipPathSpecification.js\";\r\nimport { RuleBase } from \"../Rule.js\";\r\n\r\n/**\r\n * Instance label override rule provides a way to set instance label to one of its property values,\r\n * other attributes and/or combination of them.\r\n *\r\n * @see [Instance label override reference documentation page]($docs/presentation/customization/InstanceLabelOverride.md)\r\n * @public\r\n */\r\nexport interface InstanceLabelOverride extends RuleBase {\r\n /** Used for serializing to JSON. */\r\n ruleType: \"InstanceLabelOverride\";\r\n\r\n /**\r\n * Specifies the ECClass to apply this rule to.\r\n */\r\n class: SingleSchemaClassSpecification;\r\n\r\n /**\r\n * Specifications of values used to override label. The first non-empty value is used as the actual label.\r\n */\r\n values: InstanceLabelOverrideValueSpecification[];\r\n}\r\n\r\n/**\r\n * Types of possible [[InstanceLabelOverride]] label values.\r\n * @public\r\n */\r\nexport enum InstanceLabelOverrideValueSpecificationType {\r\n Composite = \"Composite\",\r\n Property = \"Property\",\r\n ClassName = \"ClassName\",\r\n ClassLabel = \"ClassLabel\",\r\n BriefcaseId = \"BriefcaseId\",\r\n LocalId = \"LocalId\",\r\n String = \"String\",\r\n RelatedInstanceLabel = \"RelatedInstanceLabel\",\r\n}\r\n\r\n/**\r\n * Base interface for all [[InstanceLabelOverrideValueSpecification]] implementations.\r\n * @public\r\n */\r\nexport interface InstanceLabelOverrideValueSpecificationBase {\r\n /**\r\n * Type of the specification\r\n * @see InstanceLabelOverrideValueSpecificationType\r\n */\r\n specType: `${InstanceLabelOverrideValueSpecificationType}`;\r\n}\r\n\r\n/**\r\n * Specification allows creating a label value composited using multiple other specifications.\r\n *\r\n * @see [Composite value specification reference documentation page]($docs/presentation/customization/InstanceLabelOverride.md#composite-value-specification)\r\n * @public\r\n */\r\nexport interface InstanceLabelOverrideCompositeValueSpecification extends InstanceLabelOverrideValueSpecificationBase {\r\n specType: \"Composite\";\r\n\r\n /**\r\n * Parts of the value.\r\n *\r\n * If any of the parts with `isRequired` flag evaluate to an empty string, the\r\n * result of this specification is also an empty string.\r\n */\r\n parts: Array<{ spec: InstanceLabelOverrideValueSpecification; isRequired?: boolean }>;\r\n\r\n /** Separator to use when joining the parts. Defaults to a space character. */\r\n separator?: string;\r\n}\r\n\r\n/**\r\n * Specification uses property value as the label content.\r\n *\r\n * @see [Property value specification reference documentation page]($docs/presentation/customization/InstanceLabelOverride.md#property-value-specification)\r\n * @public\r\n */\r\nexport interface InstanceLabelOverridePropertyValueSpecification extends InstanceLabelOverrideValueSpecificationBase {\r\n specType: \"Property\";\r\n\r\n /**\r\n * Name of the property whose value should be used.\r\n * @note A property with this name must exist on the property class (see [[propertySource]]).\r\n */\r\n propertyName: string;\r\n\r\n /**\r\n * [Specification of the relationship path]($docs/presentation/RelationshipPathSpecification.md) from [[InstanceLabelOverride.class]]\r\n * to class of the property. If omitted, [[InstanceLabelOverride.class]] is used as property class.\r\n */\r\n propertySource?: RelationshipPathSpecification;\r\n}\r\n\r\n/**\r\n * Specification uses ECClass name as the label content.\r\n *\r\n * @see [Class name value specification reference documentation page]($docs/presentation/customization/InstanceLabelOverride.md#class-name-value-specification)\r\n * @public\r\n */\r\nexport interface InstanceLabelOverrideClassNameSpecification extends InstanceLabelOverrideValueSpecificationBase {\r\n specType: \"ClassName\";\r\n\r\n /** Should full (`{schemaName}.{className}`) class name be used */\r\n full?: boolean;\r\n}\r\n\r\n/**\r\n * Specification uses ECClass display label as the label content.\r\n *\r\n * @see [Class label value specification reference documentation page]($docs/presentation/customization/InstanceLabelOverride.md#class-label-value-specification)\r\n * @public\r\n */\r\nexport interface InstanceLabelOverrideClassLabelSpecification extends InstanceLabelOverrideValueSpecificationBase {\r\n specType: \"ClassLabel\";\r\n}\r\n\r\n/**\r\n * Specification returns ECInstance's briefcase ID in base36 format.\r\n *\r\n * @see [BriefcaseId value specification reference documentation page]($docs/presentation/customization/InstanceLabelOverride.md#briefcaseid-value-specification)\r\n * @public\r\n */\r\nexport interface InstanceLabelOverrideBriefcaseIdSpecification extends InstanceLabelOverrideValueSpecificationBase {\r\n specType: \"BriefcaseId\";\r\n}\r\n\r\n/**\r\n * Specification returns ECInstance's local ID in base36 format.\r\n *\r\n * @see [LocalId value specification reference documentation page]($docs/presentation/customization/InstanceLabelOverride.md#localid-value-specification)\r\n * @public\r\n */\r\nexport interface InstanceLabelOverrideLocalIdSpecification extends InstanceLabelOverrideValueSpecificationBase {\r\n specType: \"LocalId\";\r\n}\r\n\r\n/**\r\n * Specification uses the specified value as the label content.\r\n *\r\n * @see [String value specification reference documentation page]($docs/presentation/customization/InstanceLabelOverride.md#string-value-specification)\r\n * @public\r\n */\r\nexport interface InstanceLabelOverrideStringValueSpecification extends InstanceLabelOverrideValueSpecificationBase {\r\n specType: \"String\";\r\n\r\n /** The value to use as the label content. */\r\n value: string;\r\n}\r\n\r\n/**\r\n * Specification uses label of another related instance as the label content.\r\n *\r\n * @see [Related instance label value specification reference documentation page]($docs/presentation/customization/InstanceLabelOverride.md#related-instance-label-value-specification)\r\n * @public\r\n */\r\nexport interface InstanceLabelOverrideRelatedInstanceLabelSpecification extends InstanceLabelOverrideValueSpecificationBase {\r\n specType: \"RelatedInstanceLabel\";\r\n\r\n /**\r\n * [Specification of the relationship path]($docs/presentation/RelationshipPathSpecification.md) from `InstanceLabelOverride.class`\r\n * to class of the related instance.\r\n */\r\n pathToRelatedInstance: RelationshipPathSpecification;\r\n}\r\n\r\n/**\r\n * Specification to define how the label for [[InstanceLabelOverride]] should be created.\r\n * @public\r\n */\r\nexport type InstanceLabelOverrideValueSpecification =\r\n | InstanceLabelOverrideCompositeValueSpecification\r\n | InstanceLabelOverridePropertyValueSpecification\r\n | InstanceLabelOverrideStringValueSpecification\r\n | InstanceLabelOverrideClassNameSpecification\r\n | InstanceLabelOverrideClassLabelSpecification\r\n | InstanceLabelOverrideBriefcaseIdSpecification\r\n | InstanceLabelOverrideLocalIdSpecification\r\n | InstanceLabelOverrideRelatedInstanceLabelSpecification;\r\n"]}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"SortingRule.js","sourceRoot":"","sources":["../../../../../src/presentation-common/rules/customization/SortingRule.ts"],"names":[],"mappings":";AAAA;;;gGAGgG;AAChG;;GAEG","sourcesContent":["/*---------------------------------------------------------------------------------------------\n * Copyright (c) Bentley Systems, Incorporated. All rights reserved.\n * See LICENSE.md in the project root for license terms and full copyright notice.\n *--------------------------------------------------------------------------------------------*/\n/** @packageDocumentation\n * @module PresentationRules\n */\n\nimport { SingleSchemaClassSpecification } from \"../ClassSpecifications.js\";\nimport { RuleBase } from \"../Rule.js\";\n\n/**\n * Sorting rules provide a way to either disable sorting or sort instances by specific properties.\n *\n * @see [Sorting rule reference documentation page]($docs/presentation/customization/SortingRule.md)\n * @public\n */\nexport interface SortingRuleBase extends RuleBase {\n /**\n * Defines a condition which needs to be met in order for the rule to be used. The condition is an\n * [ECExpression]($docs/presentation/customization/ECExpressions.md#rule-condition) which has to\n * evaluate to a boolean value.\n */\n condition?: string;\n\n /** Specifies ECClass whose ECInstances should be sorted. */\n class?: SingleSchemaClassSpecification;\n\n /** Specifies that [[class]] attribute defined in this rule should be handled polymorphically. */\n isPolymorphic?: boolean;\n}\n\n/**\n * Sorting rules provide a way to either disable sorting or sort instances by specific properties.\n *\n * @see [Sorting rule reference documentation page]($docs/presentation/customization/SortingRule.md)\n * @public\n */\nexport type SortingRule = PropertySortingRule | DisabledSortingRule;\n\n/**\n * 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.\n *\n * @see [Property sorting rule reference documentation section]($docs/presentation/customization/SortingRule.md#property-sorting-rule)\n * @public\n */\nexport interface PropertySortingRule extends SortingRuleBase {\n /** Used for serializing to JSON. */\n ruleType: \"PropertySorting\";\n\n /**\n * Specifies name of the property which should be used for sorting.\n *\n * @minLength 1\n */\n propertyName: string;\n\n /** Specifies whether instances should be sorted in ascending order or descending. */\n sortAscending?: boolean;\n}\n\n/**\n * Rule to disable sorting for certain ECInstances in the hierarchy and/or content.\n *\n * @see [Disabled sorting rule reference documentation section]($docs/presentation/customization/SortingRule.md#disabled-sorting-rule)\n * @public\n */\nexport interface DisabledSortingRule extends SortingRuleBase {\n /** Used for serializing to JSON. */\n ruleType: \"DisabledSorting\";\n}\n"]}
|
|
1
|
+
{"version":3,"file":"SortingRule.js","sourceRoot":"","sources":["../../../../../src/presentation-common/rules/customization/SortingRule.ts"],"names":[],"mappings":";AAAA;;;gGAGgG;AAChG;;GAEG","sourcesContent":["/*---------------------------------------------------------------------------------------------\r\n * Copyright (c) Bentley Systems, Incorporated. All rights reserved.\r\n * See LICENSE.md in the project root for license terms and full copyright notice.\r\n *--------------------------------------------------------------------------------------------*/\r\n/** @packageDocumentation\r\n * @module PresentationRules\r\n */\r\n\r\nimport { SingleSchemaClassSpecification } from \"../ClassSpecifications.js\";\r\nimport { RuleBase } from \"../Rule.js\";\r\n\r\n/**\r\n * Sorting rules provide a way to either disable sorting or sort instances by specific properties.\r\n *\r\n * @see [Sorting rule reference documentation page]($docs/presentation/customization/SortingRule.md)\r\n * @public\r\n */\r\nexport interface SortingRuleBase extends RuleBase {\r\n /**\r\n * Defines a condition which needs to be met in order for the rule to be used. The condition is an\r\n * [ECExpression]($docs/presentation/customization/ECExpressions.md#rule-condition) which has to\r\n * evaluate to a boolean value.\r\n */\r\n condition?: string;\r\n\r\n /** Specifies ECClass whose ECInstances should be sorted. */\r\n class?: SingleSchemaClassSpecification;\r\n\r\n /** Specifies that [[class]] attribute defined in this rule should be handled polymorphically. */\r\n isPolymorphic?: boolean;\r\n}\r\n\r\n/**\r\n * Sorting rules provide a way to either disable sorting or sort instances by specific properties.\r\n *\r\n * @see [Sorting rule reference documentation page]($docs/presentation/customization/SortingRule.md)\r\n * @public\r\n */\r\nexport type SortingRule = PropertySortingRule | DisabledSortingRule;\r\n\r\n/**\r\n * 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.\r\n *\r\n * @see [Property sorting rule reference documentation section]($docs/presentation/customization/SortingRule.md#property-sorting-rule)\r\n * @public\r\n */\r\nexport interface PropertySortingRule extends SortingRuleBase {\r\n /** Used for serializing to JSON. */\r\n ruleType: \"PropertySorting\";\r\n\r\n /**\r\n * Specifies name of the property which should be used for sorting.\r\n *\r\n * @minLength 1\r\n */\r\n propertyName: string;\r\n\r\n /** Specifies whether instances should be sorted in ascending order or descending. */\r\n sortAscending?: boolean;\r\n}\r\n\r\n/**\r\n * Rule to disable sorting for certain ECInstances in the hierarchy and/or content.\r\n *\r\n * @see [Disabled sorting rule reference documentation section]($docs/presentation/customization/SortingRule.md#disabled-sorting-rule)\r\n * @public\r\n */\r\nexport interface DisabledSortingRule extends SortingRuleBase {\r\n /** Used for serializing to JSON. */\r\n ruleType: \"DisabledSorting\";\r\n}\r\n"]}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"ChildNodeRule.js","sourceRoot":"","sources":["../../../../../src/presentation-common/rules/hierarchy/ChildNodeRule.ts"],"names":[],"mappings":";AAAA;;;gGAGgG;AAChG,qDAAqD;AACrD;;GAEG","sourcesContent":["/*---------------------------------------------------------------------------------------------\n * Copyright (c) Bentley Systems, Incorporated. All rights reserved.\n * See LICENSE.md in the project root for license terms and full copyright notice.\n *--------------------------------------------------------------------------------------------*/\n/* eslint-disable @typescript-eslint/no-deprecated */\n/** @packageDocumentation\n * @module PresentationRules\n */\n\nimport { NavigationRuleBase } from \"./NavigationRule.js\";\n\n/**\n * Child node rules are used to define child nodes in a hierarchy.\n *\n * @see [Child node rule reference documentation page]($docs/presentation/hierarchies/ChildNodeRule.md)\n * @public\n * @deprecated in 5.2 - will not be removed until after 2026-10-01. Use the new [@itwin/presentation-hierarchies](https://github.com/iTwin/presentation/blob/master/packages/hierarchies/README.md)\n * package for creating hierarchies.\n */\nexport interface ChildNodeRule extends NavigationRuleBase {\n /** Used for serializing to JSON. */\n ruleType: \"ChildNodes\";\n}\n"]}
|
|
1
|
+
{"version":3,"file":"ChildNodeRule.js","sourceRoot":"","sources":["../../../../../src/presentation-common/rules/hierarchy/ChildNodeRule.ts"],"names":[],"mappings":";AAAA;;;gGAGgG;AAChG,qDAAqD;AACrD;;GAEG","sourcesContent":["/*---------------------------------------------------------------------------------------------\r\n * Copyright (c) Bentley Systems, Incorporated. All rights reserved.\r\n * See LICENSE.md in the project root for license terms and full copyright notice.\r\n *--------------------------------------------------------------------------------------------*/\r\n/* eslint-disable @typescript-eslint/no-deprecated */\r\n/** @packageDocumentation\r\n * @module PresentationRules\r\n */\r\n\r\nimport { NavigationRuleBase } from \"./NavigationRule.js\";\r\n\r\n/**\r\n * Child node rules are used to define child nodes in a hierarchy.\r\n *\r\n * @see [Child node rule reference documentation page]($docs/presentation/hierarchies/ChildNodeRule.md)\r\n * @public\r\n * @deprecated in 5.2 - will not be removed until after 2026-10-01. Use the new [@itwin/presentation-hierarchies](https://github.com/iTwin/presentation/blob/master/packages/hierarchies/README.md)\r\n * package for creating hierarchies.\r\n */\r\nexport interface ChildNodeRule extends NavigationRuleBase {\r\n /** Used for serializing to JSON. */\r\n ruleType: \"ChildNodes\";\r\n}\r\n"]}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"ChildNodeSpecification.js","sourceRoot":"","sources":["../../../../../src/presentation-common/rules/hierarchy/ChildNodeSpecification.ts"],"names":[],"mappings":";AAAA;;;gGAGgG;AAChG,qDAAqD;AACrD;;GAEG;;;AASH;;;;;GAKG;AACH,IAAY,2BAKX;AALD,WAAY,2BAA2B;IACrC,4EAA6C,CAAA;IAC7C,gGAAiE,CAAA;IACjE,oFAAqD,CAAA;IACrD,wDAAyB,CAAA;AAC3B,CAAC,EALW,2BAA2B,2CAA3B,2BAA2B,QAKtC","sourcesContent":["/*---------------------------------------------------------------------------------------------\n * Copyright (c) Bentley Systems, Incorporated. All rights reserved.\n * See LICENSE.md in the project root for license terms and full copyright notice.\n *--------------------------------------------------------------------------------------------*/\n/* eslint-disable @typescript-eslint/no-deprecated */\n/** @packageDocumentation\n * @module PresentationRules\n */\n\nimport { RelatedInstanceSpecification } from \"../RelatedInstanceSpecification.js\";\nimport { ChildNodeRule } from \"./ChildNodeRule.js\";\nimport { CustomNodeSpecification } from \"./CustomNodeSpecification.js\";\nimport { CustomQueryInstanceNodesSpecification } from \"./CustomQueryInstanceNodesSpecification.js\";\nimport { InstanceNodesOfSpecificClassesSpecification } from \"./InstanceNodesOfSpecificClassesSpecification.js\";\nimport { RelatedInstanceNodesSpecification } from \"./RelatedInstanceNodesSpecification.js\";\n\n/**\n * Used for serializing array of [[ChildNodeSpecification]]\n * @public\n * @deprecated in 5.2 - will not be removed until after 2026-10-01. Use the new [@itwin/presentation-hierarchies](https://github.com/iTwin/presentation/blob/master/packages/hierarchies/README.md)\n * package for creating hierarchies.\n */\nexport enum ChildNodeSpecificationTypes {\n RelatedInstanceNodes = \"RelatedInstanceNodes\",\n InstanceNodesOfSpecificClasses = \"InstanceNodesOfSpecificClasses\",\n CustomQueryInstanceNodes = \"CustomQueryInstanceNodes\",\n CustomNode = \"CustomNode\",\n}\n\n/**\n * Base interface for all [[ChildNodeSpecification]] implementations.\n *\n * @see [Child node specifications reference documentation section]($docs/presentation/hierarchies/ChildNodeRule.md#attribute-specifications)\n * @public\n * @deprecated in 5.2 - will not be removed until after 2026-10-01. Use the new [@itwin/presentation-hierarchies](https://github.com/iTwin/presentation/blob/master/packages/hierarchies/README.md)\n * package for creating hierarchies.\n */\nexport interface ChildNodeSpecificationBase {\n /**\n * Used for serializing to JSON.\n * @see ChildNodeSpecificationTypes\n */\n specType: `${ChildNodeSpecificationTypes}`;\n\n /**\n * Controls the order in which specifications are handled — specification with higher priority value is\n * handled first. If priorities are equal, the specifications are handled in the order they appear in the\n * ruleset.\n *\n * @type integer\n */\n priority?: number;\n\n /**\n * This attribute allows telling the engine that nodes created by this specification always or never have children.\n */\n hasChildren?: \"Always\" | \"Never\" | \"Unknown\";\n\n /**\n * When `true`, instances nodes produced by this specification are omitted and their children appear one\n * hierarchy level higher.\n */\n hideNodesInHierarchy?: boolean;\n\n /**\n * Specifies whether nodes created through this specification should be hidden if they have no child nodes.\n */\n hideIfNoChildren?: boolean;\n\n /**\n * When specified [ECExpression]($docs/presentation/hierarchies/ECExpressions.md#specification) evaluates\n * to `true`, nodes produced by this specification are omitted and their children appear one hierarchy level\n * higher.\n */\n hideExpression?: string;\n\n /**\n * Suppress sorting of nodes returned by this specification. With this attribute set to `true`, the order\n * of returned nodes is undefined.\n */\n doNotSort?: boolean;\n\n /**\n * Specifies whether similar ancestor nodes' checking should be suppressed when creating nodes based on this\n * specification. See more in [infinite hierarchies prevention page]($docs/presentation/hierarchies/InfiniteHierarchiesPrevention.md).\n */\n suppressSimilarAncestorsCheck?: boolean;\n\n /**\n * Specifications of [related instances]($docs/presentation/RelatedInstanceSpecification.md) that can be used\n * when creating the nodes.\n */\n relatedInstances?: RelatedInstanceSpecification[];\n\n /**\n * Specifications of [nested child node rules]($docs/presentation/hierarchies/Terminology.md#nested-rule) that\n * allow creating child nodes without the need of supplying a condition to match the parent node.\n */\n nestedRules?: ChildNodeRule[];\n}\n\n/**\n * A container of default grouping properties. Used for specifications that support\n * default grouping. Not meant to be used directly, see [[ChildNodeSpecification]].\n *\n * @public\n * @deprecated in 5.2 - will not be removed until after 2026-10-01. Use the new [@itwin/presentation-hierarchies](https://github.com/iTwin/presentation/blob/master/packages/hierarchies/README.md)\n * package for creating hierarchies.\n */\nexport interface DefaultGroupingPropertiesContainer {\n /** Controls whether returned instances should be grouped by ECClass. Defaults to `true`. */\n groupByClass?: boolean;\n\n /** Controls whether returned instances should be grouped by label. Defaults to `true`. */\n groupByLabel?: boolean;\n}\n\n/**\n * Hierarchy rule specifications that define what nodes are going to be returned by the rule.\n *\n * @see [Child node specifications reference documentation section]($docs/presentation/hierarchies/ChildNodeRule.md#attribute-specifications)\n * @public\n * @deprecated in 5.2 - will not be removed until after 2026-10-01. Use the new [@itwin/presentation-hierarchies](https://github.com/iTwin/presentation/blob/master/packages/hierarchies/README.md)\n * package for creating hierarchies.\n */\nexport type ChildNodeSpecification =\n | CustomNodeSpecification\n | InstanceNodesOfSpecificClassesSpecification\n | RelatedInstanceNodesSpecification\n | CustomQueryInstanceNodesSpecification;\n"]}
|
|
1
|
+
{"version":3,"file":"ChildNodeSpecification.js","sourceRoot":"","sources":["../../../../../src/presentation-common/rules/hierarchy/ChildNodeSpecification.ts"],"names":[],"mappings":";AAAA;;;gGAGgG;AAChG,qDAAqD;AACrD;;GAEG;;;AASH;;;;;GAKG;AACH,IAAY,2BAKX;AALD,WAAY,2BAA2B;IACrC,4EAA6C,CAAA;IAC7C,gGAAiE,CAAA;IACjE,oFAAqD,CAAA;IACrD,wDAAyB,CAAA;AAC3B,CAAC,EALW,2BAA2B,2CAA3B,2BAA2B,QAKtC","sourcesContent":["/*---------------------------------------------------------------------------------------------\r\n * Copyright (c) Bentley Systems, Incorporated. All rights reserved.\r\n * See LICENSE.md in the project root for license terms and full copyright notice.\r\n *--------------------------------------------------------------------------------------------*/\r\n/* eslint-disable @typescript-eslint/no-deprecated */\r\n/** @packageDocumentation\r\n * @module PresentationRules\r\n */\r\n\r\nimport { RelatedInstanceSpecification } from \"../RelatedInstanceSpecification.js\";\r\nimport { ChildNodeRule } from \"./ChildNodeRule.js\";\r\nimport { CustomNodeSpecification } from \"./CustomNodeSpecification.js\";\r\nimport { CustomQueryInstanceNodesSpecification } from \"./CustomQueryInstanceNodesSpecification.js\";\r\nimport { InstanceNodesOfSpecificClassesSpecification } from \"./InstanceNodesOfSpecificClassesSpecification.js\";\r\nimport { RelatedInstanceNodesSpecification } from \"./RelatedInstanceNodesSpecification.js\";\r\n\r\n/**\r\n * Used for serializing array of [[ChildNodeSpecification]]\r\n * @public\r\n * @deprecated in 5.2 - will not be removed until after 2026-10-01. Use the new [@itwin/presentation-hierarchies](https://github.com/iTwin/presentation/blob/master/packages/hierarchies/README.md)\r\n * package for creating hierarchies.\r\n */\r\nexport enum ChildNodeSpecificationTypes {\r\n RelatedInstanceNodes = \"RelatedInstanceNodes\",\r\n InstanceNodesOfSpecificClasses = \"InstanceNodesOfSpecificClasses\",\r\n CustomQueryInstanceNodes = \"CustomQueryInstanceNodes\",\r\n CustomNode = \"CustomNode\",\r\n}\r\n\r\n/**\r\n * Base interface for all [[ChildNodeSpecification]] implementations.\r\n *\r\n * @see [Child node specifications reference documentation section]($docs/presentation/hierarchies/ChildNodeRule.md#attribute-specifications)\r\n * @public\r\n * @deprecated in 5.2 - will not be removed until after 2026-10-01. Use the new [@itwin/presentation-hierarchies](https://github.com/iTwin/presentation/blob/master/packages/hierarchies/README.md)\r\n * package for creating hierarchies.\r\n */\r\nexport interface ChildNodeSpecificationBase {\r\n /**\r\n * Used for serializing to JSON.\r\n * @see ChildNodeSpecificationTypes\r\n */\r\n specType: `${ChildNodeSpecificationTypes}`;\r\n\r\n /**\r\n * Controls the order in which specifications are handled — specification with higher priority value is\r\n * handled first. If priorities are equal, the specifications are handled in the order they appear in the\r\n * ruleset.\r\n *\r\n * @type integer\r\n */\r\n priority?: number;\r\n\r\n /**\r\n * This attribute allows telling the engine that nodes created by this specification always or never have children.\r\n */\r\n hasChildren?: \"Always\" | \"Never\" | \"Unknown\";\r\n\r\n /**\r\n * When `true`, instances nodes produced by this specification are omitted and their children appear one\r\n * hierarchy level higher.\r\n */\r\n hideNodesInHierarchy?: boolean;\r\n\r\n /**\r\n * Specifies whether nodes created through this specification should be hidden if they have no child nodes.\r\n */\r\n hideIfNoChildren?: boolean;\r\n\r\n /**\r\n * When specified [ECExpression]($docs/presentation/hierarchies/ECExpressions.md#specification) evaluates\r\n * to `true`, nodes produced by this specification are omitted and their children appear one hierarchy level\r\n * higher.\r\n */\r\n hideExpression?: string;\r\n\r\n /**\r\n * Suppress sorting of nodes returned by this specification. With this attribute set to `true`, the order\r\n * of returned nodes is undefined.\r\n */\r\n doNotSort?: boolean;\r\n\r\n /**\r\n * Specifies whether similar ancestor nodes' checking should be suppressed when creating nodes based on this\r\n * specification. See more in [infinite hierarchies prevention page]($docs/presentation/hierarchies/InfiniteHierarchiesPrevention.md).\r\n */\r\n suppressSimilarAncestorsCheck?: boolean;\r\n\r\n /**\r\n * Specifications of [related instances]($docs/presentation/RelatedInstanceSpecification.md) that can be used\r\n * when creating the nodes.\r\n */\r\n relatedInstances?: RelatedInstanceSpecification[];\r\n\r\n /**\r\n * Specifications of [nested child node rules]($docs/presentation/hierarchies/Terminology.md#nested-rule) that\r\n * allow creating child nodes without the need of supplying a condition to match the parent node.\r\n */\r\n nestedRules?: ChildNodeRule[];\r\n}\r\n\r\n/**\r\n * A container of default grouping properties. Used for specifications that support\r\n * default grouping. Not meant to be used directly, see [[ChildNodeSpecification]].\r\n *\r\n * @public\r\n * @deprecated in 5.2 - will not be removed until after 2026-10-01. Use the new [@itwin/presentation-hierarchies](https://github.com/iTwin/presentation/blob/master/packages/hierarchies/README.md)\r\n * package for creating hierarchies.\r\n */\r\nexport interface DefaultGroupingPropertiesContainer {\r\n /** Controls whether returned instances should be grouped by ECClass. Defaults to `true`. */\r\n groupByClass?: boolean;\r\n\r\n /** Controls whether returned instances should be grouped by label. Defaults to `true`. */\r\n groupByLabel?: boolean;\r\n}\r\n\r\n/**\r\n * Hierarchy rule specifications that define what nodes are going to be returned by the rule.\r\n *\r\n * @see [Child node specifications reference documentation section]($docs/presentation/hierarchies/ChildNodeRule.md#attribute-specifications)\r\n * @public\r\n * @deprecated in 5.2 - will not be removed until after 2026-10-01. Use the new [@itwin/presentation-hierarchies](https://github.com/iTwin/presentation/blob/master/packages/hierarchies/README.md)\r\n * package for creating hierarchies.\r\n */\r\nexport type ChildNodeSpecification =\r\n | CustomNodeSpecification\r\n | InstanceNodesOfSpecificClassesSpecification\r\n | RelatedInstanceNodesSpecification\r\n | CustomQueryInstanceNodesSpecification;\r\n"]}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"CustomNodeSpecification.js","sourceRoot":"","sources":["../../../../../src/presentation-common/rules/hierarchy/CustomNodeSpecification.ts"],"names":[],"mappings":";AAAA;;;gGAGgG;AAChG,qDAAqD;AACrD;;GAEG","sourcesContent":["/*---------------------------------------------------------------------------------------------\n * Copyright (c) Bentley Systems, Incorporated. All rights reserved.\n * See LICENSE.md in the project root for license terms and full copyright notice.\n *--------------------------------------------------------------------------------------------*/\n/* eslint-disable @typescript-eslint/no-deprecated */\n/** @packageDocumentation\n * @module PresentationRules\n */\n\nimport { ChildNodeSpecificationBase } from \"./ChildNodeSpecification.js\";\n\n/**\n * Returns a static custom-defined node that's not based on an ECInstance.\n *\n * @see [Custom node specification reference documentation page]($docs/presentation/hierarchies/CustomNode.md)\n * @public\n * @deprecated in 5.2 - will not be removed until after 2026-10-01. Use the new [@itwin/presentation-hierarchies](https://github.com/iTwin/presentation/blob/master/packages/hierarchies/README.md)\n * package for creating hierarchies.\n */\nexport interface CustomNodeSpecification extends ChildNodeSpecificationBase {\n /** Used for serializing to JSON. */\n specType: \"CustomNode\";\n\n /** Specifies node type, which is assigned to node's key. */\n type: string;\n\n /**\n * Specifies node label. This is a string value that may be [localized]($docs/presentation/advanced/Localization.md).\n */\n label: string;\n\n /**\n * Specifies the value of [[Node.description]] property, which is a string that may\n * be [localized]($docs/presentation/advanced/Localization.md). UI component displaying the node may choose\n * whether and how to surface this information to users.\n */\n description?: string;\n\n /**\n * Specifies node's image ID. If set, the ID is assigned to [[Node.imageId]] and it's\n * up to the UI component to decide what to do with it.\n *\n * @deprecated in 5.0 - will not be removed until after 2026-06-13. Use [[ExtendedDataRule]] instead. See [extended data usage page]($docs/presentation/customization/ExtendedDataUsage.md) for more details.\n */\n imageId?: string;\n}\n"]}
|
|
1
|
+
{"version":3,"file":"CustomNodeSpecification.js","sourceRoot":"","sources":["../../../../../src/presentation-common/rules/hierarchy/CustomNodeSpecification.ts"],"names":[],"mappings":";AAAA;;;gGAGgG;AAChG,qDAAqD;AACrD;;GAEG","sourcesContent":["/*---------------------------------------------------------------------------------------------\r\n * Copyright (c) Bentley Systems, Incorporated. All rights reserved.\r\n * See LICENSE.md in the project root for license terms and full copyright notice.\r\n *--------------------------------------------------------------------------------------------*/\r\n/* eslint-disable @typescript-eslint/no-deprecated */\r\n/** @packageDocumentation\r\n * @module PresentationRules\r\n */\r\n\r\nimport { ChildNodeSpecificationBase } from \"./ChildNodeSpecification.js\";\r\n\r\n/**\r\n * Returns a static custom-defined node that's not based on an ECInstance.\r\n *\r\n * @see [Custom node specification reference documentation page]($docs/presentation/hierarchies/CustomNode.md)\r\n * @public\r\n * @deprecated in 5.2 - will not be removed until after 2026-10-01. Use the new [@itwin/presentation-hierarchies](https://github.com/iTwin/presentation/blob/master/packages/hierarchies/README.md)\r\n * package for creating hierarchies.\r\n */\r\nexport interface CustomNodeSpecification extends ChildNodeSpecificationBase {\r\n /** Used for serializing to JSON. */\r\n specType: \"CustomNode\";\r\n\r\n /** Specifies node type, which is assigned to node's key. */\r\n type: string;\r\n\r\n /**\r\n * Specifies node label. This is a string value that may be [localized]($docs/presentation/advanced/Localization.md).\r\n */\r\n label: string;\r\n\r\n /**\r\n * Specifies the value of [[Node.description]] property, which is a string that may\r\n * be [localized]($docs/presentation/advanced/Localization.md). UI component displaying the node may choose\r\n * whether and how to surface this information to users.\r\n */\r\n description?: string;\r\n\r\n /**\r\n * Specifies node's image ID. If set, the ID is assigned to [[Node.imageId]] and it's\r\n * up to the UI component to decide what to do with it.\r\n *\r\n * @deprecated in 5.0 - will not be removed until after 2026-06-13. Use [[ExtendedDataRule]] instead. See [extended data usage page]($docs/presentation/customization/ExtendedDataUsage.md) for more details.\r\n */\r\n imageId?: string;\r\n}\r\n"]}
|
package/lib/cjs/presentation-common/rules/hierarchy/CustomQueryInstanceNodesSpecification.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"CustomQueryInstanceNodesSpecification.js","sourceRoot":"","sources":["../../../../../src/presentation-common/rules/hierarchy/CustomQueryInstanceNodesSpecification.ts"],"names":[],"mappings":";AAAA;;;gGAGgG;AAChG,qDAAqD;AACrD;;GAEG;;;AAkCH;;;;;GAKG;AACH,IAAY,uBAGX;AAHD,WAAY,uBAAuB;IACjC,4CAAiB,CAAA;IACjB,8DAAmC,CAAA;AACrC,CAAC,EAHW,uBAAuB,uCAAvB,uBAAuB,QAGlC","sourcesContent":["/*---------------------------------------------------------------------------------------------\n * Copyright (c) Bentley Systems, Incorporated. All rights reserved.\n * See LICENSE.md in the project root for license terms and full copyright notice.\n *--------------------------------------------------------------------------------------------*/\n/* eslint-disable @typescript-eslint/no-deprecated */\n/** @packageDocumentation\n * @module PresentationRules\n */\n\nimport { SingleSchemaClassSpecification } from \"../ClassSpecifications.js\";\nimport { ChildNodeSpecificationBase, DefaultGroupingPropertiesContainer } from \"./ChildNodeSpecification.js\";\n\n/**\n * Returns nodes for instances returned by a provided ECSQL query.\n *\n * @see [Custom query instance nodes specification reference documentation page]($docs/presentation/hierarchies/CustomQueryInstanceNodes.md)\n * @public\n * @deprecated in 5.2 - will not be removed until after 2026-10-01. Use the new [@itwin/presentation-hierarchies](https://github.com/iTwin/presentation/blob/master/packages/hierarchies/README.md)\n * package for creating hierarchies.\n */\nexport interface CustomQueryInstanceNodesSpecification extends ChildNodeSpecificationBase, DefaultGroupingPropertiesContainer {\n /** Used for serializing to JSON. */\n specType: \"CustomQueryInstanceNodes\";\n\n /**\n * Specifications of queries used to create the content. Query specifications define the actual\n * results of the specification.\n */\n queries?: QuerySpecification[];\n}\n\n/**\n * Query specifications used in [[CustomQueryInstanceNodesSpecification]].\n *\n * @see [Custom query specifications reference documentation section]($docs/presentation/hierarchies/CustomQueryInstanceNodes.md#attribute-queries)\n * @public\n * @deprecated in 5.2 - will not be removed until after 2026-10-01. Use the new [@itwin/presentation-hierarchies](https://github.com/iTwin/presentation/blob/master/packages/hierarchies/README.md)\n * package for creating hierarchies.\n */\nexport declare type QuerySpecification = StringQuerySpecification | ECPropertyValueQuerySpecification;\n\n/**\n * Used for serializing array of [[QuerySpecification]] to JSON.\n * @public\n * @deprecated in 5.2 - will not be removed until after 2026-10-01. Use the new [@itwin/presentation-hierarchies](https://github.com/iTwin/presentation/blob/master/packages/hierarchies/README.md)\n * package for creating hierarchies.\n */\nexport enum QuerySpecificationTypes {\n String = \"String\",\n ECPropertyValue = \"ECPropertyValue\",\n}\n\n/**\n * Base interface for all [[QuerySpecification]] implementations.\n * @public\n * @deprecated in 5.2 - will not be removed until after 2026-10-01. Use the new [@itwin/presentation-hierarchies](https://github.com/iTwin/presentation/blob/master/packages/hierarchies/README.md)\n * package for creating hierarchies.\n */\nexport interface QuerySpecificationBase {\n /**\n * Used for serializing to JSON.\n * @see QuerySpecificationTypes\n */\n specType: `${QuerySpecificationTypes}`;\n\n /**\n * Specification of ECClass whose instances the query returns. The specification may also point to a\n * base class of instances returned by the query. If the query returns instances that are not of this\n * class, they aren't included in the result set.\n */\n class: SingleSchemaClassSpecification;\n}\n\n/**\n * The specification contains an ECSQL query which is used to query for instances.\n *\n * @see [String query specification reference documentation section]($docs/presentation/hierarchies/CustomQueryInstanceNodes.md#string-query-specification)\n * @public\n * @deprecated in 5.2 - will not be removed until after 2026-10-01. Use the new [@itwin/presentation-hierarchies](https://github.com/iTwin/presentation/blob/master/packages/hierarchies/README.md)\n * package for creating hierarchies.\n */\nexport interface StringQuerySpecification extends QuerySpecificationBase {\n /** Used for serializing to JSON. */\n specType: \"String\";\n\n /** Specifies the search ECSQL query. */\n query: string;\n}\n\n/**\n * The specification specifies the name of the parent node instance property whose value is the ECSQL\n * used to query for instances.\n *\n * @see [ECProperty value query specification reference documentation section]($docs/presentation/hierarchies/CustomQueryInstanceNodes.md#ecproperty-value-query-specification)\n * @public\n * @deprecated in 5.2 - will not be removed until after 2026-10-01. Use the new [@itwin/presentation-hierarchies](https://github.com/iTwin/presentation/blob/master/packages/hierarchies/README.md)\n * package for creating hierarchies.\n */\nexport interface ECPropertyValueQuerySpecification extends QuerySpecificationBase {\n /** Used for serializing to JSON. */\n specType: \"ECPropertyValue\";\n\n /**\n * Specifies name of the parent instance property whose value contains the ECSQL query.\n */\n parentPropertyName: string;\n}\n"]}
|
|
1
|
+
{"version":3,"file":"CustomQueryInstanceNodesSpecification.js","sourceRoot":"","sources":["../../../../../src/presentation-common/rules/hierarchy/CustomQueryInstanceNodesSpecification.ts"],"names":[],"mappings":";AAAA;;;gGAGgG;AAChG,qDAAqD;AACrD;;GAEG;;;AAkCH;;;;;GAKG;AACH,IAAY,uBAGX;AAHD,WAAY,uBAAuB;IACjC,4CAAiB,CAAA;IACjB,8DAAmC,CAAA;AACrC,CAAC,EAHW,uBAAuB,uCAAvB,uBAAuB,QAGlC","sourcesContent":["/*---------------------------------------------------------------------------------------------\r\n * Copyright (c) Bentley Systems, Incorporated. All rights reserved.\r\n * See LICENSE.md in the project root for license terms and full copyright notice.\r\n *--------------------------------------------------------------------------------------------*/\r\n/* eslint-disable @typescript-eslint/no-deprecated */\r\n/** @packageDocumentation\r\n * @module PresentationRules\r\n */\r\n\r\nimport { SingleSchemaClassSpecification } from \"../ClassSpecifications.js\";\r\nimport { ChildNodeSpecificationBase, DefaultGroupingPropertiesContainer } from \"./ChildNodeSpecification.js\";\r\n\r\n/**\r\n * Returns nodes for instances returned by a provided ECSQL query.\r\n *\r\n * @see [Custom query instance nodes specification reference documentation page]($docs/presentation/hierarchies/CustomQueryInstanceNodes.md)\r\n * @public\r\n * @deprecated in 5.2 - will not be removed until after 2026-10-01. Use the new [@itwin/presentation-hierarchies](https://github.com/iTwin/presentation/blob/master/packages/hierarchies/README.md)\r\n * package for creating hierarchies.\r\n */\r\nexport interface CustomQueryInstanceNodesSpecification extends ChildNodeSpecificationBase, DefaultGroupingPropertiesContainer {\r\n /** Used for serializing to JSON. */\r\n specType: \"CustomQueryInstanceNodes\";\r\n\r\n /**\r\n * Specifications of queries used to create the content. Query specifications define the actual\r\n * results of the specification.\r\n */\r\n queries?: QuerySpecification[];\r\n}\r\n\r\n/**\r\n * Query specifications used in [[CustomQueryInstanceNodesSpecification]].\r\n *\r\n * @see [Custom query specifications reference documentation section]($docs/presentation/hierarchies/CustomQueryInstanceNodes.md#attribute-queries)\r\n * @public\r\n * @deprecated in 5.2 - will not be removed until after 2026-10-01. Use the new [@itwin/presentation-hierarchies](https://github.com/iTwin/presentation/blob/master/packages/hierarchies/README.md)\r\n * package for creating hierarchies.\r\n */\r\nexport declare type QuerySpecification = StringQuerySpecification | ECPropertyValueQuerySpecification;\r\n\r\n/**\r\n * Used for serializing array of [[QuerySpecification]] to JSON.\r\n * @public\r\n * @deprecated in 5.2 - will not be removed until after 2026-10-01. Use the new [@itwin/presentation-hierarchies](https://github.com/iTwin/presentation/blob/master/packages/hierarchies/README.md)\r\n * package for creating hierarchies.\r\n */\r\nexport enum QuerySpecificationTypes {\r\n String = \"String\",\r\n ECPropertyValue = \"ECPropertyValue\",\r\n}\r\n\r\n/**\r\n * Base interface for all [[QuerySpecification]] implementations.\r\n * @public\r\n * @deprecated in 5.2 - will not be removed until after 2026-10-01. Use the new [@itwin/presentation-hierarchies](https://github.com/iTwin/presentation/blob/master/packages/hierarchies/README.md)\r\n * package for creating hierarchies.\r\n */\r\nexport interface QuerySpecificationBase {\r\n /**\r\n * Used for serializing to JSON.\r\n * @see QuerySpecificationTypes\r\n */\r\n specType: `${QuerySpecificationTypes}`;\r\n\r\n /**\r\n * Specification of ECClass whose instances the query returns. The specification may also point to a\r\n * base class of instances returned by the query. If the query returns instances that are not of this\r\n * class, they aren't included in the result set.\r\n */\r\n class: SingleSchemaClassSpecification;\r\n}\r\n\r\n/**\r\n * The specification contains an ECSQL query which is used to query for instances.\r\n *\r\n * @see [String query specification reference documentation section]($docs/presentation/hierarchies/CustomQueryInstanceNodes.md#string-query-specification)\r\n * @public\r\n * @deprecated in 5.2 - will not be removed until after 2026-10-01. Use the new [@itwin/presentation-hierarchies](https://github.com/iTwin/presentation/blob/master/packages/hierarchies/README.md)\r\n * package for creating hierarchies.\r\n */\r\nexport interface StringQuerySpecification extends QuerySpecificationBase {\r\n /** Used for serializing to JSON. */\r\n specType: \"String\";\r\n\r\n /** Specifies the search ECSQL query. */\r\n query: string;\r\n}\r\n\r\n/**\r\n * The specification specifies the name of the parent node instance property whose value is the ECSQL\r\n * used to query for instances.\r\n *\r\n * @see [ECProperty value query specification reference documentation section]($docs/presentation/hierarchies/CustomQueryInstanceNodes.md#ecproperty-value-query-specification)\r\n * @public\r\n * @deprecated in 5.2 - will not be removed until after 2026-10-01. Use the new [@itwin/presentation-hierarchies](https://github.com/iTwin/presentation/blob/master/packages/hierarchies/README.md)\r\n * package for creating hierarchies.\r\n */\r\nexport interface ECPropertyValueQuerySpecification extends QuerySpecificationBase {\r\n /** Used for serializing to JSON. */\r\n specType: \"ECPropertyValue\";\r\n\r\n /**\r\n * Specifies name of the parent instance property whose value contains the ECSQL query.\r\n */\r\n parentPropertyName: string;\r\n}\r\n"]}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"InstanceNodesOfSpecificClassesSpecification.js","sourceRoot":"","sources":["../../../../../src/presentation-common/rules/hierarchy/InstanceNodesOfSpecificClassesSpecification.ts"],"names":[],"mappings":";AAAA;;;gGAGgG;AAChG,qDAAqD;AACrD;;GAEG","sourcesContent":["/*---------------------------------------------------------------------------------------------\n * Copyright (c) Bentley Systems, Incorporated. All rights reserved.\n * See LICENSE.md in the project root for license terms and full copyright notice.\n *--------------------------------------------------------------------------------------------*/\n/* eslint-disable @typescript-eslint/no-deprecated */\n/** @packageDocumentation\n * @module PresentationRules\n */\n\nimport { MultiSchemaClassesSpecification } from \"../ClassSpecifications.js\";\nimport { ChildNodeSpecificationBase, DefaultGroupingPropertiesContainer } from \"./ChildNodeSpecification.js\";\n\n/**\n * Returns nodes for instances of specific ECClasses.\n *\n * @see [Instance nodes of specific classes specification reference documentation page]($docs/presentation/hierarchies/InstanceNodesOfSpecificClasses.md)\n * @public\n * @deprecated in 5.2 - will not be removed until after 2026-10-01. Use the new [@itwin/presentation-hierarchies](https://github.com/iTwin/presentation/blob/master/packages/hierarchies/README.md)\n * package for creating hierarchies.\n */\nexport interface InstanceNodesOfSpecificClassesSpecification extends ChildNodeSpecificationBase, DefaultGroupingPropertiesContainer {\n /** Used for serializing to JSON. */\n specType: \"InstanceNodesOfSpecificClasses\";\n\n /**\n * Defines a set of [multi schema classes]($docs/presentation/MultiSchemaClassesSpecification.md) that\n * specify which ECClasses need to be selected to form the result.\n */\n classes: MultiSchemaClassesSpecification | MultiSchemaClassesSpecification[];\n\n /**\n * Defines a set of [multi schema classes]($docs/presentation/MultiSchemaClassesSpecification.md) that\n * prevents specified ECClasses and subclasses from being selected by [[classes]] attribute.\n */\n excludedClasses?: MultiSchemaClassesSpecification | MultiSchemaClassesSpecification[];\n\n /**\n * Specifies an [ECExpression]($docs/presentation/hierarchies/ECExpressions.md#instance-filter) for filtering\n * instances of ECClasses specified through the [[classes]] attribute.\n */\n instanceFilter?: string;\n}\n"]}
|
|
1
|
+
{"version":3,"file":"InstanceNodesOfSpecificClassesSpecification.js","sourceRoot":"","sources":["../../../../../src/presentation-common/rules/hierarchy/InstanceNodesOfSpecificClassesSpecification.ts"],"names":[],"mappings":";AAAA;;;gGAGgG;AAChG,qDAAqD;AACrD;;GAEG","sourcesContent":["/*---------------------------------------------------------------------------------------------\r\n * Copyright (c) Bentley Systems, Incorporated. All rights reserved.\r\n * See LICENSE.md in the project root for license terms and full copyright notice.\r\n *--------------------------------------------------------------------------------------------*/\r\n/* eslint-disable @typescript-eslint/no-deprecated */\r\n/** @packageDocumentation\r\n * @module PresentationRules\r\n */\r\n\r\nimport { MultiSchemaClassesSpecification } from \"../ClassSpecifications.js\";\r\nimport { ChildNodeSpecificationBase, DefaultGroupingPropertiesContainer } from \"./ChildNodeSpecification.js\";\r\n\r\n/**\r\n * Returns nodes for instances of specific ECClasses.\r\n *\r\n * @see [Instance nodes of specific classes specification reference documentation page]($docs/presentation/hierarchies/InstanceNodesOfSpecificClasses.md)\r\n * @public\r\n * @deprecated in 5.2 - will not be removed until after 2026-10-01. Use the new [@itwin/presentation-hierarchies](https://github.com/iTwin/presentation/blob/master/packages/hierarchies/README.md)\r\n * package for creating hierarchies.\r\n */\r\nexport interface InstanceNodesOfSpecificClassesSpecification extends ChildNodeSpecificationBase, DefaultGroupingPropertiesContainer {\r\n /** Used for serializing to JSON. */\r\n specType: \"InstanceNodesOfSpecificClasses\";\r\n\r\n /**\r\n * Defines a set of [multi schema classes]($docs/presentation/MultiSchemaClassesSpecification.md) that\r\n * specify which ECClasses need to be selected to form the result.\r\n */\r\n classes: MultiSchemaClassesSpecification | MultiSchemaClassesSpecification[];\r\n\r\n /**\r\n * Defines a set of [multi schema classes]($docs/presentation/MultiSchemaClassesSpecification.md) that\r\n * prevents specified ECClasses and subclasses from being selected by [[classes]] attribute.\r\n */\r\n excludedClasses?: MultiSchemaClassesSpecification | MultiSchemaClassesSpecification[];\r\n\r\n /**\r\n * Specifies an [ECExpression]($docs/presentation/hierarchies/ECExpressions.md#instance-filter) for filtering\r\n * instances of ECClasses specified through the [[classes]] attribute.\r\n */\r\n instanceFilter?: string;\r\n}\r\n"]}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"NavigationRule.js","sourceRoot":"","sources":["../../../../../src/presentation-common/rules/hierarchy/NavigationRule.ts"],"names":[],"mappings":";AAAA;;;gGAGgG;AAChG,qDAAqD;AACrD;;GAEG","sourcesContent":["/*---------------------------------------------------------------------------------------------\n * Copyright (c) Bentley Systems, Incorporated. All rights reserved.\n * See LICENSE.md in the project root for license terms and full copyright notice.\n *--------------------------------------------------------------------------------------------*/\n/* eslint-disable @typescript-eslint/no-deprecated */\n/** @packageDocumentation\n * @module PresentationRules\n */\n\nimport { CustomizationRule } from \"../customization/CustomizationRule.js\";\nimport { RuleBase } from \"../Rule.js\";\nimport { ChildNodeRule } from \"./ChildNodeRule.js\";\nimport { ChildNodeSpecification } from \"./ChildNodeSpecification.js\";\nimport { RootNodeRule } from \"./RootNodeRule.js\";\nimport { SubCondition } from \"./SubCondition.js\";\n\n/**\n * Base class for all [[NavigationRule]] implementations.\n *\n * @see [Hierarchies reference documentation page]($docs/presentation/hierarchies/index.md)\n * @public\n * @deprecated in 5.2 - will not be removed until after 2026-10-01. Use the new [@itwin/presentation-hierarchies](https://github.com/iTwin/presentation/blob/master/packages/hierarchies/README.md)\n * package for creating hierarchies.\n */\nexport interface NavigationRuleBase extends RuleBase {\n /**\n * Defines a condition which needs to be met in order for the rule to be used. The condition is an\n * [ECExpression]($docs/presentation/hierarchies/ECExpressions.md#rule-condition) which has to evaluate\n * to a boolean value.\n */\n condition?: string;\n\n /**\n * A list of hierarchy specifications that define what nodes are going to be returned.\n */\n specifications?: ChildNodeSpecification[];\n\n /**\n * A list of [customization rules]($docs/presentation/hierarchies/index.md#hierarchy-customization) that\n * apply only to nodes produced by this rule.\n */\n customizationRules?: CustomizationRule[];\n\n /**\n * A list of sub-rules which share *placement attributes* and\n * [nested customization rules]($docs/presentation/hierarchies/ChildNodeRule.md#attribute-customizationrules)\n * of the hierarchy rule. This means the attributes of hierarchy rule are still in effect and the sub-rules\n * can add additional condition of their own.\n */\n subConditions?: SubCondition[];\n\n /**\n * Stop processing rules that have lower priority. Used in cases when recursion suppression is needed.\n */\n stopFurtherProcessing?: boolean;\n}\n\n/**\n * Navigation rules are used to define hierarchies displayed in tree components.\n *\n * @see [Hierarchies reference documentation page]($docs/presentation/hierarchies/index.md)\n * @public\n * @deprecated in 5.2 - will not be removed until after 2026-10-01. Use the new [@itwin/presentation-hierarchies](https://github.com/iTwin/presentation/blob/master/packages/hierarchies/README.md)\n * package for creating hierarchies.\n */\nexport type NavigationRule = RootNodeRule | ChildNodeRule;\n"]}
|
|
1
|
+
{"version":3,"file":"NavigationRule.js","sourceRoot":"","sources":["../../../../../src/presentation-common/rules/hierarchy/NavigationRule.ts"],"names":[],"mappings":";AAAA;;;gGAGgG;AAChG,qDAAqD;AACrD;;GAEG","sourcesContent":["/*---------------------------------------------------------------------------------------------\r\n * Copyright (c) Bentley Systems, Incorporated. All rights reserved.\r\n * See LICENSE.md in the project root for license terms and full copyright notice.\r\n *--------------------------------------------------------------------------------------------*/\r\n/* eslint-disable @typescript-eslint/no-deprecated */\r\n/** @packageDocumentation\r\n * @module PresentationRules\r\n */\r\n\r\nimport { CustomizationRule } from \"../customization/CustomizationRule.js\";\r\nimport { RuleBase } from \"../Rule.js\";\r\nimport { ChildNodeRule } from \"./ChildNodeRule.js\";\r\nimport { ChildNodeSpecification } from \"./ChildNodeSpecification.js\";\r\nimport { RootNodeRule } from \"./RootNodeRule.js\";\r\nimport { SubCondition } from \"./SubCondition.js\";\r\n\r\n/**\r\n * Base class for all [[NavigationRule]] implementations.\r\n *\r\n * @see [Hierarchies reference documentation page]($docs/presentation/hierarchies/index.md)\r\n * @public\r\n * @deprecated in 5.2 - will not be removed until after 2026-10-01. Use the new [@itwin/presentation-hierarchies](https://github.com/iTwin/presentation/blob/master/packages/hierarchies/README.md)\r\n * package for creating hierarchies.\r\n */\r\nexport interface NavigationRuleBase extends RuleBase {\r\n /**\r\n * Defines a condition which needs to be met in order for the rule to be used. The condition is an\r\n * [ECExpression]($docs/presentation/hierarchies/ECExpressions.md#rule-condition) which has to evaluate\r\n * to a boolean value.\r\n */\r\n condition?: string;\r\n\r\n /**\r\n * A list of hierarchy specifications that define what nodes are going to be returned.\r\n */\r\n specifications?: ChildNodeSpecification[];\r\n\r\n /**\r\n * A list of [customization rules]($docs/presentation/hierarchies/index.md#hierarchy-customization) that\r\n * apply only to nodes produced by this rule.\r\n */\r\n customizationRules?: CustomizationRule[];\r\n\r\n /**\r\n * A list of sub-rules which share *placement attributes* and\r\n * [nested customization rules]($docs/presentation/hierarchies/ChildNodeRule.md#attribute-customizationrules)\r\n * of the hierarchy rule. This means the attributes of hierarchy rule are still in effect and the sub-rules\r\n * can add additional condition of their own.\r\n */\r\n subConditions?: SubCondition[];\r\n\r\n /**\r\n * Stop processing rules that have lower priority. Used in cases when recursion suppression is needed.\r\n */\r\n stopFurtherProcessing?: boolean;\r\n}\r\n\r\n/**\r\n * Navigation rules are used to define hierarchies displayed in tree components.\r\n *\r\n * @see [Hierarchies reference documentation page]($docs/presentation/hierarchies/index.md)\r\n * @public\r\n * @deprecated in 5.2 - will not be removed until after 2026-10-01. Use the new [@itwin/presentation-hierarchies](https://github.com/iTwin/presentation/blob/master/packages/hierarchies/README.md)\r\n * package for creating hierarchies.\r\n */\r\nexport type NavigationRule = RootNodeRule | ChildNodeRule;\r\n"]}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"NodeArtifactsRule.js","sourceRoot":"","sources":["../../../../../src/presentation-common/rules/hierarchy/NodeArtifactsRule.ts"],"names":[],"mappings":";AAAA;;;gGAGgG;AAChG;;GAEG","sourcesContent":["/*---------------------------------------------------------------------------------------------\n * Copyright (c) Bentley Systems, Incorporated. All rights reserved.\n * See LICENSE.md in the project root for license terms and full copyright notice.\n *--------------------------------------------------------------------------------------------*/\n/** @packageDocumentation\n * @module PresentationRules\n */\n\nimport { RuleBase } from \"../Rule.js\";\n\n/**\n * Node artifacts rules are used to create and assign artifacts to specific nodes. The artifacts can be\n * accessed when evaluating parent node's `hideExpression` to decide whether it should be hidden or not.\n *\n * @see [Node artifacts rule reference documentation page]($docs/presentation/hierarchies/NodeArtifactsRule.md)\n * @public\n * @deprecated in 5.2 - will not be removed until after 2026-10-01. Use the new [@itwin/presentation-hierarchies](https://github.com/iTwin/presentation/blob/master/packages/hierarchies/README.md)\n * package for creating hierarchies.\n */\nexport interface NodeArtifactsRule extends RuleBase {\n /** Used for serializing to JSON. */\n ruleType: \"NodeArtifacts\";\n\n /**\n * Specifies an [ECExpression]($docs/presentation/customization/ECExpressions.md#rule-condition) that\n * allows applying node artifacts based on evaluation result, e.g. by some property of the parent node.\n */\n condition?: string;\n\n /**\n * A map of [ECExpressions]($docs/presentation/hierarchies/ECExpressions.md#specification) whose evaluation results\n * are used as artifact values.\n */\n items: { [key: string]: string };\n}\n"]}
|
|
1
|
+
{"version":3,"file":"NodeArtifactsRule.js","sourceRoot":"","sources":["../../../../../src/presentation-common/rules/hierarchy/NodeArtifactsRule.ts"],"names":[],"mappings":";AAAA;;;gGAGgG;AAChG;;GAEG","sourcesContent":["/*---------------------------------------------------------------------------------------------\r\n * Copyright (c) Bentley Systems, Incorporated. All rights reserved.\r\n * See LICENSE.md in the project root for license terms and full copyright notice.\r\n *--------------------------------------------------------------------------------------------*/\r\n/** @packageDocumentation\r\n * @module PresentationRules\r\n */\r\n\r\nimport { RuleBase } from \"../Rule.js\";\r\n\r\n/**\r\n * Node artifacts rules are used to create and assign artifacts to specific nodes. The artifacts can be\r\n * accessed when evaluating parent node's `hideExpression` to decide whether it should be hidden or not.\r\n *\r\n * @see [Node artifacts rule reference documentation page]($docs/presentation/hierarchies/NodeArtifactsRule.md)\r\n * @public\r\n * @deprecated in 5.2 - will not be removed until after 2026-10-01. Use the new [@itwin/presentation-hierarchies](https://github.com/iTwin/presentation/blob/master/packages/hierarchies/README.md)\r\n * package for creating hierarchies.\r\n */\r\nexport interface NodeArtifactsRule extends RuleBase {\r\n /** Used for serializing to JSON. */\r\n ruleType: \"NodeArtifacts\";\r\n\r\n /**\r\n * Specifies an [ECExpression]($docs/presentation/customization/ECExpressions.md#rule-condition) that\r\n * allows applying node artifacts based on evaluation result, e.g. by some property of the parent node.\r\n */\r\n condition?: string;\r\n\r\n /**\r\n * A map of [ECExpressions]($docs/presentation/hierarchies/ECExpressions.md#specification) whose evaluation results\r\n * are used as artifact values.\r\n */\r\n items: { [key: string]: string };\r\n}\r\n"]}
|
package/lib/cjs/presentation-common/rules/hierarchy/RelatedInstanceNodesSpecification.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"RelatedInstanceNodesSpecification.js","sourceRoot":"","sources":["../../../../../src/presentation-common/rules/hierarchy/RelatedInstanceNodesSpecification.ts"],"names":[],"mappings":";AAAA;;;gGAGgG;AAChG,qDAAqD;AACrD;;GAEG","sourcesContent":["/*---------------------------------------------------------------------------------------------\n * Copyright (c) Bentley Systems, Incorporated. All rights reserved.\n * See LICENSE.md in the project root for license terms and full copyright notice.\n *--------------------------------------------------------------------------------------------*/\n/* eslint-disable @typescript-eslint/no-deprecated */\n/** @packageDocumentation\n * @module PresentationRules\n */\n\nimport { RepeatableRelationshipPathSpecification } from \"../RelationshipPathSpecification.js\";\nimport { ChildNodeSpecificationBase, DefaultGroupingPropertiesContainer } from \"./ChildNodeSpecification.js\";\n\n/**\n * Produces ECInstance nodes that are related to some source ECInstance. The source instance is determined\n * by traversing the hierarchy upwards until an ECInstance node is encountered.\n *\n * @see [Related instance nodes specification reference documentation page]($docs/presentation/hierarchies/RelatedInstanceNodes.md)\n * @public\n * @deprecated in 5.2 - will not be removed until after 2026-10-01. Use the new [@itwin/presentation-hierarchies](https://github.com/iTwin/presentation/blob/master/packages/hierarchies/README.md)\n * package for creating hierarchies.\n */\nexport interface RelatedInstanceNodesSpecification extends ChildNodeSpecificationBase, DefaultGroupingPropertiesContainer {\n /** Used for serializing to JSON. */\n specType: \"RelatedInstanceNodes\";\n\n /**\n * Specifies a chain of [relationship path specifications]($docs/presentation/RepeatableRelationshipPathSpecification.md)\n * that forms a path from a source instance to the output instances. When this array is empty, the specification produces\n * no results.\n */\n relationshipPaths: RepeatableRelationshipPathSpecification[];\n\n /**\n * Specifies an [ECExpression]($docs/presentation/hierarchies/ECExpressions.md#instance-filter) for filtering\n * instances of ECClasses targeted through the [[relationshipPaths]] attribute.\n */\n instanceFilter?: string;\n}\n"]}
|
|
1
|
+
{"version":3,"file":"RelatedInstanceNodesSpecification.js","sourceRoot":"","sources":["../../../../../src/presentation-common/rules/hierarchy/RelatedInstanceNodesSpecification.ts"],"names":[],"mappings":";AAAA;;;gGAGgG;AAChG,qDAAqD;AACrD;;GAEG","sourcesContent":["/*---------------------------------------------------------------------------------------------\r\n * Copyright (c) Bentley Systems, Incorporated. All rights reserved.\r\n * See LICENSE.md in the project root for license terms and full copyright notice.\r\n *--------------------------------------------------------------------------------------------*/\r\n/* eslint-disable @typescript-eslint/no-deprecated */\r\n/** @packageDocumentation\r\n * @module PresentationRules\r\n */\r\n\r\nimport { RepeatableRelationshipPathSpecification } from \"../RelationshipPathSpecification.js\";\r\nimport { ChildNodeSpecificationBase, DefaultGroupingPropertiesContainer } from \"./ChildNodeSpecification.js\";\r\n\r\n/**\r\n * Produces ECInstance nodes that are related to some source ECInstance. The source instance is determined\r\n * by traversing the hierarchy upwards until an ECInstance node is encountered.\r\n *\r\n * @see [Related instance nodes specification reference documentation page]($docs/presentation/hierarchies/RelatedInstanceNodes.md)\r\n * @public\r\n * @deprecated in 5.2 - will not be removed until after 2026-10-01. Use the new [@itwin/presentation-hierarchies](https://github.com/iTwin/presentation/blob/master/packages/hierarchies/README.md)\r\n * package for creating hierarchies.\r\n */\r\nexport interface RelatedInstanceNodesSpecification extends ChildNodeSpecificationBase, DefaultGroupingPropertiesContainer {\r\n /** Used for serializing to JSON. */\r\n specType: \"RelatedInstanceNodes\";\r\n\r\n /**\r\n * Specifies a chain of [relationship path specifications]($docs/presentation/RepeatableRelationshipPathSpecification.md)\r\n * that forms a path from a source instance to the output instances. When this array is empty, the specification produces\r\n * no results.\r\n */\r\n relationshipPaths: RepeatableRelationshipPathSpecification[];\r\n\r\n /**\r\n * Specifies an [ECExpression]($docs/presentation/hierarchies/ECExpressions.md#instance-filter) for filtering\r\n * instances of ECClasses targeted through the [[relationshipPaths]] attribute.\r\n */\r\n instanceFilter?: string;\r\n}\r\n"]}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"RootNodeRule.js","sourceRoot":"","sources":["../../../../../src/presentation-common/rules/hierarchy/RootNodeRule.ts"],"names":[],"mappings":";AAAA;;;gGAGgG;AAChG,qDAAqD;AACrD;;GAEG","sourcesContent":["/*---------------------------------------------------------------------------------------------\n * Copyright (c) Bentley Systems, Incorporated. All rights reserved.\n * See LICENSE.md in the project root for license terms and full copyright notice.\n *--------------------------------------------------------------------------------------------*/\n/* eslint-disable @typescript-eslint/no-deprecated */\n/** @packageDocumentation\n * @module PresentationRules\n */\n\nimport { NavigationRuleBase } from \"./NavigationRule.js\";\n\n/**\n * Root node rules are used to define nodes that are displayed at the root hierarchy level.\n *\n * @see [Root node rule reference documentation page]($docs/presentation/hierarchies/RootNodeRule.md)\n * @public\n * @deprecated in 5.2 - will not be removed until after 2026-10-01. Use the new [@itwin/presentation-hierarchies](https://github.com/iTwin/presentation/blob/master/packages/hierarchies/README.md)\n * package for creating hierarchies.\n */\nexport interface RootNodeRule extends NavigationRuleBase {\n /** Used for serializing to JSON. */\n ruleType: \"RootNodes\";\n\n /** Tells the library to assign produced nodes a flag, indicating that they should be automatically expanded. */\n autoExpand?: boolean;\n}\n"]}
|
|
1
|
+
{"version":3,"file":"RootNodeRule.js","sourceRoot":"","sources":["../../../../../src/presentation-common/rules/hierarchy/RootNodeRule.ts"],"names":[],"mappings":";AAAA;;;gGAGgG;AAChG,qDAAqD;AACrD;;GAEG","sourcesContent":["/*---------------------------------------------------------------------------------------------\r\n * Copyright (c) Bentley Systems, Incorporated. All rights reserved.\r\n * See LICENSE.md in the project root for license terms and full copyright notice.\r\n *--------------------------------------------------------------------------------------------*/\r\n/* eslint-disable @typescript-eslint/no-deprecated */\r\n/** @packageDocumentation\r\n * @module PresentationRules\r\n */\r\n\r\nimport { NavigationRuleBase } from \"./NavigationRule.js\";\r\n\r\n/**\r\n * Root node rules are used to define nodes that are displayed at the root hierarchy level.\r\n *\r\n * @see [Root node rule reference documentation page]($docs/presentation/hierarchies/RootNodeRule.md)\r\n * @public\r\n * @deprecated in 5.2 - will not be removed until after 2026-10-01. Use the new [@itwin/presentation-hierarchies](https://github.com/iTwin/presentation/blob/master/packages/hierarchies/README.md)\r\n * package for creating hierarchies.\r\n */\r\nexport interface RootNodeRule extends NavigationRuleBase {\r\n /** Used for serializing to JSON. */\r\n ruleType: \"RootNodes\";\r\n\r\n /** Tells the library to assign produced nodes a flag, indicating that they should be automatically expanded. */\r\n autoExpand?: boolean;\r\n}\r\n"]}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"SubCondition.js","sourceRoot":"","sources":["../../../../../src/presentation-common/rules/hierarchy/SubCondition.ts"],"names":[],"mappings":";AAAA;;;gGAGgG;AAChG,qDAAqD;AACrD;;GAEG","sourcesContent":["/*---------------------------------------------------------------------------------------------\n * Copyright (c) Bentley Systems, Incorporated. All rights reserved.\n * See LICENSE.md in the project root for license terms and full copyright notice.\n *--------------------------------------------------------------------------------------------*/\n/* eslint-disable @typescript-eslint/no-deprecated */\n/** @packageDocumentation\n * @module PresentationRules\n */\n\nimport { RequiredSchemaSpecification } from \"../SchemasSpecification.js\";\nimport { ChildNodeSpecification } from \"./ChildNodeSpecification.js\";\n\n/**\n * This is a sub-rule which shares *placement attributes* and\n * [nested customization rules]($docs/presentation/hierarchies/ChildNodeRule.md#attribute-customizationrules)\n * of the hierarchy rule. This means the attributes of hierarchy rule are still in effect and the sub-rules\n * can add additional condition of their own.\n *\n * @see [Sub-conditions reference documentation section]($docs/presentation/hierarchies/ChildNodeRule.md#attribute-subconditions)\n * @public\n * @deprecated in 5.2 - will not be removed until after 2026-10-01. Use the new [@itwin/presentation-hierarchies](https://github.com/iTwin/presentation/blob/master/packages/hierarchies/README.md)\n * package for creating hierarchies.\n */\nexport interface SubCondition {\n /**\n * Defines a condition which needs to be met in order for the rule to be used. The condition is an\n * [ECExpression]($docs/presentation/hierarchies/ECExpressions.md#rule-condition) which has to evaluate\n * to a boolean value.\n */\n condition?: string;\n\n /**\n * Specifications that define [ECSchema requirements]($docs/presentation/RequiredSchemaSpecification.md) for\n * the rule to take effect.\n */\n requiredSchemas?: RequiredSchemaSpecification[];\n\n /**\n * A list of nested sub-rules which share *placement attributes* of this sub-condition. This means the\n * attributes of this sub-condition are still in effect and the sub-rules can add additional condition\n * of their own.\n */\n subConditions?: SubCondition[];\n\n /** A list of hierarchy specifications that define what nodes are going to be returned. */\n specifications?: ChildNodeSpecification[];\n}\n"]}
|
|
1
|
+
{"version":3,"file":"SubCondition.js","sourceRoot":"","sources":["../../../../../src/presentation-common/rules/hierarchy/SubCondition.ts"],"names":[],"mappings":";AAAA;;;gGAGgG;AAChG,qDAAqD;AACrD;;GAEG","sourcesContent":["/*---------------------------------------------------------------------------------------------\r\n * Copyright (c) Bentley Systems, Incorporated. All rights reserved.\r\n * See LICENSE.md in the project root for license terms and full copyright notice.\r\n *--------------------------------------------------------------------------------------------*/\r\n/* eslint-disable @typescript-eslint/no-deprecated */\r\n/** @packageDocumentation\r\n * @module PresentationRules\r\n */\r\n\r\nimport { RequiredSchemaSpecification } from \"../SchemasSpecification.js\";\r\nimport { ChildNodeSpecification } from \"./ChildNodeSpecification.js\";\r\n\r\n/**\r\n * This is a sub-rule which shares *placement attributes* and\r\n * [nested customization rules]($docs/presentation/hierarchies/ChildNodeRule.md#attribute-customizationrules)\r\n * of the hierarchy rule. This means the attributes of hierarchy rule are still in effect and the sub-rules\r\n * can add additional condition of their own.\r\n *\r\n * @see [Sub-conditions reference documentation section]($docs/presentation/hierarchies/ChildNodeRule.md#attribute-subconditions)\r\n * @public\r\n * @deprecated in 5.2 - will not be removed until after 2026-10-01. Use the new [@itwin/presentation-hierarchies](https://github.com/iTwin/presentation/blob/master/packages/hierarchies/README.md)\r\n * package for creating hierarchies.\r\n */\r\nexport interface SubCondition {\r\n /**\r\n * Defines a condition which needs to be met in order for the rule to be used. The condition is an\r\n * [ECExpression]($docs/presentation/hierarchies/ECExpressions.md#rule-condition) which has to evaluate\r\n * to a boolean value.\r\n */\r\n condition?: string;\r\n\r\n /**\r\n * Specifications that define [ECSchema requirements]($docs/presentation/RequiredSchemaSpecification.md) for\r\n * the rule to take effect.\r\n */\r\n requiredSchemas?: RequiredSchemaSpecification[];\r\n\r\n /**\r\n * A list of nested sub-rules which share *placement attributes* of this sub-condition. This means the\r\n * attributes of this sub-condition are still in effect and the sub-rules can add additional condition\r\n * of their own.\r\n */\r\n subConditions?: SubCondition[];\r\n\r\n /** A list of hierarchy specifications that define what nodes are going to be returned. */\r\n specifications?: ChildNodeSpecification[];\r\n}\r\n"]}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"SelectionScope.js","sourceRoot":"","sources":["../../../../src/presentation-common/selection/SelectionScope.ts"],"names":[],"mappings":";AAAA;;;gGAGgG;AAChG,qDAAqD;AACrD;;GAEG","sourcesContent":["/*---------------------------------------------------------------------------------------------\n * Copyright (c) Bentley Systems, Incorporated. All rights reserved.\n * See LICENSE.md in the project root for license terms and full copyright notice.\n *--------------------------------------------------------------------------------------------*/\n/* eslint-disable @typescript-eslint/no-deprecated */\n/** @packageDocumentation\n * @module UnifiedSelection\n */\n\n/**\n * Data structure that describes a [selection scope]($docs/presentation/unified-selection/index#selection-scopes).\n * @public\n * @deprecated in 5.0 - will not be removed until after 2026-06-13. Use `Props<typeof computeSelection>[\"scope\"]` from [@itwin/unified-selection](https://github.com/iTwin/presentation/blob/master/packages/unified-selection/README.md#selection-scopes) package instead.\n */\nexport interface SelectionScope {\n /** Unique ID of the selection scope */\n id: string;\n /** Label */\n label: string;\n /** Description */\n description?: string;\n}\n\n/**\n * A data structure that defines properties for applying element selection scope.\n * @public\n * @deprecated in 5.0 - will not be removed until after 2026-06-13. Use `Props<typeof computeSelection>[\"scope\"]` from [@itwin/unified-selection](https://github.com/iTwin/presentation/blob/master/packages/unified-selection/README.md#selection-scopes) package instead.\n */\nexport interface ElementSelectionScopeProps {\n /** Identifies this as the \"element\" selection scope */\n id: \"element\";\n /**\n * Specifies how far \"up\" we should walk to find the target element. When not specified or `0`,\n * the target element matches the request element. When `1`, the target element matches the direct parent element.\n * When `2`, the target element is parent of the parent element and so on. In all situations when this is `> 0`,\n * we're not walking further than the last existing element, for example when `ancestorLevel = 1` (direct parent\n * element is requested), but the request element doesn't have a parent, the request element is returned as the result.\n */\n ancestorLevel?: number;\n}\n\n/**\n * A data structure that defines properties for applying a selection scope.\n * @public\n * @deprecated in 5.0 - will not be removed until after 2026-06-13. Use `Props<typeof computeSelection>[\"scope\"]` from [@itwin/unified-selection](https://github.com/iTwin/presentation/blob/master/packages/unified-selection/README.md#selection-scopes) package instead.\n */\nexport type SelectionScopeProps = ElementSelectionScopeProps | { id: string };\n"]}
|
|
1
|
+
{"version":3,"file":"SelectionScope.js","sourceRoot":"","sources":["../../../../src/presentation-common/selection/SelectionScope.ts"],"names":[],"mappings":";AAAA;;;gGAGgG;AAChG,qDAAqD;AACrD;;GAEG","sourcesContent":["/*---------------------------------------------------------------------------------------------\r\n * Copyright (c) Bentley Systems, Incorporated. All rights reserved.\r\n * See LICENSE.md in the project root for license terms and full copyright notice.\r\n *--------------------------------------------------------------------------------------------*/\r\n/* eslint-disable @typescript-eslint/no-deprecated */\r\n/** @packageDocumentation\r\n * @module UnifiedSelection\r\n */\r\n\r\n/**\r\n * Data structure that describes a [selection scope]($docs/presentation/unified-selection/index#selection-scopes).\r\n * @public\r\n * @deprecated in 5.0 - will not be removed until after 2026-06-13. Use `Props<typeof computeSelection>[\"scope\"]` from [@itwin/unified-selection](https://github.com/iTwin/presentation/blob/master/packages/unified-selection/README.md#selection-scopes) package instead.\r\n */\r\nexport interface SelectionScope {\r\n /** Unique ID of the selection scope */\r\n id: string;\r\n /** Label */\r\n label: string;\r\n /** Description */\r\n description?: string;\r\n}\r\n\r\n/**\r\n * A data structure that defines properties for applying element selection scope.\r\n * @public\r\n * @deprecated in 5.0 - will not be removed until after 2026-06-13. Use `Props<typeof computeSelection>[\"scope\"]` from [@itwin/unified-selection](https://github.com/iTwin/presentation/blob/master/packages/unified-selection/README.md#selection-scopes) package instead.\r\n */\r\nexport interface ElementSelectionScopeProps {\r\n /** Identifies this as the \"element\" selection scope */\r\n id: \"element\";\r\n /**\r\n * Specifies how far \"up\" we should walk to find the target element. When not specified or `0`,\r\n * the target element matches the request element. When `1`, the target element matches the direct parent element.\r\n * When `2`, the target element is parent of the parent element and so on. In all situations when this is `> 0`,\r\n * we're not walking further than the last existing element, for example when `ancestorLevel = 1` (direct parent\r\n * element is requested), but the request element doesn't have a parent, the request element is returned as the result.\r\n */\r\n ancestorLevel?: number;\r\n}\r\n\r\n/**\r\n * A data structure that defines properties for applying a selection scope.\r\n * @public\r\n * @deprecated in 5.0 - will not be removed until after 2026-06-13. Use `Props<typeof computeSelection>[\"scope\"]` from [@itwin/unified-selection](https://github.com/iTwin/presentation/blob/master/packages/unified-selection/README.md#selection-scopes) package instead.\r\n */\r\nexport type SelectionScopeProps = ElementSelectionScopeProps | { id: string };\r\n"]}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"presentation-common-internal.js","sourceRoot":"","sources":["../../src/presentation-common-internal.ts"],"names":[],"mappings":";AAAA;;;gGAGgG;;;AAEhG,6IAA6I;AAC7I,qHAAqH;AAErH,iGAAmJ;AAA1I,4IAAA,6BAA6B,OAAA;AAAE,oIAAA,qBAAqB,OAAA;AAC7D,uEAAkH;AAAzG,8HAAA,4BAA4B,OAAA;AAAE,8HAAA,4BAA4B,OAAA;AACnE,mFAA4F;AAAnF,sIAAA,8BAA8B,OAAA;AACvC,2DAA8G;AAArG,2HAAA,+BAA+B,OAAA;AAAE,uHAAA,2BAA2B,OAAA;AACrE,qFAAiF;AAAxE,2HAAA,kBAAkB,OAAA;AAC3B,qGAA8G;AAArG,wJAAA,uCAAuC,OAAA;AAChD,qFAAiF;AAAxE,2HAAA,kBAAkB,OAAA;AAC3B,qEAAwE;AAA/D,kHAAA,iBAAiB,OAAA","sourcesContent":["/*---------------------------------------------------------------------------------------------\n * Copyright (c) Bentley Systems, Incorporated. All rights reserved.\n * See LICENSE.md in the project root for license terms and full copyright notice.\n *--------------------------------------------------------------------------------------------*/\n\n// WARNING: This barrel file exports internal APIs only for use by `@itwin/presentation-backend` and `@itwin/presentation-frontend` packages.\n// They should not be used outside of these packages. These APIs may be broken or removed at any time without notice.\n\nexport { PRESENTATION_IPC_CHANNEL_NAME, PresentationIpcEvents, PresentationIpcInterface } from \"./presentation-common/PresentationIpcInterface.js\";\nexport { combineDiagnosticsSeverities, compareDiagnosticsSeverities } from \"./presentation-common/Diagnostics.js\";\nexport { createElementPropertiesBuilder } from \"./presentation-common/ElementProperties.js\";\nexport { createCancellableTimeoutPromise, deepReplaceNullsToUndefined } from \"./presentation-common/Utils.js\";\nexport { LocalizationHelper } from \"./presentation-common/LocalizationHelper.js\";\nexport { isSingleElementPropertiesRequestOptions } from \"./presentation-common/PresentationManagerOptions.js\";\nexport { RpcRequestsHandler } from \"./presentation-common/RpcRequestsHandler.js\";\nexport { AsyncTasksTracker } from \"./presentation-common/AsyncTasks.js\";\n"]}
|
|
1
|
+
{"version":3,"file":"presentation-common-internal.js","sourceRoot":"","sources":["../../src/presentation-common-internal.ts"],"names":[],"mappings":";AAAA;;;gGAGgG;;;AAEhG,6IAA6I;AAC7I,qHAAqH;AAErH,iGAAmJ;AAA1I,4IAAA,6BAA6B,OAAA;AAAE,oIAAA,qBAAqB,OAAA;AAC7D,uEAAkH;AAAzG,8HAAA,4BAA4B,OAAA;AAAE,8HAAA,4BAA4B,OAAA;AACnE,mFAA4F;AAAnF,sIAAA,8BAA8B,OAAA;AACvC,2DAA8G;AAArG,2HAAA,+BAA+B,OAAA;AAAE,uHAAA,2BAA2B,OAAA;AACrE,qFAAiF;AAAxE,2HAAA,kBAAkB,OAAA;AAC3B,qGAA8G;AAArG,wJAAA,uCAAuC,OAAA;AAChD,qFAAiF;AAAxE,2HAAA,kBAAkB,OAAA;AAC3B,qEAAwE;AAA/D,kHAAA,iBAAiB,OAAA","sourcesContent":["/*---------------------------------------------------------------------------------------------\r\n * Copyright (c) Bentley Systems, Incorporated. All rights reserved.\r\n * See LICENSE.md in the project root for license terms and full copyright notice.\r\n *--------------------------------------------------------------------------------------------*/\r\n\r\n// WARNING: This barrel file exports internal APIs only for use by `@itwin/presentation-backend` and `@itwin/presentation-frontend` packages.\r\n// They should not be used outside of these packages. These APIs may be broken or removed at any time without notice.\r\n\r\nexport { PRESENTATION_IPC_CHANNEL_NAME, PresentationIpcEvents, PresentationIpcInterface } from \"./presentation-common/PresentationIpcInterface.js\";\r\nexport { combineDiagnosticsSeverities, compareDiagnosticsSeverities } from \"./presentation-common/Diagnostics.js\";\r\nexport { createElementPropertiesBuilder } from \"./presentation-common/ElementProperties.js\";\r\nexport { createCancellableTimeoutPromise, deepReplaceNullsToUndefined } from \"./presentation-common/Utils.js\";\r\nexport { LocalizationHelper } from \"./presentation-common/LocalizationHelper.js\";\r\nexport { isSingleElementPropertiesRequestOptions } from \"./presentation-common/PresentationManagerOptions.js\";\r\nexport { RpcRequestsHandler } from \"./presentation-common/RpcRequestsHandler.js\";\r\nexport { AsyncTasksTracker } from \"./presentation-common/AsyncTasks.js\";\r\n"]}
|