Class HeatMapLegendSettingsBuilder

Inheritance
System.Object
ControlBuilder
HeatMapLegendSettingsBuilder
Inherited Members
Namespace: Syncfusion.EJ2.HeatMap
Assembly: Syncfusion.EJ2.dll
Syntax
public class HeatMapLegendSettingsBuilder : ControlBuilder

Constructors

HeatMapLegendSettingsBuilder()

Declaration
public HeatMapLegendSettingsBuilder()

HeatMapLegendSettingsBuilder(HeatMapLegendSettings)

Declaration
public HeatMapLegendSettingsBuilder(HeatMapLegendSettings model)
Parameters
Type Name Description
HeatMapLegendSettings model

Methods

Alignment(Alignment)

Specifies the alignment of the legend

Declaration
public HeatMapLegendSettingsBuilder Alignment(Alignment value)
Parameters
Type Name Description
Alignment value
Returns
Type Description
HeatMapLegendSettingsBuilder

EnableSmartLegend(Boolean)

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

Declaration
public HeatMapLegendSettingsBuilder EnableSmartLegend(bool value)
Parameters
Type Name Description
System.Boolean value
Returns
Type Description
HeatMapLegendSettingsBuilder

Height(String)

Specifies the height of Legend.

Declaration
public HeatMapLegendSettingsBuilder Height(string value)
Parameters
Type Name Description
System.String value
Returns
Type Description
HeatMapLegendSettingsBuilder

LabelDisplayType(LabelDisplayType)

Specifies the type of label display for 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 HeatMapLegendSettingsBuilder LabelDisplayType(LabelDisplayType value)
Parameters
Type Name Description
LabelDisplayType value
Returns
Type Description
HeatMapLegendSettingsBuilder

LabelFormat(String)

Specifies the formatting options for the legend label.

Declaration
public HeatMapLegendSettingsBuilder LabelFormat(string value)
Parameters
Type Name Description
System.String value
Returns
Type Description
HeatMapLegendSettingsBuilder

Position(LegendPosition)

Specifies the position of Legend to render.

Declaration
public HeatMapLegendSettingsBuilder Position(LegendPosition value)
Parameters
Type Name Description
LegendPosition value
Returns
Type Description
HeatMapLegendSettingsBuilder

ShowGradientPointer(Boolean)

Specifies whether the gradient pointer should be visible or not.

Declaration
public HeatMapLegendSettingsBuilder ShowGradientPointer(bool value)
Parameters
Type Name Description
System.Boolean value
Returns
Type Description
HeatMapLegendSettingsBuilder

ShowLabel(Boolean)

Specifies whether the label should be visible or not.

Declaration
public HeatMapLegendSettingsBuilder ShowLabel(bool value)
Parameters
Type Name Description
System.Boolean value
Returns
Type Description
HeatMapLegendSettingsBuilder

TextStyle(Object)

Specifies the legend label style.

Declaration
public HeatMapLegendSettingsBuilder TextStyle(object value)
Parameters
Type Name Description
System.Object value
Returns
Type Description
HeatMapLegendSettingsBuilder

Title(HeatMapTitle)

Specifies title of Legend.

Declaration
public HeatMapLegendSettingsBuilder Title(HeatMapTitle value)
Parameters
Type Name Description
HeatMapTitle value
Returns
Type Description
HeatMapLegendSettingsBuilder

Title(Action<HeatMapTitleBuilder>)

Declaration
public HeatMapLegendSettingsBuilder Title(Action<HeatMapTitleBuilder> title)
Parameters
Type Name Description
System.Action<HeatMapTitleBuilder> title
Returns
Type Description
HeatMapLegendSettingsBuilder

ToggleVisibility(Boolean)

To toggle the visibility of heatmap cells based on legend range selection

Declaration
public HeatMapLegendSettingsBuilder ToggleVisibility(bool value)
Parameters
Type Name Description
System.Boolean value
Returns
Type Description
HeatMapLegendSettingsBuilder

Visible(Boolean)

Specifies whether the Legend should be visible or not.

Declaration
public HeatMapLegendSettingsBuilder Visible(bool value)
Parameters
Type Name Description
System.Boolean value
Returns
Type Description
HeatMapLegendSettingsBuilder

Width(String)

Specifies the width of Legend.

Declaration
public HeatMapLegendSettingsBuilder Width(string value)
Parameters
Type Name Description
System.String value
Returns
Type Description
HeatMapLegendSettingsBuilder