ui-abstract

Classes

Name Description
AbstractStatusBarItemUtilities Helper class to create Abstract StatusBar Item definitions.
BackstageItemUtilities Utilities for creating and maintaining backstage items
BaseQuantityDescription Base Quantity Property Description Beta
ConditionalBooleanValue Class used to return a boolean value.
ConditionalStringValue Class used to return a string value.
DialogLayoutDataProvider DialogLayoutDataProvider Abstract class that allows property values to be passed between hosting API and Dialog that generates and arranges components dynamically
DialogProperty DialogProperty is a generic helper class that assists working with properties used by UiLayoutDataProvider implementations (i.e.
GenericUiEvent The GenericUiEvent is the base event class for UI events that target a specific component, as identified in uiComponentId.
IconSpecUtilities Creates an IconSpec with an SVG source and gets the SVG source from an IconSpec. Beta
PropertyDescriptionHelper Helper class that builds property descriptions for specific PropertyEditors and processes descriptions. Beta
PropertyRecord PropertyRecord contains instance information about a Property, including a
SyncPropertiesChangeEvent Sync UI Control Properties Event class.
ToolbarItemUtilities Helper class to create Abstract StatusBar Item definitions.
UiAbstract Entry point for static initialization required by various components used in the package.
UiAdmin The UiAdmin controls various UI components and is callable from IModelApp.uiAdmin in the imodeljs-frontend package.
UiDataProvider UiDataProvider Abstract class that allows property values to be passed between hosting API and UI.
UiError iModel.js UI UiError class is a subclass of BentleyError.
UiItemsArbiter Arbitrates between the UiItemsApplication and a UiItemsProvider Beta
UiItemsManager Controls registering of UiItemsProviders and calls the provider's methods when populating different parts of the User Interface.
UiLayoutDataProvider

Enumerations

Name Description
AbstractZoneLocation Enum for AppUi 1 Zone locations that can have widgets added to them at run-time via UiItemsProvider.
AlternateDateFormats Alternate Data Formats that can be provide by javascript.
BackstageItemType Used to specify the item type added to the backstage menu.
BadgeType Specifies type of badge, if any, that should be overlaid on UI component.
DialogButtonStyle Enum for button style.
DialogButtonType Enum for button types.
FunctionKey Enumeration for Function Keys
PropertyChangeStatus Status of Proposed property changes from UI to UiDataProvider
PropertyEditorParamTypes Enum for Property Editor Param Types
PropertyValueFormat Enumeration for Format of the property value.
RelativePosition Relative Position for popups
SpecialKey Enumeration for Special Keys
StagePanelLocation Available Stage Panel locations.
StagePanelSection Enum for Stage Panel Sections
StageUsage Standard stage uses.
StandardEditorNames Standard Editor Names for property editors. Beta
StandardTypeNames Standard Type Names for converters and editors. Beta
StatusBarLabelSide Defines which side of Icon where label is placed
StatusBarSection Status bar Groups/Sections from Left to Right
TimeDisplay Enum that defines supported time formats.
ToolbarOrientation Used to specify the orientation of the toolbar.
ToolbarUsage Used to specify the usage of the toolbar which determine the toolbar position.
UiItemsApplicationAction Action taken by the application on item provided by a UiItemsProvider
WidgetState Widget state enum.

Global Functions

Name Description
isAbstractStatusBarActionItem AbstractStatusBarActionItem type guard.
isAbstractStatusBarCustomItem AbstractStatusBarCustomItem type guard.
isAbstractStatusBarLabelItem AbstractStatusBarLabelItem type guard.
isActionItem BackstageActionItem type guard.
isArrowKey Determines if a KeyboardEvent.key is an Arrow key
isButtonGroupEditorParams ButtonGroupEditorParams type guard.
isColorEditorParams ColorEditorParams type guard.
isCustomFormattedNumberParams CustomFormattedNumberParams type guard.
isIconListEditorParams IconListEditorParams type guard.
isInputEditorSizeParams InputEditorSizeParams type guard.
isStageLauncher BackstageStageLauncher type guard.
isSuppressLabelEditorParams SuppressLabelEditorParams type guard.

Interfaces

Name Description
AbstractActionItemProps Definition for an item that executes and action.
AbstractMenuItemProps Properties for a Menu item
AbstractStatusBarActionItem Describes the data needed to insert an action item into the status bar.
AbstractStatusBarCustomItem Describes the data needed to insert a custom item into the status bar.
AbstractStatusBarItem Describes the data needed to insert a button into the status bar.
AbstractStatusBarLabelItem Describes the data needed to insert a label item with an optional icon into the status bar.
AbstractToolbarProps Definition for a Toolbar.
AbstractWidgetProps Properties for a Widget.
ActionButton Describes the data needed to insert an action button into a toolbar.
ArrayValue Array property value
BackstageActionItem Describes the data needed to insert an action button into the backstage menu.
BackstageStageLauncher Describes the data needed to insert an action button into the backstage menu.
BaseDialogItem BaseDialogItem contains only the members necessary to create a PropertyRecord.
BasePropertyEditorParams BasePropertyEditorParams Base interface for Property Editor Params
BasePropertyValue Base interface for a property value
ButtonGroupEditorParams ButtonGroupEditorParams Parameters used by EnumButtonGroupEditor to define icons in button group.
ColorEditorParams ColorEditorParams Parameters used to populate color type editor with a specific set of colors.
CommandHandler Definition for a command handler.
CommonBackstageItem Describes the data needed to insert a button into the backstage menu.
CommonItemProps Definition that specifies properties shared between many ConfigurableUi components.
CustomButtonDefinition Describes the data needed to insert a custom button into a toolbar.
CustomFormattedNumberParams Parameters used with properties that want to control parsing and formatting.
DateFormatter Interface used to provide a custom Date Time formatter and optional parser
DialogButtonDef Interface for a dialog button in a button cluster
DialogItem DialogItem is the specification that the display engine turns into a UI item.
DialogItemValue DialogItemValue Interface of PrimitiveValue types that have type editor support for use in dialogs.
DialogPropertyItem DialogPropertyItem us the specification to use if you are defining the components directly, e.g., in React
DialogPropertySyncItem DialogPropertySyncItem is used to pass sync messages for DialogPropertyItems
DialogProps Optional props to pass to the Dialog control that is generated.
DialogRow DialogRow is the interface that groups dialog items into rows for building UI
EditorPosition EditorPosition Interface used to identify the location of the item a DialogItem property value.
EnumerationChoice Information about an enumeration choice
EnumerationChoicesInfo Information about a set of enumeration choices
GenericUiEventArgs The Generic UI Event args contains information useful for any UI message
GroupButton Describes the data needed to insert a group button into a toolbar.
IconDefinition IconDefinition Information about an icon displayed next to a property editor.
IconEditorParams Parameters used to display an icon next to property editor.
IconListEditorParams IconListEditorParams Parameters used to populate icon type editor with a specific set of icons.
ImageCheckBoxParams Parameters for ImageCheckBoxEditor
IMatch Interface that returns indices of matches
InputEditorSizeParams InputEditorSizeParams type guard.
LinkElementsInfo Properties for the PropertyRecord with link info supplied
MultilineTextEditorParams Parameter that is used to indicate that a multiline text editor should be created.
ParseResults defines Results of parsing a string input by a user into its desired value type
PrimitiveValue Primitive property value
PropertyChangeResult Interface used by UiDataProvider to report change status (validation) to UI.
PropertyConverterInfo Information about a Property Converter
PropertyDescription PropertyDescription contains metadata about a Property
PropertyEditorInfo Information about a Property Editor
PropertyRendererInfo Property renderer identification and customization attributes
ProvidedItem Properties for an item provided by UiItemsProvider
RangeEditorParams Parameters used by PropertyEditors that support defining a minimum and maximum value.
SliderEditorParams Parameters used to indicate that a Slider should be presented for the property
StructValue Struct property value
SuppressLabelEditorParams SuppressLabelEditorParams Parameters used to suppress the label for a type editor in the ToolSettings widget.
SyncPropertiesChangeEventArgs Sync UI Control Properties Event Args interface.
ToolbarItem Describes the data needed to insert a UI items into an existing set of UI items.
UiFlags Flags that control enabling/disabling certain UI features
UiItemProviderRegisteredEventArgs UIProvider Registered Event Args interface.
UiItemsApplication Application for items provided by a UiItemsProvider Beta
UiItemsProvider Describes interface of objects that want to provide UI component to the running IModelApp.

Namespaces

Name Description
Primitives Primitive Property Value Types.

Type Aliases

Name Description
BackstageItem Describes the data needed to insert a button into the backstage menu.
CommonStatusBarItem Describes the data needed to insert a button into the status bar.
CommonToolbarItem Any Button Type that can be inserted into a toolbar.
OnCancelFunc Signature for onCancel function.
OnItemExecutedFunc Signature for onItemExecuted function.
OnNumberCommitFunc Signature for number onCommit function.
OnValueCommitFunc Signature for value onCommit function.
PropertyEditorParams Type definition for Property Editor params
PropertyValue Type for all property values
StatusBarItemId Type for StatusBar Item Id
StringGetter Prototype for string getter function.
ToolbarItemId Type for Toolbar Item Id

Last Updated: 18 June, 2021