Class SfDashboardLayout

Specifies the DashboardLayout component.

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

protected variable declared.

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

BuildRenderTree(RenderTreeBuilder)

Declaration

protected override void BuildRenderTree(RenderTreeBuilder __builder)

Parameters

Type	Name	Description
Microsoft.AspNetCore.Components.Rendering.RenderTreeBuilder	__builder

GetIdValues(DashboardLayoutPanel)

Update the id values for panels.

Declaration

protected void GetIdValues(DashboardLayoutPanel panel)

Parameters

Type	Name	Description
DashboardLayoutPanel	panel	Specifies the panel.

MovePanel(String, Int32, Int32)

Moves the panel in the DashboardLayout.

Declaration

public Task MovePanel(string idValue, int rowValue, int colValue)

Parameters

Type	Name	Description
System.String	idValue	Specifies the Id value of moved panel.
System.Int32	rowValue	Specifies the Row value of moved panel.
System.Int32	colValue	Specifies the Column value of moved panel.

Returns

Type	Description
System.Threading.Tasks.Task	="Task".

MovePanelAsync(String, Int32, Int32)

Moves the panel in the DashboardLayout.

Declaration

public Task MovePanelAsync(string idValue, int rowValue, int colValue)

Parameters

Type	Name	Description
System.String	idValue	Specifies the Id value of moved panel.
System.Int32	rowValue	Specifies the Row value of moved panel.
System.Int32	colValue	Specifies the Column value of moved panel.

Returns

Type	Description
System.Threading.Tasks.Task	="Task".

OnAfterRenderAsync(Boolean)

Method invoked after each time the component has been rendered.

Declaration

protected override Task OnAfterRenderAsync(bool firstRender)

Parameters

Type	Name	Description
System.Boolean	firstRender	firstRender.

Returns

Type	Description
System.Threading.Tasks.Task	"Task".

Overrides

Syncfusion.Blazor.SfBaseComponent.OnAfterRenderAsync(System.Boolean)

OnInitializedAsync()

Override the initialized method to customize the component at server side. Method invoked when the component is ready to start.

Declaration

protected override Task OnInitializedAsync()

Returns

Type	Description
System.Threading.Tasks.Task	Task.

Overrides

Syncfusion.Blazor.SfBaseComponent.OnInitializedAsync()

OnParametersSetAsync()

Method invoked when any changes in component state occurs.

Declaration

protected override Task OnParametersSetAsync()

Returns

Type	Description
System.Threading.Tasks.Task	"Task".

RemoveAll()

Removes all the panels from the DashboardLayout.

Declaration

public Task RemoveAll()

Returns

Type	Description
System.Threading.Tasks.Task	="Task".

RemoveAllAsync()

Removes all the panels from the DashboardLayout.

Declaration

public Task RemoveAllAsync()

Returns

Type	Description
System.Threading.Tasks.Task	="Task".

ResizePanel(String, Int32, Int32)

Resize the panel in the DashboardLayout.

Declaration

public Task ResizePanel(string idValue, int sizeXValue, int sizeYValue)

Parameters

Type	Name	Description
System.String	idValue	Specifies the Id value of resize panel.
System.Int32	sizeXValue	Specifies the SizeX value of resize panel.
System.Int32	sizeYValue	Specifies the SizeY value of resize panel.

Returns

Type	Description
System.Threading.Tasks.Task	="Task".

ResizePanelAsync(String, Int32, Int32)

Resize the panel in the DashboardLayout.

Declaration

public Task ResizePanelAsync(string idValue, int sizeXValue, int sizeYValue)

Parameters

Type	Name	Description
System.String	idValue	Specifies the Id value of resize panel.
System.Int32	sizeXValue	Specifies the SizeX value of resize panel.
System.Int32	sizeYValue	Specifies the SizeY value of resize panel.

Returns

Type	Description
System.Threading.Tasks.Task	="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>>	="Task".

UpdatedPanelsValues(PanelModel[])

Update panel position after collision calculation.

Declaration

public Task UpdatedPanelsValues(PanelModel[] updatedValues)

Parameters

Type	Name	Description
PanelModel[]	updatedValues	UpdatedValues.

Returns

Type	Description
System.Threading.Tasks.Task	="Task".