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

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -1909,6 +1909,10 @@
1909
1909
  "boolean"
1910
1910
  ]
1911
1911
  },
1912
+ "isReadOnly": {
1913
+ "description": "This attribute controls whether the property field is read-only. If the attribute value is not set, the field is\nread-only when at least one of the properties is read-only.",
1914
+ "type": "boolean"
1915
+ },
1912
1916
  "labelOverride": {
1913
1917
  "description": "This is an attribute that allows overriding the property label. May be localized.",
1914
1918
  "type": "string"
@@ -1921,6 +1925,10 @@
1921
1925
  "description": "There may be multiple property specifications that apply to a single property and there may be conflicts between\ndifferent attributes. The `overridesPriority` attribute is here to help solve the problem - if multiple specifications\nattempt to override the same attribute, the override of specification with highest `overridesPriority` value is used.\nThe order of overrides from specification with the same `overridesPriority` is defined by the order they appear in\nthe overrides list.",
1922
1926
  "type": "number"
1923
1927
  },
1928
+ "priority": {
1929
+ "description": "This attribute controls the order in which property fields should be displayed. Property fields with higher priority\nwill appear before property fields with lower priority. If the attribute value is not set, the field's priority\nwill be the maximum priority of its properties.",
1930
+ "type": "number"
1931
+ },
1924
1932
  "renderer": {
1925
1933
  "$ref": "#/definitions/CustomRendererSpecification",
1926
1934
  "description": "Custom property renderer specification that allows assigning a\ncustom value renderer to be used in UI. The specification is used to set up `Field.renderer` for\nthis property and it's up to the UI component to make sure appropriate renderer is used to render the property."
@@ -53,6 +53,17 @@ export interface PropertyOverrides {
53
53
  * all other properties of the same class. When `true`, this behavior is disabled.
54
54
  */
55
55
  doNotHideOtherPropertiesOnDisplayOverride?: boolean;
56
+ /**
57
+ * This attribute controls whether the property field is read-only. If the attribute value is not set, the field is
58
+ * read-only when at least one of the properties is read-only.
59
+ */
60
+ isReadOnly?: boolean;
61
+ /**
62
+ * This attribute controls the order in which property fields should be displayed. Property fields with higher priority
63
+ * will appear before property fields with lower priority. If the attribute value is not set, the field's priority
64
+ * will be the maximum priority of its properties.
65
+ */
66
+ priority?: number;
56
67
  }
57
68
  /**
58
69
  * This specification allows overriding some attributes of specific ECProperty or define how it's displayed.
@@ -1 +1 @@
1
- {"version":3,"file":"PropertySpecification.d.ts","sourceRoot":"","sources":["../../../../../src/presentation-common/rules/content/PropertySpecification.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,EAAE,2BAA2B,EAAE,MAAM,yCAAyC,CAAC;AACtF,OAAO,EAAE,kBAAkB,EAAE,MAAM,2CAA2C,CAAC;AAC/E,OAAO,EAAE,2BAA2B,EAAE,MAAM,0CAA0C,CAAC;AAEvF;;;;;GAKG;AACH,MAAM,WAAW,iBAAiB;IAChC;;;;;;OAMG;IACH,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAE3B,uIAAuI;IACvI,aAAa,CAAC,EAAE,MAAM,CAAC;IAEvB,0EAA0E;IAC1E,UAAU,CAAC,EAAE,MAAM,GAAG,kBAAkB,CAAC;IAEzC;;;;;;;;;;;;OAYG;IACH,WAAW,CAAC,EAAE,OAAO,GAAG,MAAM,CAAC;IAE/B;;;;OAIG;IACH,QAAQ,CAAC,EAAE,2BAA2B,CAAC;IAEvC;;;OAGG;IACH,MAAM,CAAC,EAAE,2BAA2B,CAAC;IAErC;;;OAGG;IACH,yCAAyC,CAAC,EAAE,OAAO,CAAC;CACrD;AAED;;;;;GAKG;AACH,MAAM,WAAW,qBAAsB,SAAQ,iBAAiB;IAC9D;;;;;;;;;OASG;IACH,IAAI,EAAE,MAAM,CAAC;CACd"}
1
+ {"version":3,"file":"PropertySpecification.d.ts","sourceRoot":"","sources":["../../../../../src/presentation-common/rules/content/PropertySpecification.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,EAAE,2BAA2B,EAAE,MAAM,yCAAyC,CAAC;AACtF,OAAO,EAAE,kBAAkB,EAAE,MAAM,2CAA2C,CAAC;AAC/E,OAAO,EAAE,2BAA2B,EAAE,MAAM,0CAA0C,CAAC;AAEvF;;;;;GAKG;AACH,MAAM,WAAW,iBAAiB;IAChC;;;;;;OAMG;IACH,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAE3B,uIAAuI;IACvI,aAAa,CAAC,EAAE,MAAM,CAAC;IAEvB,0EAA0E;IAC1E,UAAU,CAAC,EAAE,MAAM,GAAG,kBAAkB,CAAC;IAEzC;;;;;;;;;;;;OAYG;IACH,WAAW,CAAC,EAAE,OAAO,GAAG,MAAM,CAAC;IAE/B;;;;OAIG;IACH,QAAQ,CAAC,EAAE,2BAA2B,CAAC;IAEvC;;;OAGG;IACH,MAAM,CAAC,EAAE,2BAA2B,CAAC;IAErC;;;OAGG;IACH,yCAAyC,CAAC,EAAE,OAAO,CAAC;IAEpD;;;OAGG;IACH,UAAU,CAAC,EAAE,OAAO,CAAC;IAErB;;;;OAIG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB;AAED;;;;;GAKG;AACH,MAAM,WAAW,qBAAsB,SAAQ,iBAAiB;IAC9D;;;;;;;;;OASG;IACH,IAAI,EAAE,MAAM,CAAC;CACd"}
@@ -1 +1 @@
1
- {"version":3,"file":"PropertySpecification.js","sourceRoot":"","sources":["../../../../../src/presentation-common/rules/content/PropertySpecification.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 \"./modifiers/CustomRendererSpecification\";\r\nimport { CategoryIdentifier } from \"./modifiers/PropertyCategorySpecification\";\r\nimport { PropertyEditorSpecification } from \"./modifiers/PropertyEditorsSpecification\";\r\n\r\n/**\r\n * A container structure for possible property overrides\r\n *\r\n * @see [Property specification reference documentation page]($docs/presentation/content/PropertySpecification.md)\r\n * @public\r\n */\r\nexport interface PropertyOverrides {\r\n /**\r\n * There may be multiple property specifications that apply to a single property and there may be conflicts between\r\n * different attributes. The `overridesPriority` attribute is here to help solve the problem - if multiple specifications\r\n * attempt to override the same attribute, the override of specification with highest `overridesPriority` value is used.\r\n * The order of overrides from specification with the same `overridesPriority` is defined by the order they appear in\r\n * the overrides list.\r\n */\r\n overridesPriority?: number;\r\n\r\n /** This is an attribute that allows overriding the property label. May be [localized]($docs/presentation/advanced/Localization.md). */\r\n labelOverride?: string;\r\n\r\n /** The attribute allows moving the property into a different category. */\r\n categoryId?: string | CategoryIdentifier;\r\n\r\n /**\r\n * This attribute controls whether the particular property is present in the result, even when it is marked as hidden in the\r\n * ECSchema. The allowed settings are:\r\n *\r\n * - Omitted or `undefined`: property visibility is controlled by the ECSchema.\r\n *\r\n * - `true`: property is made visible. **Warning:** this will automatically hide all other properties of the same class.\r\n * If this behavior is not desirable, set [[doNotHideOtherPropertiesOnDisplayOverride]] attribute to `true`.\r\n *\r\n * - `false`: property is made hidden.\r\n *\r\n * The value can also be set using an ECExpression.\r\n */\r\n isDisplayed?: boolean | string;\r\n\r\n /**\r\n * Custom property [renderer specification]($docs/presentation/content/RendererSpecification.md) that allows assigning a\r\n * custom value renderer to be used in UI. The specification is used to set up [[Field.renderer]] for\r\n * this property and it's up to the UI component to make sure appropriate renderer is used to render the property.\r\n */\r\n renderer?: CustomRendererSpecification;\r\n\r\n /**\r\n * Custom [property editor specification]($docs/presentation/content/PropertyEditorSpecification) that allows assigning\r\n * a custom value editor to be used in UI.\r\n */\r\n editor?: PropertyEditorSpecification;\r\n\r\n /**\r\n * This attribute controls whether making the property visible using [[isDisplayed]] attribute should automatically hide\r\n * all other properties of the same class. When `true`, this behavior is disabled.\r\n */\r\n doNotHideOtherPropertiesOnDisplayOverride?: boolean;\r\n}\r\n\r\n/**\r\n * This specification allows overriding some attributes of specific ECProperty or define how it's displayed.\r\n *\r\n * @see [Property specification reference documentation page]($docs/presentation/content/PropertySpecification.md)\r\n * @public\r\n */\r\nexport interface PropertySpecification extends PropertyOverrides {\r\n /**\r\n * Name of the ECProperty to apply overrides to. A `\"*\"` may be specified to match all properties in current context.\r\n * The current context is determined based on where the override is specified:\r\n *\r\n * - When used in a [content modifier]($docs/presentation/content/ContentModifier.md#attribute-propertyoverrides), the\r\n * properties of the ECClass specified by the [`class` attribute]($docs/presentation/content/ContentModifier.md#attribute-class) are used.\r\n *\r\n * - When used in one of the [content specifications]($docs/presentation/content/ContentRule.md#attribute-specifications),\r\n * properties produced by that specification are used.\r\n */\r\n name: string;\r\n}\r\n"]}
1
+ {"version":3,"file":"PropertySpecification.js","sourceRoot":"","sources":["../../../../../src/presentation-common/rules/content/PropertySpecification.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 \"./modifiers/CustomRendererSpecification\";\r\nimport { CategoryIdentifier } from \"./modifiers/PropertyCategorySpecification\";\r\nimport { PropertyEditorSpecification } from \"./modifiers/PropertyEditorsSpecification\";\r\n\r\n/**\r\n * A container structure for possible property overrides\r\n *\r\n * @see [Property specification reference documentation page]($docs/presentation/content/PropertySpecification.md)\r\n * @public\r\n */\r\nexport interface PropertyOverrides {\r\n /**\r\n * There may be multiple property specifications that apply to a single property and there may be conflicts between\r\n * different attributes. The `overridesPriority` attribute is here to help solve the problem - if multiple specifications\r\n * attempt to override the same attribute, the override of specification with highest `overridesPriority` value is used.\r\n * The order of overrides from specification with the same `overridesPriority` is defined by the order they appear in\r\n * the overrides list.\r\n */\r\n overridesPriority?: number;\r\n\r\n /** This is an attribute that allows overriding the property label. May be [localized]($docs/presentation/advanced/Localization.md). */\r\n labelOverride?: string;\r\n\r\n /** The attribute allows moving the property into a different category. */\r\n categoryId?: string | CategoryIdentifier;\r\n\r\n /**\r\n * This attribute controls whether the particular property is present in the result, even when it is marked as hidden in the\r\n * ECSchema. The allowed settings are:\r\n *\r\n * - Omitted or `undefined`: property visibility is controlled by the ECSchema.\r\n *\r\n * - `true`: property is made visible. **Warning:** this will automatically hide all other properties of the same class.\r\n * If this behavior is not desirable, set [[doNotHideOtherPropertiesOnDisplayOverride]] attribute to `true`.\r\n *\r\n * - `false`: property is made hidden.\r\n *\r\n * The value can also be set using an ECExpression.\r\n */\r\n isDisplayed?: boolean | string;\r\n\r\n /**\r\n * Custom property [renderer specification]($docs/presentation/content/RendererSpecification.md) that allows assigning a\r\n * custom value renderer to be used in UI. The specification is used to set up [[Field.renderer]] for\r\n * this property and it's up to the UI component to make sure appropriate renderer is used to render the property.\r\n */\r\n renderer?: CustomRendererSpecification;\r\n\r\n /**\r\n * Custom [property editor specification]($docs/presentation/content/PropertyEditorSpecification) that allows assigning\r\n * a custom value editor to be used in UI.\r\n */\r\n editor?: PropertyEditorSpecification;\r\n\r\n /**\r\n * This attribute controls whether making the property visible using [[isDisplayed]] attribute should automatically hide\r\n * all other properties of the same class. When `true`, this behavior is disabled.\r\n */\r\n doNotHideOtherPropertiesOnDisplayOverride?: boolean;\r\n\r\n /**\r\n * This attribute controls whether the property field is read-only. If the attribute value is not set, the field is\r\n * read-only when at least one of the properties is read-only.\r\n */\r\n isReadOnly?: boolean;\r\n\r\n /**\r\n * This attribute controls the order in which property fields should be displayed. Property fields with higher priority\r\n * will appear before property fields with lower priority. If the attribute value is not set, the field's priority\r\n * will be the maximum priority of its properties.\r\n */\r\n priority?: number;\r\n}\r\n\r\n/**\r\n * This specification allows overriding some attributes of specific ECProperty or define how it's displayed.\r\n *\r\n * @see [Property specification reference documentation page]($docs/presentation/content/PropertySpecification.md)\r\n * @public\r\n */\r\nexport interface PropertySpecification extends PropertyOverrides {\r\n /**\r\n * Name of the ECProperty to apply overrides to. A `\"*\"` may be specified to match all properties in current context.\r\n * The current context is determined based on where the override is specified:\r\n *\r\n * - When used in a [content modifier]($docs/presentation/content/ContentModifier.md#attribute-propertyoverrides), the\r\n * properties of the ECClass specified by the [`class` attribute]($docs/presentation/content/ContentModifier.md#attribute-class) are used.\r\n *\r\n * - When used in one of the [content specifications]($docs/presentation/content/ContentRule.md#attribute-specifications),\r\n * properties produced by that specification are used.\r\n */\r\n name: string;\r\n}\r\n"]}
@@ -53,6 +53,17 @@ export interface PropertyOverrides {
53
53
  * all other properties of the same class. When `true`, this behavior is disabled.
54
54
  */
55
55
  doNotHideOtherPropertiesOnDisplayOverride?: boolean;
56
+ /**
57
+ * This attribute controls whether the property field is read-only. If the attribute value is not set, the field is
58
+ * read-only when at least one of the properties is read-only.
59
+ */
60
+ isReadOnly?: boolean;
61
+ /**
62
+ * This attribute controls the order in which property fields should be displayed. Property fields with higher priority
63
+ * will appear before property fields with lower priority. If the attribute value is not set, the field's priority
64
+ * will be the maximum priority of its properties.
65
+ */
66
+ priority?: number;
56
67
  }
57
68
  /**
58
69
  * This specification allows overriding some attributes of specific ECProperty or define how it's displayed.
@@ -1 +1 @@
1
- {"version":3,"file":"PropertySpecification.d.ts","sourceRoot":"","sources":["../../../../../src/presentation-common/rules/content/PropertySpecification.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,EAAE,2BAA2B,EAAE,MAAM,yCAAyC,CAAC;AACtF,OAAO,EAAE,kBAAkB,EAAE,MAAM,2CAA2C,CAAC;AAC/E,OAAO,EAAE,2BAA2B,EAAE,MAAM,0CAA0C,CAAC;AAEvF;;;;;GAKG;AACH,MAAM,WAAW,iBAAiB;IAChC;;;;;;OAMG;IACH,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAE3B,uIAAuI;IACvI,aAAa,CAAC,EAAE,MAAM,CAAC;IAEvB,0EAA0E;IAC1E,UAAU,CAAC,EAAE,MAAM,GAAG,kBAAkB,CAAC;IAEzC;;;;;;;;;;;;OAYG;IACH,WAAW,CAAC,EAAE,OAAO,GAAG,MAAM,CAAC;IAE/B;;;;OAIG;IACH,QAAQ,CAAC,EAAE,2BAA2B,CAAC;IAEvC;;;OAGG;IACH,MAAM,CAAC,EAAE,2BAA2B,CAAC;IAErC;;;OAGG;IACH,yCAAyC,CAAC,EAAE,OAAO,CAAC;CACrD;AAED;;;;;GAKG;AACH,MAAM,WAAW,qBAAsB,SAAQ,iBAAiB;IAC9D;;;;;;;;;OASG;IACH,IAAI,EAAE,MAAM,CAAC;CACd"}
1
+ {"version":3,"file":"PropertySpecification.d.ts","sourceRoot":"","sources":["../../../../../src/presentation-common/rules/content/PropertySpecification.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,EAAE,2BAA2B,EAAE,MAAM,yCAAyC,CAAC;AACtF,OAAO,EAAE,kBAAkB,EAAE,MAAM,2CAA2C,CAAC;AAC/E,OAAO,EAAE,2BAA2B,EAAE,MAAM,0CAA0C,CAAC;AAEvF;;;;;GAKG;AACH,MAAM,WAAW,iBAAiB;IAChC;;;;;;OAMG;IACH,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAE3B,uIAAuI;IACvI,aAAa,CAAC,EAAE,MAAM,CAAC;IAEvB,0EAA0E;IAC1E,UAAU,CAAC,EAAE,MAAM,GAAG,kBAAkB,CAAC;IAEzC;;;;;;;;;;;;OAYG;IACH,WAAW,CAAC,EAAE,OAAO,GAAG,MAAM,CAAC;IAE/B;;;;OAIG;IACH,QAAQ,CAAC,EAAE,2BAA2B,CAAC;IAEvC;;;OAGG;IACH,MAAM,CAAC,EAAE,2BAA2B,CAAC;IAErC;;;OAGG;IACH,yCAAyC,CAAC,EAAE,OAAO,CAAC;IAEpD;;;OAGG;IACH,UAAU,CAAC,EAAE,OAAO,CAAC;IAErB;;;;OAIG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB;AAED;;;;;GAKG;AACH,MAAM,WAAW,qBAAsB,SAAQ,iBAAiB;IAC9D;;;;;;;;;OASG;IACH,IAAI,EAAE,MAAM,CAAC;CACd"}
@@ -1 +1 @@
1
- {"version":3,"file":"PropertySpecification.js","sourceRoot":"","sources":["../../../../../src/presentation-common/rules/content/PropertySpecification.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 \"./modifiers/CustomRendererSpecification\";\r\nimport { CategoryIdentifier } from \"./modifiers/PropertyCategorySpecification\";\r\nimport { PropertyEditorSpecification } from \"./modifiers/PropertyEditorsSpecification\";\r\n\r\n/**\r\n * A container structure for possible property overrides\r\n *\r\n * @see [Property specification reference documentation page]($docs/presentation/content/PropertySpecification.md)\r\n * @public\r\n */\r\nexport interface PropertyOverrides {\r\n /**\r\n * There may be multiple property specifications that apply to a single property and there may be conflicts between\r\n * different attributes. The `overridesPriority` attribute is here to help solve the problem - if multiple specifications\r\n * attempt to override the same attribute, the override of specification with highest `overridesPriority` value is used.\r\n * The order of overrides from specification with the same `overridesPriority` is defined by the order they appear in\r\n * the overrides list.\r\n */\r\n overridesPriority?: number;\r\n\r\n /** This is an attribute that allows overriding the property label. May be [localized]($docs/presentation/advanced/Localization.md). */\r\n labelOverride?: string;\r\n\r\n /** The attribute allows moving the property into a different category. */\r\n categoryId?: string | CategoryIdentifier;\r\n\r\n /**\r\n * This attribute controls whether the particular property is present in the result, even when it is marked as hidden in the\r\n * ECSchema. The allowed settings are:\r\n *\r\n * - Omitted or `undefined`: property visibility is controlled by the ECSchema.\r\n *\r\n * - `true`: property is made visible. **Warning:** this will automatically hide all other properties of the same class.\r\n * If this behavior is not desirable, set [[doNotHideOtherPropertiesOnDisplayOverride]] attribute to `true`.\r\n *\r\n * - `false`: property is made hidden.\r\n *\r\n * The value can also be set using an ECExpression.\r\n */\r\n isDisplayed?: boolean | string;\r\n\r\n /**\r\n * Custom property [renderer specification]($docs/presentation/content/RendererSpecification.md) that allows assigning a\r\n * custom value renderer to be used in UI. The specification is used to set up [[Field.renderer]] for\r\n * this property and it's up to the UI component to make sure appropriate renderer is used to render the property.\r\n */\r\n renderer?: CustomRendererSpecification;\r\n\r\n /**\r\n * Custom [property editor specification]($docs/presentation/content/PropertyEditorSpecification) that allows assigning\r\n * a custom value editor to be used in UI.\r\n */\r\n editor?: PropertyEditorSpecification;\r\n\r\n /**\r\n * This attribute controls whether making the property visible using [[isDisplayed]] attribute should automatically hide\r\n * all other properties of the same class. When `true`, this behavior is disabled.\r\n */\r\n doNotHideOtherPropertiesOnDisplayOverride?: boolean;\r\n}\r\n\r\n/**\r\n * This specification allows overriding some attributes of specific ECProperty or define how it's displayed.\r\n *\r\n * @see [Property specification reference documentation page]($docs/presentation/content/PropertySpecification.md)\r\n * @public\r\n */\r\nexport interface PropertySpecification extends PropertyOverrides {\r\n /**\r\n * Name of the ECProperty to apply overrides to. A `\"*\"` may be specified to match all properties in current context.\r\n * The current context is determined based on where the override is specified:\r\n *\r\n * - When used in a [content modifier]($docs/presentation/content/ContentModifier.md#attribute-propertyoverrides), the\r\n * properties of the ECClass specified by the [`class` attribute]($docs/presentation/content/ContentModifier.md#attribute-class) are used.\r\n *\r\n * - When used in one of the [content specifications]($docs/presentation/content/ContentRule.md#attribute-specifications),\r\n * properties produced by that specification are used.\r\n */\r\n name: string;\r\n}\r\n"]}
1
+ {"version":3,"file":"PropertySpecification.js","sourceRoot":"","sources":["../../../../../src/presentation-common/rules/content/PropertySpecification.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 \"./modifiers/CustomRendererSpecification\";\r\nimport { CategoryIdentifier } from \"./modifiers/PropertyCategorySpecification\";\r\nimport { PropertyEditorSpecification } from \"./modifiers/PropertyEditorsSpecification\";\r\n\r\n/**\r\n * A container structure for possible property overrides\r\n *\r\n * @see [Property specification reference documentation page]($docs/presentation/content/PropertySpecification.md)\r\n * @public\r\n */\r\nexport interface PropertyOverrides {\r\n /**\r\n * There may be multiple property specifications that apply to a single property and there may be conflicts between\r\n * different attributes. The `overridesPriority` attribute is here to help solve the problem - if multiple specifications\r\n * attempt to override the same attribute, the override of specification with highest `overridesPriority` value is used.\r\n * The order of overrides from specification with the same `overridesPriority` is defined by the order they appear in\r\n * the overrides list.\r\n */\r\n overridesPriority?: number;\r\n\r\n /** This is an attribute that allows overriding the property label. May be [localized]($docs/presentation/advanced/Localization.md). */\r\n labelOverride?: string;\r\n\r\n /** The attribute allows moving the property into a different category. */\r\n categoryId?: string | CategoryIdentifier;\r\n\r\n /**\r\n * This attribute controls whether the particular property is present in the result, even when it is marked as hidden in the\r\n * ECSchema. The allowed settings are:\r\n *\r\n * - Omitted or `undefined`: property visibility is controlled by the ECSchema.\r\n *\r\n * - `true`: property is made visible. **Warning:** this will automatically hide all other properties of the same class.\r\n * If this behavior is not desirable, set [[doNotHideOtherPropertiesOnDisplayOverride]] attribute to `true`.\r\n *\r\n * - `false`: property is made hidden.\r\n *\r\n * The value can also be set using an ECExpression.\r\n */\r\n isDisplayed?: boolean | string;\r\n\r\n /**\r\n * Custom property [renderer specification]($docs/presentation/content/RendererSpecification.md) that allows assigning a\r\n * custom value renderer to be used in UI. The specification is used to set up [[Field.renderer]] for\r\n * this property and it's up to the UI component to make sure appropriate renderer is used to render the property.\r\n */\r\n renderer?: CustomRendererSpecification;\r\n\r\n /**\r\n * Custom [property editor specification]($docs/presentation/content/PropertyEditorSpecification) that allows assigning\r\n * a custom value editor to be used in UI.\r\n */\r\n editor?: PropertyEditorSpecification;\r\n\r\n /**\r\n * This attribute controls whether making the property visible using [[isDisplayed]] attribute should automatically hide\r\n * all other properties of the same class. When `true`, this behavior is disabled.\r\n */\r\n doNotHideOtherPropertiesOnDisplayOverride?: boolean;\r\n\r\n /**\r\n * This attribute controls whether the property field is read-only. If the attribute value is not set, the field is\r\n * read-only when at least one of the properties is read-only.\r\n */\r\n isReadOnly?: boolean;\r\n\r\n /**\r\n * This attribute controls the order in which property fields should be displayed. Property fields with higher priority\r\n * will appear before property fields with lower priority. If the attribute value is not set, the field's priority\r\n * will be the maximum priority of its properties.\r\n */\r\n priority?: number;\r\n}\r\n\r\n/**\r\n * This specification allows overriding some attributes of specific ECProperty or define how it's displayed.\r\n *\r\n * @see [Property specification reference documentation page]($docs/presentation/content/PropertySpecification.md)\r\n * @public\r\n */\r\nexport interface PropertySpecification extends PropertyOverrides {\r\n /**\r\n * Name of the ECProperty to apply overrides to. A `\"*\"` may be specified to match all properties in current context.\r\n * The current context is determined based on where the override is specified:\r\n *\r\n * - When used in a [content modifier]($docs/presentation/content/ContentModifier.md#attribute-propertyoverrides), the\r\n * properties of the ECClass specified by the [`class` attribute]($docs/presentation/content/ContentModifier.md#attribute-class) are used.\r\n *\r\n * - When used in one of the [content specifications]($docs/presentation/content/ContentRule.md#attribute-specifications),\r\n * properties produced by that specification are used.\r\n */\r\n name: string;\r\n}\r\n"]}
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@itwin/presentation-common",
3
- "version": "3.2.0-dev.72",
3
+ "version": "3.2.0-dev.76",
4
4
  "description": "Common pieces for iModel.js presentation packages",
5
5
  "license": "MIT",
6
6
  "repository": {
@@ -21,16 +21,16 @@
21
21
  "module": "lib/esm/presentation-common.js",
22
22
  "typings": "lib/cjs/presentation-common",
23
23
  "peerDependencies": {
24
- "@itwin/core-bentley": "^3.2.0-dev.72",
25
- "@itwin/core-common": "^3.2.0-dev.72",
26
- "@itwin/core-quantity": "^3.2.0-dev.72"
24
+ "@itwin/core-bentley": "^3.2.0-dev.76",
25
+ "@itwin/core-common": "^3.2.0-dev.76",
26
+ "@itwin/core-quantity": "^3.2.0-dev.76"
27
27
  },
28
28
  "devDependencies": {
29
- "@itwin/build-tools": "3.2.0-dev.72",
30
- "@itwin/core-bentley": "3.2.0-dev.72",
31
- "@itwin/core-common": "3.2.0-dev.72",
32
- "@itwin/core-quantity": "3.2.0-dev.72",
33
- "@itwin/eslint-plugin": "3.2.0-dev.72",
29
+ "@itwin/build-tools": "3.2.0-dev.76",
30
+ "@itwin/core-bentley": "3.2.0-dev.76",
31
+ "@itwin/core-common": "3.2.0-dev.76",
32
+ "@itwin/core-quantity": "3.2.0-dev.76",
33
+ "@itwin/eslint-plugin": "3.2.0-dev.76",
34
34
  "@types/chai": "^4.1.4",
35
35
  "@types/chai-as-promised": "^7",
36
36
  "@types/chai-jest-snapshot": "^1.3.0",