DashboardLayoutModel

23 Sep 20251 minute to read

Interface for a class DashboardLayout

Properties

change EmitType<ChangeEventArgs>

Triggers whenever the panels positions are changed.

created EmitType<Object>

Triggers when Dashboard Layout is created.

destroyed EmitType<Object>

Triggers when Dashboard Layout is destroyed.

drag EmitType<DraggedEventArgs>

Triggers while a panel is dragged continuously.

dragStart EmitType<DragStartArgs>

Triggers when a panel is about to drag.

dragStop EmitType<DragStopArgs>

Triggers when a dragged panel is dropped.

resize EmitType<ResizeArgs>

Triggers when a panel is being resized continuously.

resizeStart EmitType<ResizeArgs>

Triggers when a panel is about to resize.

resizeStop EmitType<ResizeArgs>

Triggers when a panel resize ends.

allowDragging boolean

If allowDragging is set to true, then the DashboardLayout allows you to drag and reorder the panels.

allowFloating boolean

If allowFloating is set to true, then the DashboardLayout automatically move the panels upwards to fill the empty available
cells while dragging or resizing the panels.

allowResizing boolean

If allowResizing is set to true, then the DashboardLayout allows you to resize the panels.

cellAspectRatio number

Defines the cell aspect ratio of the panel.

cellSpacing number[]

Defines the spacing between the panels.

columns number

Defines the number of columns to be created in the DashboardLayout.

draggableHandle string

Defines the draggable handle selector which will act as dragging handler for the panels.

enableHtmlSanitizer boolean

Defines whether to allow the cross-scripting site or not.

enablePersistence boolean

Enable or disable persisting component’s state between page reloads.

enableRtl boolean

Enable or disable rendering component in right to left direction.

mediaQuery string

Defines the media query value where the dashboardlayout becomes stacked layout when the resolution meets.

panels PanelModel[]

Defines the panels property of the DashboardLayout component.

resizableHandles string[]

Defines the resizing handles directions used for resizing the panels.

showGridLines boolean

Enables or disables the grid lines for the Dashboard Layout panels.