ui-components
Classes
Name | Description | |
---|---|---|
AbstractTreeNodeLoader | Abstract node loader implementation which loads nodes into provided model source. | |
AbstractTreeNodeLoaderWithProvider | Abstract node loader with tree data provider which loads nodes into provided model source. | |
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 | Basic Property Editor registered for the "text" and "string" type names. | Beta |
BeInspireTree | Bentley wrapper for 'inspire-tree' | Deprecated |
BooleanEditor | BooleanEditor React component that is a property editor with checkbox input | Beta |
BooleanPropertyEditor | Boolean Property Editor registered for the "bool" and "boolean" type names. | 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 |
ColorPropertyEditor | Color Property Editor registered for the "number" type name and "color-picker" editor name. | Beta |
ColumnDragLayer | React component used to portray a column being dragged during Table column reordering. | Deprecated |
CompositePropertyDataFilterer | Composite PropertyData filter which can join two filters using logic operators | Beta |
CompositeTypeConverter | Composite type converter | |
CubeNavigationAid | Cube Navigation Aid Component | |
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. | |
DEPRECATED_Tree | A Tree React component that uses the core of BeInspireTree but renders with TreeBase and TreeNodeBase from ui-core. | Deprecated |
DisplayValuePropertyDataFilterer | Property data filterer which matches on Primitive Property Record display value text. | Beta |
DistinctValueCollection | A set of distinct values for a column. | |
DoublePropertyValueRenderer | Default Double Property Renderer | |
DrawingNavigationAid | A Drawing Navigation Aid. | Beta |
DrawingViewportChangeEvent | Drawing View Change event | |
EditorContainer | EditorContainer React component used by the Table, Tree and PropertyGrid for cell editing. | 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 | Enum Property Button Group Editor registered for the "enum" type name and the "enum-buttongroup" editor name. | Beta |
EnumPropertyEditor | Enum Property Button Group Editor registered for the "enum" type name. | Beta |
EnumTypeConverter | Enum Type Converter. | |
EventsMuteContext | A context which keeps BeInspireTree events muted until | Deprecated |
FavoritePropertiesRenderer | Renderer for Favorite Property List | Beta |
FilterDescriptorCollection | Collection of filter descriptors. | |
FilterDescriptorCollectionBase | Collection of filter descriptors. | |
FilteringInput | A helper component for filtering trees and stepping through results | |
FilteringPropertyDataProvider | IPropertyDataProvider implementation which will filter wrapped provider PropertyData using passed IPropertyDataFilterer. | Beta |
FloatTypeConverter | Float Type Converter. | |
HexadecimalTypeConverter | Hexadecimal Type Converter. | |
HighlightingEngine | Tree highlighting engine | Beta |
ImageCheckBoxEditor | ImageCheckBoxEditor | Beta |
ImageCheckBoxPropertyEditor | ImageCheckBox Property Editor registered for the "bool" and "boolean" type names. | Beta |
IntTypeConverter | Int Type Converter. | |
LabelPropertyDataFilterer | PropertyData filter which matches on any record type label and includes descendant nodes on match | Beta |
LineWeightSwatch | LineWeightSwatch Functional component | Beta |
MergedPropertyValueRenderer | Default Merged Property Renderer | |
MutableCategorizedArrayProperty | Mutable wrapper object for PropertyRecord with array valueFormat which provides methods for working with and managing record children hierarchies. | Beta |
MutableCategorizedPrimitiveProperty | Mutable wrapper object for PropertyRecord with primitive valueFormat. | Beta |
MutableCategorizedProperty | Base class for all Mutable CategorizedProperties | Beta |
MutableCategorizedStructProperty | Mutable wrapper object for PropertyRecord with struct valueFormat which provides methods for working with and managing record children hierarchies. | Beta |
MutableFlatPropertyGridItem | Base class for all FlatPropertyGrid items | Beta |
MutableGridCategory | Mutable wrapper object for PropertyCategory which provides methods for working with and managing category and record children hierarchies | Beta |
MutableGridItemFactory | Implementation of IMutableGridItemFactory for creating MutableGridItem objects. | Beta |
MutablePropertyGridModel | Implementation of PropertyGridModel for working with and converting PropertyData to mutable FlatGridItems | Beta |
MutableTreeModel | Mutable tree model which holds nodes and allows adding or removing them. | |
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 | |
NumericInputEditor | NumericInputEditor React component that is a property editor with numeric input & up/down buttons | Beta |
NumericInputPropertyEditor | Numeric Input Property Editor registered for the "number" type name and "numeric-input" editor name. | Beta |
NumericTypeConverterBase | Base Numeric Type Converter. | |
OperatorValueFilterDescriptorCollection | Collection of OperatorValue filter descriptors. | |
PagedTreeNodeLoader | Default paged tree node loader with TreeDataProvider implementation. |
|
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 | |
PropertyCategoryDataFiltererBase | PropertyDataFilter base which is suited for only Category filtering | Beta |
PropertyCategoryLabelFilterer | PropertyData filterer which matches on PropertyCategory's label. | Beta |
PropertyCategoryRendererManager | Keeps a record of currently registered property category renderers and determines which renderers get invoked for | Beta |
PropertyDataChangeEvent | An event broadcasted on property data changes | |
PropertyDataFiltererBase | PropertyDataFilter base which helps implement common logic between all IPropertyDataFilterer | Beta |
PropertyEditorBase | PropertyEditor is the base class for all property editors. | Beta |
PropertyEditorManager | Manages Property Editors. | Beta |
PropertyFilterChangeEvent | An event broadcasted when property filter changes | Beta |
PropertyGrid | PropertyGrid React component. | |
PropertyGridEventHandler | Handles events and changes on PropertyGridModel data. | Beta |
PropertyGridModelChangeEvent | An event broadcasted on property grid model changes | Beta |
PropertyGridModelSource | Controls property grid model. | Beta |
PropertyList | A React component that renders multiple properties within a category as a list. | |
PropertyRecordDataFiltererBase | PropertyDataFilter base which is suited for only Record filtering | Beta |
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 | |
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 [IPropertyDataProvider] that uses an associative array. | |
SimpleTableDataProvider | A Table Data Provider using an array of items. | |
SimpleTreeDataProvider | A tree data provider using SimpleTreeDataProviderHierarchy. | |
SliderEditor | SliderEditor React component that is a property editor with numeric input & up/down buttons | Beta |
SliderPropertyEditor | Slider Property Editor registered for the "number" type name and "slider" editor name. | Beta |
SparseArray | Structure for sparse array value storage. | |
StandardRotationChangeEvent | Standard Rotation Change event | |
StringTypeConverter | String Type Converter. | |
StructPropertyValueRenderer | Default Struct Property Renderer | |
Table | Table React component that displays rows and columns in a grid along with a header | |
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 | |
TextareaEditor | TextareaEditor React component that is a property editor with text input | Beta |
TextareaPropertyEditor | Textarea Property Editor registered for the "text" and "string" type names and "multi-line" editor name. | Beta |
TextEditor | TextEditor React component that is a property editor with text input | Beta |
ThemedEnumEditor | EnumEditor React component that is a property editor with select input | Beta |
ThemedEnumPropertyEditor | Enum Property Button Group Editor registered for the "enum" type name. | Beta |
TimelineComponent | TimelineComponent is used to playback timeline data | |
ToggleEditor | ToggleEditor React component that is a property editor with checkbox input | Beta |
TogglePropertyEditor | Toggle Property Editor registered for the "bool" and "boolean" type names and "toggle" editor name. | Beta |
TreeEventHandler | Default tree event handler. | |
TreeImageLoader | Default image loader for the tree | |
TreeModelSource | Controls tree model and visible tree nodes. | |
TreeNode | Default component for rendering a node for the DEPRECATED_Tree | Deprecated |
TreeNodeLoader | Default tree node loader with TreeDataProvider implementation. |
|
TreeRenderer | Default component for rendering tree. | Beta |
TypeConverter | Type Converter base class. | |
TypeConverterManager | Manages Type Converters. | |
UiComponents | Manages the I18N service for the ui-components package. | |
UrlPropertyValueRenderer | URL property value renderer that renders the whole value as a URL without matching it | |
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 | |
VirtualizedPropertyGrid | VirtualizedPropertyGrid React component. | Beta |
WeightEditor | WeightEditor React component that is a property editor for picking a weight using a WeightPickerButton component | Beta |
WeightPickerButton | WeightPickerButton component | Beta |
WeightPropertyEditor | Weight Property Editor registered for the "number" type name and "weight-picker" editor name. | Beta |
Constants
Name | Description | |
---|---|---|
DEFAULT_LINKS_HANDLER | Default link handler used for handling records, | Beta |
ItemStyleProvider | Style provider for stylable items like CellItem and TreeNodeItem | |
TableRowStyleProvider | Style provider for table rows | |
ToolbarButtonItem | Toolbar item component. | Beta |
TreeNodeRenderer | Default component for rendering tree node. | Beta |
TreeRendererContextConsumer | ||
TreeRendererContextProvider |
Enumerations
Name | Description | |
---|---|---|
BeInspireTreeEvent | Enum containing all events that may be emitted by BeInspireTree | Deprecated |
BreadcrumbMode | Enum for Breadcrumb Mode | Beta |
CompositeFilterType | Logical operator for composite filterer. | Beta |
CubeNavigationHitBoxX | ||
CubeNavigationHitBoxY | ||
CubeNavigationHitBoxZ | ||
Direction | Available directions. | Beta |
DropEffects | Enum for different DropEffects. | Beta |
DropStatus | Enum for status of current drag/drop item | Beta |
FilterCompositionLogicalOperator | Logical operator used for filter descriptor composition | |
FilteredType | Enumeration of possible component filtered types | Beta |
FilteringInputStatus | Enumeration of possible component contexts | Beta |
FilterOperator | Operator used in FilterDescriptor | |
FilterRenderer | Filter Renderer for a Table column | |
FlatGridItemType | Types of FlatGridItems for differentiating what property FlatGridItem is wrapping. | 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 | |
StandardEditorNames | Standard Editor Names for property editors. | Deprecated |
StandardTypeConverterTypeNames | StandardTypeConverterTypeNames. | Beta |
StandardTypeNames | Standard Type Names for converters and editors. | Beta |
TableSelectionTarget | Specifies table selection target. | |
TimelineDateDisplay | Determines if data displayed to use is the actual date or the amount of time elapsed since project start. | |
TimelinePausePlayAction | Actions for Pause/Play event | |
TimelineScale | The timeline scale. | |
ToolbarOpacitySetting | Enumeration of Toolbar Opacity setting. | Beta |
ToolbarPanelAlignment | Available alignment modes of ToolbarWithOverflow panels. | Beta |
Global Functions
Name | Description | |
---|---|---|
adjustDateToTimezone | Adjust a Date object to show time in one time zone as if it is in the local time zone. | |
BeDragDropContext | Context component for DragDrop API. | Beta |
ColorPickerButton | ColorPickerButton component | Beta |
ColorPickerDialog | Color Picker Dialog to use as modal dialog. | Beta |
ColorPickerPanel | Color Picker Dialog to use as modal dialog. | Beta |
ColorPickerPopup | ColorPickerButton component | Beta |
ColorSwatch | ColorSwatch Functional component displays a color swatch in a button | Beta |
ControlledSelectableContent | A fully-controlled component that accepts a list of child components with ids and labels and | Beta |
ControlledTree | React tree component which rendering is fully controlled from outside. | |
DEPRECATED_withTreeDragDrop | A HOC component that adds drag and drop functionality to the supplied tree component. | Beta |
from | Helper method that creates an Observable from Iterable or Promise. | |
hasChildren | Determines whether node has children | |
hasFlag | Determines if a SelectionMode is active | Deprecated |
hasLinks | Returns true if property record has an anchor tag | Deprecated |
hasSelectionModeFlag | Determines if a SelectionMode is active | |
HighlightedText | Highlighted text | Beta |
HueSlider | HueSlider component used to set the hue value. | Beta |
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 | |
isTreeModelNodePlaceholder | Checks if object is TreeModelNodePlaceholder | |
isTreeModelRootNode | Checks if object is TreeModelRootNode | |
matchLinks | Returns a list of links from a text | |
ParsedInput | Generic Input component that requires formatting and parsing functions to be passed in as props. | Beta |
PopupItem | Popup toolbar item that displays a panel | Beta |
PopupItemWithDrag | Expandable Group button Item | Beta |
QuantityInput | Input control that allows users to input a quantity and show the formatted string that represents the value. | Beta |
QuantityNumberInput | The QuantityNumberInput component accepts input for quantity values. | Beta |
renderLinks | Renders anchor tag by wrapping or splitting provided text | |
SaturationPicker | SaturationPicker component used to set the saturation value. | Beta |
SelectableContent | An uncontrolled component that accepts a list of child components with ids and labels and | Beta |
toDateString | Format a date in a display string, optionally converting to time zone, if specified by timeZoneOffset | |
Toolbar | Component that displays tool settings as a bar across the top of the content view. | Beta |
ToolbarWithOverflow | Component that displays tool settings as a bar across the top of the content view. | Beta |
toTimeString | Format the time included in a date, optionally converting to time zone, if specified | |
TreeNodeEditor | React component for displaying tree node editor | Beta |
TreeNodeIcon | React component that renders tree node icons | Deprecated |
useAsyncValue | Custom hook for working with possibly async values. | Beta |
useDragInteraction | Hook used on expandable item that require drag or long press to open | |
usePagedTreeNodeLoader | Custom hook which creates a paging nodes' loader using the supplied data provider and model source. | Beta |
usePropertyData | Custom hook that gets propertyData from data provider and subscribes to further data changes. | Beta |
usePropertyGridEventHandler | Custom hook that creates memoized version of PropertyGridEventHandler that modifies given modelSource | Beta |
usePropertyGridModel | Custom hook that automatically listens and retrieves latest model from model source | Beta |
usePropertyGridModelSource | Custom hook that creates a PropertyGridModelSource and subscribes it to data updates from the data provider. | Beta |
useTreeEventsHandler | Custom hook which creates and takes care of disposing a TreeEventsHandler. | |
useTreeModelSource | Custom hook which creates a TreeModelSource . |
|
useTreeNodeLoader | Custom hook which creates a nodes' loader using the supplied data provider and model source. | |
useTreeRendererContext | ||
useVisibleTreeNodes | Custom hook which returns a flat list of visible nodes from given TreeModelSource and subscribes |
|
VirtualizedPropertyGridWithDataProvider | VirtualizedPropertyGrid React Component which takes dataProvider and | 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 |
Interfaces
Name | Description | |
---|---|---|
ActionButtonListProps | Properties of ActionButtonList React component | Beta |
ActionButtonRendererProps | Properties of ActionButtonRenderer | Beta |
ActiveMatchInfo | Properties for identifying an active highlight on a node in a tree. | |
AlphaSliderProps | Properties for the AlphaSlider React component | Beta |
Asynchronous Error Message returned as part of AsyncValueProcessingResult | Beta | |
AsyncValueProcessingResult | Asynchronous Value Process Result | Beta |
BeInspireTreeDataProviderInterface | Signature for BeInspireTree data provider | Deprecated |
BeInspireTreeNode | Type definition for all BeInspireTree nodes | Deprecated |
BeInspireTreeNodeConfig | Be alias for Inspire.NodeConfig | Deprecated |
BeInspireTreeNodeITree | Be alias for Inspire.NodeConfig.ITree | Deprecated |
BeInspireTreeNodePayloadConfig | Data structure for BeInspireTreeNodeConfig with our injected props | Deprecated |
BeInspireTreeNodes | Definition of a list of BeInspireTreeNode with some additional filtering methods | Deprecated |
BeInspireTreeProps | Configuration properties for BeInspireTree | Deprecated |
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 |
CategorizedPropertyItem | Data structure which describes methods and properties present on immutable CategorizedPropertyItem objects | Beta |
CategoryRecordsDict | Category name to PropertyRecord[] key pair interface used to describe which records belong to which category. | Beta |
CellItem | Cell definition provided to Table. | |
CellProps | Properties for a Table cell | |
CheckBoxInfo | Immutable data structure that describes checkbox info. | |
CheckboxStateChange | Data structure that describes checkbox state change. | |
ColorPickerDialogProps | Properties for the ColorPickerDialog React component | Beta |
ColorPickerPanelProps | Properties for the ColorPickerPanel React component | Beta |
ColorPickerPopupProps | Properties for the ColorPickerPopup React component | Beta |
ColorPickerProps | Properties for the ColorPickerButton React component | Beta |
ColorSwatchProps | Properties for the ColorSwatch React component | Beta |
ColumnDescription | Column definition provided to Table. | |
ColumnFilterDescriptor | Represents a column filter descriptor associated with a specific column. | |
CommonPropertyGridProps | Common Property Grid Props to be used by Property Grid Variants | |
CompletionObserver | CompletionObserver interface compatible with rxjs | |
CompositeFilterDescriptor | Represents a composite filtering abstraction which has a collection of | |
CompositeFilterDescriptorCollection | Collection of FilterDescriptor objects composed together by a logical operator. | |
ControlledSelectableContentProps | ControlledSelectableContent component properties | Beta |
ControlledTreeProps | Properties for ControlledTree | |
CubeNavigationAidProps | Properties for the CubeNavigationAid component | |
CubeRotationChangeEventArgs | Arguments for CubeRotationChangeEvent | |
CustomToolbarItem | Describes the data needed to insert a custom framework-specific button into an ToolbarWithOverflow. | Beta |
DataController | DataControllers can be implemented per typename to validate and commit values. | Beta |
DelayLoadedTreeNodeItem | A TreeNodeItem for delay-loaded trees | |
DEPRECATED_FilteringInputProps | FilteringInput React Component properties | Deprecated |
DistinctValuesFilterDescriptor | Represents the distinct filter descriptor of a column filter descriptor. | |
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 |
DrawingNavigationAidProps | Properties for the DrawingNavigationAid 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 EditableTreeProps.Tree that has cell editing enabled | Beta |
EditorContainerProps | EditorContainer React component properties | Beta |
ErrorObserver | ErrorObserver interface compatible with rxjs | |
ExtendedTreeNodeRendererProps | Extended properties for TreeNodeRenderer. | Beta |
FieldFilterDescriptor | Represents the field filter descriptor of a column filter descriptor. | |
FilterableColumn | Represents a column that is filterable. | |
FilterableTable | FilterableTable contains the properties and methods provided by a filterable Table. | |
FilterDescriptor | A filtering abstraction that knows how to create predicate filtering expression. | |
FilteredPropertyData | Data returned by FilteringPropertyDataProvider | Beta |
FlatGridItemBase | Base immutable data structure defining common methods and properties for categories and categorized properties | Beta |
GridCategoryItem | Data structure which describes methods and properties present on immutable GridCategoryItem | Beta |
HighlightableTreeNodeProps | Properties for a highlightable TreeNode | |
HighlightableTreeProps | Properties for highlighting nodes in a tree. | |
HighlightedTextProps | Properties of HighlightedText | Beta |
HighlightInfo | Item highlight info used for identification of a specific highlight in an item | Beta |
HighlightingComponentProps | Properties used for highlighting parts in item by given text and actively highlighting one highlight in a distinct item specified in activeHighlight |
Beta |
HueSliderProps | Properties for the HueSlider React component | Beta |
IImageLoader | Interface for an image loader. | |
ImmediatelyLoadedTreeNodeItem | A TreeNodeItem for immediately loaded trees | |
IMutableCategorizedPropertyItem | Data structure which describes methods and properties to be held by Mutable CategorizedPropertyItems | Beta |
IMutableFlatPropertyGridItem | Base mutable data structure defining common methods and properties for both CategorizedProperties and GridCategoryItems | Beta |
IMutableGridCategoryItem | Data structure which describes methods and properties to be held by Mutable GridCategoryItems | Beta |
IMutableGridItemFactory | IMutableGridItemFactory interface for creating MutableGridItem objects | Beta |
IMutablePropertyGridModel | PropertyGridModel interface for working with mutable FlatGridItems | Beta |
IPropertyDataFilterer | Interface to be implemented by Property Data Filter classes | Beta |
IPropertyDataProvider | An interface for property data provider which returns | |
IPropertyGridEventHandler | Handles events and changes on PropertyGridModel data. | Beta |
IPropertyGridModel | PropertyGridModel interface for working with immutable FlatGridItems | Beta |
IPropertyGridModelSource | Beta | |
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. | |
ITreeNodeLoaderWithProvider | Tree node loader which uses TreeDataProvider to load nodes. |
|
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. | |
LoadedNodeHierarchyItem | Data structure that describes one loaded hierarchy item. | |
MilestoneRange | A range of time which can be used to focus in on activities scheduled around a milestone. | |
MutableCheckBoxInfo | Mutable data structure that describes checkbox info. | |
MutableTableDataProvider | MutableTableDataProvider provides mutation methods for data in the Table. | |
MutableTreeDataProvider | MutableTreeDataProvider provides manipulation processing for the Tree. | Beta |
MutableTreeModelNode | Mutable data structure that describes tree node. | |
NEW_FilteringInputProps | FilteringInput React Component properties | |
NextObserver | NextObserver interface compatible with rxjs | |
NodeCheckboxProps | Properties for Checkbox in TreeNode | Deprecated |
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 | |
OperatorProcessor | Operators for all filterable types | |
OperatorValueFilterDescriptor | An abstraction for all filter descriptors that have an operator and a value | |
PageOptions | Paging options. | |
ParsedInputProps | Props for ParsedInput control | Beta |
PlaybackSettings | Playback Settings. | |
PopupItemProps | Properties of PopupItem component. | Beta |
PopupItemWithDragProps | Properties of PopupItem component. | Beta |
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 | |
PropertyCategoryRendererProps | Props that property category renderer receives. | Beta |
PropertyData | Interface for property data provided to the PropertyGrid React component. | |
PropertyDataFilterResult | Data structure for storing IPropertyDataFilterer matching results | Beta |
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 | Deprecated |
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 | |
QuantityNumberInputProps | Properties for the QuantityNumberInput component | Beta |
QuantityProps | Props for QuantityInput control | Beta |
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 |
SelectableContentDefinition | A definition for content displayed in ControlledSelectableContent and | Beta |
SelectableContentProps | SelectableContent component properties | 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 | |
Subscription | Subscription interface compatible with rxjs | |
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. | |
TableDistinctValue | Distinct Value for Table filtering purposes | |
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 | |
ThemedEnumEditorProps | Properties for EnumEditor component | Beta |
TimelineComponentProps | TimelineComponentProps configure the timeline | |
TimelineDataProvider | Interface for a timeline data provider class | |
TimelineMenuItemProps | TimelineMenuItemProps specifies playback speed entries in the Timeline's ContextMenu | |
TimelinePausePlayArgs | Args for event to pause or play the timeline component | |
ToolbarButtonItemProps | Properties of ToolbarButtonItem component. | Beta |
ToolbarProps | Properties of Toolbar component. | Beta |
ToolbarWithOverflowProps | Properties of ToolbarWithOverflow component. | Beta |
TreeActions | Tree actions that can be performed on tree. | |
TreeCellUpdatedArgs | Arguments for the Tree Cell Updated event callback | Beta |
TreeCheckboxStateChangeEventArgs | Data structure that describes tree checkbox state change event payload. | |
TreeDragDropProps | Props that are injected to the HOC component. | Beta |
TreeEditingParams | Params used for tree node editing. | |
TreeEventHandlerParams | Data structure that describes tree event handler params. | |
TreeEvents | Tree events that can occur while interacting with tree. | |
TreeModel | Data structure that describes tree model. | |
TreeModelChanges | Data structure that describes changes which happened to the tree model | |
TreeModelNode | Immutable data structure that describes tree node. | |
TreeModelNodeEditingInfo | Data structure that holds callbacks used for tree node editing. | |
TreeModelNodeInput | Data structure that describes input used to create tree node. | |
TreeModelNodePlaceholder | Data structure that describes tree node placeholder. | |
TreeModelRootNode | Data structure that describes tree root node. | |
TreeNodeEditorProps | Properties for TreeNodeEditor component | Beta |
TreeNodeEventArgs | Data structure that describes tree node event payload. | |
TreeNodeIconProps | Properties for TreeNodeIcon React component | Deprecated |
TreeNodeItem | A node item which can be displayed in a tree. | |
TreeNodeLoadResult | Data structure that describes node load result | |
TreeNodeProps | Properties for TreeNode React component | Deprecated |
TreeNodeRendererProps | Properties for TreeNodeRenderer. | |
TreeProps | Properties for the DEPRECATED_Tree component | Deprecated |
TreeRendererAttributes | Attributes found on TreeRenderer component | |
TreeRendererContext | Context of TreeRenderer component. | Beta |
TreeRendererProps | Properties for TreeRenderer component. | |
TreeSelectionChange | Data structure that describes tree selection change. | |
TreeSelectionModificationEventArgs | Data structure that describes tree selection modification event payload. | |
TreeSelectionReplacementEventArgs | Data structure that describes tree selection replacement event payload. | |
TypeEditor | Interface implemented by React based type editors | Beta |
Unsubscribable | Unsubscribable interface compatible with rxjs | |
ViewClassFullNameChangedEventArgs | Arguments for ViewClassFullNameChangedEvent | |
ViewIdChangedEventArgs | Arguments for ViewIdChangedEvent | |
ViewportProps | Properties for ViewportComponent component. | |
ViewRotationChangeEventArgs | Arguments for ViewRotationChangeEvent | |
VirtualizedPropertyGridContext | Context of the surrounding VirtualizedPropertyGrid component. | Beta |
VirtualizedPropertyGridProps | Properties for VirtualizedPropertyGrid React component | Beta |
VirtualizedPropertyGridWithDataProviderProps | Properties for VirtualizedPropertyGridWithDataProvider React component | Beta |
VisibleTreeNodes | Data structure that describes set of visible tree nodes as a flat list. | |
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 | ||
AnimationFractionChangeHandler | ||
BeInspireTreeDataProvider | Type definition for all BeInspireTree data providers | Deprecated |
BeInspireTreeDataProviderMethod | ||
BeInspireTreeDataProviderPromise | A Promise for DataProviderRaw | Deprecated |
BeInspireTreeDataProviderRaw | Array of tree node data elements | Deprecated |
BeInspireTreeRenderer | ||
BreadcrumbDetailsDragDropType | Type for drag and drop, | Beta |
CategorizedPropertyTypes | Type which extracts FlatGridItemTypes relevant for working with CategorizedProperties | Beta |
FilteringInputProps | Props type for FilteringInput | |
FlatGridItem | Type which describes immutable GridCategoryItem or CategorizedPropertyItem | Beta |
GetCurrentlyEditedNode | ||
Image | Image data returned by an IImageLoader | |
ImageFileFormat | Type of raw image format | |
ImageSourceType | Type of loaded image source: | |
IMutableFlatGridItem | Type which describes mutable GridCategoryItem or CategorizedProperty | Beta |
MapPayloadToInspireNodeCallback | ||
Observer | Observer interface compatible with rxjs | |
OnItemsDeselectedCallback | ||
OnItemsSelectedCallback | ||
OnSelectionChanged | ||
PlaybackSettingsChangeHandler | ||
PropertyCategoryRenderer | ||
PropertyDataChangesListener | ||
PropertyFilterChangesListener | ||
PropertyGridModelChangeListener | ||
SetCurrentlyEditedNode | ||
ShowHideID | Union type for all possible ShowHide IDs | |
SimpleTreeDataProviderHierarchy | Used by SimpleTreeDataProvider. | |
StepFunctionProp | Step function prototype for NumberInput component | Beta |
TableDataChangesListener | ||
TableDragDropType | Type for DragDrop drag item | Beta |
TimelineMenuItemOption | TimelineMenuItemOption: specifies how the app wants the timeline speeds to be installed on the TimelineComponent's ContextMenu | |
ToolbarItem | Describes toolbar item. | Beta |
TreeDataChangesListener | ||
TreeDataProvider | Type definition for all BeInspireTree data providers | |
TreeDataProviderMethod | ||
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. | |
TreeNodeEditorRenderer | ||
TreeNodeItemData | Type definition of tree node item data. | |
ViewStateProp | Type for a ViewState prop |
Last Updated: 11 June, 2024