@thatopen/ui
Classes
Class | Description |
---|---|
Button | A custom button web component for BIM applications. HTML tag: bim-button |
Checkbox | A custom checkbox web component for BIM applications. HTML tag: bim-checkbox |
ColorInput | A custom color input web component for BIM applications. HTML tag: bim-color-input |
Component | A base class for UI components that utilizes the LitElement library. Provides functionality for rendering stateless and stateful components, as well as lazy loading of elements using Intersection Observer. |
Dropdown | A custom dropdown web component for BIM applications. |
Grid | A custom grid component for web applications. |
Icon | A custom icon web component for BIM applications. HTML tag: bim-icon |
Input | A custom input web component for BIM applications. HTML tag: bim-input |
Label | A custom label web component for BIM applications. HTML tag: bim-label |
Manager | Manager class is responsible for initializing the BIM UI library, defining custom elements, and providing configuration options. |
NumberInput | A custom number input web component for BIM applications. HTML tag: bim-number-input |
Option | A custom option web component for BIM applications. HTML tag: bim-option |
Panel | A custom panel web component for BIM applications. HTML tag: bim-panel |
PanelSection | A custom panel section web component for BIM applications. HTML tag: bim-panel-section |
Selector | A custom selector web component for BIM applications. HTML tag: bim-selector |
Tab | A custom tab web component for BIM applications. HTML tag: bim-tab |
Table | A custom table web component for BIM applications. HTML tag: bim-table |
Tabs | A custom tabs web component for BIM applications. HTML tag: bim-tabs |
TextInput | A custom text input web component for BIM applications. HTML tag: bim-text-input |
Toolbar | A custom toolbar web component for BIM applications. HTML tag: bim-toolbar |
ToolbarGroup | A custom toolbar group web component for BIM applications. HTML tag: bim-toolbar-group |
ToolbarSection | A custom toolbar section web component for BIM applications. HTML tag: bim-toolbar-section |
Viewport | A custom viewport web component for BIM applications. HTML tag: bim-viewport |
Interfaces
Interface | Description |
---|---|
CellCreatedEventDetail | Represents the detail of a cell created event. |
ColumnData | Represents a column in the table. |
EntryQuery | Represents a single query condition. |
HasName | Represents an object that has a name and an optional label. |
HasValue | Represents an object that has a value and an event for value changes. |
ManagerConfig | Configuration interface for the Manager class. Defines the properties and their types that can be configured for the Manager. |
QueryGroup | Represents a group of queries with an operator. |
RowCreatedEventDetail | Represents the detail of a row created event. |
RowDeselectedEventDetail | Represents the detail of a row deselected event. |
RowSelectedEventDetail | Represents the detail of a row selected event. |
TableGroupData | Represents a group of table rows with optional children. |
TableGroupTemplate | Represents a template for rendering a group of table rows in a table. |
Type Aliases
Type alias | Description |
---|---|
ConditionFunctions | Represents a map of condition functions, where the key is a QueryCondition and the value is a function that evaluates the condition. |
GridLayoutsDefinition | Represents a collection of predefined grid layouts for the Grid component. Each layout is defined by a unique name, a grid template string, and a map of area names to HTMLElement instances. The grid template string defines the structure of the grid, and the area names correspond to the grid-area property of the HTMLElement instances. The HTMLElement instances are used to populate the grid with content. |
Query | Represents a query, which can be a single query or a group of queries. |
QueryCondition | Represents a condition used in query building. |
QueryOperators | Represents an operator used in query building. |
StatefullComponent | Represents a function that returns a TemplateResult for a stateful component. |
StatelessComponent | Represents a function that returns a TemplateResult for a stateless component. |
TableDataTransform | Represents a transformation function for table data. |
TableRowData | Represents a row of data for a table. |
TableRowTemplate | Represents a template for rendering a row of data in a table. |
Functions
Function | Description |
---|---|
getElementValue | Extracts and returns the value of an HTML element's attributes. |