Class HeatMapLegendSettings

Specifies the heatmap legend settings.

Inheritance
System.Object
HeatMapLegendSettings
Namespace: Syncfusion.Blazor.HeatMap
Assembly: Syncfusion.Blazor.dll
Syntax
public class HeatMapLegendSettings : OwningComponentBase

Constructors

HeatMapLegendSettings()

Declaration
public HeatMapLegendSettings()

Properties

Alignment

Specifies the alignment of the legend.

Declaration
public Alignment Alignment { get; set; }
Property Value
Type
Alignment

EnableSmartLegend

Specifies whether the smart legend should be displayed or not when the palette type is fixed.

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

Height

Specifies the height of Legend.

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

LabelDisplayType

Specifies the type of label display for the smart legend.

  • All:All labels are displayed.
  • Edge:Labels will be displayed only at the edges of the legend.
  • None:No labels are displayed.
Declaration
public LabelDisplayType LabelDisplayType { get; set; }
Property Value
Type
LabelDisplayType

LabelFormat

Specifies the formatting options for the legend label.

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

Position

Specifies the position of Legend to render.

Declaration
public LegendPosition Position { get; set; }
Property Value
Type
LegendPosition

ShowGradientPointer

Specifies whether the gradient pointer should be visible or not.

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

ShowLabel

Specifies whether the label should be visible or not.

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

ToggleVisibility

Specifies whether to toggle the visibility of heatmap cells based on legend range selection or not.

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

Visible

Specifies whether the Legend should be visible or not.

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

Width

Specifies the width of Legend.

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

Methods

BuildRenderTree(RenderTreeBuilder)

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

Dispose(Boolean)

Declaration
protected override void Dispose(bool disposing)
Parameters
Type Name Description
System.Boolean disposing

OnInitializedAsync()

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

OnParametersSetAsync()

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