Expand description
Orbital DataTable — interactive tabular data product for the Orbital component library.
Modules§
- preview
- Preview registration for DataTable documentation pages and fixtures.
Structs§
- Aggregation
Model - Aggregation model mapping field keys to functions.
- Aggregation
Rule - One column aggregation rule.
- Cell
Coord - A single cell address in the visible grid.
- Cell
Selection - Spreadsheet-style cell range selection (anchor + focus).
- Chart
Binding - Live chart-data context for [
DataTableFeatures::CHARTS_INTEGRATION]. - Column
Drag Ghost - Floating preview shown while drag-reordering a column.
- Data
Record - One row of typed values, addressable by field key.
- Data
Schema - Schema describing the fields in a
crate::Dataset. - Data
Table Column Def - Column definition for
crate::DataTable. - Data
Table Column Group Def - Nested column group for multi-row headers.
- Data
Table Context - Context shared by
crate::DataTableand composable subcomponents. - Data
Table Empty View - Props for the
DataTableEmptyViewslot. - Data
Table Empty View Builder - Builder for
DataTableEmptyViewinstances. - Data
Table Events - Event callbacks fired when
crate::DataTablestate changes or the user interacts with rows/cells. - Data
Table Features - Optional capabilities enabled on
crate::DataTable. - Data
Table Filter - Structured filter model for the filter panel and controlled
filterprop. - Data
Table Footer Slot - Props for the
DataTableFooterSlotslot. - Data
Table Footer Slot Builder - Builder for
DataTableFooterSlotinstances. - Data
Table Handle - Imperative handle for programmatic DataTable actions.
- Data
Table Header Chrome Config - Per-column-header chrome toggles (menu, inline filter button, hide-column UX).
- Data
Table Initial State - One-time initial state applied when
crate::DataTablemounts. - Data
Table Loading View - Props for the
DataTableLoadingViewslot. - Data
Table Loading View Builder - Builder for
DataTableLoadingViewinstances. - Data
Table Locale - Localized strings for DataTable chrome (footer, overlays, infinite scroll).
- Data
Table NoResults View - Props for the
DataTableNoResultsViewslot. - Data
Table NoResults View Builder - Builder for
DataTableNoResultsViewinstances. - Data
Table Pivot Model - Pivot configuration: row dimensions, column dimensions, and value measures.
- Data
Table Preview Props - Props for the
DataTablePreviewcomponent. - Data
Table Props - Props for the
DataTablecomponent. - Data
Table Provider Props - Props for the
DataTableProvidercomponent. - Data
Table RowDetail - Props for the
DataTableRowDetailslot. - Data
Table RowDetail Builder - Builder for
DataTableRowDetailinstances. - Data
Table RowGrouping - Row grouping configuration (group-by column field keys, in order).
- Data
Table RowModel - Row model for
crate::DataTable. - Data
Table Slots - Internal slot content consumed by toolbar, footer, overlay, and row-detail subcomponents.
- Data
Table Sort - Sort model (multi-column when
crate::DataTableFeatures::MULTI_COLUMN_SORTis enabled). - Data
Table State - Full table state snapshot for export/restore.
- Data
Table Table State - Reactive table state shared by decomposed sub-components.
- Data
Table Table State Provider Props - Props for the
DataTableTableStateProvidercomponent. - Data
Table Toolbar Config - Built-in toolbar control visibility when no custom
crate::DataTableToolbarSlotis provided. - Data
Table Toolbar Slot - Props for the
DataTableToolbarSlotslot. - Data
Table Toolbar Slot Builder - Builder for
DataTableToolbarSlotinstances. - Dataset
- The shared shape. Tables render it; charts build series by field key.
- Edit
Cell Props - Props passed to custom column
DataTableColumnDef::edit_viewrenderers. - Edit
Field Draft - Draft state for a single editable field while a session is active.
- Edit
History - Undo/redo stacks for inline edits (gated by
super::DataTableFeatures::UNDO_REDO). - Edit
History Entry - One reversible cell edit pushed onto the undo stack.
- Edit
Session Store - Runtime edit session storage (draft signals live in the side map).
- Field
Def - Shared field descriptor — binding key for table columns and chart series.
- Filter
Rule - Single column filter rule.
- List
View Config - List view card layout configuration.
- Normalized
Cell Range - Normalized row/column index bounds into the visible grid.
- Pagination
State - Pagination state (0-based page index internally).
- Pinned
Columns State - Pinned column sides.
- Pinned
Rows State - Sticky top/bottom row ids (resolved via
crate::GetRowIdwhen set). - RowDrag
Ghost - Floating preview shown while drag-reordering a row.
- Serialized
State - JSON-serialized
DataTableStateenvelope for persistence or clipboard round-trip. - Server
Fetch Policy - Policy for server-driven
DataTableSource::Serverfetches. - Sort
Rule - Sort rule for a single column.
- Tree
RowMeta - Derived metadata for a tree row used by the grouping column.
Enums§
- Aggregation
Fn - Built-in aggregate functions for numeric and count summaries.
- Aggregation
Position - Where aggregate values are rendered.
- Cell
Align - Horizontal cell alignment.
- Column
Type - Column type — drives default sort and filter operators.
- Column
Width - Column width mode.
- Data
Table Column Group Child - Child of a column group — nested group or leaf column reference.
- Data
Table RowKind - Display row kind for tree, grouping, and aggregation chrome rows.
- Data
Table Selection Mode - Row selection mode.
- Data
Table Source - Data source: in-memory records or server fetcher.
- Data
Table Source Kind - Whether the table reads from client records or a server fetcher.
- Data
Type - Column/field data type descriptor.
- Data
Value - Typed cell value — replaces stringly-typed
HashMap<String, String>. - Edit
Mode - Scope for inline editing: one cell at a time or all editable cells in a row.
- Edit
Session - Active inline edit session for a row.
- Filter
Logic - How multiple filter rules combine in the filter panel.
- Filter
Operator - Filter operator for typed
DataValuecomparisons. - Overlay
State - Overlay state for loading, empty, and no-results views.
- Pagination
Display Format - How the footer labels paged row counts.
- Paging
Mode - Pagination presentation mode.
- PinSide
- Sticky pin side for a column.
Statics§
- DATATABLEADVANCEDDOC_
PREVIEW_ REGISTRATION - DATATABLECHARTSINTEGRATIONDOC_
PREVIEW_ REGISTRATION - DATATABLECOLUMNDEFINITIONDOC_
PREVIEW_ REGISTRATION - DATATABLECOLUMNSDOC_
PREVIEW_ REGISTRATION - DATATABLEDATASOURCEDOC_
PREVIEW_ REGISTRATION - DATATABLEEDITINGDOC_
PREVIEW_ REGISTRATION - DATATABLEEXPORTDOC_
PREVIEW_ REGISTRATION - DATATABLERENDERINGDOC_
PREVIEW_ REGISTRATION - DATATABLEROWSDOC_
PREVIEW_ REGISTRATION - DATATABLESELECTIONDOC_
PREVIEW_ REGISTRATION - DATATABLESLOTSDOC_
PREVIEW_ REGISTRATION - DATATABLESORTINGFILTERINGDOC_
PREVIEW_ REGISTRATION - DATATABLESTATEDOC_
PREVIEW_ REGISTRATION - DATATABLE_
PREVIEW_ REGISTRATION
Functions§
- Data
Table - Presents sortable, filterable tabular data with built-in toolbar, selection, and pagination.
- Data
Table Body - Body listing processed rows (optionally virtualized).
- Data
Table Footer - Footer with row count and pagination bar.
- Data
Table Header - Header row(s) with optional selection column, groups, and sortable headers.
- Data
Table Header Cell - Single header cell with sort indicator, menu, resize handle, and pin styles.
- Data
Table Overlays - Loading, empty, and no-results overlay slots.
- Data
Table Pagination Bar - Pagination control wrapper (1-indexed UI, 0-indexed internal page / offset).
- Data
Table Preview - Data
Table Provider - Required Props
- Data
Table Quick Search - Quick search bound to table filter state (client and server sources).
- Data
Table Root - Internal shell: provider, state, processed rows memo, density class.
- Data
Table Table State Provider - Provides
DataTableTableStateto custom toolbar/footer slot children. - Data
Table Toolbar - Toolbar shell for quick search, filter panel, column picker, and export.
- cell_
in_ range - Whether a cell lies inside a normalized range.
- column_
drag_ ghost_ at_ pointer - create_
column_ layout_ memo - Build a column layout memo from reactive table state inputs.
- data_
table_ cell_ view - Back-compat alias for call sites that still invoke the cell renderer as a function.
- derive_
schema_ hints - Derive suggested chart field keys from visible table columns.
- move_
column_ drag_ ghost - move_
row_ drag_ ghost - provide_
chart_ binding - Provide
ChartBindingto descendants (chart slots, dashboard panels). - range_
edge_ classes - CSS edge classes for range border rendering.
- resolve_
row_ id - Resolve a stable row id using an optional custom resolver.
- resolve_
tree_ path - Resolve tree path using optional callback.
- row_
drag_ ghost_ at_ pointer - tree_
path_ key - Build a stable path key from segments.
- use_
chart_ binding - Read the nearest
ChartBindingwhen [DataTableFeatures::CHARTS_INTEGRATION] is enabled. - use_
data_ table_ context - Read shared context from the nearest
crate::DataTable. - use_
data_ table_ table_ state - Reactive table state for custom toolbar/footer slot content.
Type Aliases§
- Aggregation
Signal - Signal-backed aggregation model.
- GetRow
Id - Optional custom row id resolver (default:
DataRecord::id). - GetTree
Path - Resolve hierarchical path segments for a row (root → leaf).
- Group
Aggregates - Inline aggregate values keyed by field (for group header rows).
- Page
Fetcher - Async fetcher for server-driven paging.
- Pivot
Signal - Signal-backed pivot model.
- RowDetail
View - Custom row detail panel body (
ROW_DETAIL). - RowGrouping
Signal - Signal-backed grouping model for reactive tables.