Skip to content

Glossary

Key terms used throughout the Dashboard Editor documentation.

TermDefinition
CanvasThe main editing area where dashboard rows and columns are displayed and manipulated.
CellA column within a row, identified by a row ID and column ID pair. A cell can be empty or hold one component.
ChartDataA typed data container pairing a list of DataPoint instances with a ChartType. Validates data on construction.
ChartTypeAn enum defining the kind of chart to render: pie, donut, bar, stackedBar, groupedBar, line, multiLine, area, sparkline, gauge.
ColumnA DashboardColumn instance within a row. Uses a flex factor for relative width sizing. Holds zero or one component.
CommandA DashboardCommand instance that encapsulates a reversible layout mutation. Implements execute() and undo().
CommandHistoryA stack-based manager that records executed commands and supports undo/redo traversal.
ComponentA registered DashboardComponentConfiguration (typically a ComponentDescriptor) that defines how a widget looks and behaves in the dashboard.
ComponentDescriptorA declarative, composition-based component definition. Accepts properties factory, render callback, config panel, and thumbnail as constructor parameters.
ComponentCategoryMetadata for organizing components in the editor palette, with an ID, display name, icon, and sort order.
Config PanelThe right-side panel in the editor that displays property editors for the selected component.
DashboardDescriptorA named group of components belonging to a specific product or domain (e.g., 'LMS', 'IPQC').
DashboardEditorControllerA facade that composes the DashboardEngine with history, persistence, selection, and analytics extensions.
DashboardEditorRegistryA scoped registry created from DashboardDescriptor instances and passed into controllers, engines, views, and layout deserialization.
DashboardEngineThe core MobX-based state kernel that owns the reactive layout, executes commands, and emits events.
DashboardEventA structured event emitted by the engine (layout changed, command executed/undone/redone, batch start/end).
DashboardExtensionA pluggable module that observes engine events and can maintain its own state. Built-in extensions: history, persistence, selection, analytics.
DashboardLayoutThe top-level model: a versioned container of rows with optional metadata. Serializable to/from JSON.
DataPointA universal data model with three dimensions: label (category), value (numeric), series (grouping).
DirtyA flag tracked by the persistence extension indicating that the layout has unsaved changes since the last save or load.
ExtensionSee DashboardExtension.
FlexAn integer value (1-6) assigned to each column, determining its proportional width within a row. All columns in a row sum to 6.
LayoutSee DashboardLayout.
PaletteThe component picker in the editor UI, organized by category, from which users drag components into cells.
PropertyCollectionA type-safe, MobX-observable collection of properties from the Property System. Used for component configuration.
RowA DashboardRow instance that contains 1-6 columns. Rows stack vertically and are ordered by their order field.
Component InstanceA ComponentInstance placed in a column. References a registered component by key and holds a PropertyCollection for configuration.
SlotSynonym for cell -- a position in the grid identified by row ID and column ID.
Viewport FractionA sizing mode where row height is expressed as a fraction of the viewport height (e.g., 0.5 = 50% of screen).

Next Steps