@itwin/presentation-common 3.2.0-dev.8 → 3.2.1

package/lib/esm/presentation-common/rules/content/modifiers/ContentModifier.d.ts

@@ -10,38 +10,48 @@ import { RelatedPropertiesSpecification } from "./RelatedPropertiesSpecification
 /**
  * Contains various rule attributes that allow modifying returned content.
  *
- * This is not expected to be used directly - use through either `ContentModifier` or `ContentSpecification`.
+ * This is not expected to be used directly - use through either [[ContentModifier]]
+ * or [[ContentSpecification]].
  *
+ * @see [Content modifier rule reference documentation page]($docs/presentation/content/ContentModifier.md)
  * @public
  */
 export interface ContentModifiersList {
-    /** Specifications for including properties of related instances */
+    /**
+     * Specifications of [related properties]($docs/presentation/content/RelatedPropertiesSpecification.md) which are
+     * included in the generated content.
+     */
     relatedProperties?: RelatedPropertiesSpecification[];
-    /** Specifications for including calculated properties */
+    /**
+     * Specifications of [calculated properties]($docs/presentation/content/CalculatedPropertiesSpecification.md) whose values are
+     * generated using provided [ECExpressions]($docs/presentation/advanced/ECExpressions.md).
+     */
     calculatedProperties?: CalculatedPropertiesSpecification[];
     /**
-     * Specifications for custom categories. Simply defining the categories does
-     * nothing - they have to be referenced from [[PropertySpecification]] defined in
+     * Specifications for [custom categories]($docs/presentation/content/PropertyCategorySpecification.md). Simply defining the categories does
+     * nothing - they have to be referenced from [property specification]($docs/presentation/content/PropertySpecification.md) defined in
      * [[propertyOverrides]] by `id`.
      */
     propertyCategories?: PropertyCategorySpecification[];
-    /** Specifications for various property overrides. */
+    /**
+     * Specifications for various [property overrides]($docs/presentation/content/PropertySpecification.md) that allow customizing property display.
+     */
     propertyOverrides?: PropertySpecification[];
 }
 /**
- * Rule that allows supplementing content with additional
- * specifications for certain ECClasses.
+ * Content modifiers are used to modify how instances of specified ECClasses are displayed in content which is
+ * produced using [content rules]($docs/presentation/content/ContentRule.md). They do not produce any content
+ * by themselves.
  *
- * @see [More details]($docs/presentation/Content/ContentModifier.md)
+ * @see [Content modifier rule reference documentation page]($docs/presentation/content/ContentModifier.md)
  * @public
  */
 export interface ContentModifier extends RuleBase, ContentModifiersList {
     /** Used for serializing to JSON. */
     ruleType: RuleTypes.ContentModifier;
     /**
-     * Specification of ECClass whose content should be supplemented.
-     * The modifier is applied to all ECClasses if this property
-     * is not specified.
+     * Specification of ECClass whose content should be modified. The modifier is applied to all content
+     * if this attribute is not specified.
      */
     class?: SingleSchemaClassSpecification;
 }

package/lib/esm/presentation-common/rules/content/modifiers/ContentModifier.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"ContentModifier.d.ts","sourceRoot":"","sources":["../../../../../../src/presentation-common/rules/content/modifiers/ContentModifier.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,EAAE,8BAA8B,EAAE,MAAM,2BAA2B,CAAC;AAC3E,OAAO,EAAE,QAAQ,EAAE,SAAS,EAAE,MAAM,YAAY,CAAC;AACjD,OAAO,EAAE,qBAAqB,EAAE,MAAM,0BAA0B,CAAC;AACjE,OAAO,EAAE,iCAAiC,EAAE,MAAM,qCAAqC,CAAC;AACxF,OAAO,EAAE,6BAA6B,EAAE,MAAM,iCAAiC,CAAC;AAChF,OAAO,EAAE,8BAA8B,EAAE,MAAM,kCAAkC,CAAC;AAElF;;;;;;GAMG;AACH,MAAM,WAAW,oBAAoB;IACnC,mEAAmE;IACnE,iBAAiB,CAAC,EAAE,8BAA8B,EAAE,CAAC;IAErD,yDAAyD;IACzD,oBAAoB,CAAC,EAAE,iCAAiC,EAAE,CAAC;IAE3D;;;;OAIG;IACH,kBAAkB,CAAC,EAAE,6BAA6B,EAAE,CAAC;IAErD,qDAAqD;IACrD,iBAAiB,CAAC,EAAE,qBAAqB,EAAE,CAAC;CAC7C;AAED;;;;;;GAMG;AACH,MAAM,WAAW,eAAgB,SAAQ,QAAQ,EAAE,oBAAoB;IACrE,oCAAoC;IACpC,QAAQ,EAAE,SAAS,CAAC,eAAe,CAAC;IAEpC;;;;OAIG;IACH,KAAK,CAAC,EAAE,8BAA8B,CAAC;CACxC"}
+{"version":3,"file":"ContentModifier.d.ts","sourceRoot":"","sources":["../../../../../../src/presentation-common/rules/content/modifiers/ContentModifier.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,EAAE,8BAA8B,EAAE,MAAM,2BAA2B,CAAC;AAC3E,OAAO,EAAE,QAAQ,EAAE,SAAS,EAAE,MAAM,YAAY,CAAC;AACjD,OAAO,EAAE,qBAAqB,EAAE,MAAM,0BAA0B,CAAC;AACjE,OAAO,EAAE,iCAAiC,EAAE,MAAM,qCAAqC,CAAC;AACxF,OAAO,EAAE,6BAA6B,EAAE,MAAM,iCAAiC,CAAC;AAChF,OAAO,EAAE,8BAA8B,EAAE,MAAM,kCAAkC,CAAC;AAElF;;;;;;;;GAQG;AACH,MAAM,WAAW,oBAAoB;IACnC;;;OAGG;IACH,iBAAiB,CAAC,EAAE,8BAA8B,EAAE,CAAC;IAErD;;;OAGG;IACH,oBAAoB,CAAC,EAAE,iCAAiC,EAAE,CAAC;IAE3D;;;;OAIG;IACH,kBAAkB,CAAC,EAAE,6BAA6B,EAAE,CAAC;IAErD;;OAEG;IACH,iBAAiB,CAAC,EAAE,qBAAqB,EAAE,CAAC;CAC7C;AAED;;;;;;;GAOG;AACH,MAAM,WAAW,eAAgB,SAAQ,QAAQ,EAAE,oBAAoB;IACrE,oCAAoC;IACpC,QAAQ,EAAE,SAAS,CAAC,eAAe,CAAC;IAEpC;;;OAGG;IACH,KAAK,CAAC,EAAE,8BAA8B,CAAC;CACxC"}

package/lib/esm/presentation-common/rules/content/modifiers/ContentModifier.js.map

@@ -1 +1 @@
-{"version":3,"file":"ContentModifier.js","sourceRoot":"","sources":["../../../../../../src/presentation-common/rules/content/modifiers/ContentModifier.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 { SingleSchemaClassSpecification } from \"../../ClassSpecifications\";\r\nimport { RuleBase, RuleTypes } from \"../../Rule\";\r\nimport { PropertySpecification } from \"../PropertySpecification\";\r\nimport { CalculatedPropertiesSpecification } from \"./CalculatedPropertiesSpecification\";\r\nimport { PropertyCategorySpecification } from \"./PropertyCategorySpecification\";\r\nimport { RelatedPropertiesSpecification } from \"./RelatedPropertiesSpecification\";\r\n\r\n/**\r\n * Contains various rule attributes that allow modifying returned content.\r\n *\r\n * This is not expected to be used directly - use through either `ContentModifier` or `ContentSpecification`.\r\n *\r\n * @public\r\n */\r\nexport interface ContentModifiersList {\r\n  /** Specifications for including properties of related instances */\r\n  relatedProperties?: RelatedPropertiesSpecification[];\r\n\r\n  /** Specifications for including calculated properties */\r\n  calculatedProperties?: CalculatedPropertiesSpecification[];\r\n\r\n  /**\r\n   * Specifications for custom categories. Simply defining the categories does\r\n   * nothing - they have to be referenced from [[PropertySpecification]] defined in\r\n   * [[propertyOverrides]] by `id`.\r\n   */\r\n  propertyCategories?: PropertyCategorySpecification[];\r\n\r\n  /** Specifications for various property overrides. */\r\n  propertyOverrides?: PropertySpecification[];\r\n}\r\n\r\n/**\r\n * Rule that allows supplementing content with additional\r\n * specifications for certain ECClasses.\r\n *\r\n * @see [More details]($docs/presentation/Content/ContentModifier.md)\r\n * @public\r\n */\r\nexport interface ContentModifier extends RuleBase, ContentModifiersList {\r\n  /** Used for serializing to JSON. */\r\n  ruleType: RuleTypes.ContentModifier;\r\n\r\n  /**\r\n   * Specification of ECClass whose content should be supplemented.\r\n   * The modifier is applied to all ECClasses if this property\r\n   * is not specified.\r\n   */\r\n  class?: SingleSchemaClassSpecification;\r\n}\r\n"]}
+{"version":3,"file":"ContentModifier.js","sourceRoot":"","sources":["../../../../../../src/presentation-common/rules/content/modifiers/ContentModifier.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 { SingleSchemaClassSpecification } from \"../../ClassSpecifications\";\r\nimport { RuleBase, RuleTypes } from \"../../Rule\";\r\nimport { PropertySpecification } from \"../PropertySpecification\";\r\nimport { CalculatedPropertiesSpecification } from \"./CalculatedPropertiesSpecification\";\r\nimport { PropertyCategorySpecification } from \"./PropertyCategorySpecification\";\r\nimport { RelatedPropertiesSpecification } from \"./RelatedPropertiesSpecification\";\r\n\r\n/**\r\n * Contains various rule attributes that allow modifying returned content.\r\n *\r\n * This is not expected to be used directly - use through either [[ContentModifier]]\r\n * or [[ContentSpecification]].\r\n *\r\n * @see [Content modifier rule reference documentation page]($docs/presentation/content/ContentModifier.md)\r\n * @public\r\n */\r\nexport interface ContentModifiersList {\r\n  /**\r\n   * Specifications of [related properties]($docs/presentation/content/RelatedPropertiesSpecification.md) which are\r\n   * included in the generated content.\r\n   */\r\n  relatedProperties?: RelatedPropertiesSpecification[];\r\n\r\n  /**\r\n   * Specifications of [calculated properties]($docs/presentation/content/CalculatedPropertiesSpecification.md) whose values are\r\n   * generated using provided [ECExpressions]($docs/presentation/advanced/ECExpressions.md).\r\n   */\r\n  calculatedProperties?: CalculatedPropertiesSpecification[];\r\n\r\n  /**\r\n   * Specifications for [custom categories]($docs/presentation/content/PropertyCategorySpecification.md). Simply defining the categories does\r\n   * nothing - they have to be referenced from [property specification]($docs/presentation/content/PropertySpecification.md) defined in\r\n   * [[propertyOverrides]] by `id`.\r\n   */\r\n  propertyCategories?: PropertyCategorySpecification[];\r\n\r\n  /**\r\n   * Specifications for various [property overrides]($docs/presentation/content/PropertySpecification.md) that allow customizing property display.\r\n   */\r\n  propertyOverrides?: PropertySpecification[];\r\n}\r\n\r\n/**\r\n * Content modifiers are used to modify how instances of specified ECClasses are displayed in content which is\r\n * produced using [content rules]($docs/presentation/content/ContentRule.md). They do not produce any content\r\n * by themselves.\r\n *\r\n * @see [Content modifier rule reference documentation page]($docs/presentation/content/ContentModifier.md)\r\n * @public\r\n */\r\nexport interface ContentModifier extends RuleBase, ContentModifiersList {\r\n  /** Used for serializing to JSON. */\r\n  ruleType: RuleTypes.ContentModifier;\r\n\r\n  /**\r\n   * Specification of ECClass whose content should be modified. The modifier is applied to all content\r\n   * if this attribute is not specified.\r\n   */\r\n  class?: SingleSchemaClassSpecification;\r\n}\r\n"]}

package/lib/esm/presentation-common/rules/content/modifiers/CustomRendererSpecification.d.ts

@@ -2,11 +2,17 @@
  * @module PresentationRules
  */
 /**
- * Specification for custom content renderer.
+ * This specification allows defining a custom renderer, which can be used to render properties or categories.
+ *
+ * @see [Renderer specification reference documentation page]($docs/presentation/content/RendererSpecification.md)
  * @public
  */
 export interface CustomRendererSpecification {
-    /** Name of the custom renderer. */
+    /**
+     * Name of the renderer that's going to be used in UI components. Value of this attribute corresponds
+     * to [[RendererDescription.name]] attribute that gets assigned to whatever the renderer
+     * is set on.
+     */
     rendererName: string;
 }
 //# sourceMappingURL=CustomRendererSpecification.d.ts.map

package/lib/esm/presentation-common/rules/content/modifiers/CustomRendererSpecification.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"CustomRendererSpecification.d.ts","sourceRoot":"","sources":["../../../../../../src/presentation-common/rules/content/modifiers/CustomRendererSpecification.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH;;;GAGG;AACH,MAAM,WAAW,2BAA2B;IAC1C,mCAAmC;IACnC,YAAY,EAAE,MAAM,CAAC;CACtB"}
+{"version":3,"file":"CustomRendererSpecification.d.ts","sourceRoot":"","sources":["../../../../../../src/presentation-common/rules/content/modifiers/CustomRendererSpecification.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH;;;;;GAKG;AACH,MAAM,WAAW,2BAA2B;IAC1C;;;;OAIG;IACH,YAAY,EAAE,MAAM,CAAC;CACtB"}

package/lib/esm/presentation-common/rules/content/modifiers/CustomRendererSpecification.js.map

@@ -1 +1 @@
-{"version":3,"file":"CustomRendererSpecification.js","sourceRoot":"","sources":["../../../../../../src/presentation-common/rules/content/modifiers/CustomRendererSpecification.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\n/**\r\n * Specification for custom content renderer.\r\n * @public\r\n */\r\nexport interface CustomRendererSpecification {\r\n  /** Name of the custom renderer. */\r\n  rendererName: string;\r\n}\r\n"]}
+{"version":3,"file":"CustomRendererSpecification.js","sourceRoot":"","sources":["../../../../../../src/presentation-common/rules/content/modifiers/CustomRendererSpecification.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\n/**\r\n * This specification allows defining a custom renderer, which can be used to render properties or categories.\r\n *\r\n * @see [Renderer specification reference documentation page]($docs/presentation/content/RendererSpecification.md)\r\n * @public\r\n */\r\nexport interface CustomRendererSpecification {\r\n  /**\r\n   * Name of the renderer that's going to be used in UI components. Value of this attribute corresponds\r\n   * to [[RendererDescription.name]] attribute that gets assigned to whatever the renderer\r\n   * is set on.\r\n   */\r\n  rendererName: string;\r\n}\r\n"]}

package/lib/esm/presentation-common/rules/content/modifiers/PropertyCategorySpecification.d.ts

@@ -58,31 +58,51 @@ export interface IdCategoryIdentifier {
  */
 export declare type CategoryIdentifier = ParentCategoryIdentifier | RootCategoryIdentifier | IdCategoryIdentifier;
 /**
- * Specification to define a custom property category.
+ * Content modifier for defining custom property categories. Custom categories are not present in the result unless
+ * they contain at least one property. One way to assign a property to the category is by using
+ * [property overrides]($docs/presentation/content/PropertySpecification.md).
  *
- * @see [More details]($docs/presentation/Content/PropertyCategorySpecification.md)
+ * @see [Property category specification reference documentation page]($docs/presentation/content/PropertyCategorySpecification.md)
  * @public
  */
 export interface PropertyCategorySpecification {
-    /** Category identifier which has to be unique at the scope of it's definition. */
+    /**
+     * Category identifier used to reference the category definition from property overrides or other category
+     * definitions. The identifier has to be unique within the list of category definitions where this
+     * specification is used.
+     */
     id: string;
     /**
-     * Identifier of a parent category. When specified as a `string`,
-     * the value acts as an [[IdCategoryIdentifier]]. Defaults to [[ParentCategoryIdentifier]].
+     * Identifier of a parent category. When specifying the parent category by ID, it has to be available in
+     * the scope of this category definition.
      */
     parentId?: string | CategoryIdentifier | NoCategoryIdentifier;
-    /** Display label of the category. May be [localized]($docs/presentation/Advanced/Localization.md). */
+    /** Display label of the category. May be [localized]($docs/presentation/advanced/Localization.md). */
     label: string;
-    /** Optional extensive description of the category. */
+    /**
+     * Extensive description of the category. The description is assigned to the category object that's set
+     * on content fields and it's up to UI component to decide how the description is displayed.
+     */
     description?: string;
     /**
-     * Priority of the category. Higher priority categories are displayed on top. Defaults to `1000`.
+     * Assign a custom [[CategoryDescription.priority]] to the category. It's up to the
+     * UI component to make sure that priority is respected - categories with higher priority should appear
+     * before or above categories with lower priority.
+     *
      * @type integer
      */
     priority?: number;
-    /** Should this category be auto-expanded. Defaults to `false`. */
+    /**
+     * Controls the value of [[CategoryDescription.expand]] which tells the UI component
+     * displaying the category to auto-expand the category.
+     */
     autoExpand?: boolean;
-    /** Custom category renderer specification. */
+    /**
+     * Custom category [renderer specification]($docs/presentation/content/RendererSpecification.md) that allows
+     * assigning a custom category renderer to be used in UI. This specification is used to set up
+     * [[CategoryDescription.renderer]] for this category and it's up to the UI component to
+     * make sure appropriate renderer is used to render the category.
+     */
     renderer?: CustomRendererSpecification;
 }
 //# sourceMappingURL=PropertyCategorySpecification.d.ts.map

package/lib/esm/presentation-common/rules/content/modifiers/PropertyCategorySpecification.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"PropertyCategorySpecification.d.ts","sourceRoot":"","sources":["../../../../../../src/presentation-common/rules/content/modifiers/PropertyCategorySpecification.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,EAAE,2BAA2B,EAAE,MAAM,+BAA+B,CAAC;AAE5E;;;;;GAKG;AACH,MAAM,WAAW,oBAAoB;IACnC,6BAA6B;IAC7B,IAAI,EAAE,MAAM,CAAC;CACd;AAED;;;;;;;;;;GAUG;AACH,MAAM,WAAW,wBAAwB;IACvC,6BAA6B;IAC7B,IAAI,EAAE,eAAe,CAAC;CACvB;AAED;;;;;;;;;;GAUG;AACH,MAAM,WAAW,sBAAsB;IACrC,6BAA6B;IAC7B,IAAI,EAAE,MAAM,CAAC;CACd;AAED;;;GAGG;AACH,MAAM,WAAW,oBAAoB;IACnC,6BAA6B;IAC7B,IAAI,EAAE,IAAI,CAAC;IAEX,uDAAuD;IACvD,UAAU,EAAE,MAAM,CAAC;CACpB;AAED;;;GAGG;AACH,oBAAY,kBAAkB,GAAG,wBAAwB,GAAG,sBAAsB,GAAG,oBAAoB,CAAC;AAE1G;;;;;GAKG;AACH,MAAM,WAAW,6BAA6B;IAC5C,kFAAkF;IAClF,EAAE,EAAE,MAAM,CAAC;IAEX;;;OAGG;IACH,QAAQ,CAAC,EAAE,MAAM,GAAG,kBAAkB,GAAG,oBAAoB,CAAC;IAE9D,sGAAsG;IACtG,KAAK,EAAE,MAAM,CAAC;IAEd,sDAAsD;IACtD,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;;OAGG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB,kEAAkE;IAClE,UAAU,CAAC,EAAE,OAAO,CAAC;IAErB,8CAA8C;IAC9C,QAAQ,CAAC,EAAE,2BAA2B,CAAC;CACxC"}
+{"version":3,"file":"PropertyCategorySpecification.d.ts","sourceRoot":"","sources":["../../../../../../src/presentation-common/rules/content/modifiers/PropertyCategorySpecification.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,EAAE,2BAA2B,EAAE,MAAM,+BAA+B,CAAC;AAE5E;;;;;GAKG;AACH,MAAM,WAAW,oBAAoB;IACnC,6BAA6B;IAC7B,IAAI,EAAE,MAAM,CAAC;CACd;AAED;;;;;;;;;;GAUG;AACH,MAAM,WAAW,wBAAwB;IACvC,6BAA6B;IAC7B,IAAI,EAAE,eAAe,CAAC;CACvB;AAED;;;;;;;;;;GAUG;AACH,MAAM,WAAW,sBAAsB;IACrC,6BAA6B;IAC7B,IAAI,EAAE,MAAM,CAAC;CACd;AAED;;;GAGG;AACH,MAAM,WAAW,oBAAoB;IACnC,6BAA6B;IAC7B,IAAI,EAAE,IAAI,CAAC;IAEX,uDAAuD;IACvD,UAAU,EAAE,MAAM,CAAC;CACpB;AAED;;;GAGG;AACH,oBAAY,kBAAkB,GAAG,wBAAwB,GAAG,sBAAsB,GAAG,oBAAoB,CAAC;AAE1G;;;;;;;GAOG;AACH,MAAM,WAAW,6BAA6B;IAC5C;;;;OAIG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;;OAGG;IACH,QAAQ,CAAC,EAAE,MAAM,GAAG,kBAAkB,GAAG,oBAAoB,CAAC;IAE9D,sGAAsG;IACtG,KAAK,EAAE,MAAM,CAAC;IAEd;;;OAGG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;;;;;OAMG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB;;;OAGG;IACH,UAAU,CAAC,EAAE,OAAO,CAAC;IAErB;;;;;OAKG;IACH,QAAQ,CAAC,EAAE,2BAA2B,CAAC;CACxC"}

package/lib/esm/presentation-common/rules/content/modifiers/PropertyCategorySpecification.js.map

@@ -1 +1 @@
-{"version":3,"file":"PropertyCategorySpecification.js","sourceRoot":"","sources":["../../../../../../src/presentation-common/rules/content/modifiers/PropertyCategorySpecification.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 { CustomRendererSpecification } from \"./CustomRendererSpecification\";\r\n\r\n/**\r\n * Identifier for no category. Used to make category displayed at root level by using\r\n * this identifier for [[PropertyCategorySpecification.parentId]].\r\n *\r\n * @public\r\n */\r\nexport interface NoCategoryIdentifier {\r\n  /** Type of the identifier */\r\n  type: \"None\";\r\n}\r\n\r\n/**\r\n * Identifier of the default parent category.\r\n *\r\n * For direct properties it's the default category. See [[DefaultPropertyCategoryOverride]] for overriding the default category.\r\n *\r\n * For related properties it's the category made up from the related ECClass defined by the **last**\r\n * [[RelatedPropertiesSpecification]] with [[RelationshipMeaning.RelatedInstance]]. If there's no such specification,\r\n * the default category is used.\r\n *\r\n * @public\r\n */\r\nexport interface ParentCategoryIdentifier {\r\n  /** Type of the identifier */\r\n  type: \"DefaultParent\";\r\n}\r\n\r\n/**\r\n * Identifier of the root category.\r\n *\r\n * For direct properties it's the default category. See [[DefaultPropertyCategoryOverride]] for overriding the default category.\r\n *\r\n * For related properties it's the category made up from the related ECClass defined by the **first**\r\n * [[RelatedPropertiesSpecification]] with [[RelationshipMeaning.RelatedInstance]]. If there's no such specification,\r\n * the default category is used.\r\n *\r\n * @public\r\n */\r\nexport interface RootCategoryIdentifier {\r\n  /** Type of the identifier */\r\n  type: \"Root\";\r\n}\r\n\r\n/**\r\n * Identifier of a category specified through [[PropertyCategorySpecification]] in this scope.\r\n * @public\r\n */\r\nexport interface IdCategoryIdentifier {\r\n  /** Type of the identifier */\r\n  type: \"Id\";\r\n\r\n  /** ID of the category pointed to by this identifier */\r\n  categoryId: string;\r\n}\r\n\r\n/**\r\n * Category identifier used to assign properties to a category.\r\n * @public\r\n */\r\nexport type CategoryIdentifier = ParentCategoryIdentifier | RootCategoryIdentifier | IdCategoryIdentifier;\r\n\r\n/**\r\n * Specification to define a custom property category.\r\n *\r\n * @see [More details]($docs/presentation/Content/PropertyCategorySpecification.md)\r\n * @public\r\n */\r\nexport interface PropertyCategorySpecification {\r\n  /** Category identifier which has to be unique at the scope of it's definition. */\r\n  id: string;\r\n\r\n  /**\r\n   * Identifier of a parent category. When specified as a `string`,\r\n   * the value acts as an [[IdCategoryIdentifier]]. Defaults to [[ParentCategoryIdentifier]].\r\n   */\r\n  parentId?: string | CategoryIdentifier | NoCategoryIdentifier;\r\n\r\n  /** Display label of the category. May be [localized]($docs/presentation/Advanced/Localization.md). */\r\n  label: string;\r\n\r\n  /** Optional extensive description of the category. */\r\n  description?: string;\r\n\r\n  /**\r\n   * Priority of the category. Higher priority categories are displayed on top. Defaults to `1000`.\r\n   * @type integer\r\n   */\r\n  priority?: number;\r\n\r\n  /** Should this category be auto-expanded. Defaults to `false`. */\r\n  autoExpand?: boolean;\r\n\r\n  /** Custom category renderer specification. */\r\n  renderer?: CustomRendererSpecification;\r\n}\r\n"]}
+{"version":3,"file":"PropertyCategorySpecification.js","sourceRoot":"","sources":["../../../../../../src/presentation-common/rules/content/modifiers/PropertyCategorySpecification.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 { CustomRendererSpecification } from \"./CustomRendererSpecification\";\r\n\r\n/**\r\n * Identifier for no category. Used to make category displayed at root level by using\r\n * this identifier for [[PropertyCategorySpecification.parentId]].\r\n *\r\n * @public\r\n */\r\nexport interface NoCategoryIdentifier {\r\n  /** Type of the identifier */\r\n  type: \"None\";\r\n}\r\n\r\n/**\r\n * Identifier of the default parent category.\r\n *\r\n * For direct properties it's the default category. See [[DefaultPropertyCategoryOverride]] for overriding the default category.\r\n *\r\n * For related properties it's the category made up from the related ECClass defined by the **last**\r\n * [[RelatedPropertiesSpecification]] with [[RelationshipMeaning.RelatedInstance]]. If there's no such specification,\r\n * the default category is used.\r\n *\r\n * @public\r\n */\r\nexport interface ParentCategoryIdentifier {\r\n  /** Type of the identifier */\r\n  type: \"DefaultParent\";\r\n}\r\n\r\n/**\r\n * Identifier of the root category.\r\n *\r\n * For direct properties it's the default category. See [[DefaultPropertyCategoryOverride]] for overriding the default category.\r\n *\r\n * For related properties it's the category made up from the related ECClass defined by the **first**\r\n * [[RelatedPropertiesSpecification]] with [[RelationshipMeaning.RelatedInstance]]. If there's no such specification,\r\n * the default category is used.\r\n *\r\n * @public\r\n */\r\nexport interface RootCategoryIdentifier {\r\n  /** Type of the identifier */\r\n  type: \"Root\";\r\n}\r\n\r\n/**\r\n * Identifier of a category specified through [[PropertyCategorySpecification]] in this scope.\r\n * @public\r\n */\r\nexport interface IdCategoryIdentifier {\r\n  /** Type of the identifier */\r\n  type: \"Id\";\r\n\r\n  /** ID of the category pointed to by this identifier */\r\n  categoryId: string;\r\n}\r\n\r\n/**\r\n * Category identifier used to assign properties to a category.\r\n * @public\r\n */\r\nexport type CategoryIdentifier = ParentCategoryIdentifier | RootCategoryIdentifier | IdCategoryIdentifier;\r\n\r\n/**\r\n * Content modifier for defining custom property categories. Custom categories are not present in the result unless\r\n * they contain at least one property. One way to assign a property to the category is by using\r\n * [property overrides]($docs/presentation/content/PropertySpecification.md).\r\n *\r\n * @see [Property category specification reference documentation page]($docs/presentation/content/PropertyCategorySpecification.md)\r\n * @public\r\n */\r\nexport interface PropertyCategorySpecification {\r\n  /**\r\n   * Category identifier used to reference the category definition from property overrides or other category\r\n   * definitions. The identifier has to be unique within the list of category definitions where this\r\n   * specification is used.\r\n   */\r\n  id: string;\r\n\r\n  /**\r\n   * Identifier of a parent category. When specifying the parent category by ID, it has to be available in\r\n   * the scope of this category definition.\r\n   */\r\n  parentId?: string | CategoryIdentifier | NoCategoryIdentifier;\r\n\r\n  /** Display label of the category. May be [localized]($docs/presentation/advanced/Localization.md). */\r\n  label: string;\r\n\r\n  /**\r\n   * Extensive description of the category. The description is assigned to the category object that's set\r\n   * on content fields and it's up to UI component to decide how the description is displayed.\r\n   */\r\n  description?: string;\r\n\r\n  /**\r\n   * Assign a custom [[CategoryDescription.priority]] to the category. It's up to the\r\n   * UI component to make sure that priority is respected - categories with higher priority should appear\r\n   * before or above categories with lower priority.\r\n   *\r\n   * @type integer\r\n   */\r\n  priority?: number;\r\n\r\n  /**\r\n   * Controls the value of [[CategoryDescription.expand]] which tells the UI component\r\n   * displaying the category to auto-expand the category.\r\n   */\r\n  autoExpand?: boolean;\r\n\r\n  /**\r\n   * Custom category [renderer specification]($docs/presentation/content/RendererSpecification.md) that allows\r\n   * assigning a custom category renderer to be used in UI. This specification is used to set up\r\n   * [[CategoryDescription.renderer]] for this category and it's up to the UI component to\r\n   * make sure appropriate renderer is used to render the category.\r\n   */\r\n  renderer?: CustomRendererSpecification;\r\n}\r\n"]}

package/lib/esm/presentation-common/rules/content/modifiers/PropertyEditorsSpecification.d.ts

@@ -2,16 +2,21 @@
  * @module PresentationRules
  */
 /**
- * Specification for custom property editor
+ * This specification allows assigning a custom property editor to specific properties.
  *
- * @see [More details]($docs/presentation/Content/PropertyEditorSpecification.md)
+ * @see [Property editor specification specification reference documentation page]($docs/presentation/content/PropertyEditorSpecification.md)
  * @public
  */
 export interface PropertyEditorSpecification {
-    /** Name of the custom editor */
+    /**
+     * Name of the property editor that's going to be used in UI components. This name is carried over to
+     * [[Field.editor]] and it's up to the UI component to make sure appropriate editor
+     * is used to edit the property.
+     */
     editorName: string;
     /**
-     * Parameters for the editor
+     * Parameters for the editor.
+     * @note At this moment the attribute is not used.
      * @public
      */
     parameters?: PropertyEditorParameters[];

package/lib/esm/presentation-common/rules/content/modifiers/PropertyEditorsSpecification.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"PropertyEditorsSpecification.d.ts","sourceRoot":"","sources":["../../../../../../src/presentation-common/rules/content/modifiers/PropertyEditorsSpecification.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH;;;;;GAKG;AACH,MAAM,WAAW,2BAA2B;IAC1C,gCAAgC;IAChC,UAAU,EAAE,MAAM,CAAC;IAEnB;;;OAGG;IACH,UAAU,CAAC,EAAE,wBAAwB,EAAE,CAAC;CACzC;AAED;;;GAGG;AACH,MAAM,CAAC,OAAO,MAAM,wBAAwB,GAAG,4BAA4B,GAAG,iCAAiC,GAAG,6BAA6B,GAAG,8BAA8B,CAAC;AAEjL;;;GAGG;AACH,oBAAY,4BAA4B;IACtC,IAAI,SAAS;IACb,SAAS,cAAc;IACvB,KAAK,UAAU;IACf,MAAM,WAAW;CAClB;AAED;;;;GAIG;AACH,MAAM,WAAW,4BAA4B;IAC3C,oCAAoC;IACpC,UAAU,EAAE,4BAA4B,CAAC;CAC1C;AAED;;;GAGG;AACH,MAAM,WAAW,4BAA6B,SAAQ,4BAA4B;IAChF,oCAAoC;IACpC,UAAU,EAAE,4BAA4B,CAAC,IAAI,CAAC;IAE9C,8DAA8D;IAC9D,IAAI,EAAE,GAAG,CAAC;CACX;AAED;;;GAGG;AACH,MAAM,WAAW,iCAAkC,SAAQ,4BAA4B;IACrF,oCAAoC;IACpC,UAAU,EAAE,4BAA4B,CAAC,SAAS,CAAC;IAEnD;;;;;OAKG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB;AAED;;;GAGG;AACH,MAAM,WAAW,6BAA8B,SAAQ,4BAA4B;IACjF,oCAAoC;IACpC,UAAU,EAAE,4BAA4B,CAAC,KAAK,CAAC;IAE/C,kCAAkC;IAClC,GAAG,CAAC,EAAE,MAAM,CAAC;IAEb,kCAAkC;IAClC,GAAG,CAAC,EAAE,MAAM,CAAC;CACd;AAED;;;GAGG;AACH,MAAM,WAAW,8BAA+B,SAAQ,4BAA4B;IAClF,oCAAoC;IACpC,UAAU,EAAE,4BAA4B,CAAC,MAAM,CAAC;IAEhD,qCAAqC;IACrC,GAAG,EAAE,MAAM,CAAC;IAEZ,qCAAqC;IACrC,GAAG,EAAE,MAAM,CAAC;IAEZ;;;;;OAKG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;IAExB,0BAA0B;IAC1B,UAAU,CAAC,EAAE,OAAO,CAAC;CACtB"}
+{"version":3,"file":"PropertyEditorsSpecification.d.ts","sourceRoot":"","sources":["../../../../../../src/presentation-common/rules/content/modifiers/PropertyEditorsSpecification.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH;;;;;GAKG;AACH,MAAM,WAAW,2BAA2B;IAC1C;;;;OAIG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;;;OAIG;IACH,UAAU,CAAC,EAAE,wBAAwB,EAAE,CAAC;CACzC;AAED;;;GAGG;AACH,MAAM,CAAC,OAAO,MAAM,wBAAwB,GAAG,4BAA4B,GAAG,iCAAiC,GAAG,6BAA6B,GAAG,8BAA8B,CAAC;AAEjL;;;GAGG;AACH,oBAAY,4BAA4B;IACtC,IAAI,SAAS;IACb,SAAS,cAAc;IACvB,KAAK,UAAU;IACf,MAAM,WAAW;CAClB;AAED;;;;GAIG;AACH,MAAM,WAAW,4BAA4B;IAC3C,oCAAoC;IACpC,UAAU,EAAE,4BAA4B,CAAC;CAC1C;AAED;;;GAGG;AACH,MAAM,WAAW,4BAA6B,SAAQ,4BAA4B;IAChF,oCAAoC;IACpC,UAAU,EAAE,4BAA4B,CAAC,IAAI,CAAC;IAE9C,8DAA8D;IAC9D,IAAI,EAAE,GAAG,CAAC;CACX;AAED;;;GAGG;AACH,MAAM,WAAW,iCAAkC,SAAQ,4BAA4B;IACrF,oCAAoC;IACpC,UAAU,EAAE,4BAA4B,CAAC,SAAS,CAAC;IAEnD;;;;;OAKG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB;AAED;;;GAGG;AACH,MAAM,WAAW,6BAA8B,SAAQ,4BAA4B;IACjF,oCAAoC;IACpC,UAAU,EAAE,4BAA4B,CAAC,KAAK,CAAC;IAE/C,kCAAkC;IAClC,GAAG,CAAC,EAAE,MAAM,CAAC;IAEb,kCAAkC;IAClC,GAAG,CAAC,EAAE,MAAM,CAAC;CACd;AAED;;;GAGG;AACH,MAAM,WAAW,8BAA+B,SAAQ,4BAA4B;IAClF,oCAAoC;IACpC,UAAU,EAAE,4BAA4B,CAAC,MAAM,CAAC;IAEhD,qCAAqC;IACrC,GAAG,EAAE,MAAM,CAAC;IAEZ,qCAAqC;IACrC,GAAG,EAAE,MAAM,CAAC;IAEZ;;;;;OAKG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;IAExB,0BAA0B;IAC1B,UAAU,CAAC,EAAE,OAAO,CAAC;CACtB"}

package/lib/esm/presentation-common/rules/content/modifiers/PropertyEditorsSpecification.js.map

@@ -1 +1 @@
-{"version":3,"file":"PropertyEditorsSpecification.js","sourceRoot":"","sources":["../../../../../../src/presentation-common/rules/content/modifiers/PropertyEditorsSpecification.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG;AAyBH;;;GAGG;AACH,MAAM,CAAN,IAAY,4BAKX;AALD,WAAY,4BAA4B;IACtC,6CAAa,CAAA;IACb,uDAAuB,CAAA;IACvB,+CAAe,CAAA;IACf,iDAAiB,CAAA;AACnB,CAAC,EALW,4BAA4B,KAA5B,4BAA4B,QAKvC","sourcesContent":["/*---------------------------------------------------------------------------------------------\r\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\r\n* See LICENSE.md in the project root for license terms and full copyright notice.\r\n*--------------------------------------------------------------------------------------------*/\r\n/** @packageDocumentation\r\n * @module PresentationRules\r\n */\r\n\r\n/**\r\n * Specification for custom property editor\r\n *\r\n * @see [More details]($docs/presentation/Content/PropertyEditorSpecification.md)\r\n * @public\r\n */\r\nexport interface PropertyEditorSpecification {\r\n  /** Name of the custom editor */\r\n  editorName: string;\r\n\r\n  /**\r\n   * Parameters for the editor\r\n   * @public\r\n   */\r\n  parameters?: PropertyEditorParameters[];\r\n}\r\n\r\n/**\r\n * Parameters for [[PropertyEditorSpecification]]\r\n * @public\r\n */\r\nexport declare type PropertyEditorParameters = PropertyEditorJsonParameters | PropertyEditorMultilineParameters | PropertyEditorRangeParameters | PropertyEditorSliderParameters;\r\n\r\n/**\r\n * Used for serializing array of [[PropertyEditorParameters]] to JSON\r\n * @public\r\n */\r\nexport enum PropertyEditorParameterTypes {\r\n  Json = \"Json\",\r\n  Multiline = \"Multiline\",\r\n  Range = \"Range\",\r\n  Slider = \"Slider\",\r\n}\r\n\r\n/**\r\n * Base interface for [[PropertyEditorParameters]]. Not meant\r\n * to be used directly, see `PropertyEditorParameters`.\r\n * @public\r\n */\r\nexport interface PropertyEditorParametersBase {\r\n  /** Used for serializing to JSON. */\r\n  paramsType: PropertyEditorParameterTypes;\r\n}\r\n\r\n/**\r\n * Arbitrary JSON parameters for custom property editors\r\n * @public\r\n */\r\nexport interface PropertyEditorJsonParameters extends PropertyEditorParametersBase {\r\n  /** Used for serializing to JSON. */\r\n  paramsType: PropertyEditorParameterTypes.Json;\r\n\r\n  /** Arbitrary JSON that can be handled by a property editor */\r\n  json: any;\r\n}\r\n\r\n/**\r\n * Multiline parameters for property editors that support multiline display\r\n * @public\r\n */\r\nexport interface PropertyEditorMultilineParameters extends PropertyEditorParametersBase {\r\n  /** Used for serializing to JSON. */\r\n  paramsType: PropertyEditorParameterTypes.Multiline;\r\n\r\n  /**\r\n   * Number of lines. Defaults to `1`.\r\n   *\r\n   * @type integer\r\n   * @minimum 1\r\n   */\r\n  height?: number;\r\n}\r\n\r\n/**\r\n * Range parameters for property editors that support ranges\r\n * @public\r\n */\r\nexport interface PropertyEditorRangeParameters extends PropertyEditorParametersBase {\r\n  /** Used for serializing to JSON. */\r\n  paramsType: PropertyEditorParameterTypes.Range;\r\n\r\n  /** Minimum value of the range. */\r\n  min?: number;\r\n\r\n  /** Maximum value of the range. */\r\n  max?: number;\r\n}\r\n\r\n/**\r\n * Slider parameters for property editors that support slider display\r\n * @public\r\n */\r\nexport interface PropertyEditorSliderParameters extends PropertyEditorParametersBase {\r\n  /** Used for serializing to JSON. */\r\n  paramsType: PropertyEditorParameterTypes.Slider;\r\n\r\n  /** Minimum value that can be set. */\r\n  min: number;\r\n\r\n  /** Maximum value that can be set. */\r\n  max: number;\r\n\r\n  /**\r\n   * Count of intervals. Defaults to `1`.\r\n   *\r\n   * @type integer\r\n   * @minimum 1\r\n   */\r\n  intervalsCount?: number;\r\n\r\n  /** Is slider vertical. */\r\n  isVertical?: boolean;\r\n}\r\n"]}
+{"version":3,"file":"PropertyEditorsSpecification.js","sourceRoot":"","sources":["../../../../../../src/presentation-common/rules/content/modifiers/PropertyEditorsSpecification.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG;AA8BH;;;GAGG;AACH,MAAM,CAAN,IAAY,4BAKX;AALD,WAAY,4BAA4B;IACtC,6CAAa,CAAA;IACb,uDAAuB,CAAA;IACvB,+CAAe,CAAA;IACf,iDAAiB,CAAA;AACnB,CAAC,EALW,4BAA4B,KAA5B,4BAA4B,QAKvC","sourcesContent":["/*---------------------------------------------------------------------------------------------\r\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\r\n* See LICENSE.md in the project root for license terms and full copyright notice.\r\n*--------------------------------------------------------------------------------------------*/\r\n/** @packageDocumentation\r\n * @module PresentationRules\r\n */\r\n\r\n/**\r\n * This specification allows assigning a custom property editor to specific properties.\r\n *\r\n * @see [Property editor specification specification reference documentation page]($docs/presentation/content/PropertyEditorSpecification.md)\r\n * @public\r\n */\r\nexport interface PropertyEditorSpecification {\r\n  /**\r\n   * Name of the property editor that's going to be used in UI components. This name is carried over to\r\n   * [[Field.editor]] and it's up to the UI component to make sure appropriate editor\r\n   * is used to edit the property.\r\n   */\r\n  editorName: string;\r\n\r\n  /**\r\n   * Parameters for the editor.\r\n   * @note At this moment the attribute is not used.\r\n   * @public\r\n   */\r\n  parameters?: PropertyEditorParameters[];\r\n}\r\n\r\n/**\r\n * Parameters for [[PropertyEditorSpecification]]\r\n * @public\r\n */\r\nexport declare type PropertyEditorParameters = PropertyEditorJsonParameters | PropertyEditorMultilineParameters | PropertyEditorRangeParameters | PropertyEditorSliderParameters;\r\n\r\n/**\r\n * Used for serializing array of [[PropertyEditorParameters]] to JSON\r\n * @public\r\n */\r\nexport enum PropertyEditorParameterTypes {\r\n  Json = \"Json\",\r\n  Multiline = \"Multiline\",\r\n  Range = \"Range\",\r\n  Slider = \"Slider\",\r\n}\r\n\r\n/**\r\n * Base interface for [[PropertyEditorParameters]]. Not meant\r\n * to be used directly, see `PropertyEditorParameters`.\r\n * @public\r\n */\r\nexport interface PropertyEditorParametersBase {\r\n  /** Used for serializing to JSON. */\r\n  paramsType: PropertyEditorParameterTypes;\r\n}\r\n\r\n/**\r\n * Arbitrary JSON parameters for custom property editors\r\n * @public\r\n */\r\nexport interface PropertyEditorJsonParameters extends PropertyEditorParametersBase {\r\n  /** Used for serializing to JSON. */\r\n  paramsType: PropertyEditorParameterTypes.Json;\r\n\r\n  /** Arbitrary JSON that can be handled by a property editor */\r\n  json: any;\r\n}\r\n\r\n/**\r\n * Multiline parameters for property editors that support multiline display\r\n * @public\r\n */\r\nexport interface PropertyEditorMultilineParameters extends PropertyEditorParametersBase {\r\n  /** Used for serializing to JSON. */\r\n  paramsType: PropertyEditorParameterTypes.Multiline;\r\n\r\n  /**\r\n   * Number of lines. Defaults to `1`.\r\n   *\r\n   * @type integer\r\n   * @minimum 1\r\n   */\r\n  height?: number;\r\n}\r\n\r\n/**\r\n * Range parameters for property editors that support ranges\r\n * @public\r\n */\r\nexport interface PropertyEditorRangeParameters extends PropertyEditorParametersBase {\r\n  /** Used for serializing to JSON. */\r\n  paramsType: PropertyEditorParameterTypes.Range;\r\n\r\n  /** Minimum value of the range. */\r\n  min?: number;\r\n\r\n  /** Maximum value of the range. */\r\n  max?: number;\r\n}\r\n\r\n/**\r\n * Slider parameters for property editors that support slider display\r\n * @public\r\n */\r\nexport interface PropertyEditorSliderParameters extends PropertyEditorParametersBase {\r\n  /** Used for serializing to JSON. */\r\n  paramsType: PropertyEditorParameterTypes.Slider;\r\n\r\n  /** Minimum value that can be set. */\r\n  min: number;\r\n\r\n  /** Maximum value that can be set. */\r\n  max: number;\r\n\r\n  /**\r\n   * Count of intervals. Defaults to `1`.\r\n   *\r\n   * @type integer\r\n   * @minimum 1\r\n   */\r\n  intervalsCount?: number;\r\n\r\n  /** Is slider vertical. */\r\n  isVertical?: boolean;\r\n}\r\n"]}

package/lib/esm/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/esm/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/esm/presentation-common/rules/content/modifiers/RelatedPropertiesSpecification.js

@@ -6,21 +6,19 @@
  * @module PresentationRules
  */
 /**
- * Meaning of the relationship
+ * Meaning of the relationship.
  * @public
  */
 export 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 || (RelationshipMeaning = {}));

package/lib/esm/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,MAAM,CAAN,IAAY,mBAcX;AAdD,WAAY,mBAAmB;IAC7B;;;;OAIG;IACH,oDAA6B,CAAA;IAE7B;;;;OAIG;IACH,0DAAmC,CAAA;AACrC,CAAC,EAdW,mBAAmB,KAAnB,mBAAmB,QAc9B;AAED;;;GAGG;AACH,MAAM,CAAN,IAAY,8BAWX;AAXD,WAAY,8BAA8B;IACxC;;;OAGG;IACH,iDAAe,CAAA;IAEf;;OAEG;IACH,2CAAS,CAAA;AACX,CAAC,EAXW,8BAA8B,KAA9B,8BAA8B,QAWzC","sourcesContent":["/*---------------------------------------------------------------------------------------------\r\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\r\n* See LICENSE.md in the project root for license terms and full copyright notice.\r\n*--------------------------------------------------------------------------------------------*/\r\n/** @packageDocumentation\r\n * @module PresentationRules\r\n */\r\n\r\nimport { RelationshipPathSpecification } from \"../../RelationshipPathSpecification\";\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,MAAM,CAAN,IAAY,mBAYX;AAZD,WAAY,mBAAmB;IAC7B;;;OAGG;IACH,oDAA6B,CAAA;IAE7B;;;OAGG;IACH,0DAAmC,CAAA;AACrC,CAAC,EAZW,mBAAmB,KAAnB,mBAAmB,QAY9B;AAED;;;GAGG;AACH,MAAM,CAAN,IAAY,8BAWX;AAXD,WAAY,8BAA8B;IACxC;;;OAGG;IACH,iDAAe,CAAA;IAEf;;OAEG;IACH,2CAAS,CAAA;AACX,CAAC,EAXW,8BAA8B,KAA9B,8BAA8B,QAWzC","sourcesContent":["/*---------------------------------------------------------------------------------------------\r\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\r\n* See LICENSE.md in the project root for license terms and full copyright notice.\r\n*--------------------------------------------------------------------------------------------*/\r\n/** @packageDocumentation\r\n * @module PresentationRules\r\n */\r\n\r\nimport { RelationshipPathSpecification } from \"../../RelationshipPathSpecification\";\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/esm/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/esm/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/esm/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/esm/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/esm/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/esm/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"]}