@itwin/appui-abstract 3.6.0-dev.8 → 4.0.0-dev.2

package/lib/esm/appui-abstract/properties/Description.js

@@ -1,193 +1,193 @@
-/*---------------------------------------------------------------------------------------------
-* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
-* See LICENSE.md in the project root for license terms and full copyright notice.
-*--------------------------------------------------------------------------------------------*/
-/** @packageDocumentation
- * @module Properties
- */
-import { PropertyEditorParamTypes, } from "./EditorParams";
-import { StandardEditorNames } from "./StandardEditorNames";
-import { StandardTypeNames } from "./StandardTypeNames";
-/** Helper class that builds property descriptions for specific PropertyEditors and processes descriptions.
- * @public
- */
-export class PropertyDescriptionHelper {
-    /** Builds a number description with a "weight-picker" editor name
-     * @public
-     */
-    static buildWeightPickerDescription(name, label, additionalParams = []) {
-        return {
-            name,
-            displayLabel: label,
-            typename: StandardTypeNames.Number,
-            editor: {
-                name: StandardEditorNames.WeightPicker,
-                params: additionalParams,
-            },
-        };
-    }
-    /** Builds an editor that uses [NumberInput]($core-react) control
-     * @public
-     */
-    static buildNumberEditorDescription(name, label, overrideParams, additionalParams = []) {
-        const editorParams = [{
-                type: PropertyEditorParamTypes.Range,
-                step: 1,
-                precision: 0,
-                ...overrideParams,
-            }, ...additionalParams];
-        const editor = {
-            name: StandardEditorNames.NumericInput,
-            params: editorParams,
-        };
-        return {
-            name,
-            displayLabel: label,
-            typename: StandardTypeNames.Number,
-            editor,
-        };
-    }
-    /** Builds a string description
-     * @public
-     */
-    static buildTextEditorDescription(name, label, additionalParams = []) {
-        const editor = {
-            params: additionalParams,
-        };
-        return {
-            name,
-            displayLabel: label,
-            typename: StandardTypeNames.String,
-            editor,
-        };
-    }
-    /** Builds an enum description
-     * @public
-     */
-    static buildEnumPicklistEditorDescription(name, label, choices, additionalParams = []) {
-        const editor = additionalParams.length ? {
-            params: additionalParams,
-        } : undefined;
-        return {
-            name,
-            displayLabel: label,
-            typename: StandardTypeNames.Enum,
-            editor,
-            enum: {
-                choices,
-            },
-        };
-    }
-    /** Builds a number description for a tool settings or dialog property that will display a "color-picker" control.
-     * @public
-     */
-    static buildColorPickerDescription(name, label, colorValues, numColumns, additionalParams = []) {
-        const editorParams = [
-            {
-                type: PropertyEditorParamTypes.ColorData,
-                colorValues,
-                numColumns,
-            },
-            ...additionalParams,
-        ];
-        return {
-            name,
-            displayLabel: label,
-            typename: StandardTypeNames.Number,
-            editor: {
-                name: StandardEditorNames.ColorPicker,
-                params: editorParams,
-            },
-        };
-    }
-    /** Builds a boolean description for a tool settings or dialog property that will display a "toggle" control.
-     * @public
-     */
-    static buildToggleDescription(name, label, additionalParams = []) {
-        return {
-            name,
-            displayLabel: label,
-            typename: StandardTypeNames.Boolean,
-            editor: {
-                name: StandardEditorNames.Toggle,
-                params: additionalParams,
-            },
-        };
-    }
-    /** Builds a boolean description for a tool settings or dialog property that will display a "image-check-box" control.
-     * @public
-     */
-    static buildImageCheckBoxDescription(name, label, imageOff, imageOn, additionalParams = []) {
-        const editorParams = [{
-                type: PropertyEditorParamTypes.CheckBoxImages,
-                imageOff,
-                imageOn,
-            }, ...additionalParams];
-        return {
-            name,
-            displayLabel: label,
-            typename: StandardTypeNames.Boolean,
-            editor: {
-                name: StandardEditorNames.ImageCheckBox,
-                params: editorParams,
-            },
-        };
-    }
-    /** Builds a boolean description for a tool settings or dialog property that will display a checkbox control.
-     * @public
-     */
-    static buildCheckboxDescription(name, label, additionalParams = []) {
-        const editor = {
-            params: additionalParams,
-        };
-        return {
-            name,
-            displayLabel: label,
-            typename: StandardTypeNames.Boolean,
-            editor,
-        };
-    }
-    /** Builds a property description for a tool settings or dialog `lock` property. This will create a checkbox control with no label.
-     * @public
-     */
-    static buildLockPropertyDescription(name, additionalParams = []) {
-        const defaultParams = {
-            type: PropertyEditorParamTypes.SuppressEditorLabel,
-            suppressLabelPlaceholder: true,
-        };
-        const editor = {
-            params: [defaultParams, ...additionalParams],
-        };
-        return {
-            name,
-            displayLabel: "",
-            typename: StandardTypeNames.Boolean,
-            editor,
-        };
-    }
-    /** Bumps an enum property description value
-     * @public
-     */
-    static async bumpEnumProperty(description, value) {
-        let choices;
-        if (description.enum) {
-            if (description.enum.choices instanceof Promise) {
-                choices = await description.enum.choices;
-            }
-            else {
-                choices = description.enum.choices;
-            }
-        }
-        if (!choices || choices.length === 0)
-            return value;
-        let choiceIndex = choices.findIndex((choice) => choice.value === value);
-        if (choiceIndex < 0)
-            return value;
-        choiceIndex++;
-        if (choiceIndex >= choices.length)
-            choiceIndex = 0;
-        const newValue = choices[choiceIndex].value;
-        return newValue;
-    }
-}
+/*---------------------------------------------------------------------------------------------
+* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
+* See LICENSE.md in the project root for license terms and full copyright notice.
+*--------------------------------------------------------------------------------------------*/
+/** @packageDocumentation
+ * @module Properties
+ */
+import { PropertyEditorParamTypes, } from "./EditorParams";
+import { StandardEditorNames } from "./StandardEditorNames";
+import { StandardTypeNames } from "./StandardTypeNames";
+/** Helper class that builds property descriptions for specific PropertyEditors and processes descriptions.
+ * @public
+ */
+export class PropertyDescriptionHelper {
+    /** Builds a number description with a "weight-picker" editor name
+     * @public
+     */
+    static buildWeightPickerDescription(name, label, additionalParams = []) {
+        return {
+            name,
+            displayLabel: label,
+            typename: StandardTypeNames.Number,
+            editor: {
+                name: StandardEditorNames.WeightPicker,
+                params: additionalParams,
+            },
+        };
+    }
+    /** Builds an editor that uses [NumberInput]($core-react) control
+     * @public
+     */
+    static buildNumberEditorDescription(name, label, overrideParams, additionalParams = []) {
+        const editorParams = [{
+                type: PropertyEditorParamTypes.Range,
+                step: 1,
+                precision: 0,
+                ...overrideParams,
+            }, ...additionalParams];
+        const editor = {
+            name: StandardEditorNames.NumericInput,
+            params: editorParams,
+        };
+        return {
+            name,
+            displayLabel: label,
+            typename: StandardTypeNames.Number,
+            editor,
+        };
+    }
+    /** Builds a string description
+     * @public
+     */
+    static buildTextEditorDescription(name, label, additionalParams = []) {
+        const editor = {
+            params: additionalParams,
+        };
+        return {
+            name,
+            displayLabel: label,
+            typename: StandardTypeNames.String,
+            editor,
+        };
+    }
+    /** Builds an enum description
+     * @public
+     */
+    static buildEnumPicklistEditorDescription(name, label, choices, additionalParams = []) {
+        const editor = additionalParams.length ? {
+            params: additionalParams,
+        } : undefined;
+        return {
+            name,
+            displayLabel: label,
+            typename: StandardTypeNames.Enum,
+            editor,
+            enum: {
+                choices,
+            },
+        };
+    }
+    /** Builds a number description for a tool settings or dialog property that will display a "color-picker" control.
+     * @public
+     */
+    static buildColorPickerDescription(name, label, colorValues, numColumns, additionalParams = []) {
+        const editorParams = [
+            {
+                type: PropertyEditorParamTypes.ColorData,
+                colorValues,
+                numColumns,
+            },
+            ...additionalParams,
+        ];
+        return {
+            name,
+            displayLabel: label,
+            typename: StandardTypeNames.Number,
+            editor: {
+                name: StandardEditorNames.ColorPicker,
+                params: editorParams,
+            },
+        };
+    }
+    /** Builds a boolean description for a tool settings or dialog property that will display a "toggle" control.
+     * @public
+     */
+    static buildToggleDescription(name, label, additionalParams = []) {
+        return {
+            name,
+            displayLabel: label,
+            typename: StandardTypeNames.Boolean,
+            editor: {
+                name: StandardEditorNames.Toggle,
+                params: additionalParams,
+            },
+        };
+    }
+    /** Builds a boolean description for a tool settings or dialog property that will display a "image-check-box" control.
+     * @public
+     */
+    static buildImageCheckBoxDescription(name, label, imageOff, imageOn, additionalParams = []) {
+        const editorParams = [{
+                type: PropertyEditorParamTypes.CheckBoxImages,
+                imageOff,
+                imageOn,
+            }, ...additionalParams];
+        return {
+            name,
+            displayLabel: label,
+            typename: StandardTypeNames.Boolean,
+            editor: {
+                name: StandardEditorNames.ImageCheckBox,
+                params: editorParams,
+            },
+        };
+    }
+    /** Builds a boolean description for a tool settings or dialog property that will display a checkbox control.
+     * @public
+     */
+    static buildCheckboxDescription(name, label, additionalParams = []) {
+        const editor = {
+            params: additionalParams,
+        };
+        return {
+            name,
+            displayLabel: label,
+            typename: StandardTypeNames.Boolean,
+            editor,
+        };
+    }
+    /** Builds a property description for a tool settings or dialog `lock` property. This will create a checkbox control with no label.
+     * @public
+     */
+    static buildLockPropertyDescription(name, additionalParams = []) {
+        const defaultParams = {
+            type: PropertyEditorParamTypes.SuppressEditorLabel,
+            suppressLabelPlaceholder: true,
+        };
+        const editor = {
+            params: [defaultParams, ...additionalParams],
+        };
+        return {
+            name,
+            displayLabel: "",
+            typename: StandardTypeNames.Boolean,
+            editor,
+        };
+    }
+    /** Bumps an enum property description value
+     * @public
+     */
+    static async bumpEnumProperty(description, value) {
+        let choices;
+        if (description.enum) {
+            if (description.enum.choices instanceof Promise) {
+                choices = await description.enum.choices;
+            }
+            else {
+                choices = description.enum.choices;
+            }
+        }
+        if (!choices || choices.length === 0)
+            return value;
+        let choiceIndex = choices.findIndex((choice) => choice.value === value);
+        if (choiceIndex < 0)
+            return value;
+        choiceIndex++;
+        if (choiceIndex >= choices.length)
+            choiceIndex = 0;
+        const newValue = choices[choiceIndex].value;
+        return newValue;
+    }
+}
 //# sourceMappingURL=Description.js.map

package/lib/esm/appui-abstract/properties/Description.js.map

@@ -1 +1 @@
-{"version":3,"file":"Description.js","sourceRoot":"","sources":["../../../../src/appui-abstract/properties/Description.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG;AAEH,OAAO,EACmF,wBAAwB,GACjH,MAAM,gBAAgB,CAAC;AACxB,OAAO,EAAE,mBAAmB,EAAE,MAAM,uBAAuB,CAAC;AAC5D,OAAO,EAAE,iBAAiB,EAAE,MAAM,qBAAqB,CAAC;AAsFxD;;GAEG;AACH,MAAM,OAAO,yBAAyB;IACpC;;OAEG;IACI,MAAM,CAAC,4BAA4B,CAAC,IAAY,EAAE,KAAa,EAAE,mBAA+C,EAAE;QACvH,OAAO;YACL,IAAI;YACJ,YAAY,EAAE,KAAK;YACnB,QAAQ,EAAE,iBAAiB,CAAC,MAAM;YAClC,MAAM,EAAE;gBACN,IAAI,EAAE,mBAAmB,CAAC,YAAY;gBACtC,MAAM,EAAE,gBAAgB;aACzB;SACF,CAAC;IACJ,CAAC;IAED;;OAEG;IACI,MAAM,CAAC,4BAA4B,CAAC,IAAY,EAAE,KAAa,EAAE,cAAkC,EAAE,mBAA+C,EAAE;QAC3J,MAAM,YAAY,GAAG,CAAC;gBACpB,IAAI,EAAE,wBAAwB,CAAC,KAAK;gBACpC,IAAI,EAAE,CAAC;gBACP,SAAS,EAAE,CAAC;gBACZ,GAAG,cAAc;aACG,EAAE,GAAG,gBAAgB,CAAC,CAAC;QAE7C,MAAM,MAAM,GAAG;YACb,IAAI,EAAE,mBAAmB,CAAC,YAAY;YACtC,MAAM,EAAE,YAAY;SACrB,CAAC;QAEF,OAAO;YACL,IAAI;YACJ,YAAY,EAAE,KAAK;YACnB,QAAQ,EAAE,iBAAiB,CAAC,MAAM;YAClC,MAAM;SACP,CAAC;IACJ,CAAC;IAED;;OAEG;IACI,MAAM,CAAC,0BAA0B,CAAC,IAAY,EAAE,KAAa,EAAE,mBAA+C,EAAE;QACrH,MAAM,MAAM,GAAG;YACb,MAAM,EAAE,gBAAgB;SACzB,CAAC;QAEF,OAAO;YACL,IAAI;YACJ,YAAY,EAAE,KAAK;YACnB,QAAQ,EAAE,iBAAiB,CAAC,MAAM;YAClC,MAAM;SACP,CAAC;IACJ,CAAC;IAED;;OAEG;IACI,MAAM,CAAC,kCAAkC,CAAC,IAAY,EAAE,KAAa,EAC1E,OAA2D,EAC3D,mBAA+C,EAAE;QACjD,MAAM,MAAM,GAAG,gBAAgB,CAAC,MAAM,CAAC,CAAC,CAAC;YACvC,MAAM,EAAE,gBAAgB;SACzB,CAAC,CAAC,CAAC,SAAS,CAAC;QAEd,OAAO;YACL,IAAI;YACJ,YAAY,EAAE,KAAK;YACnB,QAAQ,EAAE,iBAAiB,CAAC,IAAI;YAChC,MAAM;YACN,IAAI,EAAE;gBACJ,OAAO;aACR;SACF,CAAC;IACJ,CAAC;IAED;;OAEG;IACI,MAAM,CAAC,2BAA2B,CAAC,IAAY,EAAE,KAAa,EAAE,WAAqB,EAAE,UAAkB,EAC9G,mBAA+C,EAAE;QACjD,MAAM,YAAY,GAAG;YACnB;gBACE,IAAI,EAAE,wBAAwB,CAAC,SAAS;gBACxC,WAAW;gBACX,UAAU;aACU;YACtB,GAAG,gBAAgB;SACpB,CAAC;QAEF,OAAO;YACL,IAAI;YACJ,YAAY,EAAE,KAAK;YACnB,QAAQ,EAAE,iBAAiB,CAAC,MAAM;YAClC,MAAM,EAAE;gBACN,IAAI,EAAE,mBAAmB,CAAC,WAAW;gBACrC,MAAM,EAAE,YAAY;aACrB;SACF,CAAC;IACJ,CAAC;IAED;;OAEG;IACI,MAAM,CAAC,sBAAsB,CAAC,IAAY,EAAE,KAAa,EAAE,mBAA+C,EAAE;QACjH,OAAO;YACL,IAAI;YACJ,YAAY,EAAE,KAAK;YACnB,QAAQ,EAAE,iBAAiB,CAAC,OAAO;YACnC,MAAM,EAAE;gBACN,IAAI,EAAE,mBAAmB,CAAC,MAAM;gBAChC,MAAM,EAAE,gBAAgB;aACzB;SACF,CAAC;IACJ,CAAC;IAED;;OAEG;IACI,MAAM,CAAC,6BAA6B,CAAC,IAAY,EAAE,KAAa,EAAE,QAAgB,EAAE,OAAe,EAAE,mBAA+C,EAAE;QAC3J,MAAM,YAAY,GAAG,CAAC;gBACpB,IAAI,EAAE,wBAAwB,CAAC,cAAc;gBAC7C,QAAQ;gBACR,OAAO;aACe,EAAE,GAAG,gBAAgB,CAAC,CAAC;QAE/C,OAAO;YACL,IAAI;YACJ,YAAY,EAAE,KAAK;YACnB,QAAQ,EAAE,iBAAiB,CAAC,OAAO;YACnC,MAAM,EAAE;gBACN,IAAI,EAAE,mBAAmB,CAAC,aAAa;gBACvC,MAAM,EAAE,YAAY;aACrB;SACF,CAAC;IACJ,CAAC;IAED;;OAEG;IACI,MAAM,CAAC,wBAAwB,CAAC,IAAY,EAAE,KAAa,EAAE,mBAA+C,EAAE;QACnH,MAAM,MAAM,GAAG;YACb,MAAM,EAAE,gBAAgB;SACzB,CAAC;QAEF,OAAO;YACL,IAAI;YACJ,YAAY,EAAE,KAAK;YACnB,QAAQ,EAAE,iBAAiB,CAAC,OAAO;YACnC,MAAM;SACP,CAAC;IACJ,CAAC;IAED;;OAEG;IACI,MAAM,CAAC,4BAA4B,CAAC,IAAY,EAAE,mBAA+C,EAAE;QACxG,MAAM,aAAa,GAAG;YACpB,IAAI,EAAE,wBAAwB,CAAC,mBAAmB;YAClD,wBAAwB,EAAE,IAAI;SACF,CAAC;QAE/B,MAAM,MAAM,GAAG;YACb,MAAM,EAAE,CAAC,aAAa,EAAE,GAAG,gBAAgB,CAAC;SAC7C,CAAC;QAEF,OAAO;YACL,IAAI;YACJ,YAAY,EAAE,EAAE;YAChB,QAAQ,EAAE,iBAAiB,CAAC,OAAO;YACnC,MAAM;SACP,CAAC;IACJ,CAAC;IAED;;OAEG;IACI,MAAM,CAAC,KAAK,CAAC,gBAAgB,CAAC,WAAgC,EAAE,KAAsB;QAC3F,IAAI,OAAwC,CAAC;QAE7C,IAAI,WAAW,CAAC,IAAI,EAAE;YACpB,IAAI,WAAW,CAAC,IAAI,CAAC,OAAO,YAAY,OAAO,EAAE;gBAC/C,OAAO,GAAG,MAAM,WAAW,CAAC,IAAI,CAAC,OAAO,CAAC;aAC1C;iBAAM;gBACL,OAAO,GAAG,WAAW,CAAC,IAAI,CAAC,OAAO,CAAC;aACpC;SACF;QAED,IAAI,CAAC,OAAO,IAAI,OAAO,CAAC,MAAM,KAAK,CAAC;YAClC,OAAO,KAAK,CAAC;QAEf,IAAI,WAAW,GAAG,OAAO,CAAC,SAAS,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,MAAM,CAAC,KAAK,KAAK,KAAK,CAAC,CAAC;QACxE,IAAI,WAAW,GAAG,CAAC;YACjB,OAAO,KAAK,CAAC;QAEf,WAAW,EAAE,CAAC;QACd,IAAI,WAAW,IAAI,OAAO,CAAC,MAAM;YAC/B,WAAW,GAAG,CAAC,CAAC;QAElB,MAAM,QAAQ,GAAG,OAAO,CAAC,WAAW,CAAC,CAAC,KAAK,CAAC;QAC5C,OAAO,QAAQ,CAAC;IAClB,CAAC;CACF","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 Properties\r\n */\r\n\r\nimport {\r\n  BasePropertyEditorParams, ColorEditorParams, ImageCheckBoxParams, PropertyEditorParams, PropertyEditorParamTypes, RangeEditorParams, SuppressLabelEditorParams,\r\n} from \"./EditorParams\";\r\nimport { StandardEditorNames } from \"./StandardEditorNames\";\r\nimport { StandardTypeNames } from \"./StandardTypeNames\";\r\n\r\n// cSpell:ignore Picklist\r\n\r\n/**\r\n * Information about an enumeration choice\r\n * @public\r\n */\r\nexport interface EnumerationChoice {\r\n  label: string;\r\n  value: string | number;\r\n}\r\n\r\n/**\r\n * Information about a set of enumeration choices\r\n * @public\r\n */\r\nexport interface EnumerationChoicesInfo {\r\n  choices: Promise<EnumerationChoice[]> | EnumerationChoice[];\r\n  isStrict?: boolean;\r\n  maxDisplayedRows?: number;\r\n}\r\n\r\n/**\r\n * Property renderer identification and customization attributes\r\n * @public\r\n */\r\nexport interface PropertyRendererInfo {\r\n  name: string;\r\n}\r\n\r\n/**\r\n * Information about a Property Editor\r\n * @public\r\n */\r\nexport interface PropertyEditorInfo {\r\n  /** Editor name used in addition to the typename to find the registered property editor */\r\n  name?: string;\r\n  /** Editor params provided to the property editor */\r\n  params?: PropertyEditorParams[];\r\n}\r\n\r\n/**\r\n * Information about a Property Converter\r\n * @public\r\n */\r\nexport interface PropertyConverterInfo {\r\n  /** Converter name used in addition to the typename to find the registered property converter */\r\n  name?: string;\r\n  /** map of options for type converter */\r\n  options?: { [key: string]: any };\r\n}\r\n\r\n/**\r\n * [[PropertyDescription]] contains metadata about a Property\r\n * @public\r\n */\r\nexport interface PropertyDescription {\r\n  /** Name of the property description */\r\n  name: string;\r\n  /** Display label for the property description */\r\n  displayLabel: string;\r\n  /** Type name used to determine applicable Type Converter and Property Editor */\r\n  typename: string;\r\n  /** Additional information for enumerations */\r\n  enum?: EnumerationChoicesInfo;\r\n  /** Information for property renderer customization */\r\n  renderer?: PropertyRendererInfo;\r\n  /** Information for a property editor */\r\n  editor?: PropertyEditorInfo;\r\n  /** Information for a property converter */\r\n  converter?: PropertyConverterInfo;\r\n  /** Quantity type key used to look up formatting and parsing specs. This is typically either the name of a quantity type used by a tool\r\n   *  or the full name of a KOQ (schema:koq).\r\n   * @alpha\r\n   */\r\n  quantityType?: string;\r\n  /** Get the custom DataController by this name and register it with the property editor */\r\n  dataController?: string;\r\n  /**\r\n   * Should property label for composite (struct & array) properties be rendered.\r\n   * @alpha\r\n   */\r\n  hideCompositePropertyLabel?: boolean;\r\n}\r\n\r\n/** Helper class that builds property descriptions for specific PropertyEditors and processes descriptions.\r\n * @public\r\n */\r\nexport class PropertyDescriptionHelper {\r\n  /** Builds a number description with a \"weight-picker\" editor name\r\n   * @public\r\n   */\r\n  public static buildWeightPickerDescription(name: string, label: string, additionalParams: BasePropertyEditorParams[] = []): PropertyDescription {\r\n    return {\r\n      name,\r\n      displayLabel: label,\r\n      typename: StandardTypeNames.Number,\r\n      editor: {\r\n        name: StandardEditorNames.WeightPicker,\r\n        params: additionalParams,\r\n      },\r\n    };\r\n  }\r\n\r\n  /** Builds an editor that uses [NumberInput]($core-react) control\r\n   * @public\r\n   */\r\n  public static buildNumberEditorDescription(name: string, label: string, overrideParams?: RangeEditorParams, additionalParams: BasePropertyEditorParams[] = []): PropertyDescription {\r\n    const editorParams = [{\r\n      type: PropertyEditorParamTypes.Range,\r\n      step: 1,\r\n      precision: 0,\r\n      ...overrideParams,\r\n    } as RangeEditorParams, ...additionalParams];\r\n\r\n    const editor = {\r\n      name: StandardEditorNames.NumericInput,\r\n      params: editorParams,\r\n    };\r\n\r\n    return {\r\n      name,\r\n      displayLabel: label,\r\n      typename: StandardTypeNames.Number,\r\n      editor,\r\n    };\r\n  }\r\n\r\n  /** Builds a string description\r\n   * @public\r\n   */\r\n  public static buildTextEditorDescription(name: string, label: string, additionalParams: BasePropertyEditorParams[] = []): PropertyDescription {\r\n    const editor = {\r\n      params: additionalParams,\r\n    };\r\n\r\n    return {\r\n      name,\r\n      displayLabel: label,\r\n      typename: StandardTypeNames.String,\r\n      editor,\r\n    };\r\n  }\r\n\r\n  /** Builds an enum description\r\n   * @public\r\n   */\r\n  public static buildEnumPicklistEditorDescription(name: string, label: string,\r\n    choices: Promise<EnumerationChoice[]> | EnumerationChoice[],\r\n    additionalParams: BasePropertyEditorParams[] = []): PropertyDescription {\r\n    const editor = additionalParams.length ? {\r\n      params: additionalParams,\r\n    } : undefined;\r\n\r\n    return {\r\n      name,\r\n      displayLabel: label,\r\n      typename: StandardTypeNames.Enum,\r\n      editor,\r\n      enum: {\r\n        choices,\r\n      },\r\n    };\r\n  }\r\n\r\n  /** Builds a number description for a tool settings or dialog property that will display a \"color-picker\" control.\r\n   * @public\r\n   */\r\n  public static buildColorPickerDescription(name: string, label: string, colorValues: number[], numColumns: number,\r\n    additionalParams: BasePropertyEditorParams[] = []): PropertyDescription {\r\n    const editorParams = [\r\n      {\r\n        type: PropertyEditorParamTypes.ColorData,\r\n        colorValues,\r\n        numColumns,\r\n      } as ColorEditorParams,\r\n      ...additionalParams,\r\n    ];\r\n\r\n    return {\r\n      name,\r\n      displayLabel: label,\r\n      typename: StandardTypeNames.Number,\r\n      editor: {\r\n        name: StandardEditorNames.ColorPicker,\r\n        params: editorParams,\r\n      },\r\n    };\r\n  }\r\n\r\n  /** Builds a boolean description for a tool settings or dialog property that will display a \"toggle\" control.\r\n   * @public\r\n   */\r\n  public static buildToggleDescription(name: string, label: string, additionalParams: BasePropertyEditorParams[] = []): PropertyDescription {\r\n    return {\r\n      name,\r\n      displayLabel: label,\r\n      typename: StandardTypeNames.Boolean,\r\n      editor: {\r\n        name: StandardEditorNames.Toggle,\r\n        params: additionalParams,\r\n      },\r\n    };\r\n  }\r\n\r\n  /** Builds a boolean description for a tool settings or dialog property that will display a \"image-check-box\" control.\r\n   * @public\r\n   */\r\n  public static buildImageCheckBoxDescription(name: string, label: string, imageOff: string, imageOn: string, additionalParams: BasePropertyEditorParams[] = []): PropertyDescription {\r\n    const editorParams = [{\r\n      type: PropertyEditorParamTypes.CheckBoxImages,\r\n      imageOff,\r\n      imageOn,\r\n    } as ImageCheckBoxParams, ...additionalParams];\r\n\r\n    return {\r\n      name,\r\n      displayLabel: label,\r\n      typename: StandardTypeNames.Boolean,\r\n      editor: {\r\n        name: StandardEditorNames.ImageCheckBox,\r\n        params: editorParams,\r\n      },\r\n    };\r\n  }\r\n\r\n  /** Builds a boolean description for a tool settings or dialog property that will display a checkbox control.\r\n   * @public\r\n   */\r\n  public static buildCheckboxDescription(name: string, label: string, additionalParams: BasePropertyEditorParams[] = []): PropertyDescription {\r\n    const editor = {\r\n      params: additionalParams,\r\n    };\r\n\r\n    return {\r\n      name,\r\n      displayLabel: label,\r\n      typename: StandardTypeNames.Boolean,\r\n      editor,\r\n    };\r\n  }\r\n\r\n  /** Builds a property description for a tool settings or dialog `lock` property. This will create a checkbox control with no label.\r\n   * @public\r\n   */\r\n  public static buildLockPropertyDescription(name: string, additionalParams: BasePropertyEditorParams[] = []): PropertyDescription {\r\n    const defaultParams = {\r\n      type: PropertyEditorParamTypes.SuppressEditorLabel,\r\n      suppressLabelPlaceholder: true,\r\n    } as SuppressLabelEditorParams;\r\n\r\n    const editor = {\r\n      params: [defaultParams, ...additionalParams],\r\n    };\r\n\r\n    return {\r\n      name,\r\n      displayLabel: \"\",\r\n      typename: StandardTypeNames.Boolean,\r\n      editor,\r\n    };\r\n  }\r\n\r\n  /** Bumps an enum property description value\r\n   * @public\r\n   */\r\n  public static async bumpEnumProperty(description: PropertyDescription, value: string | number): Promise<string | number> {\r\n    let choices: EnumerationChoice[] | undefined;\r\n\r\n    if (description.enum) {\r\n      if (description.enum.choices instanceof Promise) {\r\n        choices = await description.enum.choices;\r\n      } else {\r\n        choices = description.enum.choices;\r\n      }\r\n    }\r\n\r\n    if (!choices || choices.length === 0)\r\n      return value;\r\n\r\n    let choiceIndex = choices.findIndex((choice) => choice.value === value);\r\n    if (choiceIndex < 0)\r\n      return value;\r\n\r\n    choiceIndex++;\r\n    if (choiceIndex >= choices.length)\r\n      choiceIndex = 0;\r\n\r\n    const newValue = choices[choiceIndex].value;\r\n    return newValue;\r\n  }\r\n}\r\n"]}
+{"version":3,"file":"Description.js","sourceRoot":"","sources":["../../../../src/appui-abstract/properties/Description.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG;AAEH,OAAO,EACmF,wBAAwB,GACjH,MAAM,gBAAgB,CAAC;AACxB,OAAO,EAAE,mBAAmB,EAAE,MAAM,uBAAuB,CAAC;AAC5D,OAAO,EAAE,iBAAiB,EAAE,MAAM,qBAAqB,CAAC;AAsFxD;;GAEG;AACH,MAAM,OAAO,yBAAyB;IACpC;;OAEG;IACI,MAAM,CAAC,4BAA4B,CAAC,IAAY,EAAE,KAAa,EAAE,mBAA+C,EAAE;QACvH,OAAO;YACL,IAAI;YACJ,YAAY,EAAE,KAAK;YACnB,QAAQ,EAAE,iBAAiB,CAAC,MAAM;YAClC,MAAM,EAAE;gBACN,IAAI,EAAE,mBAAmB,CAAC,YAAY;gBACtC,MAAM,EAAE,gBAAgB;aACzB;SACF,CAAC;IACJ,CAAC;IAED;;OAEG;IACI,MAAM,CAAC,4BAA4B,CAAC,IAAY,EAAE,KAAa,EAAE,cAAkC,EAAE,mBAA+C,EAAE;QAC3J,MAAM,YAAY,GAAG,CAAC;gBACpB,IAAI,EAAE,wBAAwB,CAAC,KAAK;gBACpC,IAAI,EAAE,CAAC;gBACP,SAAS,EAAE,CAAC;gBACZ,GAAG,cAAc;aACG,EAAE,GAAG,gBAAgB,CAAC,CAAC;QAE7C,MAAM,MAAM,GAAG;YACb,IAAI,EAAE,mBAAmB,CAAC,YAAY;YACtC,MAAM,EAAE,YAAY;SACrB,CAAC;QAEF,OAAO;YACL,IAAI;YACJ,YAAY,EAAE,KAAK;YACnB,QAAQ,EAAE,iBAAiB,CAAC,MAAM;YAClC,MAAM;SACP,CAAC;IACJ,CAAC;IAED;;OAEG;IACI,MAAM,CAAC,0BAA0B,CAAC,IAAY,EAAE,KAAa,EAAE,mBAA+C,EAAE;QACrH,MAAM,MAAM,GAAG;YACb,MAAM,EAAE,gBAAgB;SACzB,CAAC;QAEF,OAAO;YACL,IAAI;YACJ,YAAY,EAAE,KAAK;YACnB,QAAQ,EAAE,iBAAiB,CAAC,MAAM;YAClC,MAAM;SACP,CAAC;IACJ,CAAC;IAED;;OAEG;IACI,MAAM,CAAC,kCAAkC,CAAC,IAAY,EAAE,KAAa,EAC1E,OAA2D,EAC3D,mBAA+C,EAAE;QACjD,MAAM,MAAM,GAAG,gBAAgB,CAAC,MAAM,CAAC,CAAC,CAAC;YACvC,MAAM,EAAE,gBAAgB;SACzB,CAAC,CAAC,CAAC,SAAS,CAAC;QAEd,OAAO;YACL,IAAI;YACJ,YAAY,EAAE,KAAK;YACnB,QAAQ,EAAE,iBAAiB,CAAC,IAAI;YAChC,MAAM;YACN,IAAI,EAAE;gBACJ,OAAO;aACR;SACF,CAAC;IACJ,CAAC;IAED;;OAEG;IACI,MAAM,CAAC,2BAA2B,CAAC,IAAY,EAAE,KAAa,EAAE,WAAqB,EAAE,UAAkB,EAC9G,mBAA+C,EAAE;QACjD,MAAM,YAAY,GAAG;YACnB;gBACE,IAAI,EAAE,wBAAwB,CAAC,SAAS;gBACxC,WAAW;gBACX,UAAU;aACU;YACtB,GAAG,gBAAgB;SACpB,CAAC;QAEF,OAAO;YACL,IAAI;YACJ,YAAY,EAAE,KAAK;YACnB,QAAQ,EAAE,iBAAiB,CAAC,MAAM;YAClC,MAAM,EAAE;gBACN,IAAI,EAAE,mBAAmB,CAAC,WAAW;gBACrC,MAAM,EAAE,YAAY;aACrB;SACF,CAAC;IACJ,CAAC;IAED;;OAEG;IACI,MAAM,CAAC,sBAAsB,CAAC,IAAY,EAAE,KAAa,EAAE,mBAA+C,EAAE;QACjH,OAAO;YACL,IAAI;YACJ,YAAY,EAAE,KAAK;YACnB,QAAQ,EAAE,iBAAiB,CAAC,OAAO;YACnC,MAAM,EAAE;gBACN,IAAI,EAAE,mBAAmB,CAAC,MAAM;gBAChC,MAAM,EAAE,gBAAgB;aACzB;SACF,CAAC;IACJ,CAAC;IAED;;OAEG;IACI,MAAM,CAAC,6BAA6B,CAAC,IAAY,EAAE,KAAa,EAAE,QAAgB,EAAE,OAAe,EAAE,mBAA+C,EAAE;QAC3J,MAAM,YAAY,GAAG,CAAC;gBACpB,IAAI,EAAE,wBAAwB,CAAC,cAAc;gBAC7C,QAAQ;gBACR,OAAO;aACe,EAAE,GAAG,gBAAgB,CAAC,CAAC;QAE/C,OAAO;YACL,IAAI;YACJ,YAAY,EAAE,KAAK;YACnB,QAAQ,EAAE,iBAAiB,CAAC,OAAO;YACnC,MAAM,EAAE;gBACN,IAAI,EAAE,mBAAmB,CAAC,aAAa;gBACvC,MAAM,EAAE,YAAY;aACrB;SACF,CAAC;IACJ,CAAC;IAED;;OAEG;IACI,MAAM,CAAC,wBAAwB,CAAC,IAAY,EAAE,KAAa,EAAE,mBAA+C,EAAE;QACnH,MAAM,MAAM,GAAG;YACb,MAAM,EAAE,gBAAgB;SACzB,CAAC;QAEF,OAAO;YACL,IAAI;YACJ,YAAY,EAAE,KAAK;YACnB,QAAQ,EAAE,iBAAiB,CAAC,OAAO;YACnC,MAAM;SACP,CAAC;IACJ,CAAC;IAED;;OAEG;IACI,MAAM,CAAC,4BAA4B,CAAC,IAAY,EAAE,mBAA+C,EAAE;QACxG,MAAM,aAAa,GAAG;YACpB,IAAI,EAAE,wBAAwB,CAAC,mBAAmB;YAClD,wBAAwB,EAAE,IAAI;SACF,CAAC;QAE/B,MAAM,MAAM,GAAG;YACb,MAAM,EAAE,CAAC,aAAa,EAAE,GAAG,gBAAgB,CAAC;SAC7C,CAAC;QAEF,OAAO;YACL,IAAI;YACJ,YAAY,EAAE,EAAE;YAChB,QAAQ,EAAE,iBAAiB,CAAC,OAAO;YACnC,MAAM;SACP,CAAC;IACJ,CAAC;IAED;;OAEG;IACI,MAAM,CAAC,KAAK,CAAC,gBAAgB,CAAC,WAAgC,EAAE,KAAsB;QAC3F,IAAI,OAAwC,CAAC;QAE7C,IAAI,WAAW,CAAC,IAAI,EAAE;YACpB,IAAI,WAAW,CAAC,IAAI,CAAC,OAAO,YAAY,OAAO,EAAE;gBAC/C,OAAO,GAAG,MAAM,WAAW,CAAC,IAAI,CAAC,OAAO,CAAC;aAC1C;iBAAM;gBACL,OAAO,GAAG,WAAW,CAAC,IAAI,CAAC,OAAO,CAAC;aACpC;SACF;QAED,IAAI,CAAC,OAAO,IAAI,OAAO,CAAC,MAAM,KAAK,CAAC;YAClC,OAAO,KAAK,CAAC;QAEf,IAAI,WAAW,GAAG,OAAO,CAAC,SAAS,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,MAAM,CAAC,KAAK,KAAK,KAAK,CAAC,CAAC;QACxE,IAAI,WAAW,GAAG,CAAC;YACjB,OAAO,KAAK,CAAC;QAEf,WAAW,EAAE,CAAC;QACd,IAAI,WAAW,IAAI,OAAO,CAAC,MAAM;YAC/B,WAAW,GAAG,CAAC,CAAC;QAElB,MAAM,QAAQ,GAAG,OAAO,CAAC,WAAW,CAAC,CAAC,KAAK,CAAC;QAC5C,OAAO,QAAQ,CAAC;IAClB,CAAC;CACF","sourcesContent":["/*---------------------------------------------------------------------------------------------\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\n* See LICENSE.md in the project root for license terms and full copyright notice.\n*--------------------------------------------------------------------------------------------*/\n/** @packageDocumentation\n * @module Properties\n */\n\nimport {\n  BasePropertyEditorParams, ColorEditorParams, ImageCheckBoxParams, PropertyEditorParams, PropertyEditorParamTypes, RangeEditorParams, SuppressLabelEditorParams,\n} from \"./EditorParams\";\nimport { StandardEditorNames } from \"./StandardEditorNames\";\nimport { StandardTypeNames } from \"./StandardTypeNames\";\n\n// cSpell:ignore Picklist\n\n/**\n * Information about an enumeration choice\n * @public\n */\nexport interface EnumerationChoice {\n  label: string;\n  value: string | number;\n}\n\n/**\n * Information about a set of enumeration choices\n * @public\n */\nexport interface EnumerationChoicesInfo {\n  choices: Promise<EnumerationChoice[]> | EnumerationChoice[];\n  isStrict?: boolean;\n  maxDisplayedRows?: number;\n}\n\n/**\n * Property renderer identification and customization attributes\n * @public\n */\nexport interface PropertyRendererInfo {\n  name: string;\n}\n\n/**\n * Information about a Property Editor\n * @public\n */\nexport interface PropertyEditorInfo {\n  /** Editor name used in addition to the typename to find the registered property editor */\n  name?: string;\n  /** Editor params provided to the property editor */\n  params?: PropertyEditorParams[];\n}\n\n/**\n * Information about a Property Converter\n * @public\n */\nexport interface PropertyConverterInfo {\n  /** Converter name used in addition to the typename to find the registered property converter */\n  name?: string;\n  /** map of options for type converter */\n  options?: { [key: string]: any };\n}\n\n/**\n * [[PropertyDescription]] contains metadata about a Property\n * @public\n */\nexport interface PropertyDescription {\n  /** Name of the property description */\n  name: string;\n  /** Display label for the property description */\n  displayLabel: string;\n  /** Type name used to determine applicable Type Converter and Property Editor */\n  typename: string;\n  /** Additional information for enumerations */\n  enum?: EnumerationChoicesInfo;\n  /** Information for property renderer customization */\n  renderer?: PropertyRendererInfo;\n  /** Information for a property editor */\n  editor?: PropertyEditorInfo;\n  /** Information for a property converter */\n  converter?: PropertyConverterInfo;\n  /** Quantity type key used to look up formatting and parsing specs. This is typically either the name of a quantity type used by a tool\n   *  or the full name of a KOQ (schema:koq).\n   * @alpha\n   */\n  quantityType?: string;\n  /** Get the custom DataController by this name and register it with the property editor */\n  dataController?: string;\n  /**\n   * Should property label for composite (struct & array) properties be rendered.\n   * @alpha\n   */\n  hideCompositePropertyLabel?: boolean;\n}\n\n/** Helper class that builds property descriptions for specific PropertyEditors and processes descriptions.\n * @public\n */\nexport class PropertyDescriptionHelper {\n  /** Builds a number description with a \"weight-picker\" editor name\n   * @public\n   */\n  public static buildWeightPickerDescription(name: string, label: string, additionalParams: BasePropertyEditorParams[] = []): PropertyDescription {\n    return {\n      name,\n      displayLabel: label,\n      typename: StandardTypeNames.Number,\n      editor: {\n        name: StandardEditorNames.WeightPicker,\n        params: additionalParams,\n      },\n    };\n  }\n\n  /** Builds an editor that uses [NumberInput]($core-react) control\n   * @public\n   */\n  public static buildNumberEditorDescription(name: string, label: string, overrideParams?: RangeEditorParams, additionalParams: BasePropertyEditorParams[] = []): PropertyDescription {\n    const editorParams = [{\n      type: PropertyEditorParamTypes.Range,\n      step: 1,\n      precision: 0,\n      ...overrideParams,\n    } as RangeEditorParams, ...additionalParams];\n\n    const editor = {\n      name: StandardEditorNames.NumericInput,\n      params: editorParams,\n    };\n\n    return {\n      name,\n      displayLabel: label,\n      typename: StandardTypeNames.Number,\n      editor,\n    };\n  }\n\n  /** Builds a string description\n   * @public\n   */\n  public static buildTextEditorDescription(name: string, label: string, additionalParams: BasePropertyEditorParams[] = []): PropertyDescription {\n    const editor = {\n      params: additionalParams,\n    };\n\n    return {\n      name,\n      displayLabel: label,\n      typename: StandardTypeNames.String,\n      editor,\n    };\n  }\n\n  /** Builds an enum description\n   * @public\n   */\n  public static buildEnumPicklistEditorDescription(name: string, label: string,\n    choices: Promise<EnumerationChoice[]> | EnumerationChoice[],\n    additionalParams: BasePropertyEditorParams[] = []): PropertyDescription {\n    const editor = additionalParams.length ? {\n      params: additionalParams,\n    } : undefined;\n\n    return {\n      name,\n      displayLabel: label,\n      typename: StandardTypeNames.Enum,\n      editor,\n      enum: {\n        choices,\n      },\n    };\n  }\n\n  /** Builds a number description for a tool settings or dialog property that will display a \"color-picker\" control.\n   * @public\n   */\n  public static buildColorPickerDescription(name: string, label: string, colorValues: number[], numColumns: number,\n    additionalParams: BasePropertyEditorParams[] = []): PropertyDescription {\n    const editorParams = [\n      {\n        type: PropertyEditorParamTypes.ColorData,\n        colorValues,\n        numColumns,\n      } as ColorEditorParams,\n      ...additionalParams,\n    ];\n\n    return {\n      name,\n      displayLabel: label,\n      typename: StandardTypeNames.Number,\n      editor: {\n        name: StandardEditorNames.ColorPicker,\n        params: editorParams,\n      },\n    };\n  }\n\n  /** Builds a boolean description for a tool settings or dialog property that will display a \"toggle\" control.\n   * @public\n   */\n  public static buildToggleDescription(name: string, label: string, additionalParams: BasePropertyEditorParams[] = []): PropertyDescription {\n    return {\n      name,\n      displayLabel: label,\n      typename: StandardTypeNames.Boolean,\n      editor: {\n        name: StandardEditorNames.Toggle,\n        params: additionalParams,\n      },\n    };\n  }\n\n  /** Builds a boolean description for a tool settings or dialog property that will display a \"image-check-box\" control.\n   * @public\n   */\n  public static buildImageCheckBoxDescription(name: string, label: string, imageOff: string, imageOn: string, additionalParams: BasePropertyEditorParams[] = []): PropertyDescription {\n    const editorParams = [{\n      type: PropertyEditorParamTypes.CheckBoxImages,\n      imageOff,\n      imageOn,\n    } as ImageCheckBoxParams, ...additionalParams];\n\n    return {\n      name,\n      displayLabel: label,\n      typename: StandardTypeNames.Boolean,\n      editor: {\n        name: StandardEditorNames.ImageCheckBox,\n        params: editorParams,\n      },\n    };\n  }\n\n  /** Builds a boolean description for a tool settings or dialog property that will display a checkbox control.\n   * @public\n   */\n  public static buildCheckboxDescription(name: string, label: string, additionalParams: BasePropertyEditorParams[] = []): PropertyDescription {\n    const editor = {\n      params: additionalParams,\n    };\n\n    return {\n      name,\n      displayLabel: label,\n      typename: StandardTypeNames.Boolean,\n      editor,\n    };\n  }\n\n  /** Builds a property description for a tool settings or dialog `lock` property. This will create a checkbox control with no label.\n   * @public\n   */\n  public static buildLockPropertyDescription(name: string, additionalParams: BasePropertyEditorParams[] = []): PropertyDescription {\n    const defaultParams = {\n      type: PropertyEditorParamTypes.SuppressEditorLabel,\n      suppressLabelPlaceholder: true,\n    } as SuppressLabelEditorParams;\n\n    const editor = {\n      params: [defaultParams, ...additionalParams],\n    };\n\n    return {\n      name,\n      displayLabel: \"\",\n      typename: StandardTypeNames.Boolean,\n      editor,\n    };\n  }\n\n  /** Bumps an enum property description value\n   * @public\n   */\n  public static async bumpEnumProperty(description: PropertyDescription, value: string | number): Promise<string | number> {\n    let choices: EnumerationChoice[] | undefined;\n\n    if (description.enum) {\n      if (description.enum.choices instanceof Promise) {\n        choices = await description.enum.choices;\n      } else {\n        choices = description.enum.choices;\n      }\n    }\n\n    if (!choices || choices.length === 0)\n      return value;\n\n    let choiceIndex = choices.findIndex((choice) => choice.value === value);\n    if (choiceIndex < 0)\n      return value;\n\n    choiceIndex++;\n    if (choiceIndex >= choices.length)\n      choiceIndex = 0;\n\n    const newValue = choices[choiceIndex].value;\n    return newValue;\n  }\n}\n"]}