@itwin/appui-abstract 4.0.0-dev.48 → 4.0.0-dev.51

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

@@ -1,98 +1,98 @@
-/*---------------------------------------------------------------------------------------------
-* 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
- */
-/** Alternate Data Formats that can be provide by javascript. Can be used by Date TypeConverter and TypeEditor.
- * @public
- */
-export var AlternateDateFormats;
-(function (AlternateDateFormats) {
-    AlternateDateFormats[AlternateDateFormats["None"] = 0] = "None";
-    // YYYY-MM-DD
-    AlternateDateFormats[AlternateDateFormats["IsoShort"] = 1] = "IsoShort";
-    // YYYY-MM-DDTHH:mm:ss.sssZ
-    AlternateDateFormats[AlternateDateFormats["IsoDateTime"] = 2] = "IsoDateTime";
-    // dd Mmm yyyy
-    AlternateDateFormats[AlternateDateFormats["UtcShort"] = 3] = "UtcShort";
-    // dd Mmm yyyy hh:mm:ss GMT
-    AlternateDateFormats[AlternateDateFormats["UtcDateTime"] = 4] = "UtcDateTime";
-    // Www, dd Mmm yyyy
-    AlternateDateFormats[AlternateDateFormats["UtcShortWithDay"] = 5] = "UtcShortWithDay";
-    // Www, dd Mmm yyyy hh:mm:ss GMT
-    AlternateDateFormats[AlternateDateFormats["UtcDateTimeWithDay"] = 6] = "UtcDateTimeWithDay";
-})(AlternateDateFormats || (AlternateDateFormats = {}));
-/** Enum that defines supported time formats.
- * @public
- */
-export var TimeDisplay;
-(function (TimeDisplay) {
-    // 12 hour with minutes and cycle(AM/PM)
-    TimeDisplay["H12MC"] = "hh:mm aa";
-    // 12 hour with minutes, seconds and cycle(AM/PM)
-    TimeDisplay["H12MSC"] = "hh:mm:ss aa";
-    // 24 hour with minutes
-    TimeDisplay["H24M"] = "hh:mm";
-    // 24 hour with minutes and seconds
-    TimeDisplay["H24MS"] = "hh:mm:ss";
-})(TimeDisplay || (TimeDisplay = {}));
-/**
- * Enum for Property Editor Param Types
- * @public
- */
-export var PropertyEditorParamTypes;
-(function (PropertyEditorParamTypes) {
-    PropertyEditorParamTypes["ButtonGroupData"] = "UiAbstract-ButtonGroupData";
-    PropertyEditorParamTypes["CheckBoxIcons"] = "UiAbstract-CheckBoxIcons";
-    PropertyEditorParamTypes["Icon"] = "UiAbstract-Icon";
-    PropertyEditorParamTypes["InputEditorSize"] = "UiAbstract-InputEditorSize";
-    PropertyEditorParamTypes["ColorData"] = "UiAbstract-ColorData";
-    PropertyEditorParamTypes["CustomFormattedNumber"] = "UiAbstract-CustomFormattedNumber";
-    PropertyEditorParamTypes["IconListData"] = "UiAbstract-IconListData";
-    // JSON = "UiAbstract-JSON",
-    PropertyEditorParamTypes["MultilineText"] = "UiAbstract-MultilineText";
-    PropertyEditorParamTypes["Range"] = "UiAbstract-Range";
-    PropertyEditorParamTypes["Slider"] = "UiAbstract-Slider";
-    // SuppressUnitLabel = "UiAbstract-SuppressUnitLabel",
-    PropertyEditorParamTypes["SuppressEditorLabel"] = "UiAbstract-SuppressEditorLabel";
-    PropertyEditorParamTypes["CheckBoxImages"] = "UiAbstract-CheckBoxImages";
-})(PropertyEditorParamTypes || (PropertyEditorParamTypes = {}));
-/** InputEditorSizeParams type guard.
- * @public
- */
-export const isInputEditorSizeParams = (item) => {
-    return item.type === PropertyEditorParamTypes.InputEditorSize;
-};
-/** ColorEditorParams type guard.
- * @public
- */
-export const isColorEditorParams = (item) => {
-    return item.type === PropertyEditorParamTypes.ColorData;
-};
-/** IconListEditorParams type guard.
- * @public
- */
-export const isIconListEditorParams = (item) => {
-    return item.type === PropertyEditorParamTypes.IconListData;
-};
-/** ButtonGroupEditorParams type guard.
- * @public
- */
-export const isButtonGroupEditorParams = (item) => {
-    return item.type === PropertyEditorParamTypes.ButtonGroupData;
-};
-/** SuppressLabelEditorParams type guard.
- * @public
- */
-export const isSuppressLabelEditorParams = (item) => {
-    return item.type === PropertyEditorParamTypes.SuppressEditorLabel;
-};
-/** CustomFormattedNumberParams type guard.
- * @public
- */
-export const isCustomFormattedNumberParams = (item) => {
-    return item.type === PropertyEditorParamTypes.CustomFormattedNumber;
-};
+/*---------------------------------------------------------------------------------------------
+* 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
+ */
+/** Alternate Data Formats that can be provide by javascript. Can be used by Date TypeConverter and TypeEditor.
+ * @public
+ */
+export var AlternateDateFormats;
+(function (AlternateDateFormats) {
+    AlternateDateFormats[AlternateDateFormats["None"] = 0] = "None";
+    // YYYY-MM-DD
+    AlternateDateFormats[AlternateDateFormats["IsoShort"] = 1] = "IsoShort";
+    // YYYY-MM-DDTHH:mm:ss.sssZ
+    AlternateDateFormats[AlternateDateFormats["IsoDateTime"] = 2] = "IsoDateTime";
+    // dd Mmm yyyy
+    AlternateDateFormats[AlternateDateFormats["UtcShort"] = 3] = "UtcShort";
+    // dd Mmm yyyy hh:mm:ss GMT
+    AlternateDateFormats[AlternateDateFormats["UtcDateTime"] = 4] = "UtcDateTime";
+    // Www, dd Mmm yyyy
+    AlternateDateFormats[AlternateDateFormats["UtcShortWithDay"] = 5] = "UtcShortWithDay";
+    // Www, dd Mmm yyyy hh:mm:ss GMT
+    AlternateDateFormats[AlternateDateFormats["UtcDateTimeWithDay"] = 6] = "UtcDateTimeWithDay";
+})(AlternateDateFormats || (AlternateDateFormats = {}));
+/** Enum that defines supported time formats.
+ * @public
+ */
+export var TimeDisplay;
+(function (TimeDisplay) {
+    // 12 hour with minutes and cycle(AM/PM)
+    TimeDisplay["H12MC"] = "hh:mm aa";
+    // 12 hour with minutes, seconds and cycle(AM/PM)
+    TimeDisplay["H12MSC"] = "hh:mm:ss aa";
+    // 24 hour with minutes
+    TimeDisplay["H24M"] = "hh:mm";
+    // 24 hour with minutes and seconds
+    TimeDisplay["H24MS"] = "hh:mm:ss";
+})(TimeDisplay || (TimeDisplay = {}));
+/**
+ * Enum for Property Editor Param Types
+ * @public
+ */
+export var PropertyEditorParamTypes;
+(function (PropertyEditorParamTypes) {
+    PropertyEditorParamTypes["ButtonGroupData"] = "UiAbstract-ButtonGroupData";
+    PropertyEditorParamTypes["CheckBoxIcons"] = "UiAbstract-CheckBoxIcons";
+    PropertyEditorParamTypes["Icon"] = "UiAbstract-Icon";
+    PropertyEditorParamTypes["InputEditorSize"] = "UiAbstract-InputEditorSize";
+    PropertyEditorParamTypes["ColorData"] = "UiAbstract-ColorData";
+    PropertyEditorParamTypes["CustomFormattedNumber"] = "UiAbstract-CustomFormattedNumber";
+    PropertyEditorParamTypes["IconListData"] = "UiAbstract-IconListData";
+    // JSON = "UiAbstract-JSON",
+    PropertyEditorParamTypes["MultilineText"] = "UiAbstract-MultilineText";
+    PropertyEditorParamTypes["Range"] = "UiAbstract-Range";
+    PropertyEditorParamTypes["Slider"] = "UiAbstract-Slider";
+    // SuppressUnitLabel = "UiAbstract-SuppressUnitLabel",
+    PropertyEditorParamTypes["SuppressEditorLabel"] = "UiAbstract-SuppressEditorLabel";
+    PropertyEditorParamTypes["CheckBoxImages"] = "UiAbstract-CheckBoxImages";
+})(PropertyEditorParamTypes || (PropertyEditorParamTypes = {}));
+/** InputEditorSizeParams type guard.
+ * @public
+ */
+export const isInputEditorSizeParams = (item) => {
+    return item.type === PropertyEditorParamTypes.InputEditorSize;
+};
+/** ColorEditorParams type guard.
+ * @public
+ */
+export const isColorEditorParams = (item) => {
+    return item.type === PropertyEditorParamTypes.ColorData;
+};
+/** IconListEditorParams type guard.
+ * @public
+ */
+export const isIconListEditorParams = (item) => {
+    return item.type === PropertyEditorParamTypes.IconListData;
+};
+/** ButtonGroupEditorParams type guard.
+ * @public
+ */
+export const isButtonGroupEditorParams = (item) => {
+    return item.type === PropertyEditorParamTypes.ButtonGroupData;
+};
+/** SuppressLabelEditorParams type guard.
+ * @public
+ */
+export const isSuppressLabelEditorParams = (item) => {
+    return item.type === PropertyEditorParamTypes.SuppressEditorLabel;
+};
+/** CustomFormattedNumberParams type guard.
+ * @public
+ */
+export const isCustomFormattedNumberParams = (item) => {
+    return item.type === PropertyEditorParamTypes.CustomFormattedNumber;
+};
 //# sourceMappingURL=EditorParams.js.map

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

@@ -1 +1 @@
-{"version":3,"file":"EditorParams.js","sourceRoot":"","sources":["../../../../src/appui-abstract/properties/EditorParams.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG;AAcH;;GAEG;AACH,MAAM,CAAN,IAAY,oBAcX;AAdD,WAAY,oBAAoB;IAC9B,+DAAQ,CAAA;IACR,aAAa;IACb,uEAAY,CAAA;IACZ,2BAA2B;IAC3B,6EAAW,CAAA;IACX,cAAc;IACd,uEAAQ,CAAA;IACR,2BAA2B;IAC3B,6EAAW,CAAA;IACX,mBAAmB;IACnB,qFAAe,CAAA;IACf,gCAAgC;IAChC,2FAAkB,CAAA;AACpB,CAAC,EAdW,oBAAoB,KAApB,oBAAoB,QAc/B;AAED;;GAEG;AACH,MAAM,CAAN,IAAY,WASX;AATD,WAAY,WAAW;IACrB,wCAAwC;IACxC,iCAAkB,CAAA;IAClB,iDAAiD;IACjD,qCAAsB,CAAA;IACtB,uBAAuB;IACvB,6BAAc,CAAA;IACd,mCAAmC;IACnC,iCAAkB,CAAA;AACpB,CAAC,EATW,WAAW,KAAX,WAAW,QAStB;AAED;;;GAGG;AACH,MAAM,CAAN,IAAY,wBAeX;AAfD,WAAY,wBAAwB;IAClC,0EAA8C,CAAA;IAC9C,sEAA0C,CAAA;IAC1C,oDAAwB,CAAA;IACxB,0EAA8C,CAAA;IAC9C,8DAAkC,CAAA;IAClC,sFAA0D,CAAA;IAC1D,oEAAwC,CAAA;IACxC,4BAA4B;IAC5B,sEAA0C,CAAA;IAC1C,sDAA0B,CAAA;IAC1B,wDAA4B,CAAA;IAC5B,sDAAsD;IACtD,kFAAsD,CAAA;IACtD,wEAA4C,CAAA;AAC9C,CAAC,EAfW,wBAAwB,KAAxB,wBAAwB,QAenC;AAyBD;;GAEG;AACH,MAAM,CAAC,MAAM,uBAAuB,GAAG,CAAC,IAA8B,EAAiC,EAAE;IACvG,OAAO,IAAI,CAAC,IAAI,KAAK,wBAAwB,CAAC,eAAe,CAAC;AAChE,CAAC,CAAC;AAeF;;GAEG;AACH,MAAM,CAAC,MAAM,mBAAmB,GAAG,CAAC,IAA8B,EAA6B,EAAE;IAC/F,OAAO,IAAI,CAAC,IAAI,KAAK,wBAAwB,CAAC,SAAS,CAAC;AAC1D,CAAC,CAAC;AAgBF;;GAEG;AACH,MAAM,CAAC,MAAM,sBAAsB,GAAG,CAAC,IAA8B,EAAgC,EAAE;IACrG,OAAO,IAAI,CAAC,IAAI,KAAK,wBAAwB,CAAC,YAAY,CAAC;AAC7D,CAAC,CAAC;AAsBF;;GAEG;AACH,MAAM,CAAC,MAAM,yBAAyB,GAAG,CAAC,IAA8B,EAAmC,EAAE;IAC3G,OAAO,IAAI,CAAC,IAAI,KAAK,wBAAwB,CAAC,eAAe,CAAC;AAChE,CAAC,CAAC;AAYF;;GAEG;AACH,MAAM,CAAC,MAAM,2BAA2B,GAAG,CAAC,IAA8B,EAAqC,EAAE;IAC/G,OAAO,IAAI,CAAC,IAAI,KAAK,wBAAwB,CAAC,mBAAmB,CAAC;AACpE,CAAC,CAAC;AA4IF;;GAEG;AACH,MAAM,CAAC,MAAM,6BAA6B,GAAG,CAAC,IAA8B,EAAuC,EAAE;IACnH,OAAO,IAAI,CAAC,IAAI,KAAK,wBAAwB,CAAC,qBAAqB,CAAC;AACtE,CAAC,CAAC","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\n// cspell:ignore BBGGRR pushable DDTHH\n\n/** Interface used to provide a custom Date Time formatter and optional parser\n * for use by `DatePickerPopup`. If a parseData function is not implemented\n * then string to date parsing will not be possible when a `DateFormatter` is used.\n * @public\n */\nexport interface DateFormatter {\n  formateDate: (day: Date) => string;\n  parseDate?: (dateString: string) => Date | undefined;\n}\n\n/** Alternate Data Formats that can be provide by javascript. Can be used by Date TypeConverter and TypeEditor.\n * @public\n */\nexport enum AlternateDateFormats {\n  None = 0,\n  // YYYY-MM-DD\n  IsoShort = 1,\n  // YYYY-MM-DDTHH:mm:ss.sssZ\n  IsoDateTime,\n  // dd Mmm yyyy\n  UtcShort,\n  // dd Mmm yyyy hh:mm:ss GMT\n  UtcDateTime,\n  // Www, dd Mmm yyyy\n  UtcShortWithDay,\n  // Www, dd Mmm yyyy hh:mm:ss GMT\n  UtcDateTimeWithDay,\n}\n\n/** Enum that defines supported time formats.\n * @public\n */\nexport enum TimeDisplay {\n  // 12 hour with minutes and cycle(AM/PM)\n  H12MC = \"hh:mm aa\",\n  // 12 hour with minutes, seconds and cycle(AM/PM)\n  H12MSC = \"hh:mm:ss aa\",\n  // 24 hour with minutes\n  H24M = \"hh:mm\",\n  // 24 hour with minutes and seconds\n  H24MS = \"hh:mm:ss\",\n}\n\n/**\n * Enum for Property Editor Param Types\n * @public\n */\nexport enum PropertyEditorParamTypes {\n  ButtonGroupData = \"UiAbstract-ButtonGroupData\",\n  CheckBoxIcons = \"UiAbstract-CheckBoxIcons\",\n  Icon = \"UiAbstract-Icon\",\n  InputEditorSize = \"UiAbstract-InputEditorSize\",\n  ColorData = \"UiAbstract-ColorData\",\n  CustomFormattedNumber = \"UiAbstract-CustomFormattedNumber\",\n  IconListData = \"UiAbstract-IconListData\",\n  // JSON = \"UiAbstract-JSON\",\n  MultilineText = \"UiAbstract-MultilineText\",\n  Range = \"UiAbstract-Range\",\n  Slider = \"UiAbstract-Slider\",\n  // SuppressUnitLabel = \"UiAbstract-SuppressUnitLabel\",\n  SuppressEditorLabel = \"UiAbstract-SuppressEditorLabel\",\n  CheckBoxImages = \"UiAbstract-CheckBoxImages\",\n}\n\n/**\n * [[BasePropertyEditorParams]] Base interface for Property Editor Params\n * @public\n */\nexport interface BasePropertyEditorParams {\n  type: string;\n}\n\n/**\n * Parameters used by PropertyEditors that use HTML <input> element.\n * @public\n */\n/** [[InputEditorSizeParams]] type guard.\n * @public\n */\nexport interface InputEditorSizeParams extends BasePropertyEditorParams {\n  type: PropertyEditorParamTypes.InputEditorSize;\n  /** Optionally define the width in characters. */\n  size?: number;\n  /** Optionally define the maximum number of characters allowed. */\n  maxLength?: number;\n}\n\n/** InputEditorSizeParams type guard.\n * @public\n */\nexport const isInputEditorSizeParams = (item: BasePropertyEditorParams): item is InputEditorSizeParams => {\n  return item.type === PropertyEditorParamTypes.InputEditorSize;\n};\n\n/**\n * [[ColorEditorParams]] Parameters used to populate color type editor with a specific set of colors. If not specified the Color\n * Editor will show a default palette of 16 colors.\n * @public\n */\nexport interface ColorEditorParams extends BasePropertyEditorParams {\n  type: PropertyEditorParamTypes.ColorData;\n  /** array of color values to show in color picker popup. Use [[ColorByName]] enum values. Values should be 32-bit integer in the form 0xBBGGRR. */\n  colorValues: number[];\n  /** number of columns to show in color picker popup. The value of 4 is used if not defined. */\n  numColumns?: number;\n}\n\n/** ColorEditorParams type guard.\n * @public\n */\nexport const isColorEditorParams = (item: BasePropertyEditorParams): item is ColorEditorParams => {\n  return item.type === PropertyEditorParamTypes.ColorData;\n};\n\n/**\n * [[IconListEditorParams]] Parameters used to populate icon type editor with a specific set of icons.\n * @public\n */\nexport interface IconListEditorParams extends BasePropertyEditorParams {\n  type: PropertyEditorParamTypes.IconListData;\n  /** active icon shown in the button */\n  iconValue: string;\n  /** array of icon (svg) names to show in icon picker popup. */\n  iconValues: string[];\n  /** number of columns to show in icon picker popup. The value of 4 is used if not defined. */\n  numColumns?: number;\n}\n\n/** IconListEditorParams type guard.\n * @public\n */\nexport const isIconListEditorParams = (item: BasePropertyEditorParams): item is IconListEditorParams => {\n  return item.type === PropertyEditorParamTypes.IconListData;\n};\n\n/**\n * [[IconDefinition]] Information about an icon displayed next to a property editor.\n * @public\n */\nexport interface IconDefinition {\n  /** Icon specification. The value is the name of an icon WebFont entry, or if specifying an imported SVG symbol use \"webSvg:\" prefix . */\n  iconSpec: string;\n  /** Function to determine if the item is enabled. */\n  isEnabledFunction?: () => boolean;\n}\n\n/**\n * [[ButtonGroupEditorParams]] Parameters used by EnumButtonGroupEditor to define icons in button group.\n * @public\n */\nexport interface ButtonGroupEditorParams extends BasePropertyEditorParams {\n  type: PropertyEditorParamTypes.ButtonGroupData;\n  buttons: IconDefinition[];\n}\n\n/** ButtonGroupEditorParams type guard.\n * @public\n */\nexport const isButtonGroupEditorParams = (item: BasePropertyEditorParams): item is ButtonGroupEditorParams => {\n  return item.type === PropertyEditorParamTypes.ButtonGroupData;\n};\n\n/**\n * [[SuppressLabelEditorParams]] Parameters used to suppress the label for a type editor in the ToolSettings widget.\n * @public\n */\nexport interface SuppressLabelEditorParams extends BasePropertyEditorParams {\n  type: PropertyEditorParamTypes.SuppressEditorLabel;\n  /** if false then an empty placeholder label is created. This is sometimes necessary to align editor in proper column */\n  suppressLabelPlaceholder?: boolean;\n}\n\n/** SuppressLabelEditorParams type guard.\n * @public\n */\nexport const isSuppressLabelEditorParams = (item: BasePropertyEditorParams): item is SuppressLabelEditorParams => {\n  return item.type === PropertyEditorParamTypes.SuppressEditorLabel;\n};\n\n// /**\n//  * Parameters used by PropertyEditors that support JSON.\n//  * @alpha\n//  */\n// export interface JsonEditorParams extends BasePropertyEditorParams {\n//   type: PropertyEditorParamTypes.JSON;\n//   json: any;\n// }\n\n/**\n * Parameters used by PropertyEditors that support defining a minimum and maximum value.\n * @public\n */\nexport interface RangeEditorParams extends BasePropertyEditorParams {\n  type: PropertyEditorParamTypes.Range;\n  /** Defines the minimum value. Default is Number.MIN_SAFE_INTEGER. */\n  minimum?: number;\n  /** Defines the maximum value. Default is Number.MAX_SAFE_INTEGER. */\n  maximum?: number;\n  /** Defines the step value. Default is 1. */\n  step?: number;\n  /** Defines the precision. Default is 0. */\n  precision?: number;\n}\n\n/**\n * Parameters used to indicate that a Slider should be presented for the property\n * and to specify the values needed by the slider.\n * @public\n */\nexport interface SliderEditorParams extends BasePropertyEditorParams {\n  type: PropertyEditorParamTypes.Slider;\n  /** Defines the minimum value. */\n  minimum: number;\n  /** Defines the maximum value. */\n  maximum: number;\n\n  /** Optionally define the width in pixels. */\n  size?: number;\n\n  /** Step value. Default is 0.1. */\n  step?: number;\n  /** The interaction mode. Default is 1. Possible values:\n   * 1 - allows handles to cross each other.\n   * 2 - keeps the sliders from crossing and separated by a step.\n   */\n  mode?: number;\n\n  /** Indicates whether the display of the Slider values is reversed. */\n  reversed?: boolean;\n\n  /** Indicates whether to show tooltip with the value. The tooltip will be positioned above the Slider, by default. */\n  showTooltip?: boolean;\n  /** Indicates whether the tooltip should show below the Slider instead of above. */\n  tooltipBelow?: boolean;\n  /** Format a value for the tooltip */\n  formatTooltip?: (value: number) => string;\n\n  /** Indicates whether to show min & max values to the left & right of the Slider. */\n  showMinMax?: boolean;\n  /** Image to show for min. */\n  minIconSpec?: string;\n  /** Image to show for max. */\n  maxIconSpec?: string;\n\n  /** Indicates whether to show tick marks under the Slider. */\n  showTicks?: boolean;\n  /** Indicates whether to show tick labels under the tick marks. */\n  showTickLabels?: boolean;\n  /** Format a tick mark value */\n  formatTick?: (tick: number) => string;\n  /** Function to get the tick count. The default tick count is 10. */\n  getTickCount?: () => number;\n  /** Function to get the tick values. This overrides the tick count from getTickCount.\n   * Use this prop if you want to specify your own tick values instead of ticks generated by the slider.\n   * The numbers should be valid numbers in the domain and correspond to the step value.\n   * Invalid values will be coerced to the closet matching value in the domain.\n   */\n  getTickValues?: () => number[];\n}\n\n/**\n * Parameter that is used to indicate that a multiline text editor should be created.\n * The number of rows specified will determine the height of the editor control.\n * @public\n */\nexport interface MultilineTextEditorParams extends BasePropertyEditorParams {\n  type: PropertyEditorParamTypes.MultilineText;\n  rows: number;\n}\n\n/**\n * Parameters used to display an icon next to property editor.\n * @public\n */\nexport interface IconEditorParams extends BasePropertyEditorParams {\n  type: PropertyEditorParamTypes.Icon;\n  definition: IconDefinition;\n}\n\n/**\n * Parameters for ImageCheckBoxEditor\n * @public\n */\nexport interface ImageCheckBoxParams extends BasePropertyEditorParams {\n  type: PropertyEditorParamTypes.CheckBoxImages;\n  imageOn: string;\n  imageOff: string;\n\n}\n\n// /**\n//  * Parameter used to suppress Unit labels\n//  * @alpha\n//  */\n// export interface SuppressUnitLabelEditorParams extends BasePropertyEditorParams {\n//   type: PropertyEditorParamTypes.SuppressUnitLabel;\n// }\n\n/**\n * defines Results of parsing a string input by a user into its desired value type\n * @public\n */\nexport interface ParseResults {\n  value?: string | number | boolean | {} | string[] | Date | [] | undefined;\n  parseError?: string;\n}\n\n/**\n * Parameters used with properties that want to control parsing and formatting.\n * @public\n */\nexport interface CustomFormattedNumberParams extends BasePropertyEditorParams {\n  type: PropertyEditorParamTypes.CustomFormattedNumber;\n  formatFunction: (numberValue: number) => string;\n  parseFunction: (stringValue: string) => ParseResults;\n}\n\n/** CustomFormattedNumberParams type guard.\n * @public\n */\nexport const isCustomFormattedNumberParams = (item: BasePropertyEditorParams): item is CustomFormattedNumberParams => {\n  return item.type === PropertyEditorParamTypes.CustomFormattedNumber;\n};\n\n/**\n * Type definition for Property Editor params\n * @public\n */\nexport type PropertyEditorParams = BasePropertyEditorParams;\n"]}
+{"version":3,"file":"EditorParams.js","sourceRoot":"","sources":["../../../../src/appui-abstract/properties/EditorParams.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG;AAcH;;GAEG;AACH,MAAM,CAAN,IAAY,oBAcX;AAdD,WAAY,oBAAoB;IAC9B,+DAAQ,CAAA;IACR,aAAa;IACb,uEAAY,CAAA;IACZ,2BAA2B;IAC3B,6EAAW,CAAA;IACX,cAAc;IACd,uEAAQ,CAAA;IACR,2BAA2B;IAC3B,6EAAW,CAAA;IACX,mBAAmB;IACnB,qFAAe,CAAA;IACf,gCAAgC;IAChC,2FAAkB,CAAA;AACpB,CAAC,EAdW,oBAAoB,KAApB,oBAAoB,QAc/B;AAED;;GAEG;AACH,MAAM,CAAN,IAAY,WASX;AATD,WAAY,WAAW;IACrB,wCAAwC;IACxC,iCAAkB,CAAA;IAClB,iDAAiD;IACjD,qCAAsB,CAAA;IACtB,uBAAuB;IACvB,6BAAc,CAAA;IACd,mCAAmC;IACnC,iCAAkB,CAAA;AACpB,CAAC,EATW,WAAW,KAAX,WAAW,QAStB;AAED;;;GAGG;AACH,MAAM,CAAN,IAAY,wBAeX;AAfD,WAAY,wBAAwB;IAClC,0EAA8C,CAAA;IAC9C,sEAA0C,CAAA;IAC1C,oDAAwB,CAAA;IACxB,0EAA8C,CAAA;IAC9C,8DAAkC,CAAA;IAClC,sFAA0D,CAAA;IAC1D,oEAAwC,CAAA;IACxC,4BAA4B;IAC5B,sEAA0C,CAAA;IAC1C,sDAA0B,CAAA;IAC1B,wDAA4B,CAAA;IAC5B,sDAAsD;IACtD,kFAAsD,CAAA;IACtD,wEAA4C,CAAA;AAC9C,CAAC,EAfW,wBAAwB,KAAxB,wBAAwB,QAenC;AAyBD;;GAEG;AACH,MAAM,CAAC,MAAM,uBAAuB,GAAG,CAAC,IAA8B,EAAiC,EAAE;IACvG,OAAO,IAAI,CAAC,IAAI,KAAK,wBAAwB,CAAC,eAAe,CAAC;AAChE,CAAC,CAAC;AAeF;;GAEG;AACH,MAAM,CAAC,MAAM,mBAAmB,GAAG,CAAC,IAA8B,EAA6B,EAAE;IAC/F,OAAO,IAAI,CAAC,IAAI,KAAK,wBAAwB,CAAC,SAAS,CAAC;AAC1D,CAAC,CAAC;AAgBF;;GAEG;AACH,MAAM,CAAC,MAAM,sBAAsB,GAAG,CAAC,IAA8B,EAAgC,EAAE;IACrG,OAAO,IAAI,CAAC,IAAI,KAAK,wBAAwB,CAAC,YAAY,CAAC;AAC7D,CAAC,CAAC;AAsBF;;GAEG;AACH,MAAM,CAAC,MAAM,yBAAyB,GAAG,CAAC,IAA8B,EAAmC,EAAE;IAC3G,OAAO,IAAI,CAAC,IAAI,KAAK,wBAAwB,CAAC,eAAe,CAAC;AAChE,CAAC,CAAC;AAYF;;GAEG;AACH,MAAM,CAAC,MAAM,2BAA2B,GAAG,CAAC,IAA8B,EAAqC,EAAE;IAC/G,OAAO,IAAI,CAAC,IAAI,KAAK,wBAAwB,CAAC,mBAAmB,CAAC;AACpE,CAAC,CAAC;AA4IF;;GAEG;AACH,MAAM,CAAC,MAAM,6BAA6B,GAAG,CAAC,IAA8B,EAAuC,EAAE;IACnH,OAAO,IAAI,CAAC,IAAI,KAAK,wBAAwB,CAAC,qBAAqB,CAAC;AACtE,CAAC,CAAC","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\n// cspell:ignore BBGGRR pushable DDTHH\r\n\r\n/** Interface used to provide a custom Date Time formatter and optional parser\r\n * for use by `DatePickerPopup`. If a parseData function is not implemented\r\n * then string to date parsing will not be possible when a `DateFormatter` is used.\r\n * @public\r\n */\r\nexport interface DateFormatter {\r\n  formateDate: (day: Date) => string;\r\n  parseDate?: (dateString: string) => Date | undefined;\r\n}\r\n\r\n/** Alternate Data Formats that can be provide by javascript. Can be used by Date TypeConverter and TypeEditor.\r\n * @public\r\n */\r\nexport enum AlternateDateFormats {\r\n  None = 0,\r\n  // YYYY-MM-DD\r\n  IsoShort = 1,\r\n  // YYYY-MM-DDTHH:mm:ss.sssZ\r\n  IsoDateTime,\r\n  // dd Mmm yyyy\r\n  UtcShort,\r\n  // dd Mmm yyyy hh:mm:ss GMT\r\n  UtcDateTime,\r\n  // Www, dd Mmm yyyy\r\n  UtcShortWithDay,\r\n  // Www, dd Mmm yyyy hh:mm:ss GMT\r\n  UtcDateTimeWithDay,\r\n}\r\n\r\n/** Enum that defines supported time formats.\r\n * @public\r\n */\r\nexport enum TimeDisplay {\r\n  // 12 hour with minutes and cycle(AM/PM)\r\n  H12MC = \"hh:mm aa\",\r\n  // 12 hour with minutes, seconds and cycle(AM/PM)\r\n  H12MSC = \"hh:mm:ss aa\",\r\n  // 24 hour with minutes\r\n  H24M = \"hh:mm\",\r\n  // 24 hour with minutes and seconds\r\n  H24MS = \"hh:mm:ss\",\r\n}\r\n\r\n/**\r\n * Enum for Property Editor Param Types\r\n * @public\r\n */\r\nexport enum PropertyEditorParamTypes {\r\n  ButtonGroupData = \"UiAbstract-ButtonGroupData\",\r\n  CheckBoxIcons = \"UiAbstract-CheckBoxIcons\",\r\n  Icon = \"UiAbstract-Icon\",\r\n  InputEditorSize = \"UiAbstract-InputEditorSize\",\r\n  ColorData = \"UiAbstract-ColorData\",\r\n  CustomFormattedNumber = \"UiAbstract-CustomFormattedNumber\",\r\n  IconListData = \"UiAbstract-IconListData\",\r\n  // JSON = \"UiAbstract-JSON\",\r\n  MultilineText = \"UiAbstract-MultilineText\",\r\n  Range = \"UiAbstract-Range\",\r\n  Slider = \"UiAbstract-Slider\",\r\n  // SuppressUnitLabel = \"UiAbstract-SuppressUnitLabel\",\r\n  SuppressEditorLabel = \"UiAbstract-SuppressEditorLabel\",\r\n  CheckBoxImages = \"UiAbstract-CheckBoxImages\",\r\n}\r\n\r\n/**\r\n * [[BasePropertyEditorParams]] Base interface for Property Editor Params\r\n * @public\r\n */\r\nexport interface BasePropertyEditorParams {\r\n  type: string;\r\n}\r\n\r\n/**\r\n * Parameters used by PropertyEditors that use HTML <input> element.\r\n * @public\r\n */\r\n/** [[InputEditorSizeParams]] type guard.\r\n * @public\r\n */\r\nexport interface InputEditorSizeParams extends BasePropertyEditorParams {\r\n  type: PropertyEditorParamTypes.InputEditorSize;\r\n  /** Optionally define the width in characters. */\r\n  size?: number;\r\n  /** Optionally define the maximum number of characters allowed. */\r\n  maxLength?: number;\r\n}\r\n\r\n/** InputEditorSizeParams type guard.\r\n * @public\r\n */\r\nexport const isInputEditorSizeParams = (item: BasePropertyEditorParams): item is InputEditorSizeParams => {\r\n  return item.type === PropertyEditorParamTypes.InputEditorSize;\r\n};\r\n\r\n/**\r\n * [[ColorEditorParams]] Parameters used to populate color type editor with a specific set of colors. If not specified the Color\r\n * Editor will show a default palette of 16 colors.\r\n * @public\r\n */\r\nexport interface ColorEditorParams extends BasePropertyEditorParams {\r\n  type: PropertyEditorParamTypes.ColorData;\r\n  /** array of color values to show in color picker popup. Use [[ColorByName]] enum values. Values should be 32-bit integer in the form 0xBBGGRR. */\r\n  colorValues: number[];\r\n  /** number of columns to show in color picker popup. The value of 4 is used if not defined. */\r\n  numColumns?: number;\r\n}\r\n\r\n/** ColorEditorParams type guard.\r\n * @public\r\n */\r\nexport const isColorEditorParams = (item: BasePropertyEditorParams): item is ColorEditorParams => {\r\n  return item.type === PropertyEditorParamTypes.ColorData;\r\n};\r\n\r\n/**\r\n * [[IconListEditorParams]] Parameters used to populate icon type editor with a specific set of icons.\r\n * @public\r\n */\r\nexport interface IconListEditorParams extends BasePropertyEditorParams {\r\n  type: PropertyEditorParamTypes.IconListData;\r\n  /** active icon shown in the button */\r\n  iconValue: string;\r\n  /** array of icon (svg) names to show in icon picker popup. */\r\n  iconValues: string[];\r\n  /** number of columns to show in icon picker popup. The value of 4 is used if not defined. */\r\n  numColumns?: number;\r\n}\r\n\r\n/** IconListEditorParams type guard.\r\n * @public\r\n */\r\nexport const isIconListEditorParams = (item: BasePropertyEditorParams): item is IconListEditorParams => {\r\n  return item.type === PropertyEditorParamTypes.IconListData;\r\n};\r\n\r\n/**\r\n * [[IconDefinition]] Information about an icon displayed next to a property editor.\r\n * @public\r\n */\r\nexport interface IconDefinition {\r\n  /** Icon specification. The value is the name of an icon WebFont entry, or if specifying an imported SVG symbol use \"webSvg:\" prefix . */\r\n  iconSpec: string;\r\n  /** Function to determine if the item is enabled. */\r\n  isEnabledFunction?: () => boolean;\r\n}\r\n\r\n/**\r\n * [[ButtonGroupEditorParams]] Parameters used by EnumButtonGroupEditor to define icons in button group.\r\n * @public\r\n */\r\nexport interface ButtonGroupEditorParams extends BasePropertyEditorParams {\r\n  type: PropertyEditorParamTypes.ButtonGroupData;\r\n  buttons: IconDefinition[];\r\n}\r\n\r\n/** ButtonGroupEditorParams type guard.\r\n * @public\r\n */\r\nexport const isButtonGroupEditorParams = (item: BasePropertyEditorParams): item is ButtonGroupEditorParams => {\r\n  return item.type === PropertyEditorParamTypes.ButtonGroupData;\r\n};\r\n\r\n/**\r\n * [[SuppressLabelEditorParams]] Parameters used to suppress the label for a type editor in the ToolSettings widget.\r\n * @public\r\n */\r\nexport interface SuppressLabelEditorParams extends BasePropertyEditorParams {\r\n  type: PropertyEditorParamTypes.SuppressEditorLabel;\r\n  /** if false then an empty placeholder label is created. This is sometimes necessary to align editor in proper column */\r\n  suppressLabelPlaceholder?: boolean;\r\n}\r\n\r\n/** SuppressLabelEditorParams type guard.\r\n * @public\r\n */\r\nexport const isSuppressLabelEditorParams = (item: BasePropertyEditorParams): item is SuppressLabelEditorParams => {\r\n  return item.type === PropertyEditorParamTypes.SuppressEditorLabel;\r\n};\r\n\r\n// /**\r\n//  * Parameters used by PropertyEditors that support JSON.\r\n//  * @alpha\r\n//  */\r\n// export interface JsonEditorParams extends BasePropertyEditorParams {\r\n//   type: PropertyEditorParamTypes.JSON;\r\n//   json: any;\r\n// }\r\n\r\n/**\r\n * Parameters used by PropertyEditors that support defining a minimum and maximum value.\r\n * @public\r\n */\r\nexport interface RangeEditorParams extends BasePropertyEditorParams {\r\n  type: PropertyEditorParamTypes.Range;\r\n  /** Defines the minimum value. Default is Number.MIN_SAFE_INTEGER. */\r\n  minimum?: number;\r\n  /** Defines the maximum value. Default is Number.MAX_SAFE_INTEGER. */\r\n  maximum?: number;\r\n  /** Defines the step value. Default is 1. */\r\n  step?: number;\r\n  /** Defines the precision. Default is 0. */\r\n  precision?: number;\r\n}\r\n\r\n/**\r\n * Parameters used to indicate that a Slider should be presented for the property\r\n * and to specify the values needed by the slider.\r\n * @public\r\n */\r\nexport interface SliderEditorParams extends BasePropertyEditorParams {\r\n  type: PropertyEditorParamTypes.Slider;\r\n  /** Defines the minimum value. */\r\n  minimum: number;\r\n  /** Defines the maximum value. */\r\n  maximum: number;\r\n\r\n  /** Optionally define the width in pixels. */\r\n  size?: number;\r\n\r\n  /** Step value. Default is 0.1. */\r\n  step?: number;\r\n  /** The interaction mode. Default is 1. Possible values:\r\n   * 1 - allows handles to cross each other.\r\n   * 2 - keeps the sliders from crossing and separated by a step.\r\n   */\r\n  mode?: number;\r\n\r\n  /** Indicates whether the display of the Slider values is reversed. */\r\n  reversed?: boolean;\r\n\r\n  /** Indicates whether to show tooltip with the value. The tooltip will be positioned above the Slider, by default. */\r\n  showTooltip?: boolean;\r\n  /** Indicates whether the tooltip should show below the Slider instead of above. */\r\n  tooltipBelow?: boolean;\r\n  /** Format a value for the tooltip */\r\n  formatTooltip?: (value: number) => string;\r\n\r\n  /** Indicates whether to show min & max values to the left & right of the Slider. */\r\n  showMinMax?: boolean;\r\n  /** Image to show for min. */\r\n  minIconSpec?: string;\r\n  /** Image to show for max. */\r\n  maxIconSpec?: string;\r\n\r\n  /** Indicates whether to show tick marks under the Slider. */\r\n  showTicks?: boolean;\r\n  /** Indicates whether to show tick labels under the tick marks. */\r\n  showTickLabels?: boolean;\r\n  /** Format a tick mark value */\r\n  formatTick?: (tick: number) => string;\r\n  /** Function to get the tick count. The default tick count is 10. */\r\n  getTickCount?: () => number;\r\n  /** Function to get the tick values. This overrides the tick count from getTickCount.\r\n   * Use this prop if you want to specify your own tick values instead of ticks generated by the slider.\r\n   * The numbers should be valid numbers in the domain and correspond to the step value.\r\n   * Invalid values will be coerced to the closet matching value in the domain.\r\n   */\r\n  getTickValues?: () => number[];\r\n}\r\n\r\n/**\r\n * Parameter that is used to indicate that a multiline text editor should be created.\r\n * The number of rows specified will determine the height of the editor control.\r\n * @public\r\n */\r\nexport interface MultilineTextEditorParams extends BasePropertyEditorParams {\r\n  type: PropertyEditorParamTypes.MultilineText;\r\n  rows: number;\r\n}\r\n\r\n/**\r\n * Parameters used to display an icon next to property editor.\r\n * @public\r\n */\r\nexport interface IconEditorParams extends BasePropertyEditorParams {\r\n  type: PropertyEditorParamTypes.Icon;\r\n  definition: IconDefinition;\r\n}\r\n\r\n/**\r\n * Parameters for ImageCheckBoxEditor\r\n * @public\r\n */\r\nexport interface ImageCheckBoxParams extends BasePropertyEditorParams {\r\n  type: PropertyEditorParamTypes.CheckBoxImages;\r\n  imageOn: string;\r\n  imageOff: string;\r\n\r\n}\r\n\r\n// /**\r\n//  * Parameter used to suppress Unit labels\r\n//  * @alpha\r\n//  */\r\n// export interface SuppressUnitLabelEditorParams extends BasePropertyEditorParams {\r\n//   type: PropertyEditorParamTypes.SuppressUnitLabel;\r\n// }\r\n\r\n/**\r\n * defines Results of parsing a string input by a user into its desired value type\r\n * @public\r\n */\r\nexport interface ParseResults {\r\n  value?: string | number | boolean | {} | string[] | Date | [] | undefined;\r\n  parseError?: string;\r\n}\r\n\r\n/**\r\n * Parameters used with properties that want to control parsing and formatting.\r\n * @public\r\n */\r\nexport interface CustomFormattedNumberParams extends BasePropertyEditorParams {\r\n  type: PropertyEditorParamTypes.CustomFormattedNumber;\r\n  formatFunction: (numberValue: number) => string;\r\n  parseFunction: (stringValue: string) => ParseResults;\r\n}\r\n\r\n/** CustomFormattedNumberParams type guard.\r\n * @public\r\n */\r\nexport const isCustomFormattedNumberParams = (item: BasePropertyEditorParams): item is CustomFormattedNumberParams => {\r\n  return item.type === PropertyEditorParamTypes.CustomFormattedNumber;\r\n};\r\n\r\n/**\r\n * Type definition for Property Editor params\r\n * @public\r\n */\r\nexport type PropertyEditorParams = BasePropertyEditorParams;\r\n"]}

package/lib/esm/appui-abstract/properties/PrimitiveTypes.d.ts

@@ -1,61 +1,61 @@
-/** @packageDocumentation
- * @module Properties
- */
-import { Id64String } from "@itwin/core-bentley";
-/** Primitive Property Value Types.
- * @public
- */
-export declare namespace Primitives {
-    /** Text type */
-    type Text = string;
-    /** String type */
-    type String = string;
-    /** DateTime will be formatted as date and time */
-    type DateTime = string | Date;
-    /** ShortDate will be formatted as date only and will not include time */
-    type ShortDate = string | Date;
-    /** Boolean type */
-    type Boolean = boolean | string | {} | [];
-    /** Float type */
-    type Float = number | string;
-    /** Int type */
-    type Int = number | string;
-    /** Hexadecimal type (number expressed in hex string) */
-    type Hexadecimal = Id64String;
-    /** Enum type (enumerated list of values) */
-    type Enum = number | string;
-    /** Numeric type (can be float or int) */
-    type Numeric = Float | Int;
-    /** Point2d type (contains an x and a y coordinate) */
-    type Point2d = string[] | number[] | {
-        x: number;
-        y: number;
-    };
-    /** Point3d type (contains x,y,and z coordinates) */
-    type Point3d = string[] | number[] | {
-        x: number;
-        y: number;
-        z: number;
-    };
-    /** Point type (can be a 2d or 3d point) */
-    type Point = Point2d | Point3d;
-    /** CompositePart (ties a raw value of a specific type to a display string) */
-    interface CompositePart {
-        displayValue: string;
-        rawValue: Value;
-        typeName: string;
-    }
-    /** Composite type (built of one or more CompositePart items) */
-    interface Composite {
-        separator: string;
-        parts: CompositePart[];
-    }
-    /** Instance key type. */
-    interface InstanceKey {
-        className: string;
-        id: Id64String;
-    }
-    /** Raw value */
-    type Value = Text | String | ShortDate | Boolean | Numeric | Enum | Point | Composite | InstanceKey;
-}
+/** @packageDocumentation
+ * @module Properties
+ */
+import { Id64String } from "@itwin/core-bentley";
+/** Primitive Property Value Types.
+ * @public
+ */
+export declare namespace Primitives {
+    /** Text type */
+    type Text = string;
+    /** String type */
+    type String = string;
+    /** DateTime will be formatted as date and time */
+    type DateTime = string | Date;
+    /** ShortDate will be formatted as date only and will not include time */
+    type ShortDate = string | Date;
+    /** Boolean type */
+    type Boolean = boolean | string | {} | [];
+    /** Float type */
+    type Float = number | string;
+    /** Int type */
+    type Int = number | string;
+    /** Hexadecimal type (number expressed in hex string) */
+    type Hexadecimal = Id64String;
+    /** Enum type (enumerated list of values) */
+    type Enum = number | string;
+    /** Numeric type (can be float or int) */
+    type Numeric = Float | Int;
+    /** Point2d type (contains an x and a y coordinate) */
+    type Point2d = string[] | number[] | {
+        x: number;
+        y: number;
+    };
+    /** Point3d type (contains x,y,and z coordinates) */
+    type Point3d = string[] | number[] | {
+        x: number;
+        y: number;
+        z: number;
+    };
+    /** Point type (can be a 2d or 3d point) */
+    type Point = Point2d | Point3d;
+    /** CompositePart (ties a raw value of a specific type to a display string) */
+    interface CompositePart {
+        displayValue: string;
+        rawValue: Value;
+        typeName: string;
+    }
+    /** Composite type (built of one or more CompositePart items) */
+    interface Composite {
+        separator: string;
+        parts: CompositePart[];
+    }
+    /** Instance key type. */
+    interface InstanceKey {
+        className: string;
+        id: Id64String;
+    }
+    /** Raw value */
+    type Value = Text | String | ShortDate | Boolean | Numeric | Enum | Point | Composite | InstanceKey;
+}
 //# sourceMappingURL=PrimitiveTypes.d.ts.map

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

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

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

@@ -1 +1 @@
-{"version":3,"file":"PrimitiveTypes.js","sourceRoot":"","sources":["../../../../src/appui-abstract/properties/PrimitiveTypes.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG","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 { Id64String } from \"@itwin/core-bentley\";\n\n/** Primitive Property Value Types.\n * @public\n */\nexport namespace Primitives {\n  /** Text type */\n  export type Text = string;\n  /** String type */\n  export type String = string;\n  /** DateTime will be formatted as date and time */\n  export type DateTime = string | Date;\n  /** ShortDate will be formatted as date only and will not include time */\n  export type ShortDate = string | Date;\n  /** Boolean type */\n  export type Boolean = boolean | string | {} | [];\n  /** Float type */\n  export type Float = number | string;\n  /** Int type */\n  export type Int = number | string;\n  /** Hexadecimal type (number expressed in hex string) */\n  export type Hexadecimal = Id64String;\n  /** Enum type (enumerated list of values) */\n  export type Enum = number | string;\n  /** Numeric type (can be float or int) */\n  export type Numeric = Float | Int;\n\n  /** Point2d type (contains an x and a y coordinate) */\n  export type Point2d = string[] | number[] | { x: number, y: number };\n  /** Point3d type (contains x,y,and z coordinates) */\n  export type Point3d = string[] | number[] | { x: number, y: number, z: number };\n\n  /** Point type (can be a 2d or 3d point) */\n  export type Point = Point2d | Point3d;\n\n  /** CompositePart (ties a raw value of a specific type to a display string) */\n  export interface CompositePart {\n    displayValue: string;\n    rawValue: Value;\n    typeName: string;\n  }\n  /** Composite type (built of one or more CompositePart items) */\n  export interface Composite {\n    separator: string;\n    parts: CompositePart[];\n  }\n\n  /** Instance key type. */\n  export interface InstanceKey {\n    className: string;\n    id: Id64String;\n  }\n\n  /** Raw value */\n  export type Value = Text | String | ShortDate | Boolean | Numeric | Enum | Point | Composite | InstanceKey;\n}\n"]}
+{"version":3,"file":"PrimitiveTypes.js","sourceRoot":"","sources":["../../../../src/appui-abstract/properties/PrimitiveTypes.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 Properties\r\n */\r\n\r\nimport { Id64String } from \"@itwin/core-bentley\";\r\n\r\n/** Primitive Property Value Types.\r\n * @public\r\n */\r\nexport namespace Primitives {\r\n  /** Text type */\r\n  export type Text = string;\r\n  /** String type */\r\n  export type String = string;\r\n  /** DateTime will be formatted as date and time */\r\n  export type DateTime = string | Date;\r\n  /** ShortDate will be formatted as date only and will not include time */\r\n  export type ShortDate = string | Date;\r\n  /** Boolean type */\r\n  export type Boolean = boolean | string | {} | [];\r\n  /** Float type */\r\n  export type Float = number | string;\r\n  /** Int type */\r\n  export type Int = number | string;\r\n  /** Hexadecimal type (number expressed in hex string) */\r\n  export type Hexadecimal = Id64String;\r\n  /** Enum type (enumerated list of values) */\r\n  export type Enum = number | string;\r\n  /** Numeric type (can be float or int) */\r\n  export type Numeric = Float | Int;\r\n\r\n  /** Point2d type (contains an x and a y coordinate) */\r\n  export type Point2d = string[] | number[] | { x: number, y: number };\r\n  /** Point3d type (contains x,y,and z coordinates) */\r\n  export type Point3d = string[] | number[] | { x: number, y: number, z: number };\r\n\r\n  /** Point type (can be a 2d or 3d point) */\r\n  export type Point = Point2d | Point3d;\r\n\r\n  /** CompositePart (ties a raw value of a specific type to a display string) */\r\n  export interface CompositePart {\r\n    displayValue: string;\r\n    rawValue: Value;\r\n    typeName: string;\r\n  }\r\n  /** Composite type (built of one or more CompositePart items) */\r\n  export interface Composite {\r\n    separator: string;\r\n    parts: CompositePart[];\r\n  }\r\n\r\n  /** Instance key type. */\r\n  export interface InstanceKey {\r\n    className: string;\r\n    id: Id64String;\r\n  }\r\n\r\n  /** Raw value */\r\n  export type Value = Text | String | ShortDate | Boolean | Numeric | Enum | Point | Composite | InstanceKey;\r\n}\r\n"]}

package/lib/esm/appui-abstract/properties/Record.d.ts

@@ -1,58 +1,58 @@
-/** @packageDocumentation
- * @module Properties
- */
-import { PropertyDescription } from "./Description";
-import { PropertyValue } from "./Value";
-/** Properties for the [[PropertyRecord]] with link info supplied
- * @public
- */
-export interface LinkElementsInfo {
-    /** Callback to link click event */
-    onClick: (text: string) => void;
-    /**
-     * Function that specifies which parts of display value need to be clickable.
-     *
-     * Letters will be picked from __start__ index to __end__ index. __end__ index is not included.
-     * For a string _"example"_ and a match ```{ start: 1, end: 3 }```, _"xa"_ will be clickable.
-     */
-    matcher?: (displayValue: string) => Array<{
-        start: number;
-        end: number;
-    }>;
-}
-/**
- * PropertyRecord contains instance information about a Property, including a
- * value that can be edited using a PropertyEditor and converted using a TypeConverter.
- * @public
- */
-export declare class PropertyRecord {
-    /** Value for the property */
-    readonly value: PropertyValue;
-    /** The property description containing metadata for the property */
-    readonly property: PropertyDescription;
-    /** Description for the property */
-    description?: string;
-    /** Indicates if the property is read-only */
-    isReadonly?: boolean;
-    /** Indicates if the property is disabled */
-    isDisabled?: boolean;
-    /** Indicates if the property record represents merged properties */
-    isMerged?: boolean;
-    /** Indicates if the property should be automatically expanded */
-    autoExpand?: boolean;
-    /** Map containing any additional data */
-    extendedData?: {
-        [key: string]: any;
-    };
-    /** Properties for link logic */
-    links?: LinkElementsInfo;
-    /** Constructs a PropertyRecord instance */
-    constructor(value: PropertyValue, property: PropertyDescription);
-    /** Creates a copy of this PropertyRecord with a new value and optionally a new PropertyDescription */
-    copyWithNewValue(newValue: PropertyValue, newDescription?: PropertyDescription): PropertyRecord;
-    /** Gets this property record value children records */
-    getChildrenRecords(): PropertyRecord[];
-    /** Creates a PropertyRecord based on a value string and an optional property description or name */
-    static fromString(value: string, descriptionOrName?: PropertyDescription | string): PropertyRecord;
-}
+/** @packageDocumentation
+ * @module Properties
+ */
+import { PropertyDescription } from "./Description";
+import { PropertyValue } from "./Value";
+/** Properties for the [[PropertyRecord]] with link info supplied
+ * @public
+ */
+export interface LinkElementsInfo {
+    /** Callback to link click event */
+    onClick: (text: string) => void;
+    /**
+     * Function that specifies which parts of display value need to be clickable.
+     *
+     * Letters will be picked from __start__ index to __end__ index. __end__ index is not included.
+     * For a string _"example"_ and a match ```{ start: 1, end: 3 }```, _"xa"_ will be clickable.
+     */
+    matcher?: (displayValue: string) => Array<{
+        start: number;
+        end: number;
+    }>;
+}
+/**
+ * PropertyRecord contains instance information about a Property, including a
+ * value that can be edited using a PropertyEditor and converted using a TypeConverter.
+ * @public
+ */
+export declare class PropertyRecord {
+    /** Value for the property */
+    readonly value: PropertyValue;
+    /** The property description containing metadata for the property */
+    readonly property: PropertyDescription;
+    /** Description for the property */
+    description?: string;
+    /** Indicates if the property is read-only */
+    isReadonly?: boolean;
+    /** Indicates if the property is disabled */
+    isDisabled?: boolean;
+    /** Indicates if the property record represents merged properties */
+    isMerged?: boolean;
+    /** Indicates if the property should be automatically expanded */
+    autoExpand?: boolean;
+    /** Map containing any additional data */
+    extendedData?: {
+        [key: string]: any;
+    };
+    /** Properties for link logic */
+    links?: LinkElementsInfo;
+    /** Constructs a PropertyRecord instance */
+    constructor(value: PropertyValue, property: PropertyDescription);
+    /** Creates a copy of this PropertyRecord with a new value and optionally a new PropertyDescription */
+    copyWithNewValue(newValue: PropertyValue, newDescription?: PropertyDescription): PropertyRecord;
+    /** Gets this property record value children records */
+    getChildrenRecords(): PropertyRecord[];
+    /** Creates a PropertyRecord based on a value string and an optional property description or name */
+    static fromString(value: string, descriptionOrName?: PropertyDescription | string): PropertyRecord;
+}
 //# sourceMappingURL=Record.d.ts.map