@itwin/presentation-common 4.0.0-dev.8 → 4.0.0-dev.80

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

@@ -1,87 +1,87 @@
-/** @packageDocumentation
- * @module PresentationRules
- */
-import { CustomRendererSpecification } from "./modifiers/CustomRendererSpecification";
-import { CategoryIdentifier } from "./modifiers/PropertyCategorySpecification";
-import { PropertyEditorSpecification } from "./modifiers/PropertyEditorsSpecification";
-/**
- * A container structure for possible property overrides
- *
- * @see [Property specification reference documentation page]($docs/presentation/content/PropertySpecification.md)
- * @public
- */
-export interface PropertyOverrides {
-    /**
-     * There may be multiple property specifications that apply to a single property and there may be conflicts between
-     * different attributes. The `overridesPriority` attribute is here to help solve the problem - if multiple specifications
-     * attempt to override the same attribute, the override of specification with highest `overridesPriority` value is used.
-     * The order of overrides from specification with the same `overridesPriority` is defined by the order they appear in
-     * the overrides list.
-     */
-    overridesPriority?: number;
-    /** This is an attribute that allows overriding the property label. May be [localized]($docs/presentation/advanced/Localization.md). */
-    labelOverride?: string;
-    /** The attribute allows moving the property into a different category. */
-    categoryId?: string | CategoryIdentifier;
-    /**
-     * This attribute controls whether the particular property is present in the result, even when it is marked as hidden in the
-     * ECSchema. The allowed settings are:
-     *
-     * - Omitted or `undefined`: property visibility is controlled by the ECSchema.
-     *
-     * - `true`: property is made visible. **Warning:** this will automatically hide all other properties of the same class.
-     *   If this behavior is not desirable, set [[doNotHideOtherPropertiesOnDisplayOverride]] attribute to `true`.
-     *
-     * - `false`: property is made hidden.
-     *
-     * The value can also be set using an ECExpression.
-     */
-    isDisplayed?: boolean | string;
-    /**
-     * Custom property [renderer specification]($docs/presentation/content/RendererSpecification.md) that allows assigning a
-     * custom value renderer to be used in UI. The specification is used to set up [[Field.renderer]] for
-     * this property and it's up to the UI component to make sure appropriate renderer is used to render the property.
-     */
-    renderer?: CustomRendererSpecification;
-    /**
-     * Custom [property editor specification]($docs/presentation/content/PropertyEditorSpecification) that allows assigning
-     * a custom value editor to be used in UI.
-     */
-    editor?: PropertyEditorSpecification;
-    /**
-     * This attribute controls whether making the property visible using [[isDisplayed]] attribute should automatically hide
-     * all other properties of the same class. When `true`, this behavior is disabled.
-     */
-    doNotHideOtherPropertiesOnDisplayOverride?: boolean;
-    /**
-     * This attribute controls whether the property field is read-only. If the attribute value is not set, the field is
-     * read-only when at least one of the properties is read-only.
-     */
-    isReadOnly?: boolean;
-    /**
-     * This attribute controls the order in which property fields should be displayed. Property fields with higher priority
-     * will appear before property fields with lower priority. If the attribute value is not set, the field's priority
-     * will be the maximum priority of its properties.
-     */
-    priority?: number;
-}
-/**
- * This specification allows overriding some attributes of specific ECProperty or define how it's displayed.
- *
- * @see [Property specification reference documentation page]($docs/presentation/content/PropertySpecification.md)
- * @public
- */
-export interface PropertySpecification extends PropertyOverrides {
-    /**
-     * Name of the ECProperty to apply overrides to. A `"*"` may be specified to match all properties in current context.
-     * The current context is determined based on where the override is specified:
-     *
-     * - When used in a [content modifier]($docs/presentation/content/ContentModifier.md#attribute-propertyoverrides), the
-     *   properties of the ECClass specified by the [`class` attribute]($docs/presentation/content/ContentModifier.md#attribute-class) are used.
-     *
-     * - When used in one of the [content specifications]($docs/presentation/content/ContentRule.md#attribute-specifications),
-     *   properties produced by that specification are used.
-     */
-    name: string;
-}
+/** @packageDocumentation
+ * @module PresentationRules
+ */
+import { CustomRendererSpecification } from "./modifiers/CustomRendererSpecification";
+import { CategoryIdentifier } from "./modifiers/PropertyCategorySpecification";
+import { PropertyEditorSpecification } from "./modifiers/PropertyEditorsSpecification";
+/**
+ * A container structure for possible property overrides
+ *
+ * @see [Property specification reference documentation page]($docs/presentation/content/PropertySpecification.md)
+ * @public
+ */
+export interface PropertyOverrides {
+    /**
+     * There may be multiple property specifications that apply to a single property and there may be conflicts between
+     * different attributes. The `overridesPriority` attribute is here to help solve the problem - if multiple specifications
+     * attempt to override the same attribute, the override of specification with highest `overridesPriority` value is used.
+     * The order of overrides from specification with the same `overridesPriority` is defined by the order they appear in
+     * the overrides list.
+     */
+    overridesPriority?: number;
+    /** This is an attribute that allows overriding the property label. May be [localized]($docs/presentation/advanced/Localization.md). */
+    labelOverride?: string;
+    /** The attribute allows moving the property into a different category. */
+    categoryId?: string | CategoryIdentifier;
+    /**
+     * This attribute controls whether the particular property is present in the result, even when it is marked as hidden in the
+     * ECSchema. The allowed settings are:
+     *
+     * - Omitted or `undefined`: property visibility is controlled by the ECSchema.
+     *
+     * - `true`: property is made visible. **Warning:** this will automatically hide all other properties of the same class.
+     *   If this behavior is not desirable, set [[doNotHideOtherPropertiesOnDisplayOverride]] attribute to `true`.
+     *
+     * - `false`: property is made hidden.
+     *
+     * The value can also be set using an ECExpression.
+     */
+    isDisplayed?: boolean | string;
+    /**
+     * Custom property [renderer specification]($docs/presentation/content/RendererSpecification.md) that allows assigning a
+     * custom value renderer to be used in UI. The specification is used to set up [[Field.renderer]] for
+     * this property and it's up to the UI component to make sure appropriate renderer is used to render the property.
+     */
+    renderer?: CustomRendererSpecification;
+    /**
+     * Custom [property editor specification]($docs/presentation/content/PropertyEditorSpecification) that allows assigning
+     * a custom value editor to be used in UI.
+     */
+    editor?: PropertyEditorSpecification;
+    /**
+     * This attribute controls whether making the property visible using [[isDisplayed]] attribute should automatically hide
+     * all other properties of the same class. When `true`, this behavior is disabled.
+     */
+    doNotHideOtherPropertiesOnDisplayOverride?: boolean;
+    /**
+     * This attribute controls whether the property field is read-only. If the attribute value is not set, the field is
+     * read-only when at least one of the properties is read-only.
+     */
+    isReadOnly?: boolean;
+    /**
+     * This attribute controls the order in which property fields should be displayed. Property fields with higher priority
+     * will appear before property fields with lower priority. If the attribute value is not set, the field's priority
+     * will be the maximum priority of its properties.
+     */
+    priority?: number;
+}
+/**
+ * This specification allows overriding some attributes of specific ECProperty or define how it's displayed.
+ *
+ * @see [Property specification reference documentation page]($docs/presentation/content/PropertySpecification.md)
+ * @public
+ */
+export interface PropertySpecification extends PropertyOverrides {
+    /**
+     * Name of the ECProperty to apply overrides to. A `"*"` may be specified to match all properties in current context.
+     * The current context is determined based on where the override is specified:
+     *
+     * - When used in a [content modifier]($docs/presentation/content/ContentModifier.md#attribute-propertyoverrides), the
+     *   properties of the ECClass specified by the [`class` attribute]($docs/presentation/content/ContentModifier.md#attribute-class) are used.
+     *
+     * - When used in one of the [content specifications]($docs/presentation/content/ContentRule.md#attribute-specifications),
+     *   properties produced by that specification are used.
+     */
+    name: string;
+}
 //# sourceMappingURL=PropertySpecification.d.ts.map

package/lib/cjs/presentation-common/rules/content/PropertySpecification.js

@@ -1,10 +1,10 @@
-"use strict";
-/*---------------------------------------------------------------------------------------------
-* 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
- */
-Object.defineProperty(exports, "__esModule", { value: true });
+"use strict";
+/*---------------------------------------------------------------------------------------------
+* 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
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
 //# sourceMappingURL=PropertySpecification.js.map

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

@@ -1,29 +1,29 @@
-/** @packageDocumentation
- * @module PresentationRules
- */
-import { ContentSpecificationBase } from "./ContentSpecification";
-/**
- * Returns content for selected (input) instances.
- *
- * @see [Selected node instances specification reference documentation page]($docs/presentation/content/SelectedNodeInstances.md)
- * @public
- */
-export interface SelectedNodeInstancesSpecification extends ContentSpecificationBase {
-    /** Used for serializing to JSON. */
-    specType: "SelectedNodeInstances";
-    /**
-     * Specifies ECSchema name which the input instances have to match for the specification to be used.
-     *
-     * @pattern ^[\w\d]+$
-     */
-    acceptableSchemaName?: string;
-    /**
-     * Specifies a list of class names which the input instances have to match for the specification to be used.
-     */
-    acceptableClassNames?: string[];
-    /**
-     * Specifies whether derived classes of [[acceptableClassNames]] should be included in the content.
-     */
-    acceptablePolymorphically?: boolean;
-}
+/** @packageDocumentation
+ * @module PresentationRules
+ */
+import { ContentSpecificationBase } from "./ContentSpecification";
+/**
+ * Returns content for selected (input) instances.
+ *
+ * @see [Selected node instances specification reference documentation page]($docs/presentation/content/SelectedNodeInstances.md)
+ * @public
+ */
+export interface SelectedNodeInstancesSpecification extends ContentSpecificationBase {
+    /** Used for serializing to JSON. */
+    specType: "SelectedNodeInstances";
+    /**
+     * Specifies ECSchema name which the input instances have to match for the specification to be used.
+     *
+     * @pattern ^[\w\d]+$
+     */
+    acceptableSchemaName?: string;
+    /**
+     * Specifies a list of class names which the input instances have to match for the specification to be used.
+     */
+    acceptableClassNames?: string[];
+    /**
+     * Specifies whether derived classes of [[acceptableClassNames]] should be included in the content.
+     */
+    acceptablePolymorphically?: boolean;
+}
 //# sourceMappingURL=SelectedNodeInstancesSpecification.d.ts.map

package/lib/cjs/presentation-common/rules/content/SelectedNodeInstancesSpecification.js

@@ -1,10 +1,10 @@
-"use strict";
-/*---------------------------------------------------------------------------------------------
-* 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
- */
-Object.defineProperty(exports, "__esModule", { value: true });
+"use strict";
+/*---------------------------------------------------------------------------------------------
+* 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
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
 //# sourceMappingURL=SelectedNodeInstancesSpecification.js.map

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

@@ -1,26 +1,26 @@
-/** @packageDocumentation
- * @module PresentationRules
- */
-/**
- * This content modifier allows including additional calculated properties into the content.
- *
- * @see [Calculated properties specification reference documentation page]($docs/presentation/content/CalculatedPropertiesSpecification.md)
- * @public
- */
-export interface CalculatedPropertiesSpecification {
-    /** Specifies label of the calculated property. Supports [localization]($docs/presentation/advanced/Localization.md). */
-    label: string;
-    /**
-     * Defines an expression to calculate the value. The expression can use [ECInstance]($docs/presentation/advanced/ECExpressions.md#ecinstance)
-     * and [Ruleset Variables]($docs/presentation/advanced/ECExpressions.md#ruleset-variables-user-settings) symbol contexts.
-     */
-    value: string;
-    /**
-     * Assign a custom [[Field.priority]] to the property. It's up to the UI component to make sure that priority
-     * is respected - properties with higher priority should appear before or above properties with lower priority.
-     *
-     * @type integer
-     */
-    priority?: number;
-}
+/** @packageDocumentation
+ * @module PresentationRules
+ */
+/**
+ * This content modifier allows including additional calculated properties into the content.
+ *
+ * @see [Calculated properties specification reference documentation page]($docs/presentation/content/CalculatedPropertiesSpecification.md)
+ * @public
+ */
+export interface CalculatedPropertiesSpecification {
+    /** Specifies label of the calculated property. Supports [localization]($docs/presentation/advanced/Localization.md). */
+    label: string;
+    /**
+     * Defines an expression to calculate the value. The expression can use [ECInstance]($docs/presentation/advanced/ECExpressions.md#ecinstance)
+     * and [Ruleset Variables]($docs/presentation/advanced/ECExpressions.md#ruleset-variables-user-settings) symbol contexts.
+     */
+    value: string;
+    /**
+     * Assign a custom [[Field.priority]] to the property. It's up to the UI component to make sure that priority
+     * is respected - properties with higher priority should appear before or above properties with lower priority.
+     *
+     * @type integer
+     */
+    priority?: number;
+}
 //# sourceMappingURL=CalculatedPropertiesSpecification.d.ts.map

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

@@ -1,10 +1,10 @@
-"use strict";
-/*---------------------------------------------------------------------------------------------
-* 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
- */
-Object.defineProperty(exports, "__esModule", { value: true });
+"use strict";
+/*---------------------------------------------------------------------------------------------
+* 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
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
 //# sourceMappingURL=CalculatedPropertiesSpecification.js.map

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

@@ -1,58 +1,58 @@
-/** @packageDocumentation
- * @module PresentationRules
- */
-import { SingleSchemaClassSpecification } from "../../ClassSpecifications";
-import { RuleBase } from "../../Rule";
-import { PropertySpecification } from "../PropertySpecification";
-import { CalculatedPropertiesSpecification } from "./CalculatedPropertiesSpecification";
-import { PropertyCategorySpecification } from "./PropertyCategorySpecification";
-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]].
- *
- * @see [Content modifier rule reference documentation page]($docs/presentation/content/ContentModifier.md)
- * @public
- */
-export interface ContentModifiersList {
-    /**
-     * Specifications of [related properties]($docs/presentation/content/RelatedPropertiesSpecification.md) which are
-     * included in the generated content.
-     */
-    relatedProperties?: RelatedPropertiesSpecification[];
-    /**
-     * 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]($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]($docs/presentation/content/PropertySpecification.md) that allow customizing property display.
-     */
-    propertyOverrides?: PropertySpecification[];
-}
-/**
- * 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 [Content modifier rule reference documentation page]($docs/presentation/content/ContentModifier.md)
- * @public
- */
-export interface ContentModifier extends RuleBase, ContentModifiersList {
-    /** Used for serializing to JSON. */
-    ruleType: "ContentModifier";
-    /**
-     * Specification of ECClass whose content should be modified. The modifier is applied to all content
-     * if this attribute is not specified.
-     */
-    class?: SingleSchemaClassSpecification;
-}
+/** @packageDocumentation
+ * @module PresentationRules
+ */
+import { SingleSchemaClassSpecification } from "../../ClassSpecifications";
+import { RuleBase } from "../../Rule";
+import { PropertySpecification } from "../PropertySpecification";
+import { CalculatedPropertiesSpecification } from "./CalculatedPropertiesSpecification";
+import { PropertyCategorySpecification } from "./PropertyCategorySpecification";
+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]].
+ *
+ * @see [Content modifier rule reference documentation page]($docs/presentation/content/ContentModifier.md)
+ * @public
+ */
+export interface ContentModifiersList {
+    /**
+     * Specifications of [related properties]($docs/presentation/content/RelatedPropertiesSpecification.md) which are
+     * included in the generated content.
+     */
+    relatedProperties?: RelatedPropertiesSpecification[];
+    /**
+     * 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]($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]($docs/presentation/content/PropertySpecification.md) that allow customizing property display.
+     */
+    propertyOverrides?: PropertySpecification[];
+}
+/**
+ * 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 [Content modifier rule reference documentation page]($docs/presentation/content/ContentModifier.md)
+ * @public
+ */
+export interface ContentModifier extends RuleBase, ContentModifiersList {
+    /** Used for serializing to JSON. */
+    ruleType: "ContentModifier";
+    /**
+     * Specification of ECClass whose content should be modified. The modifier is applied to all content
+     * if this attribute is not specified.
+     */
+    class?: SingleSchemaClassSpecification;
+}
 //# sourceMappingURL=ContentModifier.d.ts.map

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

@@ -1,10 +1,10 @@
-"use strict";
-/*---------------------------------------------------------------------------------------------
-* 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
- */
-Object.defineProperty(exports, "__esModule", { value: true });
+"use strict";
+/*---------------------------------------------------------------------------------------------
+* 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
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
 //# sourceMappingURL=ContentModifier.js.map

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

@@ -1,18 +1,18 @@
-/** @packageDocumentation
- * @module PresentationRules
- */
-/**
- * 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 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;
-}
+/** @packageDocumentation
+ * @module PresentationRules
+ */
+/**
+ * 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 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/cjs/presentation-common/rules/content/modifiers/CustomRendererSpecification.js

@@ -1,10 +1,10 @@
-"use strict";
-/*---------------------------------------------------------------------------------------------
-* 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
- */
-Object.defineProperty(exports, "__esModule", { value: true });
+"use strict";
+/*---------------------------------------------------------------------------------------------
+* 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
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
 //# sourceMappingURL=CustomRendererSpecification.js.map