API Reference > ui-components > All ui-components Classes Name Description AbstractTreeNodeLoader Abstract node loader which loads nodes to provided model source. Beta AbstractTreeNodeLoaderWithProvider Abstract node loader with tree data provider which loads nodes to provided model source. Beta ActionButtonList ActionButtonList React component. Beta AlphaSlider AlphaSlider component used to set the alpha value. Beta ArrayPropertyValueRenderer Default Array Property Renderer BasePointTypeConverter Point type converter. BasicPropertyEditor BasicPropertyEditor React component that uses the TextEditor property editor. Beta BeDragDropContextComponent React component for DragDrop API. Beta BeInspireTree Bentley wrapper for 'inspire-tree' BooleanEditor BooleanEditor React component that is a property editor with checkbox input Beta BooleanPropertyEditor BooleanPropertyEditor React component that uses the BooleanEditor property editor. Beta BooleanTypeConverter Boolean Type Converter. Breadcrumb Breadcrumb navigation component, with two discrete modes: text mode, and dropdown mode. Beta BreadcrumbDetails A Table containing all children of tree node specified in path. Beta BreadcrumbNode Default BreadcrumbNode component Beta BreadcrumbPath Breadcrumb Path class. Beta BreadcrumbTreeUtils Utility class for tree searching and manipulation in the Breadcrumb component. Beta BreadcrumbUpdateEvent BreadcrumbChangeEvent Event class. Beta CellEditingEngine Tree Cell editing information Beta ColorEditor ColorEditor React component that is a property editor with text input Beta ColorPickerButton ColorPickerButton component Beta ColorPropertyEditor ColorPropertyEditor returns React component ColorEditor to select a color value. Beta ColumnDragLayer React component used to portray a column being dragged during Table column reordering. CompositeTypeConverter Composite type converter CubeRotationChangeEvent 3d Cube Rotation Change event DataControllerBase DataControllerBase is the base class for all Data Controllers. Beta DateTimeTypeConverter Date Time Type Converter. DateTimeTypeConverterBase DateTime Type Converter. DoublePropertyValueRenderer Default Double Property Renderer DrawingViewportChangeEvent Drawing View Change event EditorContainer EditorContainer React component Beta EnumButtonGroupEditor EnumButtonGroupEditor React component that is a property editor with select input Beta EnumEditor EnumEditor React component that is a property editor with select input Beta EnumPropertyButtonGroupEditor EnumPropertyButtonGroupEditor React component that uses the EnumButtonGroupEditor property editor. Beta EnumPropertyEditor EnumPropertyEditor React component that uses the EnumEditor property editor. Beta EnumTypeConverter Enum Type Converter. EventsMuteContext A context which keeps BeInspireTree events muted until FilteringInput A helper component for filtering trees and stepping through results FloatTypeConverter Float Type Converter. HexadecimalTypeConverter Hexadecimal Type Converter. HighlightingEngine Tree highlighting engine Beta HueSlider HueSlider component used to set the hue value. Beta IntTypeConverter Int Type Converter. LineWeightSwatch LineWeightSwatch Functional component Beta MergedPropertyValueRenderer Default Merged Property Renderer MutableTreeModel Mutable tree model which holds nodes and allows adding or removing them. Beta NavigationPropertyTypeConverter Navigation property type converter NavigationPropertyValueRenderer Default Navigation Property Renderer NonPrimitivePropertyLabelRenderer A React component that renders a non-primitive property label. NonPrimitivePropertyRenderer React Component that renders struct and array properties NumericTypeConverterBase Base Numeric Type Converter. PagedTreeNodeLoader Default paged tree node loader with TreeDataProvider implementation. Beta Point2dTypeConverter Point2d type converter. Point3dTypeConverter Point3d type converter. PrimitivePropertyLabelRenderer A React component that renders a primitive property label PrimitivePropertyRenderer React Component that renders primitive properties PrimitivePropertyValueRenderer Default Primitive Property Renderer PropertyCategoryBlock PropertyCategoryBlock React component PropertyDataChangeEvent An event broadcasted on property data changes PropertyEditorBase PropertyEditor is the base class for all property editors. Beta PropertyEditorManager Manages Property Editors. Beta PropertyGrid PropertyGrid React component. PropertyList A React component that renders multiple properties within a category as a list. PropertyRenderer A React component that renders properties PropertyValueRendererManager Default implementation of property value renderer manager PropertyView A React component that renders property as label/value pair ResultSelector Component for stepping through results/entries SaturationPicker SaturationPicker component used to set the saturation value. Beta ShortDateTypeConverter Short Date Type Converter. ShowHideDialog Dialog Component used to toggle show/hide items, given through items prop, through a list of checkboxes. ShowHideMenu ContextMenu Component used to toggle show/hide items, given through items prop, through a list of checkboxes. SignIn SignIn React presentational component SimplePropertyDataProvider Implementation of [PropertyDataProvider] that uses an associative array. SimpleTableDataProvider A Table Data Provider using an array of items. Beta SimpleTreeDataProvider A tree data provider using SimpleTreeDataProviderHierarchy. SparseArray Structure for sparse array value storage. Beta StandardRotationChangeEvent Standard Rotation Change event StringTypeConverter String Type Converter. StructPropertyValueRenderer Default Struct Property Renderer Table Table React component TableArrayValueRenderer A react component which renders array property value as a button with text TableCell A React component that renders a table cell TableCellContent A React component that renders table cell content TableDataChangeEvent An event broadcasted on table data changes TableIconCellContent A React component that renders table cell content as a Bentley icon TableNonPrimitiveValueRenderer A React component that renders non primitive values as a button with text. TableStructValueRenderer A react component which renders struct property value as a button with text TextEditor TextEditor React component that is a property editor with text input Beta ToggleEditor ToggleEditor React component that is a property editor with checkbox input Beta TogglePropertyEditor TogglePropertyEditor React component that uses the ToggleEditor property editor. Beta Tree A Tree React component that uses the core of BeInspireTree TreeEventHandler Default tree event handler. Beta TreeImageLoader Default image loader for the tree TreeModelSource Controls tree model and visible tree nodes. Beta TreeNode Default component for rendering a node for the Tree TreeNodeLoader Default tree node loader with TreeDataProvider implementation. Beta TypeConverter Type Converter base class. TypeConverterManager Manages Type Converters. UiComponents Entry point for static initialization required by various ViewClassFullNameChangedEvent View Class Full Name Change event ViewIdChangedEvent View Id Change event ViewportComponent A viewport React component that creates a ScreenViewport. ViewportComponentEvents Viewport Rotation events and methods ViewRotationChangeEvent View Rotation Change event WeightEditor WeightEditor React component that is a property editor with text input Beta WeightPickerButton WeightPickerButton component Beta WeightPropertyEditor WeightPropertyEditor returns React component WeightEditor to select a color value. Beta Constants Name Description BeDragDropContext Context component for DragDrop API. Beta ItemStyleProvider Style provider for stylable items like CellItem and TreeNodeItem TableRowStyleProvider Style provider for table rows TreeNodeRenderer Default component for rendering tree node. Beta TreeRendererContextConsumer Context of TreeRenderer consumer. Beta TreeRendererContextProvider Context of TreeRenderer provider. Beta useTreeRendererContext Custom hook to use TreeRenderer context. Beta Enumerations Name Description BeInspireTreeEvent Enum containing all events that may be emitted by BeInspireTree BreadcrumbMode Enum for Breadcrumb Mode Beta DropEffects Enum for different DropEffects. Beta DropStatus Enum for status of current drag/drop item Beta PropertyContainerType Types of property containers SelectionMode Selection modes for Table and Tree row selection SelectionModeFlags Selection mode flags for Table and Tree row selection StandardTypeConverterTypeNames StandardTypeConverterTypeNames. Beta TableSelectionTarget Specifies table selection target. Global Functions Name Description ColorSwatch ColorSwatch Functional component Beta ControlledTree React tree component which rendering is fully controlled from outside. Beta from Helper method that creates an Observable from Iterable or Promise. Beta hasChildren Determines whether node has children hasFlag Determines if a SelectionMode is active hasLinks Returns true if property record has an anchor tag isTreeDataProviderInterface Checks if TreeDataProvider is an ITreeDataProvider isTreeDataProviderMethod Checks if TreeDataProvider is a TreeDataProviderMethod isTreeDataProviderPromise Checks if TreeDataProvider is a TreeDataProviderPromise isTreeDataProviderRaw Checks if TreeDataProvider is a TreeDataProviderRaw isTreeModelNode Checks if object is TreeModelNode Beta isTreeModelNodePlaceholder Checks if object is TreeModelNodePlaceholder Beta isTreeModelRootNode Checks if object is TreeModelRootNode Beta matchLinks Returns a list of links from a text renderLinks Renders anchor tag by wrapping or splitting provided text TreeNodeEditor React component for displaying tree node editor Beta TreeNodeIcon React component that renders tree node icons TreeRenderer Default component for rendering tree. Beta useModelSource Custom hook which creates TreeModelSource Beta useNodeLoader Custom hook which creates TreeNodeLoader for supplied dataProvider. Beta usePagedNodeLoader Custom hook which creates PagedTreeNodeLoader for supplied dataProvider. Beta useVisibleTreeNodes Custom hook which returns visible nodes from model source and subscribes to onModelChanged event. Beta withBreadcrumbDetailsDragDrop A HOC component that adds drag and drop functionality to the supplied Beta withBreadcrumbDragDrop A HOC component that adds drag and drop functionality to the supplied breadcrumb component. Beta withContextStyle Wraps a React component with a span element with a given style attribute withDragSource HOC (Higher-Order Component) that transforms wrapped component into a DragSource. Beta withDropTarget HOC (Higher-Order Component) that transforms wrapped component into a DropTarget. Beta withLinks If record has links, wraps stringValue in them, otherwise returns unchanged stringValue withTableDragDrop A HOC component that adds drag and drop functionality to the supplied table component. Beta withTreeDragDrop A HOC component that adds drag and drop functionality to the supplied Beta Interfaces Name Description ActionButtonListProps Properties of ActionButtonList React component Beta ActionButtonRendererProps Properties of ActionButtonRenderer Beta ActiveMatchInfo Active match info for highlightable Tree Beta AlphaSliderProps Properties for the AlphaSlider React component Beta AsyncErrorMessage Asynchronous Error Message returned as part of AsyncValueProcessingResult Beta AsyncValueProcessingResult Asynchronous Value Process Result Beta BeInspireTreeDataProviderInterface Signature for BeInspireTree data provider BeInspireTreeNode Type definition for all BeInspireTree nodes BeInspireTreeNodeConfig Be alias for Inspire.NodeConfig BeInspireTreeNodeITree Be alias for Inspire.NodeConfig.ITree BeInspireTreeNodePayloadConfig Data structure for BeInspireTreeNodeConfig with our injected props BeInspireTreeNodes Definition of a list of BeInspireTreeNode with some additional filtering methods BeInspireTreeProps Configuration properties for BeInspireTree BreadcrumbDetailsDragDropProps Props that are injected to the HOC component. Beta BreadcrumbDetailsProps Properties for the BreadcrumbDetails component Beta BreadcrumbDragDropProps Props that are injected to the HOC component. Beta BreadcrumbNodeProps Properties for BreadcrumbNode component Beta BreadcrumbProps Properties for Breadcrumb component Beta BreadcrumbUpdateEventArgs BreadcrumbChangeEvent Event Args class. Beta CellItem Cell definition provided to Table. CellProps Properties for a Table cell CheckBoxInfo Immutable data structure that describes checkbox info. Beta CheckboxStateChange Data structure that describes checkbox state change. Beta ColorPickerProps Properties for the ColorPickerButton React component Beta ColorSwatchProps Properties for the ColorSwatch React component Beta ColumnDescription Column definition provided to Table. CompletionObserver CompletionObserver interface compatible with rxjs Beta ControlledTreeProps Properties for ControlledTree Beta CubeRotationChangeEventArgs Arguments for CubeRotationChangeEvent DataController DataControllers can be implemented per typename to validate and commit values. Beta DelayLoadedTreeNodeItem A TreeNodeItem for delay-loaded trees DragDropArguments Base DragDropArguments interface, used by both DragSourceArguments and DragTargetArguments. Beta DragLayerProps Properties for DragLayer components Beta DragSourceArguments Interface for arguments supplied to DragSource callbacks, including onDragSourceBegin, and onDragSourceEnd, as well as to the DragLayers as a prop. Beta DragSourceProps Properties and callbacks for the withDragSource Higher-Order Component. Beta DrawingViewportChangeEventArgs Arguments for DrawingViewportChangeEvent DropTargetArguments Interface for arguments supplied to DropTarget callbacks, including onDropTargetOver, onDropTargetDrop, and canDropTargetDrop. Beta DropTargetProps Properties and callbacks for the withDragSource Higher-Order Component. Beta EditableTreeDataProvider EditableTreeDataProvider provides cell editing processing for the Tree. EditableTreeProps Properties for a Tree that has cell editing enabled Beta EditorContainerProps EditorContainer React component properties Beta ErrorObserver ErrorObserver interface compatible with rxjs Beta ExtendedTreeNodeRendererProps Extended properties for TreeNodeRenderer. Beta FilteringInputProps FilteringInput React Component properties HighlightableTreeNodeProps Properties for a highlightable TreeNode Beta HighlightableTreeProps Properties for the HighlightingEngine Beta HueSliderProps Properties for the HueSlider React component Beta IElementPropertyDataProvider An interface for element property data provider which returns Beta IImageLoader Interface for an image loader. ImmediatelyLoadedTreeNodeItem A TreeNodeItem for immediately loaded trees IPropertyDataProvider An interface for property data provider which returns IPropertyValueRenderer Custom property value renderer interface ItemColorOverrides Color overrides for styled item ItemStyle Style properties for styled item like CellItem and TreeNodeItem ITreeDataProvider Interface for a tree data provider class ITreeImageLoader Interface for a tree image loader ITreeNodeLoader Tree node loader which is used to load tree nodes. Beta ITreeNodeLoaderWithProvider Tree node loader which uses TreeDataProvider to load nodes. Beta LessGreaterOperatorProcessor Operators for Numeric types, DateTime, TimeSpan, or any type that supports these comparisons LineWeightSwatchProps Properties for the LineWeightSwatch React component Beta LoadedBinaryImage Image data for raw images LoadedImage Image data for string based images LoadedNodeHierarchy Data structure that describes hierarchy loaded for parent node. Beta LoadedNodeHierarchyItem Data structure that describes one loaded hierarchy item. Beta MutableCheckBoxInfo Mutable data structure that describes checkbox info. Beta MutableTableDataProvider MutableTableDataProvider provides mutation methods for data in the Table. Beta MutableTreeDataProvider MutableTreeDataProvider provides manipulation processing for the Tree. Beta MutableTreeModelNode Mutable data structure that describes tree node. Beta NextObserver NextObserver interface compatible with rxjs Beta NodeCheckboxProps Properties for Checkbox in TreeNode NonPrimitivePropertyLabelRendererProps Properties for the NonPrimitivePropertyLabelRenderer React component NonPrimitivePropertyRendererProps Properties of NonPrimitivePropertyRenderer React component NullableOperatorProcessor Operators for all filterable null-able types Observable Observable interface compatible with rxjs Beta OperatorProcessor Operators for all filterable types PageOptions Paging options. PrimitivePropertyLabelRendererProps Properties of a PrimitivePropertyLabelRenderer React component PrimitiveRendererProps Properties of PrimitivePropertyRenderer React component PropertyCategory Contains metadata about a group of Properties. PropertyCategoryBlockProps Properties for the PropertyCategoryBlock React component PropertyData Interface for property data provided to the PropertyGrid React component. PropertyDialogState State of the Dialog component in a container which renders properties PropertyEditingArgs Arguments for the Property Editing event callback PropertyEditorProps Properties for a property editor component Beta PropertyGridCategory Property Category in the PropertyGrid state PropertyGridContextMenuArgs Arguments for PropertyGridProps.onPropertyContextMenu callback PropertyGridProps Properties for PropertyGrid React component PropertyLabelRendererProps Base properties for a property label renderer PropertyListProps Properties of PropertyList React component PropertyPopupState State of the Popup component in a container which renders properties PropertyRendererProps Properties of PropertyRenderer React component PropertyUpdatedArgs Arguments for the Property Updated event callback Beta PropertyValueRendererContext Additional parameters to the renderer PropertyViewProps Properties of PropertyView React component ReactDataGridColumn ReactDataGrid.Column with additional properties ResultSelectorProps ResultSelector React Component properties RowItem Row definition provided to Table. RowProps Properties for a Table row SaturationPickerProps Properties for the SaturationPicker React component Beta SharedRendererProps Properties shared by all renderers and PropertyView SharedTableNonPrimitiveValueRendererProps Shared properties between table non-primitive value renderers ShowHideDialogProps Properties for the ShowHideDialog component ShowHideItem Interface for ShowHide items ShowHideMenuProps Properties for the ShowHideMenu component SignInProps Properties for the SignIn component SortComparer Sort compare method for types that support sorting StandardRotationChangeEventArgs Arguments for StandardRotationChangeEvent StringOperatorProcessor Operators for string types Subscribable Subscribable interface compatible with rxjs Beta Subscription Subscription interface compatible with rxjs Beta TableCellContentProps Properties of the TableCellContent React component TableCellContextMenuArgs Arguments for TableProps.onCellContextMenu callback Beta TableCellEditorState Cell/Property Editor state TableCellProps Properties of the TableCell React component TableCellUpdatedArgs Cell/Property Updated Args TableDataProvider TableDataProvider provides data to the Table. TableDragDropProps Props that are injected to the HOC component. Beta TableDropTargetProps Properties for the Table's DropTarget. Beta TableIconCellContentProps Properties for the TableIconCellContent React component TableNonPrimitiveValueRendererProps Properties for TableNonPrimitiveValueRenderer React component TableProps Properties for the Table React component TableSpecificValueRendererProps Properties for TableArrayValueRenderer and TableStructValueRenderer React component TreeActions Tree actions that can be performed on tree. Beta TreeCellUpdatedArgs Arguments for the Tree Cell Updated event callback Beta TreeCheckboxStateChangeEvent Data structure that describes tree checkbox state change event payload. Beta TreeDragDropProps Props that are injected to the HOC component. Beta TreeEditingParams Params used for tree node editing. Beta TreeEventHandlerParams Data structure that describes tree event handler params. Beta TreeEvents Tree events that can occur while interacting with tree. Beta TreeModel Data structure that describes tree model. Beta TreeModelChanges Data structure that describes changes which happened to the tree model Beta TreeModelNode Immutable data structure that describes tree node. Beta TreeModelNodeEditingInfo Data structure that holds callbacks used for tree node editing. Beta TreeModelNodeInput Data structure that describes input used to create tree node. Beta TreeModelNodePlaceholder Data structure that describes tree node placeholder. Beta TreeModelRootNode Data structure that describes tree root node. Beta TreeNodeEditorProps Properties for TreeNodeEditor component Beta TreeNodeEvent Data structure that describes tree node event payload. Beta TreeNodeIconProps Properties for TreeNodeIcon React component TreeNodeItem A node item which can be displayed in a tree. TreeNodeLoadResult Data structure that describes node load result Beta TreeNodeProps Properties for TreeNode React component TreeNodeRendererProps Properties for TreeNodeRenderer. Beta TreeProps Properties for the Tree component TreeRendererContext Context of TreeRenderer component. Beta TreeRendererProps Properties for TreeRenderer component. Beta TreeSelectionChange Data structure that describes tree selection change. Beta TreeSelectionModificationEvent Data structure that describes tree selection modification event payload. Beta TreeSelectionReplacementEvent Data structure that describes tree selection replacement event payload. Beta TypeEditor Interface implemented by React based type editors Beta Unsubscribable Unsubscribable interface compatible with rxjs Beta ViewClassFullNameChangedEventArgs Arguments for ViewClassFullNameChangedEvent ViewIdChangedEventArgs Arguments for ViewIdChangedEvent ViewportProps Properties for ViewportComponent component. ViewRotationChangeEventArgs Arguments for ViewRotationChangeEvent VisibleTreeNodes Data structure that describes set of visible tree nodes as a flat list. Beta WeightPickerProps Properties for the WeightPickerButton React component Beta WithDragSourceProps React properties for withDragSource Higher-Order Component Beta WithDropTargetProps React properties for withDropTarget Higher-Order Component Beta Namespaces Name Description ConvertedPrimitives Converted Primitives namespace Type Aliases Name Description ActionButtonRenderer Renders a React component (usually a button) for a PropertyRecord Beta BeInspireTreeDataProvider Type definition for all BeInspireTree data providers BeInspireTreeDataProviderMethod Signature for BeInspireTree data provider BeInspireTreeDataProviderPromise A Promise for DataProviderRaw BeInspireTreeDataProviderRaw Array of tree node data elements BeInspireTreeRenderer Type definition for a BeInspireTree renderer BreadcrumbDetailsDragDropType Type for drag and drop, Beta GetCurrentlyEditedNode Prototype for function to get the currently edited tree node Beta HorizontalAlignment Type for Horizontal Alignment Image Image data returned by an IImageLoader ImageFileFormat Type of raw image format ImageSourceType Type of loaded image source: MapPayloadToInspireNodeCallback Prototype for BeInspireTreeProps.mapPayloadToInspireNodeConfig Observer Observer interface compatible with rxjs Beta OnItemsDeselectedCallback Called after items were deselected. OnItemsSelectedCallback Called after items were selected. OnSelectionChanged Prototype for a Selection Changed handler PropertyDataChangesListener A signature for property data change listeners SetCurrentlyEditedNode Prototype for function to set the currently edited tree node Beta ShowHideID Union type for all possible ShowHide IDs SimpleTreeDataProviderHierarchy Used by SimpleTreeDataProvider. TableDataChangesListener An interface table data change listeners TableDragDropType Type for DragDrop drag item Beta TreeDataChangesListener An interface tree data change listeners. TreeDataProvider Type definition for all BeInspireTree data providers TreeDataProviderMethod Signature for a method that returns TreeDataProviderPromise for supplied parent node TreeDataProviderPromise A Promise for TreeDataProviderRaw TreeDataProviderRaw Array of tree node data elements TreeDragDropType Type for drag and drop, Beta TreeModelNodeType Type definition of all tree model nodes. Beta TreeNodeEditorRenderer Type for tree node editor renderer Beta TreeNodeItemData Type definition of tree node item data. Beta Last Updated: 13 June, 2024