@itwin/presentation-common 3.2.0-dev.9 → 3.2.0

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;

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

@@ -1 +1 @@
-{"version":3,"file":"GroupingRule.js","sourceRoot":"","sources":["../../../../../src/presentation-common/rules/customization/GroupingRule.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AAmDH;;;GAGG;AACH,IAAY,0BAIX;AAJD,WAAY,0BAA0B;IACpC,6CAAe,CAAA;IACf,mDAAqB,CAAA;IACrB,qEAAuC,CAAA;AACzC,CAAC,EAJW,0BAA0B,GAA1B,kCAA0B,KAA1B,kCAA0B,QAIrC;AAgDD;;;GAGG;AACH,IAAY,sCAYX;AAZD,WAAY,sCAAsC;IAChD,qCAAqC;IACrC,yDAAe,CAAA;IAEf;;;;;;OAMG;IACH,qEAA2B,CAAA;AAC7B,CAAC,EAZW,sCAAsC,GAAtC,8CAAsC,KAAtC,8CAAsC,QAYjD;AAuED;;;;;;GAMG;AACH,IAAY,qBAMX;AAND,WAAY,qBAAqB;IAC/B,wBAAwB;IACxB,wDAA+B,CAAA;IAE/B,uBAAuB;IACvB,sDAA6B,CAAA;AAC/B,CAAC,EANW,qBAAqB,GAArB,6BAAqB,KAArB,6BAAqB,QAMhC","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\";\r\nimport { ConditionContainer, RuleBase, RuleTypes } from \"../Rule\";\r\n\r\n/**\r\n * Grouping rule is an advanced way to configure node grouping.\r\n *\r\n * It allows to define these types of groupings:\r\n * - Group by base class.\r\n * - Group by any property of the instance by a common value or a range of values.\r\n * - Group multiple instances with the same label in to one ECInstance node. This can be used in cases when these\r\n * instances represent the same object for the user.\r\n *\r\n * The rule works in conjunction with other grouping options available in navigation specifications [[ChildNodeSpecification]]:\r\n * `groupByClass` and `groupByLabel`. The grouping hierarchy looks like this:\r\n * - Base ECClass grouping node (specified by base class grouping specification [[ClassGroup]])\r\n *   - ECClass grouping node (specified by `groupByClass` property)\r\n *     - ECProperty grouping node 1 (specified by 1st [[PropertyGroup]])\r\n *       - ECProperty grouping node 2 (specified by 2nd [[PropertyGroup]])\r\n *         - ECProperty grouping node n (specified by n-th [[PropertyGroup]])\r\n *           - Display label grouping node (specified by `groupByLabel` property)\r\n *             - ECInstance nodes (may be grouped under a single node by [[SameLabelInstanceGroup]])\r\n *\r\n * @see [More details]($docs/presentation/Hierarchies/GroupingRule.md)\r\n * @public\r\n */\r\nexport interface GroupingRule extends RuleBase, ConditionContainer {\r\n  /** Used for serializing to JSON. */\r\n  ruleType: RuleTypes.Grouping;\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/Hierarchies/ECExpressions.md#rule-condition).\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  /** Specifications of grouping which should be applied to matching ECInstances */\r\n  groups: GroupingSpecification[];\r\n}\r\n\r\n/**\r\n * Grouping rule specifications\r\n * @public\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 */\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 */\r\nexport interface GroupingSpecificationBase {\r\n  /** Type of the subclass */\r\n  specType: GroupingSpecificationTypes;\r\n}\r\n\r\n/**\r\n * Allows grouping ECInstance nodes by their base class.\r\n * @public\r\n */\r\nexport interface ClassGroup extends GroupingSpecificationBase {\r\n  /** Used for serializing to JSON. */\r\n  specType: GroupingSpecificationTypes.Class;\r\n\r\n  /** Should the grouping node be created if there is only one item in that group. */\r\n  createGroupForSingleItem?: boolean;\r\n\r\n  /** Specification of the base ECClass to group by. Defaults to rule's class. */\r\n  baseClass?: SingleSchemaClassSpecification;\r\n}\r\n\r\n/**\r\n * Allows grouping multiple instances with the same label into one ECInstance node.\r\n * It can be used in cases when these instances represent the same object for the user.\r\n *\r\n * When multiple instances are grouped, an ECInstance node is created instead of a\r\n * grouping node and the ECInstance key for the node is assigned to key of one of grouped\r\n * instances.\r\n *\r\n * @public\r\n */\r\nexport interface SameLabelInstanceGroup extends GroupingSpecificationBase {\r\n  /** Used for serializing to JSON. */\r\n  specType: GroupingSpecificationTypes.SameLabelInstance;\r\n  /**\r\n   * Stage of hierarchy creation at which the rule is applied.\r\n   * Defaults to [[SameLabelInstanceGroupApplicationStage.Query]].\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 */\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 * Allows grouping by property of the instance\r\n * by a common value or by range of values.\r\n *\r\n * @public\r\n */\r\nexport interface PropertyGroup extends GroupingSpecificationBase {\r\n  /** Used for serializing to JSON. */\r\n  specType: GroupingSpecificationTypes.Property;\r\n\r\n  /**\r\n   * Name of the ECProperty which is used for grouping.\r\n   *\r\n   * @minLength 1\r\n   */\r\n  propertyName: string;\r\n\r\n  /**\r\n   * ID of an image to use for the grouping node\r\n   *\r\n   * @minLength 1\r\n   */\r\n  imageId?: string;\r\n\r\n  /** Should the grouping node 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\r\n   * set or is an empty string.\r\n   *\r\n   * Defaults to `true`.\r\n   */\r\n  createGroupForUnspecifiedValues?: boolean;\r\n\r\n  /**\r\n   * Should the instances be grouped on display label or the grouping property value.\r\n   * Defaults to [[PropertyGroupingValue.DisplayLabel]].\r\n   *\r\n   * **Note:** Grouping by property value is required if the display label is\r\n   * overridden to display grouped instances count.\r\n   *\r\n   * **Warning:** Grouping by label and sorting by property value is not possible.\r\n   *\r\n   * @deprecated Display value should always be used for grouping. In cases when there's a\r\n   * need to show grouped instances count suffix, that can be achieved at the UI component\r\n   * layer by composing UI node's label from node's display label and\r\n   * [GroupingNodeKey.groupedInstancesCount]($presentation-common).\r\n   */\r\n  groupingValue?: PropertyGroupingValue; // eslint-disable-line deprecation/deprecation\r\n\r\n  /**\r\n   * Should the nodes be sorted by display label or the grouping property value. In most\r\n   * cases the result is the same, unless [[LabelOverride]] rule is used to change the display label.\r\n   * Defaults to [[PropertyGroupingValue.DisplayLabel]].\r\n   *\r\n   * **Note:** Sorting by property value only makes sense when instances are grouped by\r\n   * property value as well.\r\n   *\r\n   * **Warning:** Grouping by label and sorting by property value is not possible.\r\n   *\r\n   * @deprecated Property grouping nodes should always be sorted by display label.\r\n   */\r\n  sortingValue?: PropertyGroupingValue; // eslint-disable-line deprecation/deprecation\r\n\r\n  /** Ranges into which the grouping values are divided */\r\n  ranges?: PropertyRangeGroupSpecification[];\r\n}\r\n\r\n/**\r\n * Used in [[PropertyGroup]] to specify the type of value to use\r\n * for grouping and sorting\r\n *\r\n * @public\r\n * @deprecated The attributes using this enum are deprecated.\r\n */\r\nexport enum PropertyGroupingValue {\r\n  /** By property value */\r\n  PropertyValue = \"PropertyValue\",\r\n\r\n  /** By display label */\r\n  DisplayLabel = \"DisplayLabel\",\r\n}\r\n\r\n/**\r\n * Describes a grouping range\r\n * @public\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   */\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"]}
+{"version":3,"file":"GroupingRule.js","sourceRoot":"","sources":["../../../../../src/presentation-common/rules/customization/GroupingRule.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AAsCH;;;GAGG;AACH,IAAY,0BAIX;AAJD,WAAY,0BAA0B;IACpC,6CAAe,CAAA;IACf,mDAAqB,CAAA;IACrB,qEAAuC,CAAA;AACzC,CAAC,EAJW,0BAA0B,GAA1B,kCAA0B,KAA1B,kCAA0B,QAIrC;AA2DD;;;GAGG;AACH,IAAY,sCAYX;AAZD,WAAY,sCAAsC;IAChD,qCAAqC;IACrC,yDAAe,CAAA;IAEf;;;;;;OAMG;IACH,qEAA2B,CAAA;AAC7B,CAAC,EAZW,sCAAsC,GAAtC,8CAAsC,KAAtC,8CAAsC,QAYjD;AAuDD;;;;;;GAMG;AACH,IAAY,qBAMX;AAND,WAAY,qBAAqB;IAC/B,wBAAwB;IACxB,wDAA+B,CAAA;IAE/B,uBAAuB;IACvB,sDAA6B,CAAA;AAC/B,CAAC,EANW,qBAAqB,GAArB,6BAAqB,KAArB,6BAAqB,QAMhC","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\";\r\nimport { RuleBase, RuleTypes } from \"../Rule\";\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 */\r\nexport interface GroupingRule extends RuleBase {\r\n  /** Used for serializing to JSON. */\r\n  ruleType: RuleTypes.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 */\r\nexport declare type GroupingSpecification = ClassGroup | PropertyGroup | SameLabelInstanceGroup;\r\n\r\n/**\r\n * Available types of [[GroupingSpecification]].\r\n * @public\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 */\r\nexport interface GroupingSpecificationBase {\r\n  /** Type of the subclass */\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 */\r\nexport interface ClassGroup extends GroupingSpecificationBase {\r\n  /** Used for serializing to JSON. */\r\n  specType: GroupingSpecificationTypes.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 */\r\nexport interface SameLabelInstanceGroup extends GroupingSpecificationBase {\r\n  /** Used for serializing to JSON. */\r\n  specType: GroupingSpecificationTypes.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  applicationStage?: SameLabelInstanceGroupApplicationStage;\r\n}\r\n\r\n/**\r\n * Specifies hierarchy creation stages used to apply [[SameLabelInstanceGroup]] grouping.\r\n * @public\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 */\r\nexport interface PropertyGroup extends GroupingSpecificationBase {\r\n  /** Used for serializing to JSON. */\r\n  specType: GroupingSpecificationTypes.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   */\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  /**\r\n   * Specifies whether instances should be grouped using property's display or raw value.\r\n   *\r\n   * @deprecated Display value should always be used for grouping.\r\n   */\r\n  groupingValue?: PropertyGroupingValue; // eslint-disable-line deprecation/deprecation\r\n\r\n  /**\r\n   * Specifies whether nodes should be sorted by their display label or the grouping property's value. In most cases the result\r\n   * is the same, unless a [label override rule]($docs/presentation/customization/LabelOverride.md) is used to change node's display label.\r\n   *\r\n   * @deprecated Property grouping nodes should always be sorted by display label.\r\n   */\r\n  sortingValue?: PropertyGroupingValue; // eslint-disable-line deprecation/deprecation\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 * Used in [[PropertyGroup]] to specify the type of value to use\r\n * for grouping and sorting\r\n *\r\n * @public\r\n * @deprecated The attributes using this enum are deprecated.\r\n */\r\nexport enum PropertyGroupingValue {\r\n  /** By property value */\r\n  PropertyValue = \"PropertyValue\",\r\n\r\n  /** By display label */\r\n  DisplayLabel = \"DisplayLabel\",\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 */\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   */\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"]}

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

@@ -1,27 +1,26 @@
 /** @packageDocumentation
  * @module PresentationRules
  */
-import { ConditionContainer, RuleBase, RuleTypes } from "../Rule";
+import { RuleBase, RuleTypes } from "../Rule";
 /**
- * Rule that allows overriding default icon and dynamically define an icon
- * for a particular node based on the context.
+ * ImageId override rules allow setting an image ID to specific types of ECInstances.
  *
- * @see [More details]($docs/presentation/Customization/ImageIdOverride.md)
+ * @see [Image ID override reference documentation page]($docs/presentation/customization/ImageIdOverride.md)
  * @public
- * @deprecated Use [[ExtendedDataRule]] instead. See [extended data usage page]($docs/presentation/Customization/ExtendedDataUsage.md) for more details.
+ * @deprecated Use [[ExtendedDataRule]] instead. See [extended data usage page]($docs/presentation/customization/ExtendedDataUsage.md) for more details.
  */
-export interface ImageIdOverride extends RuleBase, ConditionContainer {
+export interface ImageIdOverride extends RuleBase {
     /** Used for serializing to JSON. */
     ruleType: RuleTypes.ImageIdOverride;
     /**
      * 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/Customization/ECExpressions.md#rule-condition).
+     * 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;
     /**
-     * Defines an image ID that should be used for nodes that meet rule condition. This is
-     * an [ECExpression]($docs/presentation/Customization/ECExpressions.md), so ID can be
+     * An expression whose result becomes the image ID. This is
+     * an [ECExpression]($docs/presentation/customization/ECExpressions.md), so ID can be
      * defined/formatted dynamically based on the context - for example ECInstance property value.
      *
      * @minLength 1

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

@@ -1 +1 @@
-{"version":3,"file":"ImageIdOverride.d.ts","sourceRoot":"","sources":["../../../../../src/presentation-common/rules/customization/ImageIdOverride.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,EAAE,kBAAkB,EAAE,QAAQ,EAAE,SAAS,EAAE,MAAM,SAAS,CAAC;AAElE;;;;;;;GAOG;AACH,MAAM,WAAW,eAAgB,SAAQ,QAAQ,EAAE,kBAAkB;IACnE,oCAAoC;IACpC,QAAQ,EAAE,SAAS,CAAC,eAAe,CAAC;IAEpC;;;;OAIG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB;;;;;;OAMG;IACH,iBAAiB,EAAE,MAAM,CAAC;CAC3B"}
+{"version":3,"file":"ImageIdOverride.d.ts","sourceRoot":"","sources":["../../../../../src/presentation-common/rules/customization/ImageIdOverride.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,EAAE,QAAQ,EAAE,SAAS,EAAE,MAAM,SAAS,CAAC;AAE9C;;;;;;GAMG;AACH,MAAM,WAAW,eAAgB,SAAQ,QAAQ;IAC/C,oCAAoC;IACpC,QAAQ,EAAE,SAAS,CAAC,eAAe,CAAC;IAEpC;;;;OAIG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB;;;;;;OAMG;IACH,iBAAiB,EAAE,MAAM,CAAC;CAC3B"}

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

@@ -1 +1 @@
-{"version":3,"file":"ImageIdOverride.js","sourceRoot":"","sources":["../../../../../src/presentation-common/rules/customization/ImageIdOverride.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 overriding default icon and dynamically define an icon\r\n * for a particular node based on the context.\r\n *\r\n * @see [More details]($docs/presentation/Customization/ImageIdOverride.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 ImageIdOverride extends RuleBase, ConditionContainer {\r\n  /** Used for serializing to JSON. */\r\n  ruleType: RuleTypes.ImageIdOverride;\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   * Defines an image ID that should be used for nodes that meet rule condition. This is\r\n   * an [ECExpression]($docs/presentation/Customization/ECExpressions.md), so ID can be\r\n   * defined/formatted dynamically based on the context - for example ECInstance property value.\r\n   *\r\n   * @minLength 1\r\n   */\r\n  imageIdExpression: string;\r\n}\r\n"]}
+{"version":3,"file":"ImageIdOverride.js","sourceRoot":"","sources":["../../../../../src/presentation-common/rules/customization/ImageIdOverride.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 * ImageId override rules allow setting an image ID to specific types of ECInstances.\r\n *\r\n * @see [Image ID override reference documentation page]($docs/presentation/customization/ImageIdOverride.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 ImageIdOverride extends RuleBase {\r\n  /** Used for serializing to JSON. */\r\n  ruleType: RuleTypes.ImageIdOverride;\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   * An expression whose result becomes the image ID. This is\r\n   * an [ECExpression]($docs/presentation/customization/ECExpressions.md), so ID can be\r\n   * defined/formatted dynamically based on the context - for example ECInstance property value.\r\n   *\r\n   * @minLength 1\r\n   */\r\n  imageIdExpression: string;\r\n}\r\n"]}

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

@@ -5,29 +5,26 @@ import { SingleSchemaClassSpecification } from "../ClassSpecifications";
 import { RelationshipPathSpecification } from "../RelationshipPathSpecification";
 import { RuleBase, RuleTypes } from "../Rule";
 /**
- * Rule to override labels for instances of specific ECClasses.
+ * Instance label override rule provides a way to set instance label to one of its property values,
+ * other attributes and/or combination of them.
  *
- * **Important:** Prefer this rule over [[LabelOverride]] when possible as it
- * has better performance.
- *
- * @see [More details]($docs/presentation/Customization/InstanceLabelOverride.md)
+ * @see [Instance label override reference documentation page]($docs/presentation/customization/InstanceLabelOverride.md)
  * @public
  */
 export interface InstanceLabelOverride extends RuleBase {
     /** Used for serializing to JSON. */
     ruleType: RuleTypes.InstanceLabelOverride;
     /**
-     * Specification of the ECClass to apply this rule to.
+     * Specifies the ECClass to apply this rule to.
      */
     class: SingleSchemaClassSpecification;
     /**
-     * Specifications for the label value. The first non-empty value
-     * is used as the actual label.
+     * Specifications of values used to override label. The first non-empty value is used as the actual label.
      */
     values: InstanceLabelOverrideValueSpecification[];
 }
 /**
- * Types of possible [[InstanceLabelOverride]] label value.
+ * Types of possible [[InstanceLabelOverride]] label values.
  * @public
  */
 export declare enum InstanceLabelOverrideValueSpecificationType {
@@ -49,9 +46,9 @@ export interface InstanceLabelOverrideValueSpecificationBase {
     specType: InstanceLabelOverrideValueSpecificationType;
 }
 /**
- * Specification that allows creating a label value composited using
- * multiple other specifications.
+ * Specification allows creating a label value composited using multiple other specifications.
  *
+ * @see [Composite value specification reference documentation page]($docs/presentation/customization/InstanceLabelOverride.md#composite-value-specification)
  * @public
  */
 export interface InstanceLabelOverrideCompositeValueSpecification extends InstanceLabelOverrideValueSpecificationBase {
@@ -70,7 +67,9 @@ export interface InstanceLabelOverrideCompositeValueSpecification extends Instan
     separator?: string;
 }
 /**
- * Specification that uses property value as the label content.
+ * Specification uses property value as the label content.
+ *
+ * @see [Property value specification reference documentation page]($docs/presentation/customization/InstanceLabelOverride.md#property-value-specification)
  * @public
  */
 export interface InstanceLabelOverridePropertyValueSpecification extends InstanceLabelOverrideValueSpecificationBase {
@@ -81,14 +80,16 @@ export interface InstanceLabelOverridePropertyValueSpecification extends Instanc
      */
     propertyName: string;
     /**
-     * Path from `InstanceLabelOverride.class` to the property class. If omitted,
-     * `InstanceLabelOverride.class` is used as property class.
+     * [Specification of the relationship path]($docs/presentation/RelationshipPathSpecification.md) from `InstanceLabelOverride.class`
+     * to class of the property. If omitted, `InstanceLabelOverride.class` is used as property class.
      * @beta
      */
     propertySource?: RelationshipPathSpecification;
 }
 /**
- * Specification that uses ECClass name as the label content.
+ * Specification uses ECClass name as the label content.
+ *
+ * @see [Class name value specification reference documentation page]($docs/presentation/customization/InstanceLabelOverride.md#class-name-value-specification)
  * @public
  */
 export interface InstanceLabelOverrideClassNameSpecification extends InstanceLabelOverrideValueSpecificationBase {
@@ -97,28 +98,36 @@ export interface InstanceLabelOverrideClassNameSpecification extends InstanceLab
     full?: boolean;
 }
 /**
- * Specification that uses ECClass display label as the label content.
+ * Specification uses ECClass display label as the label content.
+ *
+ * @see [Class label value specification reference documentation page]($docs/presentation/customization/InstanceLabelOverride.md#class-label-value-specification)
  * @public
  */
 export interface InstanceLabelOverrideClassLabelSpecification extends InstanceLabelOverrideValueSpecificationBase {
     specType: InstanceLabelOverrideValueSpecificationType.ClassLabel;
 }
 /**
- * Specification that returns ECInstance's briefcase ID in base36 format.
+ * Specification returns ECInstance's briefcase ID in base36 format.
+ *
+ * @see [BriefcaseId value specification reference documentation page]($docs/presentation/customization/InstanceLabelOverride.md#briefcaseid-value-specification)
  * @public
  */
 export interface InstanceLabelOverrideBriefcaseIdSpecification extends InstanceLabelOverrideValueSpecificationBase {
     specType: InstanceLabelOverrideValueSpecificationType.BriefcaseId;
 }
 /**
- * Specification that returns ECInstance's local ID in base36 format.
+ * Specification returns ECInstance's local ID in base36 format.
+ *
+ * @see [LocalId value specification reference documentation page]($docs/presentation/customization/InstanceLabelOverride.md#localid-value-specification)
  * @public
  */
 export interface InstanceLabelOverrideLocalIdSpecification extends InstanceLabelOverrideValueSpecificationBase {
     specType: InstanceLabelOverrideValueSpecificationType.LocalId;
 }
 /**
- * Specification that uses the specified value as the label content.
+ * Specification uses the specified value as the label content.
+ *
+ * @see [String value specification reference documentation page]($docs/presentation/customization/InstanceLabelOverride.md#string-value-specification)
  * @public
  */
 export interface InstanceLabelOverrideStringValueSpecification extends InstanceLabelOverrideValueSpecificationBase {
@@ -127,14 +136,16 @@ export interface InstanceLabelOverrideStringValueSpecification extends InstanceL
     value: string;
 }
 /**
- * Specification that uses label of a related instance as the label content.
+ * Specification uses label of another related instance as the label content.
+ *
+ * @see [Related instance label value specification reference documentation page]($docs/presentation/customization/InstanceLabelOverride.md#related-instance-label-value-specification)
  * @public
  */
 export interface InstanceLabelOverrideRelatedInstanceLabelSpecification extends InstanceLabelOverrideValueSpecificationBase {
     specType: InstanceLabelOverrideValueSpecificationType.RelatedInstanceLabel;
     /**
-     * Path from `InstanceLabelOverride.class` to the class of related instance whose label
-     * should be returned.
+     * [Specification of the relationship path]($docs/presentation/RelationshipPathSpecification.md) from `InstanceLabelOverride.class`
+     * to class of the related instance.
      */
     pathToRelatedInstance: RelationshipPathSpecification;
 }

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

@@ -1 +1 @@
-{"version":3,"file":"InstanceLabelOverride.d.ts","sourceRoot":"","sources":["../../../../../src/presentation-common/rules/customization/InstanceLabelOverride.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,EAAE,8BAA8B,EAAE,MAAM,wBAAwB,CAAC;AACxE,OAAO,EAAE,6BAA6B,EAAE,MAAM,kCAAkC,CAAC;AACjF,OAAO,EAAE,QAAQ,EAAE,SAAS,EAAE,MAAM,SAAS,CAAC;AAE9C;;;;;;;;GAQG;AACH,MAAM,WAAW,qBAAsB,SAAQ,QAAQ;IACrD,oCAAoC;IACpC,QAAQ,EAAE,SAAS,CAAC,qBAAqB,CAAC;IAE1C;;OAEG;IACH,KAAK,EAAE,8BAA8B,CAAC;IAEtC;;;OAGG;IACH,MAAM,EAAE,uCAAuC,EAAE,CAAC;CACnD;AAED;;;GAGG;AACH,oBAAY,2CAA2C;IACrD,SAAS,cAAc;IACvB,QAAQ,aAAa;IACrB,SAAS,cAAc;IACvB,UAAU,eAAe;IACzB,WAAW,gBAAgB;IAC3B,OAAO,YAAY;IACnB,MAAM,WAAW;IACjB,oBAAoB,yBAAyB;CAC9C;AAED;;;GAGG;AACH,MAAM,WAAW,2CAA2C;IAC1D,gCAAgC;IAChC,QAAQ,EAAE,2CAA2C,CAAC;CACvD;AAED;;;;;GAKG;AACH,MAAM,WAAW,gDAAiD,SAAQ,2CAA2C;IACnH,QAAQ,EAAE,2CAA2C,CAAC,SAAS,CAAC;IAEhE;;;;;OAKG;IACH,KAAK,EAAE,KAAK,CAAC;QAAE,IAAI,EAAE,uCAAuC,CAAC;QAAC,UAAU,CAAC,EAAE,OAAO,CAAA;KAAE,CAAC,CAAC;IAEtF,8EAA8E;IAC9E,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB;AAED;;;GAGG;AACH,MAAM,WAAW,+CAAgD,SAAQ,2CAA2C;IAClH,QAAQ,EAAE,2CAA2C,CAAC,QAAQ,CAAC;IAE/D;;;OAGG;IACH,YAAY,EAAE,MAAM,CAAC;IAErB;;;;OAIG;IACH,cAAc,CAAC,EAAE,6BAA6B,CAAC;CAChD;AAED;;;GAGG;AACH,MAAM,WAAW,2CAA4C,SAAQ,2CAA2C;IAC9G,QAAQ,EAAE,2CAA2C,CAAC,SAAS,CAAC;IAEhE,kEAAkE;IAClE,IAAI,CAAC,EAAE,OAAO,CAAC;CAChB;AAED;;;GAGG;AACH,MAAM,WAAW,4CAA6C,SAAQ,2CAA2C;IAC/G,QAAQ,EAAE,2CAA2C,CAAC,UAAU,CAAC;CAClE;AAED;;;GAGG;AACH,MAAM,WAAW,6CAA8C,SAAQ,2CAA2C;IAChH,QAAQ,EAAE,2CAA2C,CAAC,WAAW,CAAC;CACnE;AAED;;;GAGG;AACH,MAAM,WAAW,yCAA0C,SAAQ,2CAA2C;IAC5G,QAAQ,EAAE,2CAA2C,CAAC,OAAO,CAAC;CAC/D;AAED;;;GAGG;AACH,MAAM,WAAW,6CAA8C,SAAQ,2CAA2C;IAChH,QAAQ,EAAE,2CAA2C,CAAC,MAAM,CAAC;IAE7D,6CAA6C;IAC7C,KAAK,EAAE,MAAM,CAAC;CACf;AAED;;;GAGG;AACH,MAAM,WAAW,sDAAuD,SAAQ,2CAA2C;IACzH,QAAQ,EAAE,2CAA2C,CAAC,oBAAoB,CAAC;IAE3E;;;OAGG;IACH,qBAAqB,EAAE,6BAA6B,CAAC;CACtD;AAED;;;GAGG;AACH,oBAAY,uCAAuC,GACjD,gDAAgD,GAAG,+CAA+C,GAClG,6CAA6C,GAAG,2CAA2C,GAC3F,4CAA4C,GAAG,6CAA6C,GAC5F,yCAAyC,GAAG,sDAAsD,CAAC"}
+{"version":3,"file":"InstanceLabelOverride.d.ts","sourceRoot":"","sources":["../../../../../src/presentation-common/rules/customization/InstanceLabelOverride.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,EAAE,8BAA8B,EAAE,MAAM,wBAAwB,CAAC;AACxE,OAAO,EAAE,6BAA6B,EAAE,MAAM,kCAAkC,CAAC;AACjF,OAAO,EAAE,QAAQ,EAAE,SAAS,EAAE,MAAM,SAAS,CAAC;AAE9C;;;;;;GAMG;AACH,MAAM,WAAW,qBAAsB,SAAQ,QAAQ;IACrD,oCAAoC;IACpC,QAAQ,EAAE,SAAS,CAAC,qBAAqB,CAAC;IAE1C;;OAEG;IACH,KAAK,EAAE,8BAA8B,CAAC;IAEtC;;OAEG;IACH,MAAM,EAAE,uCAAuC,EAAE,CAAC;CACnD;AAED;;;GAGG;AACH,oBAAY,2CAA2C;IACrD,SAAS,cAAc;IACvB,QAAQ,aAAa;IACrB,SAAS,cAAc;IACvB,UAAU,eAAe;IACzB,WAAW,gBAAgB;IAC3B,OAAO,YAAY;IACnB,MAAM,WAAW;IACjB,oBAAoB,yBAAyB;CAC9C;AAED;;;GAGG;AACH,MAAM,WAAW,2CAA2C;IAC1D,gCAAgC;IAChC,QAAQ,EAAE,2CAA2C,CAAC;CACvD;AAED;;;;;GAKG;AACH,MAAM,WAAW,gDAAiD,SAAQ,2CAA2C;IACnH,QAAQ,EAAE,2CAA2C,CAAC,SAAS,CAAC;IAEhE;;;;;OAKG;IACH,KAAK,EAAE,KAAK,CAAC;QAAE,IAAI,EAAE,uCAAuC,CAAC;QAAC,UAAU,CAAC,EAAE,OAAO,CAAA;KAAE,CAAC,CAAC;IAEtF,8EAA8E;IAC9E,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB;AAED;;;;;GAKG;AACH,MAAM,WAAW,+CAAgD,SAAQ,2CAA2C;IAClH,QAAQ,EAAE,2CAA2C,CAAC,QAAQ,CAAC;IAE/D;;;OAGG;IACH,YAAY,EAAE,MAAM,CAAC;IAErB;;;;OAIG;IACH,cAAc,CAAC,EAAE,6BAA6B,CAAC;CAChD;AAED;;;;;GAKG;AACH,MAAM,WAAW,2CAA4C,SAAQ,2CAA2C;IAC9G,QAAQ,EAAE,2CAA2C,CAAC,SAAS,CAAC;IAEhE,kEAAkE;IAClE,IAAI,CAAC,EAAE,OAAO,CAAC;CAChB;AAED;;;;;GAKG;AACH,MAAM,WAAW,4CAA6C,SAAQ,2CAA2C;IAC/G,QAAQ,EAAE,2CAA2C,CAAC,UAAU,CAAC;CAClE;AAED;;;;;GAKG;AACH,MAAM,WAAW,6CAA8C,SAAQ,2CAA2C;IAChH,QAAQ,EAAE,2CAA2C,CAAC,WAAW,CAAC;CACnE;AAED;;;;;GAKG;AACH,MAAM,WAAW,yCAA0C,SAAQ,2CAA2C;IAC5G,QAAQ,EAAE,2CAA2C,CAAC,OAAO,CAAC;CAC/D;AAED;;;;;GAKG;AACH,MAAM,WAAW,6CAA8C,SAAQ,2CAA2C;IAChH,QAAQ,EAAE,2CAA2C,CAAC,MAAM,CAAC;IAE7D,6CAA6C;IAC7C,KAAK,EAAE,MAAM,CAAC;CACf;AAED;;;;;GAKG;AACH,MAAM,WAAW,sDAAuD,SAAQ,2CAA2C;IACzH,QAAQ,EAAE,2CAA2C,CAAC,oBAAoB,CAAC;IAE3E;;;OAGG;IACH,qBAAqB,EAAE,6BAA6B,CAAC;CACtD;AAED;;;GAGG;AACH,oBAAY,uCAAuC,GACjD,gDAAgD,GAAG,+CAA+C,GAClG,6CAA6C,GAAG,2CAA2C,GAC3F,4CAA4C,GAAG,6CAA6C,GAC5F,yCAAyC,GAAG,sDAAsD,CAAC"}

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

@@ -9,7 +9,7 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.InstanceLabelOverrideValueSpecificationType = void 0;
 /**
- * Types of possible [[InstanceLabelOverride]] label value.
+ * Types of possible [[InstanceLabelOverride]] label values.
  * @public
  */
 var InstanceLabelOverrideValueSpecificationType;

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

@@ -1 +1 @@
-{"version":3,"file":"InstanceLabelOverride.js","sourceRoot":"","sources":["../../../../../src/presentation-common/rules/customization/InstanceLabelOverride.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AA+BH;;;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,GAA3C,mDAA2C,KAA3C,mDAA2C,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\";\r\nimport { RelationshipPathSpecification } from \"../RelationshipPathSpecification\";\r\nimport { RuleBase, RuleTypes } from \"../Rule\";\r\n\r\n/**\r\n * Rule to override labels for instances of specific ECClasses.\r\n *\r\n * **Important:** Prefer this rule over [[LabelOverride]] when possible as it\r\n * has better performance.\r\n *\r\n * @see [More details]($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: RuleTypes.InstanceLabelOverride;\r\n\r\n  /**\r\n   * Specification of the ECClass to apply this rule to.\r\n   */\r\n  class: SingleSchemaClassSpecification;\r\n\r\n  /**\r\n   * Specifications for the label value. The first non-empty value\r\n   * 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 value.\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  /** Type of the specification */\r\n  specType: InstanceLabelOverrideValueSpecificationType;\r\n}\r\n\r\n/**\r\n * Specification that allows creating a label value composited using\r\n * multiple other specifications.\r\n *\r\n * @public\r\n */\r\nexport interface InstanceLabelOverrideCompositeValueSpecification extends InstanceLabelOverrideValueSpecificationBase {\r\n  specType: InstanceLabelOverrideValueSpecificationType.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 that uses property value as the label content.\r\n * @public\r\n */\r\nexport interface InstanceLabelOverridePropertyValueSpecification extends InstanceLabelOverrideValueSpecificationBase {\r\n  specType: InstanceLabelOverrideValueSpecificationType.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   * Path from `InstanceLabelOverride.class` to the property class. If omitted,\r\n   * `InstanceLabelOverride.class` is used as property class.\r\n   * @beta\r\n   */\r\n  propertySource?: RelationshipPathSpecification;\r\n}\r\n\r\n/**\r\n * Specification that uses ECClass name as the label content.\r\n * @public\r\n */\r\nexport interface InstanceLabelOverrideClassNameSpecification extends InstanceLabelOverrideValueSpecificationBase {\r\n  specType: InstanceLabelOverrideValueSpecificationType.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 that uses ECClass display label as the label content.\r\n * @public\r\n */\r\nexport interface InstanceLabelOverrideClassLabelSpecification extends InstanceLabelOverrideValueSpecificationBase {\r\n  specType: InstanceLabelOverrideValueSpecificationType.ClassLabel;\r\n}\r\n\r\n/**\r\n * Specification that returns ECInstance's briefcase ID in base36 format.\r\n * @public\r\n */\r\nexport interface InstanceLabelOverrideBriefcaseIdSpecification extends InstanceLabelOverrideValueSpecificationBase {\r\n  specType: InstanceLabelOverrideValueSpecificationType.BriefcaseId;\r\n}\r\n\r\n/**\r\n * Specification that returns ECInstance's local ID in base36 format.\r\n * @public\r\n */\r\nexport interface InstanceLabelOverrideLocalIdSpecification extends InstanceLabelOverrideValueSpecificationBase {\r\n  specType: InstanceLabelOverrideValueSpecificationType.LocalId;\r\n}\r\n\r\n/**\r\n * Specification that uses the specified value as the label content.\r\n * @public\r\n */\r\nexport interface InstanceLabelOverrideStringValueSpecification extends InstanceLabelOverrideValueSpecificationBase {\r\n  specType: InstanceLabelOverrideValueSpecificationType.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 that uses label of a related instance as the label content.\r\n * @public\r\n */\r\nexport interface InstanceLabelOverrideRelatedInstanceLabelSpecification extends InstanceLabelOverrideValueSpecificationBase {\r\n  specType: InstanceLabelOverrideValueSpecificationType.RelatedInstanceLabel;\r\n\r\n  /**\r\n   * Path from `InstanceLabelOverride.class` to the class of related instance whose label\r\n   * should be returned.\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 | InstanceLabelOverridePropertyValueSpecification |\r\n  InstanceLabelOverrideStringValueSpecification | InstanceLabelOverrideClassNameSpecification |\r\n  InstanceLabelOverrideClassLabelSpecification | InstanceLabelOverrideBriefcaseIdSpecification |\r\n  InstanceLabelOverrideLocalIdSpecification | InstanceLabelOverrideRelatedInstanceLabelSpecification;\r\n"]}
+{"version":3,"file":"InstanceLabelOverride.js","sourceRoot":"","sources":["../../../../../src/presentation-common/rules/customization/InstanceLabelOverride.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;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,GAA3C,mDAA2C,KAA3C,mDAA2C,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\";\r\nimport { RelationshipPathSpecification } from \"../RelationshipPathSpecification\";\r\nimport { RuleBase, RuleTypes } from \"../Rule\";\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: RuleTypes.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  /** Type of the specification */\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: InstanceLabelOverrideValueSpecificationType.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: InstanceLabelOverrideValueSpecificationType.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   * @beta\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: InstanceLabelOverrideValueSpecificationType.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: InstanceLabelOverrideValueSpecificationType.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: InstanceLabelOverrideValueSpecificationType.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: InstanceLabelOverrideValueSpecificationType.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: InstanceLabelOverrideValueSpecificationType.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: InstanceLabelOverrideValueSpecificationType.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 | InstanceLabelOverridePropertyValueSpecification |\r\n  InstanceLabelOverrideStringValueSpecification | InstanceLabelOverrideClassNameSpecification |\r\n  InstanceLabelOverrideClassLabelSpecification | InstanceLabelOverrideBriefcaseIdSpecification |\r\n  InstanceLabelOverrideLocalIdSpecification | InstanceLabelOverrideRelatedInstanceLabelSpecification;\r\n"]}