Glossary
Key terms used throughout the Dashboard Editor documentation.
| Term | Definition |
|---|---|
| Canvas | The main editing area where dashboard rows and columns are displayed and manipulated. |
| Cell | A column within a row, identified by a row ID and column ID pair. A cell can be empty or hold one component. |
| ChartData | A typed data container pairing a list of DataPoint instances with a ChartType. Validates data on construction. |
| ChartType | An enum defining the kind of chart to render: pie, donut, bar, stackedBar, groupedBar, line, multiLine, area, sparkline, gauge. |
| Column | A DashboardColumn instance within a row. Uses a flex factor for relative width sizing. Holds zero or one component. |
| Command | A DashboardCommand instance that encapsulates a reversible layout mutation. Implements execute() and undo(). |
| CommandHistory | A stack-based manager that records executed commands and supports undo/redo traversal. |
| Component | A registered DashboardComponentConfiguration (typically a ComponentDescriptor) that defines how a widget looks and behaves in the dashboard. |
| ComponentDescriptor | A declarative, composition-based component definition. Accepts properties factory, render callback, config panel, and thumbnail as constructor parameters. |
| ComponentCategory | Metadata for organizing components in the editor palette, with an ID, display name, icon, and sort order. |
| Config Panel | The right-side panel in the editor that displays property editors for the selected component. |
| DashboardDescriptor | A named group of components belonging to a specific product or domain (e.g., 'LMS', 'IPQC'). |
| DashboardEditorController | A facade that composes the DashboardEngine with history, persistence, selection, and analytics extensions. |
| DashboardEditorRegistry | A scoped registry created from DashboardDescriptor instances and passed into controllers, engines, views, and layout deserialization. |
| DashboardEngine | The core MobX-based state kernel that owns the reactive layout, executes commands, and emits events. |
| DashboardEvent | A structured event emitted by the engine (layout changed, command executed/undone/redone, batch start/end). |
| DashboardExtension | A pluggable module that observes engine events and can maintain its own state. Built-in extensions: history, persistence, selection, analytics. |
| DashboardLayout | The top-level model: a versioned container of rows with optional metadata. Serializable to/from JSON. |
| DataPoint | A universal data model with three dimensions: label (category), value (numeric), series (grouping). |
| Dirty | A flag tracked by the persistence extension indicating that the layout has unsaved changes since the last save or load. |
| Extension | See DashboardExtension. |
| Flex | An integer value (1-6) assigned to each column, determining its proportional width within a row. All columns in a row sum to 6. |
| Layout | See DashboardLayout. |
| Palette | The component picker in the editor UI, organized by category, from which users drag components into cells. |
| PropertyCollection | A type-safe, MobX-observable collection of properties from the Property System. Used for component configuration. |
| Row | A DashboardRow instance that contains 1-6 columns. Rows stack vertically and are ordered by their order field. |
| Component Instance | A ComponentInstance placed in a column. References a registered component by key and holds a PropertyCollection for configuration. |
| Slot | Synonym for cell -- a position in the grid identified by row ID and column ID. |
| Viewport Fraction | A sizing mode where row height is expressed as a fraction of the viewport height (e.g., 0.5 = 50% of screen). |
Next Steps
- API Reference -- Quick reference tables
- Architecture -- System design overview
- Getting Started -- Build your first dashboard