@itwin/presentation-common 3.2.0-dev.7 → 3.2.0-dev.72

package/lib/cjs/presentation-common/rules/content/modifiers/RelatedPropertiesSpecification.d.ts

@@ -4,20 +4,18 @@
 import { RelationshipPathSpecification } from "../../RelationshipPathSpecification";
 import { PropertySpecification } from "../PropertySpecification";
 /**
- * Meaning of the relationship
+ * Meaning of the relationship.
  * @public
  */
 export declare enum RelationshipMeaning {
     /**
-     * Related instance is part of the primary instance. Related properties
-     * with this meaning are displayed in UI as if they belonged to the
-     * primary instance.
+     * The properties should be displayed as if they belonged to the [primary instance]($docs/presentation/content/Terminology.md#primary-instance).
+     * Generally that means they assigned a category, that's nested under the default category.
      */
     SameInstance = "SameInstance",
     /**
-     * Related instance if not part of the primary instance - it should
-     * appear as related. UI components may display related instance properties
-     * differently, e.g. put them under a different category, etc.
+     * The properties should be distinguished from properties of the [primary instance]($docs/presentation/content/Terminology.md#primary-instance)
+     * and shown separately to make it clear they belong to another instance. Generally that means they're assigned a separate root category.
      */
     RelatedInstance = "RelatedInstance"
 }
@@ -37,45 +35,51 @@ export declare enum RelatedPropertiesSpecialValues {
     All = "*"
 }
 /**
- * Sub-specification to include additional related instance properties.
+ * This specification allows including related instance properties into the content.
  *
- * @see [More details]($docs/presentation/Content/RelatedPropertiesSpecification.md)
+ * @see [Related properties specification specification reference documentation page]($docs/presentation/content/RelatedPropertiesSpecification.md)
  * @public
  */
 export interface RelatedPropertiesSpecification {
     /**
-     * Relationship path from content class to properties' class.
+     * Specifies a chain of [relationship path specifications]($docs/presentation/RelationshipPathSpecification.md) that
+     * forms a path from the content instance to the related instance(s) whose properties should additionally be loaded.
      */
     propertiesSource: RelationshipPathSpecification;
     /**
-     * Should the target class specified in [[propertiesSource]] be handled
-     * polymorphically. This means properties of not only the target class, but also all its subclasses
-     * are loaded.
+     * Condition for filtering instances targeted by the [[propertiesSource]] attribute.
+     *
+     * **See:** [ECExpressions available in instance filter]($docs/presentation/Content/ECExpressions.md#instance-filter)
+     */
+    instanceFilter?: string;
+    /**
+     * The attribute tells whether the target class specified through [[propertiesSource]] should be handled
+     * polymorphically. This means properties of the concrete class are loaded in addition to properties of the
+     * target class itself.
      *
      * @note There's a difference between loading properties and instances polymorphically. This attribute
      * only controls polymorphism of properties, while instances are always looked up in a polymorphic fashion.
      */
     handleTargetClassPolymorphically?: boolean;
     /**
-     * Should field containing related properties be automatically expanded. This only takes effect when
-     * content class is related to properties source class through a one-to-many or many-to-many relationship.
+     * Should the field containing related properties be assigned the [[NestedContentField.autoExpand]]
+     * attribute. The attribute tells UI components showing the properties that they should be initially displayed in the expanded state.
      */
     autoExpand?: boolean;
     /**
-     * Should this related properties specification be ignored if it duplicates another higher priority specification for the same relationship.
+     * Specifies whether the specification should be ignored if another higher priority specification for the same relationship already exists.
      * @beta
      */
     skipIfDuplicate?: boolean;
     /**
-     * Meaning of the relationship which tells how to categorize the related properties. Defaults to [[RelationshipMeaning.RelatedInstance]].
-     * @see [More details]($docs/presentation/Content/RelatedPropertiesSpecification.md#attribute-relationshipmeaning)
+     * The attribute describes what the related properties mean to the [primary instance]($docs/presentation/content/Terminology.md#primary-instance)
+     * whose properties are displayed.
      */
     relationshipMeaning?: RelationshipMeaning;
-    /** Specifications for nested related properties */
+    /** The attribute allows loading additional related properties that are related to the target instance of this specification. */
     nestedRelatedProperties?: RelatedPropertiesSpecification[];
     /**
-     * A list of property names or specifications that should be included in the content. All
-     * properties are included if this attribute is not specified.
+     * List of names or definitions of related class properties that should be included in the content.
      */
     properties?: Array<string | PropertySpecification> | RelatedPropertiesSpecialValues;
 }

package/lib/cjs/presentation-common/rules/content/modifiers/RelatedPropertiesSpecification.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"RelatedPropertiesSpecification.d.ts","sourceRoot":"","sources":["../../../../../../src/presentation-common/rules/content/modifiers/RelatedPropertiesSpecification.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,EAAE,6BAA6B,EAAE,MAAM,qCAAqC,CAAC;AACpF,OAAO,EAAE,qBAAqB,EAAE,MAAM,0BAA0B,CAAC;AAEjE;;;GAGG;AACH,oBAAY,mBAAmB;IAC7B;;;;OAIG;IACH,YAAY,iBAAiB;IAE7B;;;;OAIG;IACH,eAAe,oBAAoB;CACpC;AAED;;;GAGG;AACH,oBAAY,8BAA8B;IACxC;;;OAGG;IACH,IAAI,WAAW;IAEf;;OAEG;IACH,GAAG,MAAM;CACV;AAED;;;;;GAKG;AACH,MAAM,WAAW,8BAA8B;IAC7C;;OAEG;IACH,gBAAgB,EAAE,6BAA6B,CAAC;IAEhD;;;;;;;OAOG;IACH,gCAAgC,CAAC,EAAE,OAAO,CAAC;IAE3C;;;OAGG;IACH,UAAU,CAAC,EAAE,OAAO,CAAC;IAErB;;;OAGG;IACH,eAAe,CAAC,EAAE,OAAO,CAAC;IAE1B;;;OAGG;IACH,mBAAmB,CAAC,EAAE,mBAAmB,CAAC;IAE1C,mDAAmD;IACnD,uBAAuB,CAAC,EAAE,8BAA8B,EAAE,CAAC;IAE3D;;;OAGG;IACH,UAAU,CAAC,EAAE,KAAK,CAAC,MAAM,GAAG,qBAAqB,CAAC,GAAG,8BAA8B,CAAC;CACrF"}
+{"version":3,"file":"RelatedPropertiesSpecification.d.ts","sourceRoot":"","sources":["../../../../../../src/presentation-common/rules/content/modifiers/RelatedPropertiesSpecification.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,EAAE,6BAA6B,EAAE,MAAM,qCAAqC,CAAC;AACpF,OAAO,EAAE,qBAAqB,EAAE,MAAM,0BAA0B,CAAC;AAEjE;;;GAGG;AACH,oBAAY,mBAAmB;IAC7B;;;OAGG;IACH,YAAY,iBAAiB;IAE7B;;;OAGG;IACH,eAAe,oBAAoB;CACpC;AAED;;;GAGG;AACH,oBAAY,8BAA8B;IACxC;;;OAGG;IACH,IAAI,WAAW;IAEf;;OAEG;IACH,GAAG,MAAM;CACV;AAED;;;;;GAKG;AACH,MAAM,WAAW,8BAA8B;IAC7C;;;OAGG;IACH,gBAAgB,EAAE,6BAA6B,CAAC;IAEhD;;;;OAIG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;IAExB;;;;;;;OAOG;IACH,gCAAgC,CAAC,EAAE,OAAO,CAAC;IAE3C;;;OAGG;IACH,UAAU,CAAC,EAAE,OAAO,CAAC;IAErB;;;OAGG;IACH,eAAe,CAAC,EAAE,OAAO,CAAC;IAE1B;;;OAGG;IACH,mBAAmB,CAAC,EAAE,mBAAmB,CAAC;IAE1C,gIAAgI;IAChI,uBAAuB,CAAC,EAAE,8BAA8B,EAAE,CAAC;IAE3D;;OAEG;IACH,UAAU,CAAC,EAAE,KAAK,CAAC,MAAM,GAAG,qBAAqB,CAAC,GAAG,8BAA8B,CAAC;CACrF"}

package/lib/cjs/presentation-common/rules/content/modifiers/RelatedPropertiesSpecification.js

@@ -9,21 +9,19 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.RelatedPropertiesSpecialValues = exports.RelationshipMeaning = void 0;
 /**
- * Meaning of the relationship
+ * Meaning of the relationship.
  * @public
  */
 var RelationshipMeaning;
 (function (RelationshipMeaning) {
     /**
-     * Related instance is part of the primary instance. Related properties
-     * with this meaning are displayed in UI as if they belonged to the
-     * primary instance.
+     * The properties should be displayed as if they belonged to the [primary instance]($docs/presentation/content/Terminology.md#primary-instance).
+     * Generally that means they assigned a category, that's nested under the default category.
      */
     RelationshipMeaning["SameInstance"] = "SameInstance";
     /**
-     * Related instance if not part of the primary instance - it should
-     * appear as related. UI components may display related instance properties
-     * differently, e.g. put them under a different category, etc.
+     * The properties should be distinguished from properties of the [primary instance]($docs/presentation/content/Terminology.md#primary-instance)
+     * and shown separately to make it clear they belong to another instance. Generally that means they're assigned a separate root category.
      */
     RelationshipMeaning["RelatedInstance"] = "RelatedInstance";
 })(RelationshipMeaning = exports.RelationshipMeaning || (exports.RelationshipMeaning = {}));

package/lib/cjs/presentation-common/rules/content/modifiers/RelatedPropertiesSpecification.js.map

@@ -1 +1 @@
-{"version":3,"file":"RelatedPropertiesSpecification.js","sourceRoot":"","sources":["../../../../../../src/presentation-common/rules/content/modifiers/RelatedPropertiesSpecification.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AAKH;;;GAGG;AACH,IAAY,mBAcX;AAdD,WAAY,mBAAmB;IAC7B;;;;OAIG;IACH,oDAA6B,CAAA;IAE7B;;;;OAIG;IACH,0DAAmC,CAAA;AACrC,CAAC,EAdW,mBAAmB,GAAnB,2BAAmB,KAAnB,2BAAmB,QAc9B;AAED;;;GAGG;AACH,IAAY,8BAWX;AAXD,WAAY,8BAA8B;IACxC;;;OAGG;IACH,iDAAe,CAAA;IAEf;;OAEG;IACH,2CAAS,CAAA;AACX,CAAC,EAXW,8BAA8B,GAA9B,sCAA8B,KAA9B,sCAA8B,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\";\r\nimport { PropertySpecification } from \"../PropertySpecification\";\r\n\r\n/**\r\n * Meaning of the relationship\r\n * @public\r\n */\r\nexport enum RelationshipMeaning {\r\n  /**\r\n   * Related instance is part of the primary instance. Related properties\r\n   * with this meaning are displayed in UI as if they belonged to the\r\n   * primary instance.\r\n   */\r\n  SameInstance = \"SameInstance\",\r\n\r\n  /**\r\n   * Related instance if not part of the primary instance - it should\r\n   * appear as related. UI components may display related instance properties\r\n   * differently, e.g. put them under a different category, etc.\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 * Sub-specification to include additional related instance properties.\r\n *\r\n * @see [More details]($docs/presentation/Content/RelatedPropertiesSpecification.md)\r\n * @public\r\n */\r\nexport interface RelatedPropertiesSpecification {\r\n  /**\r\n   * Relationship path from content class to properties' class.\r\n   */\r\n  propertiesSource: RelationshipPathSpecification;\r\n\r\n  /**\r\n   * Should the target class specified in [[propertiesSource]] be handled\r\n   * polymorphically. This means properties of not only the target class, but also all its subclasses\r\n   * are loaded.\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 field containing related properties be automatically expanded. This only takes effect when\r\n   * content class is related to properties source class through a one-to-many or many-to-many relationship.\r\n   */\r\n  autoExpand?: boolean;\r\n\r\n  /**\r\n   * Should this related properties specification be ignored if it duplicates another higher priority specification for the same relationship.\r\n   * @beta\r\n   */\r\n  skipIfDuplicate?: boolean;\r\n\r\n  /**\r\n   * Meaning of the relationship which tells how to categorize the related properties. Defaults to [[RelationshipMeaning.RelatedInstance]].\r\n   * @see [More details]($docs/presentation/Content/RelatedPropertiesSpecification.md#attribute-relationshipmeaning)\r\n   */\r\n  relationshipMeaning?: RelationshipMeaning;\r\n\r\n  /** Specifications for nested related properties */\r\n  nestedRelatedProperties?: RelatedPropertiesSpecification[];\r\n\r\n  /**\r\n   * A list of property names or specifications that should be included in the content. All\r\n   * properties are included if this attribute is not specified.\r\n   */\r\n  properties?: Array<string | PropertySpecification> | RelatedPropertiesSpecialValues;\r\n}\r\n"]}
+{"version":3,"file":"RelatedPropertiesSpecification.js","sourceRoot":"","sources":["../../../../../../src/presentation-common/rules/content/modifiers/RelatedPropertiesSpecification.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AAKH;;;GAGG;AACH,IAAY,mBAYX;AAZD,WAAY,mBAAmB;IAC7B;;;OAGG;IACH,oDAA6B,CAAA;IAE7B;;;OAGG;IACH,0DAAmC,CAAA;AACrC,CAAC,EAZW,mBAAmB,GAAnB,2BAAmB,KAAnB,2BAAmB,QAY9B;AAED;;;GAGG;AACH,IAAY,8BAWX;AAXD,WAAY,8BAA8B;IACxC;;;OAGG;IACH,iDAAe,CAAA;IAEf;;OAEG;IACH,2CAAS,CAAA;AACX,CAAC,EAXW,8BAA8B,GAA9B,sCAA8B,KAA9B,sCAA8B,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\";\r\nimport { PropertySpecification } from \"../PropertySpecification\";\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   * @beta\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   */\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   */\r\n  properties?: Array<string | PropertySpecification> | RelatedPropertiesSpecialValues;\r\n}\r\n"]}

package/lib/cjs/presentation-common/rules/customization/CheckBoxRule.d.ts

@@ -1,28 +1,26 @@
 /** @packageDocumentation
  * @module PresentationRules
  */
-import { ConditionContainer, RuleBase, RuleTypes } from "../Rule";
+import { RuleBase, RuleTypes } from "../Rule";
 /**
- * Rule that allows configuring check boxes for certain nodes.
+ * CheckBox rules provide a way to create a checkbox for specific types of ECInstance's.
  *
- * Is also allows binding check box state with boolean properties by setting [[propertyName]] parameter.
- * If [[propertyName]] is not set, then [[defaultValue]] is used for default check box state.
- *
- * @see [More details]($docs/presentation/Customization/CheckBoxRule.md)
+ * @see [CheckBox rule reference documentation page]($docs/presentation/customization/CheckBoxRule.md)
  * @public
+ * @deprecated Use [[ExtendedDataRule]] instead. See [extended data usage page]($docs/presentation/customization/ExtendedDataUsage.md) for more details.
  */
-export interface CheckBoxRule extends RuleBase, ConditionContainer {
+export interface CheckBoxRule extends RuleBase {
     /** Used for serializing to JSON. */
     ruleType: RuleTypes.CheckBox;
     /**
      * Defines a condition for the rule, which needs to be met in order to execute it. Condition
-     * is an [ECExpression]($docs/presentation/Advanced/ECExpressions.md), which can use
+     * is an [ECExpression]($docs/presentation/advanced/ECExpressions.md), which can use
      * a [limited set of symbols]($docs/presentation/customization/ECExpressions.md#rule-condition).
      */
     condition?: string;
     /**
-     * Name of boolean type ECProperty which is bound with the check box state. When set,
-     * property value gets bound to checkbox state.
+     * Name of boolean type ECProperty which is bound with the check box state. When set, property
+     * value gets bound to checkbox state.
      *
      * @minLength 1
      */

package/lib/cjs/presentation-common/rules/customization/CheckBoxRule.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"CheckBoxRule.d.ts","sourceRoot":"","sources":["../../../../../src/presentation-common/rules/customization/CheckBoxRule.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,EAAE,kBAAkB,EAAE,QAAQ,EAAE,SAAS,EAAE,MAAM,SAAS,CAAC;AAElE;;;;;;;;GAQG;AACH,MAAM,WAAW,YAAa,SAAQ,QAAQ,EAAE,kBAAkB;IAChE,oCAAoC;IACpC,QAAQ,EAAE,SAAS,CAAC,QAAQ,CAAC;IAE7B;;;;OAIG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB;;;;;OAKG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IAEtB;;;;OAIG;IACH,wBAAwB,CAAC,EAAE,OAAO,CAAC;IAEnC;;;;OAIG;IACH,YAAY,CAAC,EAAE,OAAO,CAAC;IAEvB;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC;CAC9B"}
+{"version":3,"file":"CheckBoxRule.d.ts","sourceRoot":"","sources":["../../../../../src/presentation-common/rules/customization/CheckBoxRule.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,EAAE,QAAQ,EAAE,SAAS,EAAE,MAAM,SAAS,CAAC;AAE9C;;;;;;GAMG;AACH,MAAM,WAAW,YAAa,SAAQ,QAAQ;IAC5C,oCAAoC;IACpC,QAAQ,EAAE,SAAS,CAAC,QAAQ,CAAC;IAE7B;;;;OAIG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB;;;;;OAKG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IAEtB;;;;OAIG;IACH,wBAAwB,CAAC,EAAE,OAAO,CAAC;IAEnC;;;;OAIG;IACH,YAAY,CAAC,EAAE,OAAO,CAAC;IAEvB;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC;CAC9B"}

package/lib/cjs/presentation-common/rules/customization/CheckBoxRule.js.map

@@ -1 +1 @@
-{"version":3,"file":"CheckBoxRule.js","sourceRoot":"","sources":["../../../../../src/presentation-common/rules/customization/CheckBoxRule.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;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 { ConditionContainer, RuleBase, RuleTypes } from \"../Rule\";\r\n\r\n/**\r\n * Rule that allows configuring check boxes for certain nodes.\r\n *\r\n * Is also allows binding check box state with boolean properties by setting [[propertyName]] parameter.\r\n * If [[propertyName]] is not set, then [[defaultValue]] is used for default check box state.\r\n *\r\n * @see [More details]($docs/presentation/Customization/CheckBoxRule.md)\r\n * @public\r\n */\r\nexport interface CheckBoxRule extends RuleBase, ConditionContainer {\r\n  /** Used for serializing to JSON. */\r\n  ruleType: RuleTypes.CheckBox;\r\n\r\n  /**\r\n   * Defines a condition for the rule, which needs to be met in order to execute it. Condition\r\n   * is an [ECExpression]($docs/presentation/Advanced/ECExpressions.md), which can use\r\n   * a [limited set of symbols]($docs/presentation/customization/ECExpressions.md#rule-condition).\r\n   */\r\n  condition?: string;\r\n\r\n  /**\r\n   * Name of boolean type ECProperty which is bound with the check box state. When set,\r\n   * property value gets bound to checkbox state.\r\n   *\r\n   * @minLength 1\r\n   */\r\n  propertyName?: string;\r\n\r\n  /**\r\n   * Should property value be inversed for the check box state.\r\n   *\r\n   * **Note:** Only makes sense when bound to an ECProperty.\r\n   */\r\n  useInversedPropertyValue?: boolean;\r\n\r\n  /**\r\n   * Default value to use for the check box state\r\n   *\r\n   * **Note:** Only makes sense when *not* bound to an ECProperty.\r\n   */\r\n  defaultValue?: boolean;\r\n\r\n  /**\r\n   * Indicates whether check box is enabled or disabled.\r\n   */\r\n  isEnabled?: string | boolean;\r\n}\r\n"]}
+{"version":3,"file":"CheckBoxRule.js","sourceRoot":"","sources":["../../../../../src/presentation-common/rules/customization/CheckBoxRule.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;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, RuleTypes } from \"../Rule\";\r\n\r\n/**\r\n * CheckBox rules provide a way to create a checkbox for specific types of ECInstance's.\r\n *\r\n * @see [CheckBox rule reference documentation page]($docs/presentation/customization/CheckBoxRule.md)\r\n * @public\r\n * @deprecated Use [[ExtendedDataRule]] instead. See [extended data usage page]($docs/presentation/customization/ExtendedDataUsage.md) for more details.\r\n */\r\nexport interface CheckBoxRule extends RuleBase {\r\n  /** Used for serializing to JSON. */\r\n  ruleType: RuleTypes.CheckBox;\r\n\r\n  /**\r\n   * Defines a condition for the rule, which needs to be met in order to execute it. Condition\r\n   * is an [ECExpression]($docs/presentation/advanced/ECExpressions.md), which can use\r\n   * a [limited set of symbols]($docs/presentation/customization/ECExpressions.md#rule-condition).\r\n   */\r\n  condition?: string;\r\n\r\n  /**\r\n   * Name of boolean type ECProperty which is bound with the check box state. When set, property\r\n   * value gets bound to checkbox state.\r\n   *\r\n   * @minLength 1\r\n   */\r\n  propertyName?: string;\r\n\r\n  /**\r\n   * Should property value be inversed for the check box state.\r\n   *\r\n   * **Note:** Only makes sense when bound to an ECProperty.\r\n   */\r\n  useInversedPropertyValue?: boolean;\r\n\r\n  /**\r\n   * Default value to use for the check box state\r\n   *\r\n   * **Note:** Only makes sense when *not* bound to an ECProperty.\r\n   */\r\n  defaultValue?: boolean;\r\n\r\n  /**\r\n   * Indicates whether check box is enabled or disabled.\r\n   */\r\n  isEnabled?: string | boolean;\r\n}\r\n"]}

package/lib/cjs/presentation-common/rules/customization/CustomizationRule.d.ts

@@ -12,7 +12,7 @@ import { SortingRule } from "./SortingRule";
 import { StyleOverride } from "./StyleOverride";
 /**
  * Customization rules allow customizing each node or content item separately.
- * Most of the rules have a `condition` property which uses [ECExpressions]($docs/presentation/Customization/ECExpressions.md)
+ * Most of the rules have a `condition` property which uses [ECExpressions]($docs/presentation/customization/ECExpressions.md)
  * for conditional rule filtering.
  *
  * **Nested customization rules:**
@@ -29,6 +29,9 @@ import { StyleOverride } from "./StyleOverride";
  *
  * @public
  */
-export declare type CustomizationRule = InstanceLabelOverride | CheckBoxRule | GroupingRule | ImageIdOverride | LabelOverride | // eslint-disable-line deprecation/deprecation
-SortingRule | StyleOverride | ExtendedDataRule | NodeArtifactsRule;
+export declare type CustomizationRule = InstanceLabelOverride | CheckBoxRule | // eslint-disable-line deprecation/deprecation
+GroupingRule | ImageIdOverride | // eslint-disable-line deprecation/deprecation
+LabelOverride | // eslint-disable-line deprecation/deprecation
+SortingRule | StyleOverride | // eslint-disable-line deprecation/deprecation
+ExtendedDataRule | NodeArtifactsRule;
 //# sourceMappingURL=CustomizationRule.d.ts.map

package/lib/cjs/presentation-common/rules/customization/CustomizationRule.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"CustomizationRule.d.ts","sourceRoot":"","sources":["../../../../../src/presentation-common/rules/customization/CustomizationRule.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,EAAE,iBAAiB,EAAE,MAAM,gCAAgC,CAAC;AACnE,OAAO,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAC;AAC9C,OAAO,EAAE,gBAAgB,EAAE,MAAM,oBAAoB,CAAC;AACtD,OAAO,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAC;AAC9C,OAAO,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAC;AACpD,OAAO,EAAE,qBAAqB,EAAE,MAAM,yBAAyB,CAAC;AAChE,OAAO,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAC;AAChD,OAAO,EAAE,WAAW,EAAE,MAAM,eAAe,CAAC;AAC5C,OAAO,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAC;AAEhD;;;;;;;;;;;;;;;;;;GAkBG;AACH,MAAM,CAAC,OAAO,MAAM,iBAAiB,GACnC,qBAAqB,GACrB,YAAY,GACZ,YAAY,GACZ,eAAe,GACf,aAAa,GAAG,8CAA8C;AAC9D,WAAW,GACX,aAAa,GACb,gBAAgB,GAChB,iBAAiB,CAAC"}
+{"version":3,"file":"CustomizationRule.d.ts","sourceRoot":"","sources":["../../../../../src/presentation-common/rules/customization/CustomizationRule.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,EAAE,iBAAiB,EAAE,MAAM,gCAAgC,CAAC;AACnE,OAAO,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAC;AAC9C,OAAO,EAAE,gBAAgB,EAAE,MAAM,oBAAoB,CAAC;AACtD,OAAO,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAC;AAC9C,OAAO,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAC;AACpD,OAAO,EAAE,qBAAqB,EAAE,MAAM,yBAAyB,CAAC;AAChE,OAAO,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAC;AAChD,OAAO,EAAE,WAAW,EAAE,MAAM,eAAe,CAAC;AAC5C,OAAO,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAC;AAEhD;;;;;;;;;;;;;;;;;;GAkBG;AACH,MAAM,CAAC,OAAO,MAAM,iBAAiB,GACnC,qBAAqB,GACrB,YAAY,GAAG,8CAA8C;AAC7D,YAAY,GACZ,eAAe,GAAG,8CAA8C;AAChE,aAAa,GAAG,8CAA8C;AAC9D,WAAW,GACX,aAAa,GAAG,8CAA8C;AAC9D,gBAAgB,GAChB,iBAAiB,CAAC"}

package/lib/cjs/presentation-common/rules/customization/CustomizationRule.js.map

@@ -1 +1 @@
-{"version":3,"file":"CustomizationRule.js","sourceRoot":"","sources":["../../../../../src/presentation-common/rules/customization/CustomizationRule.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;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 { NodeArtifactsRule } from \"../hierarchy/NodeArtifactsRule\";\r\nimport { CheckBoxRule } from \"./CheckBoxRule\";\r\nimport { ExtendedDataRule } from \"./ExtendedDataRule\";\r\nimport { GroupingRule } from \"./GroupingRule\";\r\nimport { ImageIdOverride } from \"./ImageIdOverride\";\r\nimport { InstanceLabelOverride } from \"./InstanceLabelOverride\";\r\nimport { LabelOverride } from \"./LabelOverride\";\r\nimport { SortingRule } from \"./SortingRule\";\r\nimport { StyleOverride } from \"./StyleOverride\";\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 =\r\n  InstanceLabelOverride |\r\n  CheckBoxRule |\r\n  GroupingRule |\r\n  ImageIdOverride |\r\n  LabelOverride | // eslint-disable-line deprecation/deprecation\r\n  SortingRule |\r\n  StyleOverride |\r\n  ExtendedDataRule |\r\n  NodeArtifactsRule;\r\n"]}
+{"version":3,"file":"CustomizationRule.js","sourceRoot":"","sources":["../../../../../src/presentation-common/rules/customization/CustomizationRule.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;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 { NodeArtifactsRule } from \"../hierarchy/NodeArtifactsRule\";\r\nimport { CheckBoxRule } from \"./CheckBoxRule\";\r\nimport { ExtendedDataRule } from \"./ExtendedDataRule\";\r\nimport { GroupingRule } from \"./GroupingRule\";\r\nimport { ImageIdOverride } from \"./ImageIdOverride\";\r\nimport { InstanceLabelOverride } from \"./InstanceLabelOverride\";\r\nimport { LabelOverride } from \"./LabelOverride\";\r\nimport { SortingRule } from \"./SortingRule\";\r\nimport { StyleOverride } from \"./StyleOverride\";\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 =\r\n  InstanceLabelOverride |\r\n  CheckBoxRule | // eslint-disable-line deprecation/deprecation\r\n  GroupingRule |\r\n  ImageIdOverride | // eslint-disable-line deprecation/deprecation\r\n  LabelOverride | // eslint-disable-line deprecation/deprecation\r\n  SortingRule |\r\n  StyleOverride | // eslint-disable-line deprecation/deprecation\r\n  ExtendedDataRule |\r\n  NodeArtifactsRule;\r\n"]}

package/lib/cjs/presentation-common/rules/customization/ExtendedDataRule.d.ts

@@ -1,40 +1,25 @@
 /** @packageDocumentation
  * @module PresentationRules
  */
-import { ConditionContainer, RuleBase, RuleTypes } from "../Rule";
+import { RuleBase, RuleTypes } from "../Rule";
 /**
- * Rule used to inject some extended data into presentation data
- * objects (nodes, records).
+ * Extended data rule is used to inject some arbitrary data into presentation data objects (nodes, content records).
  *
- * A couple of typical use cases:
- * - Table is showing models and elements polymorphically and application
- *   wants to handle all models and all elements differently. The rule can be used
- *   to inject some flag that tells whether table row represents a model or an element.
- * - Tree shows a hierarchy of models and elements. Then element node is clicked,
- *   application needs to additionally know element model's ID. The rule can be used
- *   to inject that ID into element's node.
- *
- * @see [More details]($docs/presentation/Customization/ExtendedDataRule.md)
+ * @see [Extended data rule reference documentation page]($docs/presentation/customization/ExtendedDataRule.md)
  * @public
  */
-export interface ExtendedDataRule extends RuleBase, ConditionContainer {
+export interface ExtendedDataRule extends RuleBase {
     /** Used for serializing to JSON. */
     ruleType: RuleTypes.ExtendedData;
     /**
-     * Defines a condition for the rule, which needs to be met in order for it to be used. Condition
-     * is an [ECExpression]($docs/presentation/Advanced/ECExpressions.md), which can use
-     * a [limited set of symbols]($docs/presentation/Customization/ECExpressions.md#rule-condition).
+     * Defines a condition which needs to be met in order for the rule to be used. The condition
+     * is an [ECExpression]($docs/presentation/customization/ECExpressions.md#rule-condition) which has
+     * to evaluate to a boolean value.
      */
     condition?: string;
     /**
-     * A map of items that define the values stored in the extended data structure.
-     *
-     * The key part of the pair should be unique within all keys which are used for specific
-     * presentation object, even if they are applied using different `ExtendedData` definitions.
-     *
-     * The value part of the pair is an [ECExpression]($docs/presentation/Advanced/ECExpressions.md), which can use
-     * a [limited set of symbols]($docs/presentation/Customization/ECExpressions.md#rule-condition) and whose
-     * evaluated result is used as the value of the extended data item.
+     * A map of [ECExpressions]($docs/presentation/customization/ECExpressions.md#rule-condition) whose
+     * evaluation results are used as extended data values.
      */
     items: {
         [key: string]: string;

package/lib/cjs/presentation-common/rules/customization/ExtendedDataRule.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"ExtendedDataRule.d.ts","sourceRoot":"","sources":["../../../../../src/presentation-common/rules/customization/ExtendedDataRule.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,EAAE,kBAAkB,EAAE,QAAQ,EAAE,SAAS,EAAE,MAAM,SAAS,CAAC;AAElE;;;;;;;;;;;;;;GAcG;AACH,MAAM,WAAW,gBAAiB,SAAQ,QAAQ,EAAE,kBAAkB;IACpE,oCAAoC;IACpC,QAAQ,EAAE,SAAS,CAAC,YAAY,CAAC;IAEjC;;;;OAIG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB;;;;;;;;;OASG;IACH,KAAK,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;KAAE,CAAC;CAClC"}
+{"version":3,"file":"ExtendedDataRule.d.ts","sourceRoot":"","sources":["../../../../../src/presentation-common/rules/customization/ExtendedDataRule.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,EAAE,QAAQ,EAAE,SAAS,EAAE,MAAM,SAAS,CAAC;AAE9C;;;;;GAKG;AACH,MAAM,WAAW,gBAAiB,SAAQ,QAAQ;IAChD,oCAAoC;IACpC,QAAQ,EAAE,SAAS,CAAC,YAAY,CAAC;IAEjC;;;;OAIG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB;;;OAGG;IACH,KAAK,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;KAAE,CAAC;CAClC"}

package/lib/cjs/presentation-common/rules/customization/ExtendedDataRule.js.map

@@ -1 +1 @@
-{"version":3,"file":"ExtendedDataRule.js","sourceRoot":"","sources":["../../../../../src/presentation-common/rules/customization/ExtendedDataRule.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;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 { ConditionContainer, RuleBase, RuleTypes } from \"../Rule\";\r\n\r\n/**\r\n * Rule used to inject some extended data into presentation data\r\n * objects (nodes, records).\r\n *\r\n * A couple of typical use cases:\r\n * - Table is showing models and elements polymorphically and application\r\n *   wants to handle all models and all elements differently. The rule can be used\r\n *   to inject some flag that tells whether table row represents a model or an element.\r\n * - Tree shows a hierarchy of models and elements. Then element node is clicked,\r\n *   application needs to additionally know element model's ID. The rule can be used\r\n *   to inject that ID into element's node.\r\n *\r\n * @see [More details]($docs/presentation/Customization/ExtendedDataRule.md)\r\n * @public\r\n */\r\nexport interface ExtendedDataRule extends RuleBase, ConditionContainer {\r\n  /** Used for serializing to JSON. */\r\n  ruleType: RuleTypes.ExtendedData;\r\n\r\n  /**\r\n   * Defines a condition for the rule, which needs to be met in order for it to be used. Condition\r\n   * is an [ECExpression]($docs/presentation/Advanced/ECExpressions.md), which can use\r\n   * a [limited set of symbols]($docs/presentation/Customization/ECExpressions.md#rule-condition).\r\n   */\r\n  condition?: string;\r\n\r\n  /**\r\n   * A map of items that define the values stored in the extended data structure.\r\n   *\r\n   * The key part of the pair should be unique within all keys which are used for specific\r\n   * presentation object, even if they are applied using different `ExtendedData` definitions.\r\n   *\r\n   * The value part of the pair is an [ECExpression]($docs/presentation/Advanced/ECExpressions.md), which can use\r\n   * a [limited set of symbols]($docs/presentation/Customization/ECExpressions.md#rule-condition) and whose\r\n   * evaluated result is used as the value of the extended data item.\r\n   */\r\n  items: { [key: string]: string };\r\n}\r\n"]}
+{"version":3,"file":"ExtendedDataRule.js","sourceRoot":"","sources":["../../../../../src/presentation-common/rules/customization/ExtendedDataRule.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;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, RuleTypes } from \"../Rule\";\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: RuleTypes.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"]}

package/lib/cjs/presentation-common/rules/customization/GroupingRule.d.ts

@@ -2,50 +2,37 @@
  * @module PresentationRules
  */
 import { SingleSchemaClassSpecification } from "../ClassSpecifications";
-import { ConditionContainer, RuleBase, RuleTypes } from "../Rule";
+import { RuleBase, RuleTypes } from "../Rule";
 /**
- * Grouping rule is an advanced way to configure node grouping.
+ * Grouping rules provide advanced ways to group instances when creating hierarchies.
  *
- * It allows to define these types of groupings:
- * - Group by base class.
- * - Group by any property of the instance by a common value or a range of values.
- * - Group multiple instances with the same label in to one ECInstance node. This can be used in cases when these
- * instances represent the same object for the user.
- *
- * The rule works in conjunction with other grouping options available in navigation specifications [[ChildNodeSpecification]]:
- * `groupByClass` and `groupByLabel`. The grouping hierarchy looks like this:
- * - Base ECClass grouping node (specified by base class grouping specification [[ClassGroup]])
- *   - ECClass grouping node (specified by `groupByClass` property)
- *     - ECProperty grouping node 1 (specified by 1st [[PropertyGroup]])
- *       - ECProperty grouping node 2 (specified by 2nd [[PropertyGroup]])
- *         - ECProperty grouping node n (specified by n-th [[PropertyGroup]])
- *           - Display label grouping node (specified by `groupByLabel` property)
- *             - ECInstance nodes (may be grouped under a single node by [[SameLabelInstanceGroup]])
- *
- * @see [More details]($docs/presentation/Hierarchies/GroupingRule.md)
+ * @see [Grouping rule reference documentation page]($docs/presentation/hierarchies/GroupingRule.md)
  * @public
  */
-export interface GroupingRule extends RuleBase, ConditionContainer {
+export interface GroupingRule extends RuleBase {
     /** Used for serializing to JSON. */
     ruleType: RuleTypes.Grouping;
     /**
-     * Defines a condition for the rule, which needs to be met in order to execute it. Condition
-     * is an [ECExpression]($docs/presentation/Advanced/ECExpressions.md), which can use
-     * a [limited set of symbols]($docs/presentation/Hierarchies/ECExpressions.md#rule-condition).
+     * An [ECExpression]($docs/presentation/hierarchies/ECExpressions.md#rule-condition) that results in
+     * a boolean value. If specified,  the grouping rule applies only to instance nodes that cause the condition
+     * to evaluate to `true`.
      */
     condition?: string;
-    /** Specification of ECClass which should be grouped using this rule */
+    /** Specification of ECClass which should be grouped using this rule. */
     class: SingleSchemaClassSpecification;
-    /** Specifications of grouping which should be applied to matching ECInstances */
+    /**
+     * Specifies a list of [grouping specifications]($docs/presentation/hierarchies/GroupingRule.md#grouping-specifications)
+     * which describe the kind of grouping that should be applied.
+     */
     groups: GroupingSpecification[];
 }
 /**
- * Grouping rule specifications
+ * Grouping rule specifications.
  * @public
  */
 export declare type GroupingSpecification = ClassGroup | PropertyGroup | SameLabelInstanceGroup;
 /**
- * Available types of [[GroupingSpecification]]
+ * Available types of [[GroupingSpecification]].
  * @public
  */
 export declare enum GroupingSpecificationTypes {
@@ -64,33 +51,43 @@ export interface GroupingSpecificationBase {
     specType: GroupingSpecificationTypes;
 }
 /**
- * Allows grouping ECInstance nodes by their base class.
+ * Base class grouping allows grouping ECInstance nodes by their base class (as opposed to the hierarchy
+ * specifications' `groupByClass` attribute, which always groups by direct class).
+ *
+ * @see [Base class grouping documentation section]($docs/presentation/hierarchies/GroupingRule.md#base-class-grouping)
  * @public
  */
 export interface ClassGroup extends GroupingSpecificationBase {
     /** Used for serializing to JSON. */
     specType: GroupingSpecificationTypes.Class;
-    /** Should the grouping node be created if there is only one item in that group. */
+    /** Specifies whether a grouping node should be created if there is only one item in that group. */
     createGroupForSingleItem?: boolean;
-    /** Specification of the base ECClass to group by. Defaults to rule's class. */
+    /**
+     * Specification of the base ECClass to group by. If specified, allows grouping by a subclass of the class
+     * specified by rule's `class` attribute.
+     */
     baseClass?: SingleSchemaClassSpecification;
 }
 /**
- * Allows grouping multiple instances with the same label into one ECInstance node.
- * It can be used in cases when these instances represent the same object for the user.
- *
- * When multiple instances are grouped, an ECInstance node is created instead of a
- * grouping node and the ECInstance key for the node is assigned to key of one of grouped
- * instances.
+ * Allows grouping multiple instances with the same label into one ECInstances type of node. Similar to display label grouping,
+ * but instead of showing a grouping node with multiple grouped ECInstance nodes, it shows a single ECInstances node which represents
+ * multiple ECInstances.
  *
+ * @see [Same label instance grouping documentation section]($docs/presentation/hierarchies/GroupingRule.md#same-label-instance-grouping)
  * @public
  */
 export interface SameLabelInstanceGroup extends GroupingSpecificationBase {
     /** Used for serializing to JSON. */
     specType: GroupingSpecificationTypes.SameLabelInstance;
     /**
-     * Stage of hierarchy creation at which the rule is applied.
-     * Defaults to [[SameLabelInstanceGroupApplicationStage.Query]].
+     * Grouping nodes by label is an expensive operation because it requires the whole hierarchy level to be created before even the first
+     * grouped node can be produced. To alleviate the performance impact when this specification is used, two `applicationStage` settings have been introduced:
+     *
+     * - `"Query"` groups instances during ECSql query, which can often make use of database indices and is generally fairly quick. It is chosen
+     *   as the default option, however, it fails to produce grouping nodes when certain ruleset specifications are involved.
+     *
+     * - `"PostProcess"` groups instances after the whole hierarchy level is built. It incurs a large performance penalty, but it will
+     *   produce the expected result in all cases.
      */
     applicationStage?: SameLabelInstanceGroupApplicationStage;
 }
@@ -111,64 +108,48 @@ export declare enum SameLabelInstanceGroupApplicationStage {
     PostProcess = "PostProcess"
 }
 /**
- * Allows grouping by property of the instance
- * by a common value or by range of values.
+ * Property grouping allows grouping by a property of the instance by value or by given ranges of values.
  *
+ * @see [Property grouping documentation section]($docs/presentation/hierarchies/GroupingRule.md#property-grouping)
  * @public
  */
 export interface PropertyGroup extends GroupingSpecificationBase {
     /** Used for serializing to JSON. */
     specType: GroupingSpecificationTypes.Property;
     /**
-     * Name of the ECProperty which is used for grouping.
+     * Name of the ECProperty which is used for grouping. The property must exist on the ECClass specified by the
+     * rule's `class` attribute and it must be of either a primitive or a navigation type.
      *
      * @minLength 1
      */
     propertyName: string;
     /**
-     * ID of an image to use for the grouping node
+     * Specifies grouping node's image ID. If set, the ID is assigned to [[Node.imageId]] and
+     * it's up to the UI component to decide what to do with it.
      *
      * @minLength 1
      */
     imageId?: string;
-    /** Should the grouping node be created if there is only one item in that group */
+    /** Specifies whether a grouping node should be created if there is only one item in that group. */
     createGroupForSingleItem?: boolean;
     /**
-     * Should a separate grouping node be created for nodes whose grouping value is not
-     * set or is an empty string.
-     *
-     * Defaults to `true`.
+     * Should a separate grouping node be created for nodes whose grouping value is not set or is set to an empty string.
      */
     createGroupForUnspecifiedValues?: boolean;
     /**
-     * Should the instances be grouped on display label or the grouping property value.
-     * Defaults to [[PropertyGroupingValue.DisplayLabel]].
-     *
-     * **Note:** Grouping by property value is required if the display label is
-     * overridden to display grouped instances count.
+     * Specifies whether instances should be grouped using property's display or raw value.
      *
-     * **Warning:** Grouping by label and sorting by property value is not possible.
-     *
-     * @deprecated Display value should always be used for grouping. In cases when there's a
-     * need to show grouped instances count suffix, that can be achieved at the UI component
-     * layer by composing UI node's label from node's display label and
-     * [GroupingNodeKey.groupedInstancesCount]($presentation-common).
+     * @deprecated Display value should always be used for grouping.
      */
     groupingValue?: PropertyGroupingValue;
     /**
-     * Should the nodes be sorted by display label or the grouping property value. In most
-     * cases the result is the same, unless [[LabelOverride]] rule is used to change the display label.
-     * Defaults to [[PropertyGroupingValue.DisplayLabel]].
-     *
-     * **Note:** Sorting by property value only makes sense when instances are grouped by
-     * property value as well.
-     *
-     * **Warning:** Grouping by label and sorting by property value is not possible.
+     * Specifies whether nodes should be sorted by their display label or the grouping property's value. In most cases the result
+     * is the same, unless a [label override rule]($docs/presentation/customization/LabelOverride.md) is used to change node's display label.
      *
      * @deprecated Property grouping nodes should always be sorted by display label.
      */
     sortingValue?: PropertyGroupingValue;
-    /** Ranges into which the grouping values are divided */
+    /** Ranges into which the grouping values are divided. Instances are grouped by value if no ranges are specified. */
     ranges?: PropertyRangeGroupSpecification[];
 }
 /**
@@ -185,7 +166,9 @@ export declare enum PropertyGroupingValue {
     DisplayLabel = "DisplayLabel"
 }
 /**
- * Describes a grouping range
+ * Describes a grouping range.
+ *
+ * @see [Property range group specification documentation section]($docs/presentation/hierarchies/GroupingRule.md#attribute-ranges)
  * @public
  */
 export interface PropertyRangeGroupSpecification {
@@ -196,20 +179,20 @@ export interface PropertyRangeGroupSpecification {
      */
     imageId?: string;
     /**
-     * Grouping node label. May be [localized]($docs/presentation/Advanced/Localization.md).
-     * Defaults to `{from value} - {to value}`
+     * Grouping node label. May be [localized]($docs/presentation/advanced/Localization.md).
+     * Defaults to `{from value} - {to value}`.
      *
      * @minLength 1
      */
     label?: string;
     /**
-     * Value that defines the range start (inclusive)
+     * Value that defines the range start (inclusive).
      *
      * @minLength 1
      */
     fromValue: string;
     /**
-     * Value that defines the range end (inclusive)
+     * Value that defines the range end (inclusive).
      *
      * @minLength 1
      */

package/lib/cjs/presentation-common/rules/customization/GroupingRule.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"GroupingRule.d.ts","sourceRoot":"","sources":["../../../../../src/presentation-common/rules/customization/GroupingRule.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,EAAE,8BAA8B,EAAE,MAAM,wBAAwB,CAAC;AACxE,OAAO,EAAE,kBAAkB,EAAE,QAAQ,EAAE,SAAS,EAAE,MAAM,SAAS,CAAC;AAElE;;;;;;;;;;;;;;;;;;;;;GAqBG;AACH,MAAM,WAAW,YAAa,SAAQ,QAAQ,EAAE,kBAAkB;IAChE,oCAAoC;IACpC,QAAQ,EAAE,SAAS,CAAC,QAAQ,CAAC;IAE7B;;;;OAIG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB,uEAAuE;IACvE,KAAK,EAAE,8BAA8B,CAAC;IAEtC,iFAAiF;IACjF,MAAM,EAAE,qBAAqB,EAAE,CAAC;CACjC;AAED;;;GAGG;AACH,MAAM,CAAC,OAAO,MAAM,qBAAqB,GAAG,UAAU,GAAG,aAAa,GAAG,sBAAsB,CAAC;AAEhG;;;GAGG;AACH,oBAAY,0BAA0B;IACpC,KAAK,UAAU;IACf,QAAQ,aAAa;IACrB,iBAAiB,sBAAsB;CACxC;AAED;;;;;GAKG;AACH,MAAM,WAAW,yBAAyB;IACxC,2BAA2B;IAC3B,QAAQ,EAAE,0BAA0B,CAAC;CACtC;AAED;;;GAGG;AACH,MAAM,WAAW,UAAW,SAAQ,yBAAyB;IAC3D,oCAAoC;IACpC,QAAQ,EAAE,0BAA0B,CAAC,KAAK,CAAC;IAE3C,mFAAmF;IACnF,wBAAwB,CAAC,EAAE,OAAO,CAAC;IAEnC,+EAA+E;IAC/E,SAAS,CAAC,EAAE,8BAA8B,CAAC;CAC5C;AAED;;;;;;;;;GASG;AACH,MAAM,WAAW,sBAAuB,SAAQ,yBAAyB;IACvE,oCAAoC;IACpC,QAAQ,EAAE,0BAA0B,CAAC,iBAAiB,CAAC;IACvD;;;OAGG;IACH,gBAAgB,CAAC,EAAE,sCAAsC,CAAC;CAC3D;AAED;;;GAGG;AACH,oBAAY,sCAAsC;IAChD,qCAAqC;IACrC,KAAK,UAAU;IAEf;;;;;;OAMG;IACH,WAAW,gBAAgB;CAC5B;AAED;;;;;GAKG;AACH,MAAM,WAAW,aAAc,SAAQ,yBAAyB;IAC9D,oCAAoC;IACpC,QAAQ,EAAE,0BAA0B,CAAC,QAAQ,CAAC;IAE9C;;;;OAIG;IACH,YAAY,EAAE,MAAM,CAAC;IAErB;;;;OAIG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IAEjB,kFAAkF;IAClF,wBAAwB,CAAC,EAAE,OAAO,CAAC;IAEnC;;;;;OAKG;IACH,+BAA+B,CAAC,EAAE,OAAO,CAAC;IAE1C;;;;;;;;;;;;;OAaG;IACH,aAAa,CAAC,EAAE,qBAAqB,CAAC;IAEtC;;;;;;;;;;;OAWG;IACH,YAAY,CAAC,EAAE,qBAAqB,CAAC;IAErC,wDAAwD;IACxD,MAAM,CAAC,EAAE,+BAA+B,EAAE,CAAC;CAC5C;AAED;;;;;;GAMG;AACH,oBAAY,qBAAqB;IAC/B,wBAAwB;IACxB,aAAa,kBAAkB;IAE/B,uBAAuB;IACvB,YAAY,iBAAiB;CAC9B;AAED;;;GAGG;AACH,MAAM,WAAW,+BAA+B;IAC9C;;;;OAIG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IAEjB;;;;;OAKG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf;;;;OAIG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;;;OAIG;IACH,OAAO,EAAE,MAAM,CAAC;CACjB"}
+{"version":3,"file":"GroupingRule.d.ts","sourceRoot":"","sources":["../../../../../src/presentation-common/rules/customization/GroupingRule.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,EAAE,8BAA8B,EAAE,MAAM,wBAAwB,CAAC;AACxE,OAAO,EAAE,QAAQ,EAAE,SAAS,EAAE,MAAM,SAAS,CAAC;AAE9C;;;;;GAKG;AACH,MAAM,WAAW,YAAa,SAAQ,QAAQ;IAC5C,oCAAoC;IACpC,QAAQ,EAAE,SAAS,CAAC,QAAQ,CAAC;IAE7B;;;;OAIG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB,wEAAwE;IACxE,KAAK,EAAE,8BAA8B,CAAC;IAEtC;;;OAGG;IACH,MAAM,EAAE,qBAAqB,EAAE,CAAC;CACjC;AAED;;;GAGG;AACH,MAAM,CAAC,OAAO,MAAM,qBAAqB,GAAG,UAAU,GAAG,aAAa,GAAG,sBAAsB,CAAC;AAEhG;;;GAGG;AACH,oBAAY,0BAA0B;IACpC,KAAK,UAAU;IACf,QAAQ,aAAa;IACrB,iBAAiB,sBAAsB;CACxC;AAED;;;;;GAKG;AACH,MAAM,WAAW,yBAAyB;IACxC,2BAA2B;IAC3B,QAAQ,EAAE,0BAA0B,CAAC;CACtC;AAED;;;;;;GAMG;AACH,MAAM,WAAW,UAAW,SAAQ,yBAAyB;IAC3D,oCAAoC;IACpC,QAAQ,EAAE,0BAA0B,CAAC,KAAK,CAAC;IAE3C,mGAAmG;IACnG,wBAAwB,CAAC,EAAE,OAAO,CAAC;IAEnC;;;OAGG;IACH,SAAS,CAAC,EAAE,8BAA8B,CAAC;CAC5C;AAED;;;;;;;GAOG;AACH,MAAM,WAAW,sBAAuB,SAAQ,yBAAyB;IACvE,oCAAoC;IACpC,QAAQ,EAAE,0BAA0B,CAAC,iBAAiB,CAAC;IAEvD;;;;;;;;;OASG;IACH,gBAAgB,CAAC,EAAE,sCAAsC,CAAC;CAC3D;AAED;;;GAGG;AACH,oBAAY,sCAAsC;IAChD,qCAAqC;IACrC,KAAK,UAAU;IAEf;;;;;;OAMG;IACH,WAAW,gBAAgB;CAC5B;AAED;;;;;GAKG;AACH,MAAM,WAAW,aAAc,SAAQ,yBAAyB;IAC9D,oCAAoC;IACpC,QAAQ,EAAE,0BAA0B,CAAC,QAAQ,CAAC;IAE9C;;;;;OAKG;IACH,YAAY,EAAE,MAAM,CAAC;IAErB;;;;;OAKG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IAEjB,mGAAmG;IACnG,wBAAwB,CAAC,EAAE,OAAO,CAAC;IAEnC;;OAEG;IACH,+BAA+B,CAAC,EAAE,OAAO,CAAC;IAE1C;;;;OAIG;IACH,aAAa,CAAC,EAAE,qBAAqB,CAAC;IAEtC;;;;;OAKG;IACH,YAAY,CAAC,EAAE,qBAAqB,CAAC;IAErC,oHAAoH;IACpH,MAAM,CAAC,EAAE,+BAA+B,EAAE,CAAC;CAC5C;AAED;;;;;;GAMG;AACH,oBAAY,qBAAqB;IAC/B,wBAAwB;IACxB,aAAa,kBAAkB;IAE/B,uBAAuB;IACvB,YAAY,iBAAiB;CAC9B;AAED;;;;;GAKG;AACH,MAAM,WAAW,+BAA+B;IAC9C;;;;OAIG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IAEjB;;;;;OAKG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf;;;;OAIG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;;;OAIG;IACH,OAAO,EAAE,MAAM,CAAC;CACjB"}

package/lib/cjs/presentation-common/rules/customization/GroupingRule.js

@@ -9,7 +9,7 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.PropertyGroupingValue = exports.SameLabelInstanceGroupApplicationStage = exports.GroupingSpecificationTypes = void 0;
 /**
- * Available types of [[GroupingSpecification]]
+ * Available types of [[GroupingSpecification]].
  * @public
  */
 var GroupingSpecificationTypes;