Class HeatMapLegendSettings

Specifies the heatmap legend settings.

Inheritance
System.Object
SfBaseComponent
HeatMapLegendSettings
Inherited Members
Namespace: Syncfusion.Blazor.HeatMap
Assembly: Syncfusion.Blazor.dll
Syntax
public class HeatMapLegendSettings : SfBaseComponent

Constructors

HeatMapLegendSettings()

Declaration
public HeatMapLegendSettings()

Properties

Alignment

Specifies the alignment of the legend.

Declaration
public Alignment Alignment { get; set; }
Property Value
Type Description
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 Description
System.Boolean

Height

Specifies the height of Legend.

Declaration
public string Height { get; set; }
Property Value
Type Description
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 Description
LabelDisplayType

LabelFormat

Specifies the formatting options for the legend label.

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

Position

Specifies the position of Legend to render.

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

ShowGradientPointer

Specifies whether the gradient pointer should be visible or not.

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

ShowLabel

Specifies whether the label should be visible or not.

Declaration
public bool ShowLabel { get; set; }
Property Value
Type Description
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 Description
System.Boolean

Visible

Specifies whether the Legend should be visible or not.

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

Width

Specifies the width of Legend.

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

Methods

BuildRenderTree(RenderTreeBuilder)

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

OnInitializedAsync()

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

OnParametersSetAsync()

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