Class HeatMapLegendSettings

Specifies the heatmap legend settings.

Inheritance
object
ComponentBase
OwningComponentBase
SfOwningComponentBase
HeatMapLegendSettings
Implements
Inherited Members
Namespace: Syncfusion.Blazor.HeatMap
Assembly: Syncfusion.Blazor.dll
Syntax
public class HeatMapLegendSettings : SfOwningComponentBase, IComponent, IHandleEvent, IHandleAfterRender, IDisposable

Constructors

HeatMapLegendSettings()

Declaration
public HeatMapLegendSettings()

Properties

Alignment

Specifies the alignment of the legend.

Declaration
[Parameter]
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
[Parameter]
public bool EnableSmartLegend { get; set; }
Property Value
Type
bool

Height

Specifies the height of Legend.

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

LabelFormat

Specifies the formatting options for the legend label.

Declaration
[Parameter]
public string LabelFormat { get; set; }
Property Value
Type
string

Position

Specifies the position of Legend to render.

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

ShowGradientPointer

Specifies whether the gradient pointer should be visible or not.

Declaration
[Parameter]
public bool ShowGradientPointer { get; set; }
Property Value
Type
bool

ShowLabel

Specifies whether the label should be visible or not.

Declaration
[Parameter]
public bool ShowLabel { get; set; }
Property Value
Type
bool

ToggleVisibility

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

Declaration
[Parameter]
public bool ToggleVisibility { get; set; }
Property Value
Type
bool

Visible

Specifies whether the Legend should be visible or not.

Declaration
[Parameter]
public bool Visible { get; set; }
Property Value
Type
bool

Width

Specifies the width of Legend.

Declaration
[Parameter]
public string Width { get; set; }
Property Value
Type
string

Methods

BuildRenderTree(RenderTreeBuilder)

Declaration
protected override void BuildRenderTree(RenderTreeBuilder __builder)
Parameters
Type Name Description
RenderTreeBuilder __builder
Overrides

Dispose(bool)

Releases the unmanaged resources used by the component and optionally disposes of the managed resources.

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

True to dispose managed resources; otherwise, false.
Overrides

OnInitializedAsync()

Initializes the component and registers the legend settings with the parent heatmap.

Declaration
protected override Task OnInitializedAsync()
Returns
Type Description
Task

A task that represents the asynchronous initialization operation.
Overrides

OnParametersSetAsync()

Processes updated parameters and propagates legend property changes to the parent component.

Declaration
protected override Task OnParametersSetAsync()
Returns
Type Description
Task

A task that represents the asynchronous parameter processing operation.
Overrides

Implements