@itwin/appui-abstract 3.6.0-dev.8 → 3.7.0-dev.1

package/lib/cjs/appui-abstract/properties/Description.d.ts

@@ -1,128 +1,128 @@
-/** @packageDocumentation
- * @module Properties
- */
-import { BasePropertyEditorParams, PropertyEditorParams, RangeEditorParams } from "./EditorParams";
-/**
- * Information about an enumeration choice
- * @public
- */
-export interface EnumerationChoice {
-    label: string;
-    value: string | number;
-}
-/**
- * Information about a set of enumeration choices
- * @public
- */
-export interface EnumerationChoicesInfo {
-    choices: Promise<EnumerationChoice[]> | EnumerationChoice[];
-    isStrict?: boolean;
-    maxDisplayedRows?: number;
-}
-/**
- * Property renderer identification and customization attributes
- * @public
- */
-export interface PropertyRendererInfo {
-    name: string;
-}
-/**
- * Information about a Property Editor
- * @public
- */
-export interface PropertyEditorInfo {
-    /** Editor name used in addition to the typename to find the registered property editor */
-    name?: string;
-    /** Editor params provided to the property editor */
-    params?: PropertyEditorParams[];
-}
-/**
- * Information about a Property Converter
- * @public
- */
-export interface PropertyConverterInfo {
-    /** Converter name used in addition to the typename to find the registered property converter */
-    name?: string;
-    /** map of options for type converter */
-    options?: {
-        [key: string]: any;
-    };
-}
-/**
- * [[PropertyDescription]] contains metadata about a Property
- * @public
- */
-export interface PropertyDescription {
-    /** Name of the property description */
-    name: string;
-    /** Display label for the property description */
-    displayLabel: string;
-    /** Type name used to determine applicable Type Converter and Property Editor */
-    typename: string;
-    /** Additional information for enumerations */
-    enum?: EnumerationChoicesInfo;
-    /** Information for property renderer customization */
-    renderer?: PropertyRendererInfo;
-    /** Information for a property editor */
-    editor?: PropertyEditorInfo;
-    /** Information for a property converter */
-    converter?: PropertyConverterInfo;
-    /** 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
-     *  or the full name of a KOQ (schema:koq).
-     * @alpha
-     */
-    quantityType?: string;
-    /** Get the custom DataController by this name and register it with the property editor */
-    dataController?: string;
-    /**
-     * Should property label for composite (struct & array) properties be rendered.
-     * @alpha
-     */
-    hideCompositePropertyLabel?: boolean;
-}
-/** Helper class that builds property descriptions for specific PropertyEditors and processes descriptions.
- * @public
- */
-export declare class PropertyDescriptionHelper {
-    /** Builds a number description with a "weight-picker" editor name
-     * @public
-     */
-    static buildWeightPickerDescription(name: string, label: string, additionalParams?: BasePropertyEditorParams[]): PropertyDescription;
-    /** Builds an editor that uses [NumberInput]($core-react) control
-     * @public
-     */
-    static buildNumberEditorDescription(name: string, label: string, overrideParams?: RangeEditorParams, additionalParams?: BasePropertyEditorParams[]): PropertyDescription;
-    /** Builds a string description
-     * @public
-     */
-    static buildTextEditorDescription(name: string, label: string, additionalParams?: BasePropertyEditorParams[]): PropertyDescription;
-    /** Builds an enum description
-     * @public
-     */
-    static buildEnumPicklistEditorDescription(name: string, label: string, choices: Promise<EnumerationChoice[]> | EnumerationChoice[], additionalParams?: BasePropertyEditorParams[]): PropertyDescription;
-    /** Builds a number description for a tool settings or dialog property that will display a "color-picker" control.
-     * @public
-     */
-    static buildColorPickerDescription(name: string, label: string, colorValues: number[], numColumns: number, additionalParams?: BasePropertyEditorParams[]): PropertyDescription;
-    /** Builds a boolean description for a tool settings or dialog property that will display a "toggle" control.
-     * @public
-     */
-    static buildToggleDescription(name: string, label: string, additionalParams?: BasePropertyEditorParams[]): PropertyDescription;
-    /** Builds a boolean description for a tool settings or dialog property that will display a "image-check-box" control.
-     * @public
-     */
-    static buildImageCheckBoxDescription(name: string, label: string, imageOff: string, imageOn: string, additionalParams?: BasePropertyEditorParams[]): PropertyDescription;
-    /** Builds a boolean description for a tool settings or dialog property that will display a checkbox control.
-     * @public
-     */
-    static buildCheckboxDescription(name: string, label: string, additionalParams?: BasePropertyEditorParams[]): PropertyDescription;
-    /** 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: string, additionalParams?: BasePropertyEditorParams[]): PropertyDescription;
-    /** Bumps an enum property description value
-     * @public
-     */
-    static bumpEnumProperty(description: PropertyDescription, value: string | number): Promise<string | number>;
-}
+/** @packageDocumentation
+ * @module Properties
+ */
+import { BasePropertyEditorParams, PropertyEditorParams, RangeEditorParams } from "./EditorParams";
+/**
+ * Information about an enumeration choice
+ * @public
+ */
+export interface EnumerationChoice {
+    label: string;
+    value: string | number;
+}
+/**
+ * Information about a set of enumeration choices
+ * @public
+ */
+export interface EnumerationChoicesInfo {
+    choices: Promise<EnumerationChoice[]> | EnumerationChoice[];
+    isStrict?: boolean;
+    maxDisplayedRows?: number;
+}
+/**
+ * Property renderer identification and customization attributes
+ * @public
+ */
+export interface PropertyRendererInfo {
+    name: string;
+}
+/**
+ * Information about a Property Editor
+ * @public
+ */
+export interface PropertyEditorInfo {
+    /** Editor name used in addition to the typename to find the registered property editor */
+    name?: string;
+    /** Editor params provided to the property editor */
+    params?: PropertyEditorParams[];
+}
+/**
+ * Information about a Property Converter
+ * @public
+ */
+export interface PropertyConverterInfo {
+    /** Converter name used in addition to the typename to find the registered property converter */
+    name?: string;
+    /** map of options for type converter */
+    options?: {
+        [key: string]: any;
+    };
+}
+/**
+ * [[PropertyDescription]] contains metadata about a Property
+ * @public
+ */
+export interface PropertyDescription {
+    /** Name of the property description */
+    name: string;
+    /** Display label for the property description */
+    displayLabel: string;
+    /** Type name used to determine applicable Type Converter and Property Editor */
+    typename: string;
+    /** Additional information for enumerations */
+    enum?: EnumerationChoicesInfo;
+    /** Information for property renderer customization */
+    renderer?: PropertyRendererInfo;
+    /** Information for a property editor */
+    editor?: PropertyEditorInfo;
+    /** Information for a property converter */
+    converter?: PropertyConverterInfo;
+    /** 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
+     *  or the full name of a KOQ (schema:koq).
+     * @alpha
+     */
+    quantityType?: string;
+    /** Get the custom DataController by this name and register it with the property editor */
+    dataController?: string;
+    /**
+     * Should property label for composite (struct & array) properties be rendered.
+     * @alpha
+     */
+    hideCompositePropertyLabel?: boolean;
+}
+/** Helper class that builds property descriptions for specific PropertyEditors and processes descriptions.
+ * @public
+ */
+export declare class PropertyDescriptionHelper {
+    /** Builds a number description with a "weight-picker" editor name
+     * @public
+     */
+    static buildWeightPickerDescription(name: string, label: string, additionalParams?: BasePropertyEditorParams[]): PropertyDescription;
+    /** Builds an editor that uses [NumberInput]($core-react) control
+     * @public
+     */
+    static buildNumberEditorDescription(name: string, label: string, overrideParams?: RangeEditorParams, additionalParams?: BasePropertyEditorParams[]): PropertyDescription;
+    /** Builds a string description
+     * @public
+     */
+    static buildTextEditorDescription(name: string, label: string, additionalParams?: BasePropertyEditorParams[]): PropertyDescription;
+    /** Builds an enum description
+     * @public
+     */
+    static buildEnumPicklistEditorDescription(name: string, label: string, choices: Promise<EnumerationChoice[]> | EnumerationChoice[], additionalParams?: BasePropertyEditorParams[]): PropertyDescription;
+    /** Builds a number description for a tool settings or dialog property that will display a "color-picker" control.
+     * @public
+     */
+    static buildColorPickerDescription(name: string, label: string, colorValues: number[], numColumns: number, additionalParams?: BasePropertyEditorParams[]): PropertyDescription;
+    /** Builds a boolean description for a tool settings or dialog property that will display a "toggle" control.
+     * @public
+     */
+    static buildToggleDescription(name: string, label: string, additionalParams?: BasePropertyEditorParams[]): PropertyDescription;
+    /** Builds a boolean description for a tool settings or dialog property that will display a "image-check-box" control.
+     * @public
+     */
+    static buildImageCheckBoxDescription(name: string, label: string, imageOff: string, imageOn: string, additionalParams?: BasePropertyEditorParams[]): PropertyDescription;
+    /** Builds a boolean description for a tool settings or dialog property that will display a checkbox control.
+     * @public
+     */
+    static buildCheckboxDescription(name: string, label: string, additionalParams?: BasePropertyEditorParams[]): PropertyDescription;
+    /** 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: string, additionalParams?: BasePropertyEditorParams[]): PropertyDescription;
+    /** Bumps an enum property description value
+     * @public
+     */
+    static bumpEnumProperty(description: PropertyDescription, value: string | number): Promise<string | number>;
+}
 //# sourceMappingURL=Description.d.ts.map

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

@@ -1,197 +1,197 @@
-"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 Properties
- */
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.PropertyDescriptionHelper = void 0;
-const EditorParams_1 = require("./EditorParams");
-const StandardEditorNames_1 = require("./StandardEditorNames");
-const StandardTypeNames_1 = require("./StandardTypeNames");
-/** Helper class that builds property descriptions for specific PropertyEditors and processes descriptions.
- * @public
- */
-class PropertyDescriptionHelper {
-    /** Builds a number description with a "weight-picker" editor name
-     * @public
-     */
-    static buildWeightPickerDescription(name, label, additionalParams = []) {
-        return {
-            name,
-            displayLabel: label,
-            typename: StandardTypeNames_1.StandardTypeNames.Number,
-            editor: {
-                name: StandardEditorNames_1.StandardEditorNames.WeightPicker,
-                params: additionalParams,
-            },
-        };
-    }
-    /** Builds an editor that uses [NumberInput]($core-react) control
-     * @public
-     */
-    static buildNumberEditorDescription(name, label, overrideParams, additionalParams = []) {
-        const editorParams = [{
-                type: EditorParams_1.PropertyEditorParamTypes.Range,
-                step: 1,
-                precision: 0,
-                ...overrideParams,
-            }, ...additionalParams];
-        const editor = {
-            name: StandardEditorNames_1.StandardEditorNames.NumericInput,
-            params: editorParams,
-        };
-        return {
-            name,
-            displayLabel: label,
-            typename: StandardTypeNames_1.StandardTypeNames.Number,
-            editor,
-        };
-    }
-    /** Builds a string description
-     * @public
-     */
-    static buildTextEditorDescription(name, label, additionalParams = []) {
-        const editor = {
-            params: additionalParams,
-        };
-        return {
-            name,
-            displayLabel: label,
-            typename: StandardTypeNames_1.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_1.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: EditorParams_1.PropertyEditorParamTypes.ColorData,
-                colorValues,
-                numColumns,
-            },
-            ...additionalParams,
-        ];
-        return {
-            name,
-            displayLabel: label,
-            typename: StandardTypeNames_1.StandardTypeNames.Number,
-            editor: {
-                name: StandardEditorNames_1.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_1.StandardTypeNames.Boolean,
-            editor: {
-                name: StandardEditorNames_1.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: EditorParams_1.PropertyEditorParamTypes.CheckBoxImages,
-                imageOff,
-                imageOn,
-            }, ...additionalParams];
-        return {
-            name,
-            displayLabel: label,
-            typename: StandardTypeNames_1.StandardTypeNames.Boolean,
-            editor: {
-                name: StandardEditorNames_1.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_1.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: EditorParams_1.PropertyEditorParamTypes.SuppressEditorLabel,
-            suppressLabelPlaceholder: true,
-        };
-        const editor = {
-            params: [defaultParams, ...additionalParams],
-        };
-        return {
-            name,
-            displayLabel: "",
-            typename: StandardTypeNames_1.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;
-    }
-}
-exports.PropertyDescriptionHelper = PropertyDescriptionHelper;
+"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 Properties
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.PropertyDescriptionHelper = void 0;
+const EditorParams_1 = require("./EditorParams");
+const StandardEditorNames_1 = require("./StandardEditorNames");
+const StandardTypeNames_1 = require("./StandardTypeNames");
+/** Helper class that builds property descriptions for specific PropertyEditors and processes descriptions.
+ * @public
+ */
+class PropertyDescriptionHelper {
+    /** Builds a number description with a "weight-picker" editor name
+     * @public
+     */
+    static buildWeightPickerDescription(name, label, additionalParams = []) {
+        return {
+            name,
+            displayLabel: label,
+            typename: StandardTypeNames_1.StandardTypeNames.Number,
+            editor: {
+                name: StandardEditorNames_1.StandardEditorNames.WeightPicker,
+                params: additionalParams,
+            },
+        };
+    }
+    /** Builds an editor that uses [NumberInput]($core-react) control
+     * @public
+     */
+    static buildNumberEditorDescription(name, label, overrideParams, additionalParams = []) {
+        const editorParams = [{
+                type: EditorParams_1.PropertyEditorParamTypes.Range,
+                step: 1,
+                precision: 0,
+                ...overrideParams,
+            }, ...additionalParams];
+        const editor = {
+            name: StandardEditorNames_1.StandardEditorNames.NumericInput,
+            params: editorParams,
+        };
+        return {
+            name,
+            displayLabel: label,
+            typename: StandardTypeNames_1.StandardTypeNames.Number,
+            editor,
+        };
+    }
+    /** Builds a string description
+     * @public
+     */
+    static buildTextEditorDescription(name, label, additionalParams = []) {
+        const editor = {
+            params: additionalParams,
+        };
+        return {
+            name,
+            displayLabel: label,
+            typename: StandardTypeNames_1.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_1.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: EditorParams_1.PropertyEditorParamTypes.ColorData,
+                colorValues,
+                numColumns,
+            },
+            ...additionalParams,
+        ];
+        return {
+            name,
+            displayLabel: label,
+            typename: StandardTypeNames_1.StandardTypeNames.Number,
+            editor: {
+                name: StandardEditorNames_1.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_1.StandardTypeNames.Boolean,
+            editor: {
+                name: StandardEditorNames_1.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: EditorParams_1.PropertyEditorParamTypes.CheckBoxImages,
+                imageOff,
+                imageOn,
+            }, ...additionalParams];
+        return {
+            name,
+            displayLabel: label,
+            typename: StandardTypeNames_1.StandardTypeNames.Boolean,
+            editor: {
+                name: StandardEditorNames_1.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_1.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: EditorParams_1.PropertyEditorParamTypes.SuppressEditorLabel,
+            suppressLabelPlaceholder: true,
+        };
+        const editor = {
+            params: [defaultParams, ...additionalParams],
+        };
+        return {
+            name,
+            displayLabel: "",
+            typename: StandardTypeNames_1.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;
+    }
+}
+exports.PropertyDescriptionHelper = PropertyDescriptionHelper;
 //# sourceMappingURL=Description.js.map