API Reference

Quick reference tables for all public classes in the Dashboard Editor package.

Layout Model

Class	Description	Reference
`DashboardLayout`	Top-level container: rows, version, metadata. Max 25 rows.	Layout API
`DashboardRow`	Horizontal container for 1-6 columns. Flex-based sizing.	Layout API
`DashboardColumn`	Slot within a row that holds zero or one component.	Layout API
`ComponentInstance`	Component instance with key, title, and PropertyCollection.	Layout API
`DashboardLayoutConstants`	Central constants for spacing, flex, and sizing.	Layout API

Class	Description	Reference
`ComponentDescriptor`	Declarative component definition with callbacks.	Components API
`DashboardComponentConfiguration`	Abstract base class for components (prefer ComponentDescriptor).	Components API
`ComponentCategory`	Metadata for organizing components in the palette.	Components API
`DashboardDescriptor`	Named group of components for a product/domain.	Components API
`DashboardEditorRegistry`	Scoped registry for descriptors and components.	Components API

Class	Description	Reference
`DashboardEngine`	MobX-based state kernel with command execution.	Engine API
`DashboardEngineApi`	Forward declaration interface for extensions.	Engine API
`DashboardCommand`	Abstract reversible command (execute/undo).	Engine API
`CommandHistory`	Undo/redo stack with configurable max size.	Engine API
`DashboardEditorController`	Editor facade composing engine with extensions.	Engine API

Class	Description	Reference
`DashboardEvent`	Abstract base for all engine events.	Engine API
`DashboardLayoutChanged`	Emitted when layout is updated (any reason).	Engine API
`DashboardCommandExecuted`	Emitted when a command is first executed.	Engine API
`DashboardCommandUndone`	Emitted when a command is undone.	Engine API
`DashboardCommandRedone`	Emitted when a command is redone.	Engine API
`DashboardBatchStarted`	Emitted when a batch operation begins.	Engine API
`DashboardBatchEnded`	Emitted when a batch operation ends.	Engine API

Class	ID	Description	Reference
`DashboardExtension`	--	Abstract extension interface.	Engine API
`DashboardHistoryExtension`	`dashboard-history`	Undo/redo via CommandHistory.	Engine API
`DashboardPersistenceExtension`	`dashboard-persistence`	Layout JSON serialization, direct load, and dirty tracking.	Engine API
`DashboardSelectionExtension`	`dashboard-selection`	Cell, row, and panel selection state.	Engine API
`DashboardAnalyticsExtension`	`dashboard-analytics`	Analytics tracking for editor actions.	Engine API

Command	Description
`AddRowCommand`	Add a row at a position
`RemoveRowCommand`	Remove a row
`ReorderRowsCommand`	Move a row to a new position
`SplitRowCommand`	Replace columns with N equal columns
`UpdateRowTitleCommand`	Change or clear row title
`UpdateRowHeightCommand`	Set row height in pixels
`UpdateRowViewportFractionCommand`	Set viewport-relative row height
`AddColumnCommand`	Add an empty column to a row
`RemoveColumnCommand`	Remove a column from a row
`ReorderColumnsCommand`	Reorder columns within a row
`UpdateColumnFlexCommand`	Change a single column's flex
`ResizeAdjacentColumnsCommand`	Resize two adjacent columns together
`UpdateRowFlexCommand`	Update flex for all columns in a row
`AddComponentCommand`	Place a component in a column
`RemoveComponentCommand`	Clear a column's component
`ReplaceComponentCommand`	Replace one component with another
`SwapComponentsCommand`	Swap components between two columns
`DuplicateComponentCommand`	Copy component to nearest empty slot
`UpdateComponentConfigCommand`	Update a component's properties
`UpdateDashboardMetadataCommand`	Patch dashboard metadata

Class	Description
`ChartDataSource`	Abstract interface for data fetching
`ChartDataSourceRegistry`	Singleton registry for static, API, and app-provided chart sources
`ApiChartDataSource`	HTTP data source with nested JSON support
`StaticChartDataSource`	Static JSON data source for charts
`DataPoint`	Universal data model (label, value, series)
`ChartData`	Data + chart type with validation
`ChartType`	Enum: pie, donut, bar, stackedBar, groupedBar, line, multiLine, area, sparkline, gauge
`ChartFieldMapping`	Maps source fields to chart dimensions
`ChartFieldProvider`	Interface for field suggestions
`ChartFieldProviderRegistry`	Optional singleton registry for chart field suggestions
`EntityTypeProviderRegistry`	Optional singleton registry for entity type dropdowns
`BaseChartRenderer`	Abstract renderer with color palette and legend
`ChartRendererFactory`	Singleton factory for renderer lookup
`DashboardDataStore`	MobX store for data fetching and polling
`ApiDataSource`	REST data source using vyuh.network

Class	Description
`DashboardEditor`	Core editor widget with canvas, palette, and config panels
`DashboardDesignerTab`	Plug-and-play editor shell that wraps DashboardEditor
`DashboardView`	Read-only runtime dashboard renderer
`DashboardEditorController`	Facade composing engine, extensions, and editor state
`PaletteVisibilityController`	Controls floating palette collapsed/pinned state

Alias	Signature
`ComponentBuilder`	`Widget Function(BuildContext, PropertyCollection)`
`PropertiesFactory`	`PropertyCollection Function()`
`ConfigPanelBuilder`	`Widget? Function(BuildContext, PropertyCollection)`
`ThumbnailBuilder`	`Widget? Function(BuildContext)`