Class SfDashboardLayout

The DashboardLayout is a grid structured layout component, that helps to create a dashboard with panels. Panels hold the UI components or data to be visualized with flexible options like resize, reorder, drag-n-drop, remove and add, that allows users to easily place the panels at a desired position within the grid layout.

Inheritance
System.Object
Syncfusion.Blazor.SfBaseComponent
SfDashboardLayout
Namespace: Syncfusion.Blazor.Layouts
Assembly: Syncfusion.Blazor.dll
Syntax
public class SfDashboardLayout : SfBaseComponent

Constructors

SfDashboardLayout()

Declaration
public SfDashboardLayout()

Properties

AllowDragging

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

Declaration
public bool AllowDragging { get; set; }
Property Value
Type Description
System.Boolean

AllowFloating

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.

Declaration
public bool AllowFloating { get; set; }
Property Value
Type Description
System.Boolean

AllowResizing

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

Declaration
public bool AllowResizing { get; set; }
Property Value
Type Description
System.Boolean

CellAspectRatio

Defines the cell aspect ratio of the panel.

Declaration
public double CellAspectRatio { get; set; }
Property Value
Type Description
System.Double

CellSpacing

Defines the spacing between the panels.

Declaration
public double[] CellSpacing { get; set; }
Property Value
Type Description
System.Double[]

Columns

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

Declaration
public int Columns { get; set; }
Property Value
Type Description
System.Int32

DraggableHandle

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

Declaration
public string DraggableHandle { get; set; }
Property Value
Type Description
System.String

EnableHtmlSanitizer

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

Declaration
public bool EnableHtmlSanitizer { get; set; }
Property Value
Type Description
System.Boolean

EnablePersistence

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

Declaration
public bool EnablePersistence { get; set; }
Property Value
Type Description
System.Boolean

EnableRtl

Enable or disable rendering component in right to left direction.

Declaration
public bool EnableRtl { get; set; }
Property Value
Type Description
System.Boolean

HtmlAttributes

Used to specify an additional html attributes such as styles, class, and more to the root element.

Declaration
public Dictionary<string, object> HtmlAttributes { get; set; }
Property Value
Type Description
System.Collections.Generic.Dictionary<System.String, System.Object>

ID

Sets id attribute for the dashboard element.

Declaration
public string ID { get; set; }
Property Value
Type Description
System.String

IsAddPanelCalled

Declaration
protected bool IsAddPanelCalled { get; set; }
Property Value
Type Description
System.Boolean

MediaQuery

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

Declaration
public string MediaQuery { get; set; }
Property Value
Type Description
System.String

Panels

Defines the panels property of the DashboardLayout component.

Declaration
public List<DashboardLayoutPanel> Panels { get; set; }
Property Value
Type Description
System.Collections.Generic.List<DashboardLayoutPanel>

ResizableHandles

Defines the resizing handles directions used for resizing the panels.

Declaration
public ResizableHandle ResizableHandles { get; set; }
Property Value
Type Description
ResizableHandle

ShowGridLines

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

Declaration
public bool ShowGridLines { get; set; }
Property Value
Type Description
System.Boolean

Methods

AddPanel(PanelModel)

Allows to add a panel to the Dashboardlayout. panel - Specifies the adding panel.

Declaration
public Task AddPanel(PanelModel panel)
Parameters
Type Name Description
PanelModel panel
Returns
Type Description
System.Threading.Tasks.Task

BuildRenderTree(RenderTreeBuilder)

Declaration
protected override void BuildRenderTree(RenderTreeBuilder __builder)
Parameters
Type Name Description
Microsoft.AspNetCore.Components.Rendering.RenderTreeBuilder __builder

GetIdValues(DashboardLayoutPanel)

Declaration
protected void GetIdValues(DashboardLayoutPanel panel)
Parameters
Type Name Description
DashboardLayoutPanel panel

MovePanel(String, Int32, Int32)

Moves the panel in the DashboardLayout. idValue - Specifies the Id value of moved panel. rowValue - Specifies the Row value of moved panel colValue - Specifies the Column value of moved panel

Declaration
public Task MovePanel(string idValue, int rowValue, int colValue)
Parameters
Type Name Description
System.String idValue
System.Int32 rowValue
System.Int32 colValue
Returns
Type Description
System.Threading.Tasks.Task

MovePanelAsync(String, Int32, Int32)

Moves the panel in the DashboardLayout. idValue - Specifies the Id value of moved panel. rowValue - Specifies the Row value of moved panel colValue - Specifies the Column value of moved panel

Declaration
public Task MovePanelAsync(string idValue, int rowValue, int colValue)
Parameters
Type Name Description
System.String idValue
System.Int32 rowValue
System.Int32 colValue
Returns
Type Description
System.Threading.Tasks.Task

OnAfterRenderAsync(Boolean)

Declaration
protected override Task OnAfterRenderAsync(bool firstRender)
Parameters
Type Name Description
System.Boolean firstRender
Returns
Type Description
System.Threading.Tasks.Task
Overrides
Syncfusion.Blazor.SfBaseComponent.OnAfterRenderAsync(System.Boolean)

OnInitializedAsync()

Declaration
protected override Task OnInitializedAsync()
Returns
Type Description
System.Threading.Tasks.Task
Overrides
Syncfusion.Blazor.SfBaseComponent.OnInitializedAsync()

OnParametersSetAsync()

Declaration
protected override Task OnParametersSetAsync()
Returns
Type Description
System.Threading.Tasks.Task

RemoveAll()

Removes all the panels from the DashboardLayout.

Declaration
public Task RemoveAll()
Returns
Type Description
System.Threading.Tasks.Task

RemoveAllAsync()

Removes all the panels from the DashboardLayout.

Declaration
public Task RemoveAllAsync()
Returns
Type Description
System.Threading.Tasks.Task

RemovePanel(String)

Removes the panel from the DashboardLayout. idValue - Specifies the Id value of remove panel.

Declaration
public Task RemovePanel(string idValue)
Parameters
Type Name Description
System.String idValue
Returns
Type Description
System.Threading.Tasks.Task

ResizePanel(String, Int32, Int32)

Resize the panel in the DashboardLayout. idValue - Specifies the Id value of resize panel. sizeXValue - Specifies the SizeX value of resize panel. sizeYValue - Specifies the SizeY value of resize panel.

Declaration
public Task ResizePanel(string idValue, int sizeXValue, int sizeYValue)
Parameters
Type Name Description
System.String idValue
System.Int32 sizeXValue
System.Int32 sizeYValue
Returns
Type Description
System.Threading.Tasks.Task

ResizePanelAsync(String, Int32, Int32)

Resize the panel in the DashboardLayout. idValue - Specifies the Id value of resize panel. sizeXValue - Specifies the SizeX value of resize panel. sizeYValue - Specifies the SizeY value of resize panel.

Declaration
public Task ResizePanelAsync(string idValue, int sizeXValue, int sizeYValue)
Parameters
Type Name Description
System.String idValue
System.Int32 sizeXValue
System.Int32 sizeYValue
Returns
Type Description
System.Threading.Tasks.Task

Serialize()

Returns the panels object of the DashboardLayout.

Declaration
public Task<List<PanelModel>> Serialize()
Returns
Type Description
System.Threading.Tasks.Task<System.Collections.Generic.List<PanelModel>>

UpdatedPanelsValues(PanelModel[])

Declaration
public void UpdatedPanelsValues(PanelModel[] updatedValues)
Parameters
Type Name Description
PanelModel[] updatedValues