Represents the Essential JS 2 React DashboardLayout Component.
<DashBoardLayoutComponent></DashBoardLayoutComponent>
boolean
If allowDragging is set to true, then the DashboardLayout allows you to drag and reorder the panels.
Defaults to true
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.
Defaults to true
boolean
If allowResizing is set to true, then the DashboardLayout allows you to resize the panels.
Defaults to false
number
Defines the cell aspect ratio of the panel.
Defaults to 1
number[]
Defines the spacing between the panels.
Defaults to [5,5]
number
Defines the number of columns to be created in the DashboardLayout.
Defaults to 1
string
Defines the draggable handle selector which will act as dragging handler for the panels.
Defaults to null
boolean
Defines whether to allow the cross-scripting site or not.
Defaults to true
boolean
Enable or disable persisting component’s state between page reloads.
Defaults to false
boolean
Enable or disable rendering component in right to left direction.
Defaults to false
string
Defines the media query value where the dashboardlayout becomes stacked layout when the resolution meets.
Defaults to ‘max-width:600px’
Defines the panels property of the DashboardLayout component.
Defaults to null
string[]
Defines the resizing handles directions used for resizing the panels.
Defaults to ‘e-south-east’
boolean
Enables or disables the grid lines for the Dashboard Layout panels.
Defaults to false
Allows to add a panel to the Dashboardlayout.
Parameter | Type | Description |
---|---|---|
panel | PanelModel |
Defines the panel element. |
Returns void
Destroys the DashboardLayout component
Returns void
Moves the panel in the DashboardLayout.
Parameter | Type | Description |
---|---|---|
id | string |
Defines the panel ID. |
row | number |
Defines the row of dashboard layout. |
col | number |
Defines the column of dashboard layout. |
Returns void
Method to update the draggable handle when draggable panel elements are bound dynamically.
Returns void
Removes all the panels from the DashboardLayout.
Returns void
Removes the panel from the DashboardLayout.
Parameter | Type | Description |
---|---|---|
id | string |
Defines the panel ID. |
Returns void
Resize the panel in the DashboardLayout.
Parameter | Type | Description |
---|---|---|
id | string |
Defines the panel ID. |
sizeX | number |
Defines the sizeX of dashboard layout. |
sizeY | number |
Defines the sizeY of dashboard layout. |
Returns void
Returns the panels object of the DashboardLayout.
Returns PanelModel[]
Allows to update a panel in the DashboardLayout.
Parameter | Type | Description |
---|---|---|
panel | PanelModel |
Defines the panel element. |
Returns void
Triggers whenever the panels positions are changed.
EmitType<Object>
Triggers when Dashboard Layout is created.
EmitType<Object>
Triggers when Dashboard Layout is destroyed.
Triggers while a panel is dragged continuously.
Triggers when a panel is about to drag.
Triggers when a dragged panel is dropped.
Triggers when a panel is being resized continuously.
Triggers when a panel is about to resize.
Triggers when a panel resize ends.