@itwin/presentation-common 4.0.0-dev.6 → 4.0.0-dev.61

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

@@ -1,108 +1,108 @@
-/** @packageDocumentation
- * @module PresentationRules
- */
-import { CustomRendererSpecification } from "./CustomRendererSpecification";
-/**
- * Identifier for no category. Used to make category displayed at root level by using
- * this identifier for [[PropertyCategorySpecification.parentId]].
- *
- * @public
- */
-export interface NoCategoryIdentifier {
-    /** Type of the identifier */
-    type: "None";
-}
-/**
- * Identifier of the default parent category.
- *
- * For direct properties it's the default category. See [[DefaultPropertyCategoryOverride]] for overriding the default category.
- *
- * For related properties it's the category made up from the related ECClass defined by the **last**
- * [[RelatedPropertiesSpecification]] with [[RelationshipMeaning.RelatedInstance]]. If there's no such specification,
- * the default category is used.
- *
- * @public
- */
-export interface ParentCategoryIdentifier {
-    /** Type of the identifier */
-    type: "DefaultParent";
-}
-/**
- * Identifier of the root category.
- *
- * For direct properties it's the default category. See [[DefaultPropertyCategoryOverride]] for overriding the default category.
- *
- * For related properties it's the category made up from the related ECClass defined by the **first**
- * [[RelatedPropertiesSpecification]] with [[RelationshipMeaning.RelatedInstance]]. If there's no such specification,
- * the default category is used.
- *
- * @public
- */
-export interface RootCategoryIdentifier {
-    /** Type of the identifier */
-    type: "Root";
-}
-/**
- * Identifier of a category specified through [[PropertyCategorySpecification]] in this scope.
- * @public
- */
-export interface IdCategoryIdentifier {
-    /** Type of the identifier */
-    type: "Id";
-    /** ID of the category pointed to by this identifier */
-    categoryId: string;
-}
-/**
- * Category identifier used to assign properties to a category.
- * @public
- */
-export declare type CategoryIdentifier = ParentCategoryIdentifier | RootCategoryIdentifier | IdCategoryIdentifier;
-/**
- * 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 [Property category specification reference documentation page]($docs/presentation/content/PropertyCategorySpecification.md)
- * @public
- */
-export interface PropertyCategorySpecification {
-    /**
-     * 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 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). */
-    label: string;
-    /**
-     * 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;
-    /**
-     * 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;
-    /**
-     * 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]($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;
-}
+/** @packageDocumentation
+ * @module PresentationRules
+ */
+import { CustomRendererSpecification } from "./CustomRendererSpecification";
+/**
+ * Identifier for no category. Used to make category displayed at root level by using
+ * this identifier for [[PropertyCategorySpecification.parentId]].
+ *
+ * @public
+ */
+export interface NoCategoryIdentifier {
+    /** Type of the identifier */
+    type: "None";
+}
+/**
+ * Identifier of the default parent category.
+ *
+ * For direct properties it's the default category. See [[DefaultPropertyCategoryOverride]] for overriding the default category.
+ *
+ * For related properties it's the category made up from the related ECClass defined by the **last**
+ * [[RelatedPropertiesSpecification]] with [[RelationshipMeaning.RelatedInstance]]. If there's no such specification,
+ * the default category is used.
+ *
+ * @public
+ */
+export interface ParentCategoryIdentifier {
+    /** Type of the identifier */
+    type: "DefaultParent";
+}
+/**
+ * Identifier of the root category.
+ *
+ * For direct properties it's the default category. See [[DefaultPropertyCategoryOverride]] for overriding the default category.
+ *
+ * For related properties it's the category made up from the related ECClass defined by the **first**
+ * [[RelatedPropertiesSpecification]] with [[RelationshipMeaning.RelatedInstance]]. If there's no such specification,
+ * the default category is used.
+ *
+ * @public
+ */
+export interface RootCategoryIdentifier {
+    /** Type of the identifier */
+    type: "Root";
+}
+/**
+ * Identifier of a category specified through [[PropertyCategorySpecification]] in this scope.
+ * @public
+ */
+export interface IdCategoryIdentifier {
+    /** Type of the identifier */
+    type: "Id";
+    /** ID of the category pointed to by this identifier */
+    categoryId: string;
+}
+/**
+ * Category identifier used to assign properties to a category.
+ * @public
+ */
+export type CategoryIdentifier = ParentCategoryIdentifier | RootCategoryIdentifier | IdCategoryIdentifier;
+/**
+ * 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 [Property category specification reference documentation page]($docs/presentation/content/PropertyCategorySpecification.md)
+ * @public
+ */
+export interface PropertyCategorySpecification {
+    /**
+     * 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 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). */
+    label: string;
+    /**
+     * 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;
+    /**
+     * 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;
+    /**
+     * 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]($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;;;;;;;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"}
+{"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,MAAM,MAAM,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

@@ -1,9 +1,9 @@
-/*---------------------------------------------------------------------------------------------
-* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
-* See LICENSE.md in the project root for license terms and full copyright notice.
-*--------------------------------------------------------------------------------------------*/
-/** @packageDocumentation
- * @module PresentationRules
- */
-export {};
+/*---------------------------------------------------------------------------------------------
+* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
+* See LICENSE.md in the project root for license terms and full copyright notice.
+*--------------------------------------------------------------------------------------------*/
+/** @packageDocumentation
+ * @module PresentationRules
+ */
+export {};
 //# sourceMappingURL=PropertyCategorySpecification.js.map

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

@@ -1,109 +1,109 @@
-/** @packageDocumentation
- * @module PresentationRules
- */
-/**
- * This specification allows assigning a custom property editor to specific properties.
- *
- * @see [Property editor specification specification reference documentation page]($docs/presentation/content/PropertyEditorSpecification.md)
- * @public
- */
-export interface PropertyEditorSpecification {
-    /**
-     * 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.
-     * @note At this moment the attribute is not used.
-     * @public
-     */
-    parameters?: PropertyEditorParameters[];
-}
-/**
- * Parameters for [[PropertyEditorSpecification]]
- * @public
- */
-export declare type PropertyEditorParameters = PropertyEditorJsonParameters | PropertyEditorMultilineParameters | PropertyEditorRangeParameters | PropertyEditorSliderParameters;
-/**
- * Used for serializing array of [[PropertyEditorParameters]] to JSON
- * @public
- */
-export declare enum PropertyEditorParameterTypes {
-    Json = "Json",
-    Multiline = "Multiline",
-    Range = "Range",
-    Slider = "Slider"
-}
-/**
- * Base interface for [[PropertyEditorParameters]]. Not meant
- * to be used directly, see `PropertyEditorParameters`.
- * @public
- */
-export interface PropertyEditorParametersBase {
-    /**
-     * Used for serializing to JSON.
-     * @see PropertyEditorParameterTypes
-     */
-    paramsType: `${PropertyEditorParameterTypes}`;
-}
-/**
- * Arbitrary JSON parameters for custom property editors
- * @public
- */
-export interface PropertyEditorJsonParameters extends PropertyEditorParametersBase {
-    /** Used for serializing to JSON. */
-    paramsType: "Json";
-    /** Arbitrary JSON that can be handled by a property editor */
-    json: any;
-}
-/**
- * Multiline parameters for property editors that support multiline display
- * @public
- */
-export interface PropertyEditorMultilineParameters extends PropertyEditorParametersBase {
-    /** Used for serializing to JSON. */
-    paramsType: "Multiline";
-    /**
-     * Number of lines. Defaults to `1`.
-     *
-     * @type integer
-     * @minimum 1
-     */
-    height?: number;
-}
-/**
- * Range parameters for property editors that support ranges
- * @public
- */
-export interface PropertyEditorRangeParameters extends PropertyEditorParametersBase {
-    /** Used for serializing to JSON. */
-    paramsType: "Range";
-    /** Minimum value of the range. */
-    min?: number;
-    /** Maximum value of the range. */
-    max?: number;
-}
-/**
- * Slider parameters for property editors that support slider display
- * @public
- */
-export interface PropertyEditorSliderParameters extends PropertyEditorParametersBase {
-    /** Used for serializing to JSON. */
-    paramsType: "Slider";
-    /** Minimum value that can be set. */
-    min: number;
-    /** Maximum value that can be set. */
-    max: number;
-    /**
-     * Count of intervals. Defaults to `1`.
-     *
-     * @type integer
-     * @minimum 1
-     */
-    intervalsCount?: number;
-    /** Is slider vertical. */
-    isVertical?: boolean;
-}
+/** @packageDocumentation
+ * @module PresentationRules
+ */
+/**
+ * This specification allows assigning a custom property editor to specific properties.
+ *
+ * @see [Property editor specification specification reference documentation page]($docs/presentation/content/PropertyEditorSpecification.md)
+ * @public
+ */
+export interface PropertyEditorSpecification {
+    /**
+     * 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.
+     * @note At this moment the attribute is not used.
+     * @public
+     */
+    parameters?: PropertyEditorParameters[];
+}
+/**
+ * Parameters for [[PropertyEditorSpecification]]
+ * @public
+ */
+export declare type PropertyEditorParameters = PropertyEditorJsonParameters | PropertyEditorMultilineParameters | PropertyEditorRangeParameters | PropertyEditorSliderParameters;
+/**
+ * Used for serializing array of [[PropertyEditorParameters]] to JSON
+ * @public
+ */
+export declare enum PropertyEditorParameterTypes {
+    Json = "Json",
+    Multiline = "Multiline",
+    Range = "Range",
+    Slider = "Slider"
+}
+/**
+ * Base interface for [[PropertyEditorParameters]]. Not meant
+ * to be used directly, see `PropertyEditorParameters`.
+ * @public
+ */
+export interface PropertyEditorParametersBase {
+    /**
+     * Used for serializing to JSON.
+     * @see PropertyEditorParameterTypes
+     */
+    paramsType: `${PropertyEditorParameterTypes}`;
+}
+/**
+ * Arbitrary JSON parameters for custom property editors
+ * @public
+ */
+export interface PropertyEditorJsonParameters extends PropertyEditorParametersBase {
+    /** Used for serializing to JSON. */
+    paramsType: "Json";
+    /** Arbitrary JSON that can be handled by a property editor */
+    json: any;
+}
+/**
+ * Multiline parameters for property editors that support multiline display
+ * @public
+ */
+export interface PropertyEditorMultilineParameters extends PropertyEditorParametersBase {
+    /** Used for serializing to JSON. */
+    paramsType: "Multiline";
+    /**
+     * Number of lines. Defaults to `1`.
+     *
+     * @type integer
+     * @minimum 1
+     */
+    height?: number;
+}
+/**
+ * Range parameters for property editors that support ranges
+ * @public
+ */
+export interface PropertyEditorRangeParameters extends PropertyEditorParametersBase {
+    /** Used for serializing to JSON. */
+    paramsType: "Range";
+    /** Minimum value of the range. */
+    min?: number;
+    /** Maximum value of the range. */
+    max?: number;
+}
+/**
+ * Slider parameters for property editors that support slider display
+ * @public
+ */
+export interface PropertyEditorSliderParameters extends PropertyEditorParametersBase {
+    /** Used for serializing to JSON. */
+    paramsType: "Slider";
+    /** Minimum value that can be set. */
+    min: number;
+    /** Maximum value that can be set. */
+    max: number;
+    /**
+     * Count of intervals. Defaults to `1`.
+     *
+     * @type integer
+     * @minimum 1
+     */
+    intervalsCount?: number;
+    /** Is slider vertical. */
+    isVertical?: boolean;
+}
 //# sourceMappingURL=PropertyEditorsSpecification.d.ts.map

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

@@ -1,19 +1,19 @@
-/*---------------------------------------------------------------------------------------------
-* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
-* See LICENSE.md in the project root for license terms and full copyright notice.
-*--------------------------------------------------------------------------------------------*/
-/** @packageDocumentation
- * @module PresentationRules
- */
-/**
- * Used for serializing array of [[PropertyEditorParameters]] to JSON
- * @public
- */
-export var PropertyEditorParameterTypes;
-(function (PropertyEditorParameterTypes) {
-    PropertyEditorParameterTypes["Json"] = "Json";
-    PropertyEditorParameterTypes["Multiline"] = "Multiline";
-    PropertyEditorParameterTypes["Range"] = "Range";
-    PropertyEditorParameterTypes["Slider"] = "Slider";
-})(PropertyEditorParameterTypes || (PropertyEditorParameterTypes = {}));
+/*---------------------------------------------------------------------------------------------
+* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
+* See LICENSE.md in the project root for license terms and full copyright notice.
+*--------------------------------------------------------------------------------------------*/
+/** @packageDocumentation
+ * @module PresentationRules
+ */
+/**
+ * Used for serializing array of [[PropertyEditorParameters]] to JSON
+ * @public
+ */
+export var PropertyEditorParameterTypes;
+(function (PropertyEditorParameterTypes) {
+    PropertyEditorParameterTypes["Json"] = "Json";
+    PropertyEditorParameterTypes["Multiline"] = "Multiline";
+    PropertyEditorParameterTypes["Range"] = "Range";
+    PropertyEditorParameterTypes["Slider"] = "Slider";
+})(PropertyEditorParameterTypes || (PropertyEditorParameterTypes = {}));
 //# sourceMappingURL=PropertyEditorsSpecification.js.map