@itwin/appui-abstract 4.0.0-dev.52 → 4.0.0-dev.55
Sign up to get free protection for your applications and to get access to all the features.
- package/lib/cjs/appui-abstract/BaseUiItemsProvider.d.ts +30 -30
- package/lib/cjs/appui-abstract/BaseUiItemsProvider.d.ts.map +1 -1
- package/lib/cjs/appui-abstract/BaseUiItemsProvider.js +79 -79
- package/lib/cjs/appui-abstract/UiAdmin.d.ts +221 -221
- package/lib/cjs/appui-abstract/UiAdmin.js +224 -224
- package/lib/cjs/appui-abstract/UiAdmin.js.map +1 -1
- package/lib/cjs/appui-abstract/UiItemsManager.d.ts +113 -113
- package/lib/cjs/appui-abstract/UiItemsManager.d.ts.map +1 -1
- package/lib/cjs/appui-abstract/UiItemsManager.js +193 -193
- package/lib/cjs/appui-abstract/UiItemsManager.js.map +1 -1
- package/lib/cjs/appui-abstract/UiItemsProvider.d.ts +29 -29
- package/lib/cjs/appui-abstract/UiItemsProvider.js +9 -9
- package/lib/cjs/appui-abstract/backstage/BackstageItem.d.ts +91 -91
- package/lib/cjs/appui-abstract/backstage/BackstageItem.d.ts.map +1 -1
- package/lib/cjs/appui-abstract/backstage/BackstageItem.js +70 -70
- package/lib/cjs/appui-abstract/backstage/BackstageItem.js.map +1 -1
- package/lib/cjs/appui-abstract/backstage/BackstageItemsManager.d.ts +38 -38
- package/lib/cjs/appui-abstract/backstage/BackstageItemsManager.js +133 -133
- package/lib/cjs/appui-abstract/backstage/BackstageItemsManager.js.map +1 -1
- package/lib/cjs/appui-abstract/common/KeyboardKey.d.ts +51 -51
- package/lib/cjs/appui-abstract/common/KeyboardKey.js +63 -63
- package/lib/cjs/appui-abstract/content/ContentLayoutProps.d.ts +62 -62
- package/lib/cjs/appui-abstract/content/ContentLayoutProps.js +9 -9
- package/lib/cjs/appui-abstract/content/StandardContentLayouts.d.ts +19 -19
- package/lib/cjs/appui-abstract/content/StandardContentLayouts.js +108 -108
- package/lib/cjs/appui-abstract/content/StandardContentLayouts.js.map +1 -1
- package/lib/cjs/appui-abstract/dialogs/DialogItem.d.ts +76 -76
- package/lib/cjs/appui-abstract/dialogs/DialogItem.js +67 -67
- package/lib/cjs/appui-abstract/dialogs/UiDataProvider.d.ts +55 -55
- package/lib/cjs/appui-abstract/dialogs/UiDataProvider.js +66 -66
- package/lib/cjs/appui-abstract/dialogs/UiLayoutDataProvider.d.ts +97 -97
- package/lib/cjs/appui-abstract/dialogs/UiLayoutDataProvider.js +175 -175
- package/lib/cjs/appui-abstract/dialogs/UiLayoutDataProvider.js.map +1 -1
- package/lib/cjs/appui-abstract/items/AbstractItemProps.d.ts +53 -53
- package/lib/cjs/appui-abstract/items/AbstractItemProps.d.ts.map +1 -1
- package/lib/cjs/appui-abstract/items/AbstractItemProps.js +9 -9
- package/lib/cjs/appui-abstract/items/AbstractMenuItemProps.d.ts +20 -20
- package/lib/cjs/appui-abstract/items/AbstractMenuItemProps.js +9 -9
- package/lib/cjs/appui-abstract/items/AbstractToolbarProps.d.ts +13 -13
- package/lib/cjs/appui-abstract/items/AbstractToolbarProps.js +9 -9
- package/lib/cjs/appui-abstract/items/BadgeType.d.ts +14 -14
- package/lib/cjs/appui-abstract/items/BadgeType.js +22 -22
- package/lib/cjs/appui-abstract/items/ConditionalBooleanValue.d.ts +27 -27
- package/lib/cjs/appui-abstract/items/ConditionalBooleanValue.js +60 -60
- package/lib/cjs/appui-abstract/items/ConditionalStringValue.d.ts +29 -29
- package/lib/cjs/appui-abstract/items/ConditionalStringValue.js +62 -62
- package/lib/cjs/appui-abstract/items/ProvidedItem.d.ts +11 -11
- package/lib/cjs/appui-abstract/items/ProvidedItem.js +9 -9
- package/lib/cjs/appui-abstract/items/RelativePosition.d.ts +18 -18
- package/lib/cjs/appui-abstract/items/RelativePosition.js +26 -26
- package/lib/cjs/appui-abstract/items/StageUsage.d.ts +16 -16
- package/lib/cjs/appui-abstract/items/StageUsage.js +24 -24
- package/lib/cjs/appui-abstract/notification/MessagePresenter.d.ts +42 -42
- package/lib/cjs/appui-abstract/notification/MessagePresenter.js +24 -24
- package/lib/cjs/appui-abstract/notification/MessageSeverity.d.ts +15 -15
- package/lib/cjs/appui-abstract/notification/MessageSeverity.js +23 -23
- package/lib/cjs/appui-abstract/properties/Description.d.ts +127 -127
- package/lib/cjs/appui-abstract/properties/Description.js +196 -196
- package/lib/cjs/appui-abstract/properties/EditorParams.d.ts +260 -260
- package/lib/cjs/appui-abstract/properties/EditorParams.d.ts.map +1 -1
- package/lib/cjs/appui-abstract/properties/EditorParams.js +106 -106
- package/lib/cjs/appui-abstract/properties/PrimitiveTypes.d.ts +60 -60
- package/lib/cjs/appui-abstract/properties/PrimitiveTypes.js +9 -9
- package/lib/cjs/appui-abstract/properties/Record.d.ts +57 -57
- package/lib/cjs/appui-abstract/properties/Record.js +78 -78
- package/lib/cjs/appui-abstract/properties/StandardEditorNames.d.ts +22 -22
- package/lib/cjs/appui-abstract/properties/StandardEditorNames.js +30 -30
- package/lib/cjs/appui-abstract/properties/StandardTypeNames.d.ts +30 -30
- package/lib/cjs/appui-abstract/properties/StandardTypeNames.js +39 -39
- package/lib/cjs/appui-abstract/properties/Value.d.ts +49 -49
- package/lib/cjs/appui-abstract/properties/Value.d.ts.map +1 -1
- package/lib/cjs/appui-abstract/properties/Value.js +20 -20
- package/lib/cjs/appui-abstract/quantity/BaseQuantityDescription.d.ts +22 -22
- package/lib/cjs/appui-abstract/quantity/BaseQuantityDescription.js +48 -48
- package/lib/cjs/appui-abstract/statusbar/StatusBarItem.d.ts +128 -128
- package/lib/cjs/appui-abstract/statusbar/StatusBarItem.d.ts.map +1 -1
- package/lib/cjs/appui-abstract/statusbar/StatusBarItem.js +87 -87
- package/lib/cjs/appui-abstract/statusbar/StatusBarItem.js.map +1 -1
- package/lib/cjs/appui-abstract/statusbar/StatusBarItemsManager.d.ts +39 -39
- package/lib/cjs/appui-abstract/statusbar/StatusBarItemsManager.js +135 -135
- package/lib/cjs/appui-abstract/statusbar/StatusBarItemsManager.js.map +1 -1
- package/lib/cjs/appui-abstract/toolbars/ToolbarItem.d.ts +121 -121
- package/lib/cjs/appui-abstract/toolbars/ToolbarItem.d.ts.map +1 -1
- package/lib/cjs/appui-abstract/toolbars/ToolbarItem.js +64 -64
- package/lib/cjs/appui-abstract/toolbars/ToolbarItem.js.map +1 -1
- package/lib/cjs/appui-abstract/toolbars/ToolbarItemsManager.d.ts +45 -45
- package/lib/cjs/appui-abstract/toolbars/ToolbarItemsManager.js +235 -235
- package/lib/cjs/appui-abstract/toolbars/ToolbarItemsManager.js.map +1 -1
- package/lib/cjs/appui-abstract/utils/IconSpecUtilities.d.ts +29 -29
- package/lib/cjs/appui-abstract/utils/IconSpecUtilities.js +51 -51
- package/lib/cjs/appui-abstract/utils/IconSpecUtilities.js.map +1 -1
- package/lib/cjs/appui-abstract/utils/PointProps.d.ts +10 -10
- package/lib/cjs/appui-abstract/utils/PointProps.js +9 -9
- package/lib/cjs/appui-abstract/utils/UiError.d.ts +12 -12
- package/lib/cjs/appui-abstract/utils/UiError.js +22 -22
- package/lib/cjs/appui-abstract/utils/UiEvent.d.ts +9 -9
- package/lib/cjs/appui-abstract/utils/UiEvent.js +17 -17
- package/lib/cjs/appui-abstract/utils/UiEventDispatcher.d.ts +46 -46
- package/lib/cjs/appui-abstract/utils/UiEventDispatcher.js +131 -131
- package/lib/cjs/appui-abstract/utils/callbacks.d.ts +20 -20
- package/lib/cjs/appui-abstract/utils/callbacks.d.ts.map +1 -1
- package/lib/cjs/appui-abstract/utils/callbacks.js +9 -9
- package/lib/cjs/appui-abstract/utils/filter/charCode.d.ts +416 -416
- package/lib/cjs/appui-abstract/utils/filter/charCode.js +6 -6
- package/lib/cjs/appui-abstract/utils/filter/filters.d.ts +98 -98
- package/lib/cjs/appui-abstract/utils/filter/filters.d.ts.map +1 -1
- package/lib/cjs/appui-abstract/utils/filter/filters.js +709 -709
- package/lib/cjs/appui-abstract/utils/filter/filters.js.map +1 -1
- package/lib/cjs/appui-abstract/utils/filter/map.d.ts +59 -59
- package/lib/cjs/appui-abstract/utils/filter/map.js +402 -402
- package/lib/cjs/appui-abstract/utils/filter/map.js.map +1 -1
- package/lib/cjs/appui-abstract/utils/filter/strings.d.ts +20 -20
- package/lib/cjs/appui-abstract/utils/filter/strings.js +78 -78
- package/lib/cjs/appui-abstract/utils/filter/strings.js.map +1 -1
- package/lib/cjs/appui-abstract/utils/isLetter.d.ts +9 -9
- package/lib/cjs/appui-abstract/utils/isLetter.js +19 -19
- package/lib/cjs/appui-abstract/utils/misc.d.ts +11 -11
- package/lib/cjs/appui-abstract/utils/misc.js +36 -36
- package/lib/cjs/appui-abstract/widget/AbstractWidgetProps.d.ts +86 -86
- package/lib/cjs/appui-abstract/widget/AbstractWidgetProps.js +9 -9
- package/lib/cjs/appui-abstract/widget/StagePanel.d.ts +36 -36
- package/lib/cjs/appui-abstract/widget/StagePanel.js +46 -46
- package/lib/cjs/appui-abstract/widget/WidgetState.d.ts +19 -19
- package/lib/cjs/appui-abstract/widget/WidgetState.js +27 -27
- package/lib/cjs/appui-abstract.d.ts +103 -103
- package/lib/cjs/appui-abstract.js +123 -119
- package/lib/cjs/appui-abstract.js.map +1 -1
- package/lib/esm/appui-abstract/BaseUiItemsProvider.d.ts +30 -30
- package/lib/esm/appui-abstract/BaseUiItemsProvider.d.ts.map +1 -1
- package/lib/esm/appui-abstract/BaseUiItemsProvider.js +75 -75
- package/lib/esm/appui-abstract/UiAdmin.d.ts +221 -221
- package/lib/esm/appui-abstract/UiAdmin.js +220 -219
- package/lib/esm/appui-abstract/UiAdmin.js.map +1 -1
- package/lib/esm/appui-abstract/UiItemsManager.d.ts +113 -113
- package/lib/esm/appui-abstract/UiItemsManager.d.ts.map +1 -1
- package/lib/esm/appui-abstract/UiItemsManager.js +190 -189
- package/lib/esm/appui-abstract/UiItemsManager.js.map +1 -1
- package/lib/esm/appui-abstract/UiItemsProvider.d.ts +29 -29
- package/lib/esm/appui-abstract/UiItemsProvider.js +8 -8
- package/lib/esm/appui-abstract/backstage/BackstageItem.d.ts +91 -91
- package/lib/esm/appui-abstract/backstage/BackstageItem.d.ts.map +1 -1
- package/lib/esm/appui-abstract/backstage/BackstageItem.js +65 -64
- package/lib/esm/appui-abstract/backstage/BackstageItem.js.map +1 -1
- package/lib/esm/appui-abstract/backstage/BackstageItemsManager.d.ts +38 -38
- package/lib/esm/appui-abstract/backstage/BackstageItemsManager.js +129 -129
- package/lib/esm/appui-abstract/backstage/BackstageItemsManager.js.map +1 -1
- package/lib/esm/appui-abstract/common/KeyboardKey.d.ts +51 -51
- package/lib/esm/appui-abstract/common/KeyboardKey.js +59 -59
- package/lib/esm/appui-abstract/content/ContentLayoutProps.d.ts +62 -62
- package/lib/esm/appui-abstract/content/ContentLayoutProps.js +8 -8
- package/lib/esm/appui-abstract/content/StandardContentLayouts.d.ts +19 -19
- package/lib/esm/appui-abstract/content/StandardContentLayouts.js +105 -104
- package/lib/esm/appui-abstract/content/StandardContentLayouts.js.map +1 -1
- package/lib/esm/appui-abstract/dialogs/DialogItem.d.ts +76 -76
- package/lib/esm/appui-abstract/dialogs/DialogItem.js +63 -63
- package/lib/esm/appui-abstract/dialogs/UiDataProvider.d.ts +55 -55
- package/lib/esm/appui-abstract/dialogs/UiDataProvider.js +61 -61
- package/lib/esm/appui-abstract/dialogs/UiLayoutDataProvider.d.ts +97 -97
- package/lib/esm/appui-abstract/dialogs/UiLayoutDataProvider.js +171 -170
- package/lib/esm/appui-abstract/dialogs/UiLayoutDataProvider.js.map +1 -1
- package/lib/esm/appui-abstract/items/AbstractItemProps.d.ts +53 -53
- package/lib/esm/appui-abstract/items/AbstractItemProps.d.ts.map +1 -1
- package/lib/esm/appui-abstract/items/AbstractItemProps.js +8 -8
- package/lib/esm/appui-abstract/items/AbstractMenuItemProps.d.ts +20 -20
- package/lib/esm/appui-abstract/items/AbstractMenuItemProps.js +8 -8
- package/lib/esm/appui-abstract/items/AbstractToolbarProps.d.ts +13 -13
- package/lib/esm/appui-abstract/items/AbstractToolbarProps.js +8 -8
- package/lib/esm/appui-abstract/items/BadgeType.d.ts +14 -14
- package/lib/esm/appui-abstract/items/BadgeType.js +19 -19
- package/lib/esm/appui-abstract/items/ConditionalBooleanValue.d.ts +27 -27
- package/lib/esm/appui-abstract/items/ConditionalBooleanValue.js +56 -56
- package/lib/esm/appui-abstract/items/ConditionalStringValue.d.ts +29 -29
- package/lib/esm/appui-abstract/items/ConditionalStringValue.js +58 -58
- package/lib/esm/appui-abstract/items/ProvidedItem.d.ts +11 -11
- package/lib/esm/appui-abstract/items/ProvidedItem.js +8 -8
- package/lib/esm/appui-abstract/items/RelativePosition.d.ts +18 -18
- package/lib/esm/appui-abstract/items/RelativePosition.js +23 -23
- package/lib/esm/appui-abstract/items/StageUsage.d.ts +16 -16
- package/lib/esm/appui-abstract/items/StageUsage.js +21 -21
- package/lib/esm/appui-abstract/notification/MessagePresenter.d.ts +42 -42
- package/lib/esm/appui-abstract/notification/MessagePresenter.js +21 -21
- package/lib/esm/appui-abstract/notification/MessageSeverity.d.ts +15 -15
- package/lib/esm/appui-abstract/notification/MessageSeverity.js +20 -20
- package/lib/esm/appui-abstract/properties/Description.d.ts +127 -127
- package/lib/esm/appui-abstract/properties/Description.js +192 -192
- package/lib/esm/appui-abstract/properties/EditorParams.d.ts +260 -260
- package/lib/esm/appui-abstract/properties/EditorParams.d.ts.map +1 -1
- package/lib/esm/appui-abstract/properties/EditorParams.js +97 -97
- package/lib/esm/appui-abstract/properties/PrimitiveTypes.d.ts +60 -60
- package/lib/esm/appui-abstract/properties/PrimitiveTypes.js +8 -8
- package/lib/esm/appui-abstract/properties/Record.d.ts +57 -57
- package/lib/esm/appui-abstract/properties/Record.js +74 -74
- package/lib/esm/appui-abstract/properties/StandardEditorNames.d.ts +22 -22
- package/lib/esm/appui-abstract/properties/StandardEditorNames.js +27 -27
- package/lib/esm/appui-abstract/properties/StandardTypeNames.d.ts +30 -30
- package/lib/esm/appui-abstract/properties/StandardTypeNames.js +36 -36
- package/lib/esm/appui-abstract/properties/Value.d.ts +49 -49
- package/lib/esm/appui-abstract/properties/Value.d.ts.map +1 -1
- package/lib/esm/appui-abstract/properties/Value.js +17 -17
- package/lib/esm/appui-abstract/quantity/BaseQuantityDescription.d.ts +22 -22
- package/lib/esm/appui-abstract/quantity/BaseQuantityDescription.js +44 -44
- package/lib/esm/appui-abstract/statusbar/StatusBarItem.d.ts +128 -128
- package/lib/esm/appui-abstract/statusbar/StatusBarItem.d.ts.map +1 -1
- package/lib/esm/appui-abstract/statusbar/StatusBarItem.js +81 -80
- package/lib/esm/appui-abstract/statusbar/StatusBarItem.js.map +1 -1
- package/lib/esm/appui-abstract/statusbar/StatusBarItemsManager.d.ts +39 -39
- package/lib/esm/appui-abstract/statusbar/StatusBarItemsManager.js +131 -131
- package/lib/esm/appui-abstract/statusbar/StatusBarItemsManager.js.map +1 -1
- package/lib/esm/appui-abstract/toolbars/ToolbarItem.d.ts +121 -121
- package/lib/esm/appui-abstract/toolbars/ToolbarItem.d.ts.map +1 -1
- package/lib/esm/appui-abstract/toolbars/ToolbarItem.js +61 -60
- package/lib/esm/appui-abstract/toolbars/ToolbarItem.js.map +1 -1
- package/lib/esm/appui-abstract/toolbars/ToolbarItemsManager.d.ts +45 -45
- package/lib/esm/appui-abstract/toolbars/ToolbarItemsManager.js +231 -231
- package/lib/esm/appui-abstract/toolbars/ToolbarItemsManager.js.map +1 -1
- package/lib/esm/appui-abstract/utils/IconSpecUtilities.d.ts +29 -29
- package/lib/esm/appui-abstract/utils/IconSpecUtilities.js +48 -47
- package/lib/esm/appui-abstract/utils/IconSpecUtilities.js.map +1 -1
- package/lib/esm/appui-abstract/utils/PointProps.d.ts +10 -10
- package/lib/esm/appui-abstract/utils/PointProps.js +8 -8
- package/lib/esm/appui-abstract/utils/UiError.d.ts +12 -12
- package/lib/esm/appui-abstract/utils/UiError.js +18 -18
- package/lib/esm/appui-abstract/utils/UiEvent.d.ts +9 -9
- package/lib/esm/appui-abstract/utils/UiEvent.js +13 -13
- package/lib/esm/appui-abstract/utils/UiEventDispatcher.d.ts +46 -46
- package/lib/esm/appui-abstract/utils/UiEventDispatcher.js +126 -126
- package/lib/esm/appui-abstract/utils/callbacks.d.ts +20 -20
- package/lib/esm/appui-abstract/utils/callbacks.d.ts.map +1 -1
- package/lib/esm/appui-abstract/utils/callbacks.js +8 -8
- package/lib/esm/appui-abstract/utils/filter/charCode.d.ts +416 -416
- package/lib/esm/appui-abstract/utils/filter/charCode.js +5 -5
- package/lib/esm/appui-abstract/utils/filter/filters.d.ts +98 -98
- package/lib/esm/appui-abstract/utils/filter/filters.d.ts.map +1 -1
- package/lib/esm/appui-abstract/utils/filter/filters.js +694 -694
- package/lib/esm/appui-abstract/utils/filter/filters.js.map +1 -1
- package/lib/esm/appui-abstract/utils/filter/map.d.ts +59 -59
- package/lib/esm/appui-abstract/utils/filter/map.js +397 -397
- package/lib/esm/appui-abstract/utils/filter/map.js.map +1 -1
- package/lib/esm/appui-abstract/utils/filter/strings.d.ts +20 -20
- package/lib/esm/appui-abstract/utils/filter/strings.js +70 -70
- package/lib/esm/appui-abstract/utils/filter/strings.js.map +1 -1
- package/lib/esm/appui-abstract/utils/isLetter.d.ts +9 -9
- package/lib/esm/appui-abstract/utils/isLetter.js +15 -15
- package/lib/esm/appui-abstract/utils/misc.d.ts +11 -11
- package/lib/esm/appui-abstract/utils/misc.js +31 -31
- package/lib/esm/appui-abstract/widget/AbstractWidgetProps.d.ts +86 -86
- package/lib/esm/appui-abstract/widget/AbstractWidgetProps.js +8 -8
- package/lib/esm/appui-abstract/widget/StagePanel.d.ts +36 -36
- package/lib/esm/appui-abstract/widget/StagePanel.js +43 -43
- package/lib/esm/appui-abstract/widget/WidgetState.d.ts +19 -19
- package/lib/esm/appui-abstract/widget/WidgetState.js +24 -24
- package/lib/esm/appui-abstract.d.ts +103 -103
- package/lib/esm/appui-abstract.js +107 -107
- package/package.json +6 -6
@@ -1,193 +1,193 @@
|
|
1
|
-
/*---------------------------------------------------------------------------------------------
|
2
|
-
* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
|
3
|
-
* See LICENSE.md in the project root for license terms and full copyright notice.
|
4
|
-
*--------------------------------------------------------------------------------------------*/
|
5
|
-
/** @packageDocumentation
|
6
|
-
* @module Properties
|
7
|
-
*/
|
8
|
-
import { PropertyEditorParamTypes, } from "./EditorParams";
|
9
|
-
import { StandardEditorNames } from "./StandardEditorNames";
|
10
|
-
import { StandardTypeNames } from "./StandardTypeNames";
|
11
|
-
/** Helper class that builds property descriptions for specific PropertyEditors and processes descriptions.
|
12
|
-
* @public
|
13
|
-
*/
|
14
|
-
export class PropertyDescriptionHelper {
|
15
|
-
/** Builds a number description with a "weight-picker" editor name
|
16
|
-
* @public
|
17
|
-
*/
|
18
|
-
static buildWeightPickerDescription(name, label, additionalParams = []) {
|
19
|
-
return {
|
20
|
-
name,
|
21
|
-
displayLabel: label,
|
22
|
-
typename: StandardTypeNames.Number,
|
23
|
-
editor: {
|
24
|
-
name: StandardEditorNames.WeightPicker,
|
25
|
-
params: additionalParams,
|
26
|
-
},
|
27
|
-
};
|
28
|
-
}
|
29
|
-
/** Builds an editor that uses [NumberInput]($core-react) control
|
30
|
-
* @public
|
31
|
-
*/
|
32
|
-
static buildNumberEditorDescription(name, label, overrideParams, additionalParams = []) {
|
33
|
-
const editorParams = [{
|
34
|
-
type: PropertyEditorParamTypes.Range,
|
35
|
-
step: 1,
|
36
|
-
precision: 0,
|
37
|
-
...overrideParams,
|
38
|
-
}, ...additionalParams];
|
39
|
-
const editor = {
|
40
|
-
name: StandardEditorNames.NumericInput,
|
41
|
-
params: editorParams,
|
42
|
-
};
|
43
|
-
return {
|
44
|
-
name,
|
45
|
-
displayLabel: label,
|
46
|
-
typename: StandardTypeNames.Number,
|
47
|
-
editor,
|
48
|
-
};
|
49
|
-
}
|
50
|
-
/** Builds a string description
|
51
|
-
* @public
|
52
|
-
*/
|
53
|
-
static buildTextEditorDescription(name, label, additionalParams = []) {
|
54
|
-
const editor = {
|
55
|
-
params: additionalParams,
|
56
|
-
};
|
57
|
-
return {
|
58
|
-
name,
|
59
|
-
displayLabel: label,
|
60
|
-
typename: StandardTypeNames.String,
|
61
|
-
editor,
|
62
|
-
};
|
63
|
-
}
|
64
|
-
/** Builds an enum description
|
65
|
-
* @public
|
66
|
-
*/
|
67
|
-
static buildEnumPicklistEditorDescription(name, label, choices, additionalParams = []) {
|
68
|
-
const editor = additionalParams.length ? {
|
69
|
-
params: additionalParams,
|
70
|
-
} : undefined;
|
71
|
-
return {
|
72
|
-
name,
|
73
|
-
displayLabel: label,
|
74
|
-
typename: StandardTypeNames.Enum,
|
75
|
-
editor,
|
76
|
-
enum: {
|
77
|
-
choices,
|
78
|
-
},
|
79
|
-
};
|
80
|
-
}
|
81
|
-
/** Builds a number description for a tool settings or dialog property that will display a "color-picker" control.
|
82
|
-
* @public
|
83
|
-
*/
|
84
|
-
static buildColorPickerDescription(name, label, colorValues, numColumns, additionalParams = []) {
|
85
|
-
const editorParams = [
|
86
|
-
{
|
87
|
-
type: PropertyEditorParamTypes.ColorData,
|
88
|
-
colorValues,
|
89
|
-
numColumns,
|
90
|
-
},
|
91
|
-
...additionalParams,
|
92
|
-
];
|
93
|
-
return {
|
94
|
-
name,
|
95
|
-
displayLabel: label,
|
96
|
-
typename: StandardTypeNames.Number,
|
97
|
-
editor: {
|
98
|
-
name: StandardEditorNames.ColorPicker,
|
99
|
-
params: editorParams,
|
100
|
-
},
|
101
|
-
};
|
102
|
-
}
|
103
|
-
/** Builds a boolean description for a tool settings or dialog property that will display a "toggle" control.
|
104
|
-
* @public
|
105
|
-
*/
|
106
|
-
static buildToggleDescription(name, label, additionalParams = []) {
|
107
|
-
return {
|
108
|
-
name,
|
109
|
-
displayLabel: label,
|
110
|
-
typename: StandardTypeNames.Boolean,
|
111
|
-
editor: {
|
112
|
-
name: StandardEditorNames.Toggle,
|
113
|
-
params: additionalParams,
|
114
|
-
},
|
115
|
-
};
|
116
|
-
}
|
117
|
-
/** Builds a boolean description for a tool settings or dialog property that will display a "image-check-box" control.
|
118
|
-
* @public
|
119
|
-
*/
|
120
|
-
static buildImageCheckBoxDescription(name, label, imageOff, imageOn, additionalParams = []) {
|
121
|
-
const editorParams = [{
|
122
|
-
type: PropertyEditorParamTypes.CheckBoxImages,
|
123
|
-
imageOff,
|
124
|
-
imageOn,
|
125
|
-
}, ...additionalParams];
|
126
|
-
return {
|
127
|
-
name,
|
128
|
-
displayLabel: label,
|
129
|
-
typename: StandardTypeNames.Boolean,
|
130
|
-
editor: {
|
131
|
-
name: StandardEditorNames.ImageCheckBox,
|
132
|
-
params: editorParams,
|
133
|
-
},
|
134
|
-
};
|
135
|
-
}
|
136
|
-
/** Builds a boolean description for a tool settings or dialog property that will display a checkbox control.
|
137
|
-
* @public
|
138
|
-
*/
|
139
|
-
static buildCheckboxDescription(name, label, additionalParams = []) {
|
140
|
-
const editor = {
|
141
|
-
params: additionalParams,
|
142
|
-
};
|
143
|
-
return {
|
144
|
-
name,
|
145
|
-
displayLabel: label,
|
146
|
-
typename: StandardTypeNames.Boolean,
|
147
|
-
editor,
|
148
|
-
};
|
149
|
-
}
|
150
|
-
/** Builds a property description for a tool settings or dialog `lock` property. This will create a checkbox control with no label.
|
151
|
-
* @public
|
152
|
-
*/
|
153
|
-
static buildLockPropertyDescription(name, additionalParams = []) {
|
154
|
-
const defaultParams = {
|
155
|
-
type: PropertyEditorParamTypes.SuppressEditorLabel,
|
156
|
-
suppressLabelPlaceholder: true,
|
157
|
-
};
|
158
|
-
const editor = {
|
159
|
-
params: [defaultParams, ...additionalParams],
|
160
|
-
};
|
161
|
-
return {
|
162
|
-
name,
|
163
|
-
displayLabel: "",
|
164
|
-
typename: StandardTypeNames.Boolean,
|
165
|
-
editor,
|
166
|
-
};
|
167
|
-
}
|
168
|
-
/** Bumps an enum property description value
|
169
|
-
* @public
|
170
|
-
*/
|
171
|
-
static async bumpEnumProperty(description, value) {
|
172
|
-
let choices;
|
173
|
-
if (description.enum) {
|
174
|
-
if (description.enum.choices instanceof Promise) {
|
175
|
-
choices = await description.enum.choices;
|
176
|
-
}
|
177
|
-
else {
|
178
|
-
choices = description.enum.choices;
|
179
|
-
}
|
180
|
-
}
|
181
|
-
if (!choices || choices.length === 0)
|
182
|
-
return value;
|
183
|
-
let choiceIndex = choices.findIndex((choice) => choice.value === value);
|
184
|
-
if (choiceIndex < 0)
|
185
|
-
return value;
|
186
|
-
choiceIndex++;
|
187
|
-
if (choiceIndex >= choices.length)
|
188
|
-
choiceIndex = 0;
|
189
|
-
const newValue = choices[choiceIndex].value;
|
190
|
-
return newValue;
|
191
|
-
}
|
192
|
-
}
|
1
|
+
/*---------------------------------------------------------------------------------------------
|
2
|
+
* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
|
3
|
+
* See LICENSE.md in the project root for license terms and full copyright notice.
|
4
|
+
*--------------------------------------------------------------------------------------------*/
|
5
|
+
/** @packageDocumentation
|
6
|
+
* @module Properties
|
7
|
+
*/
|
8
|
+
import { PropertyEditorParamTypes, } from "./EditorParams";
|
9
|
+
import { StandardEditorNames } from "./StandardEditorNames";
|
10
|
+
import { StandardTypeNames } from "./StandardTypeNames";
|
11
|
+
/** Helper class that builds property descriptions for specific PropertyEditors and processes descriptions.
|
12
|
+
* @public
|
13
|
+
*/
|
14
|
+
export class PropertyDescriptionHelper {
|
15
|
+
/** Builds a number description with a "weight-picker" editor name
|
16
|
+
* @public
|
17
|
+
*/
|
18
|
+
static buildWeightPickerDescription(name, label, additionalParams = []) {
|
19
|
+
return {
|
20
|
+
name,
|
21
|
+
displayLabel: label,
|
22
|
+
typename: StandardTypeNames.Number,
|
23
|
+
editor: {
|
24
|
+
name: StandardEditorNames.WeightPicker,
|
25
|
+
params: additionalParams,
|
26
|
+
},
|
27
|
+
};
|
28
|
+
}
|
29
|
+
/** Builds an editor that uses [NumberInput]($core-react) control
|
30
|
+
* @public
|
31
|
+
*/
|
32
|
+
static buildNumberEditorDescription(name, label, overrideParams, additionalParams = []) {
|
33
|
+
const editorParams = [{
|
34
|
+
type: PropertyEditorParamTypes.Range,
|
35
|
+
step: 1,
|
36
|
+
precision: 0,
|
37
|
+
...overrideParams,
|
38
|
+
}, ...additionalParams];
|
39
|
+
const editor = {
|
40
|
+
name: StandardEditorNames.NumericInput,
|
41
|
+
params: editorParams,
|
42
|
+
};
|
43
|
+
return {
|
44
|
+
name,
|
45
|
+
displayLabel: label,
|
46
|
+
typename: StandardTypeNames.Number,
|
47
|
+
editor,
|
48
|
+
};
|
49
|
+
}
|
50
|
+
/** Builds a string description
|
51
|
+
* @public
|
52
|
+
*/
|
53
|
+
static buildTextEditorDescription(name, label, additionalParams = []) {
|
54
|
+
const editor = {
|
55
|
+
params: additionalParams,
|
56
|
+
};
|
57
|
+
return {
|
58
|
+
name,
|
59
|
+
displayLabel: label,
|
60
|
+
typename: StandardTypeNames.String,
|
61
|
+
editor,
|
62
|
+
};
|
63
|
+
}
|
64
|
+
/** Builds an enum description
|
65
|
+
* @public
|
66
|
+
*/
|
67
|
+
static buildEnumPicklistEditorDescription(name, label, choices, additionalParams = []) {
|
68
|
+
const editor = additionalParams.length ? {
|
69
|
+
params: additionalParams,
|
70
|
+
} : undefined;
|
71
|
+
return {
|
72
|
+
name,
|
73
|
+
displayLabel: label,
|
74
|
+
typename: StandardTypeNames.Enum,
|
75
|
+
editor,
|
76
|
+
enum: {
|
77
|
+
choices,
|
78
|
+
},
|
79
|
+
};
|
80
|
+
}
|
81
|
+
/** Builds a number description for a tool settings or dialog property that will display a "color-picker" control.
|
82
|
+
* @public
|
83
|
+
*/
|
84
|
+
static buildColorPickerDescription(name, label, colorValues, numColumns, additionalParams = []) {
|
85
|
+
const editorParams = [
|
86
|
+
{
|
87
|
+
type: PropertyEditorParamTypes.ColorData,
|
88
|
+
colorValues,
|
89
|
+
numColumns,
|
90
|
+
},
|
91
|
+
...additionalParams,
|
92
|
+
];
|
93
|
+
return {
|
94
|
+
name,
|
95
|
+
displayLabel: label,
|
96
|
+
typename: StandardTypeNames.Number,
|
97
|
+
editor: {
|
98
|
+
name: StandardEditorNames.ColorPicker,
|
99
|
+
params: editorParams,
|
100
|
+
},
|
101
|
+
};
|
102
|
+
}
|
103
|
+
/** Builds a boolean description for a tool settings or dialog property that will display a "toggle" control.
|
104
|
+
* @public
|
105
|
+
*/
|
106
|
+
static buildToggleDescription(name, label, additionalParams = []) {
|
107
|
+
return {
|
108
|
+
name,
|
109
|
+
displayLabel: label,
|
110
|
+
typename: StandardTypeNames.Boolean,
|
111
|
+
editor: {
|
112
|
+
name: StandardEditorNames.Toggle,
|
113
|
+
params: additionalParams,
|
114
|
+
},
|
115
|
+
};
|
116
|
+
}
|
117
|
+
/** Builds a boolean description for a tool settings or dialog property that will display a "image-check-box" control.
|
118
|
+
* @public
|
119
|
+
*/
|
120
|
+
static buildImageCheckBoxDescription(name, label, imageOff, imageOn, additionalParams = []) {
|
121
|
+
const editorParams = [{
|
122
|
+
type: PropertyEditorParamTypes.CheckBoxImages,
|
123
|
+
imageOff,
|
124
|
+
imageOn,
|
125
|
+
}, ...additionalParams];
|
126
|
+
return {
|
127
|
+
name,
|
128
|
+
displayLabel: label,
|
129
|
+
typename: StandardTypeNames.Boolean,
|
130
|
+
editor: {
|
131
|
+
name: StandardEditorNames.ImageCheckBox,
|
132
|
+
params: editorParams,
|
133
|
+
},
|
134
|
+
};
|
135
|
+
}
|
136
|
+
/** Builds a boolean description for a tool settings or dialog property that will display a checkbox control.
|
137
|
+
* @public
|
138
|
+
*/
|
139
|
+
static buildCheckboxDescription(name, label, additionalParams = []) {
|
140
|
+
const editor = {
|
141
|
+
params: additionalParams,
|
142
|
+
};
|
143
|
+
return {
|
144
|
+
name,
|
145
|
+
displayLabel: label,
|
146
|
+
typename: StandardTypeNames.Boolean,
|
147
|
+
editor,
|
148
|
+
};
|
149
|
+
}
|
150
|
+
/** Builds a property description for a tool settings or dialog `lock` property. This will create a checkbox control with no label.
|
151
|
+
* @public
|
152
|
+
*/
|
153
|
+
static buildLockPropertyDescription(name, additionalParams = []) {
|
154
|
+
const defaultParams = {
|
155
|
+
type: PropertyEditorParamTypes.SuppressEditorLabel,
|
156
|
+
suppressLabelPlaceholder: true,
|
157
|
+
};
|
158
|
+
const editor = {
|
159
|
+
params: [defaultParams, ...additionalParams],
|
160
|
+
};
|
161
|
+
return {
|
162
|
+
name,
|
163
|
+
displayLabel: "",
|
164
|
+
typename: StandardTypeNames.Boolean,
|
165
|
+
editor,
|
166
|
+
};
|
167
|
+
}
|
168
|
+
/** Bumps an enum property description value
|
169
|
+
* @public
|
170
|
+
*/
|
171
|
+
static async bumpEnumProperty(description, value) {
|
172
|
+
let choices;
|
173
|
+
if (description.enum) {
|
174
|
+
if (description.enum.choices instanceof Promise) {
|
175
|
+
choices = await description.enum.choices;
|
176
|
+
}
|
177
|
+
else {
|
178
|
+
choices = description.enum.choices;
|
179
|
+
}
|
180
|
+
}
|
181
|
+
if (!choices || choices.length === 0)
|
182
|
+
return value;
|
183
|
+
let choiceIndex = choices.findIndex((choice) => choice.value === value);
|
184
|
+
if (choiceIndex < 0)
|
185
|
+
return value;
|
186
|
+
choiceIndex++;
|
187
|
+
if (choiceIndex >= choices.length)
|
188
|
+
choiceIndex = 0;
|
189
|
+
const newValue = choices[choiceIndex].value;
|
190
|
+
return newValue;
|
191
|
+
}
|
192
|
+
}
|
193
193
|
//# sourceMappingURL=Description.js.map
|