Class HeatMapAxisBuilder
Inheritance
System.Object
Syncfusion.EJ2.ControlBuilder
HeatMapAxisBuilder
Assembly: Syncfusion.EJ2.dll
Syntax
public class HeatMapAxisBuilder : ControlBuilder
Constructors
HeatMapAxisBuilder()
Declaration
public HeatMapAxisBuilder()
HeatMapAxisBuilder(HeatMapAxis)
Declaration
public HeatMapAxisBuilder(HeatMapAxis model)
Parameters
Methods
Border(HeatMapAxisLabelBorder)
Set and gets the options to customize the border of the axis labels.
Declaration
public HeatMapAxisBuilder Border(HeatMapAxisLabelBorder value)
Parameters
Returns
Border(Action<HeatMapAxisLabelBorderBuilder>)
Declaration
public HeatMapAxisBuilder Border(Action<HeatMapAxisLabelBorderBuilder> border)
Parameters
Returns
EnableTrim(Boolean)
Enables or disables the trimming of the axis labels when the label exceeds maximum length.
Declaration
public HeatMapAxisBuilder EnableTrim(bool value)
Parameters
| Type |
Name |
Description |
| System.Boolean |
value |
|
Returns
Increment(Double)
Specifies the increment for an axis label. When this property is set, the displayed text of the labels will be multiplied with the increment value.
Declaration
public HeatMapAxisBuilder Increment(double value)
Parameters
| Type |
Name |
Description |
| System.Double |
value |
|
Returns
Interval(Double)
Specifies the interval for an axis. This properties provides an interval between the axis labels.
Declaration
public HeatMapAxisBuilder Interval(double value)
Parameters
| Type |
Name |
Description |
| System.Double |
value |
|
Returns
IntervalType(IntervalType)
Specifies the type of the interval between the axis labels in date time axis.The available types are,
Years: Defines the interval of the axis labels in years.
Months: Defines the interval of the axis labels in months.
Days: Defines the interval of the axis labels in days.
Hours: Defines the interval of the axis labels in hours.
Minutes: Defines the interval of the axis labels in minutes.
Declaration
public HeatMapAxisBuilder IntervalType(IntervalType value)
Parameters
Returns
IsInversed(Boolean)
Enables or disables the axis to be rendered in an inversed manner.
Declaration
public HeatMapAxisBuilder IsInversed(bool value)
Parameters
| Type |
Name |
Description |
| System.Boolean |
value |
|
Returns
Used to format the axis label that accepts any global string format like 'C', 'n1', 'P' etc.
It also accepts placeholder like '{value}°C' in which value represent the axis label, e.g, 20°C.
Declaration
public HeatMapAxisBuilder LabelFormat(string value)
Parameters
| Type |
Name |
Description |
| System.String |
value |
|
Returns
LabelIntersectAction(LabelIntersectAction)
Specifies the actions when the axis labels intersect with each other.The actions available are,
None: Shows all the labels.
Trim : Trims the label when label text intersects with other labels.
Rotate45: Rotates the label to 45 degree when it intersects other labels.
MultipleRows: Shows all the labels as multiple rows when it intersects other labels.
Declaration
public HeatMapAxisBuilder LabelIntersectAction(LabelIntersectAction value)
Parameters
Returns
LabelRotation(Double)
Sets and gets the angle to rotate the axis label.
Declaration
public HeatMapAxisBuilder LabelRotation(double value)
Parameters
| Type |
Name |
Description |
| System.Double |
value |
|
Returns
Labels(String[])
Sets and gets the list of texts to be displayed in an axis as labels.
Declaration
public HeatMapAxisBuilder Labels(string[] value)
Parameters
| Type |
Name |
Description |
| System.String[] |
value |
|
Returns
Maximum(Object)
Specifies the maximum range of an axis.
Declaration
public HeatMapAxisBuilder Maximum(object value)
Parameters
| Type |
Name |
Description |
| System.Object |
value |
|
Returns
MaxLabelLength(Double)
Specifies the maximum length of the axis labels.
Declaration
public HeatMapAxisBuilder MaxLabelLength(double value)
Parameters
| Type |
Name |
Description |
| System.Double |
value |
|
Returns
Minimum(Object)
Specifies the minimum range of an axis.
Declaration
public HeatMapAxisBuilder Minimum(object value)
Parameters
| Type |
Name |
Description |
| System.Object |
value |
|
Returns
MultiLevelLabels(Action<HeatMapMultiLevelLabelBuilder>)
Declaration
public HeatMapAxisBuilder MultiLevelLabels(Action<HeatMapMultiLevelLabelBuilder> multiLevelLabels)
Parameters
Returns
MultiLevelLabels(List<HeatMapMultiLevelLabel>)
Sets and gets the options to customize the multi level labels for an axis.
Declaration
public HeatMapAxisBuilder MultiLevelLabels(List<HeatMapMultiLevelLabel> value)
Parameters
Returns
OpposedPosition(Boolean)
Enables or disables the axis to render in opposed position. If set to true, the axis will render at the opposite side of its default position.
Declaration
public HeatMapAxisBuilder OpposedPosition(bool value)
Parameters
| Type |
Name |
Description |
| System.Boolean |
value |
|
Returns
ShowLabelOn(LabelType)
Specifies the axis label display type for the date time axis. The following are available types,
None: Axis labels displayed based on the value type.
Years: Displays the axis labels for every year.
Months: Displays the axis labels for every month.
Days: Displays the axis labels for every day.
Hours: Displays the axis labels for every hour.
Declaration
public HeatMapAxisBuilder ShowLabelOn(LabelType value)
Parameters
Returns
TextStyle(Object)
Sets and gets the options to customize the axis labels.
Declaration
public HeatMapAxisBuilder TextStyle(object value)
Parameters
| Type |
Name |
Description |
| System.Object |
value |
|
Returns
Title(Object)
Sets and gets the options to customize the title of heatmap axis.
Declaration
public HeatMapAxisBuilder Title(object value)
Parameters
| Type |
Name |
Description |
| System.Object |
value |
|
Returns
ValueType(ValueType)
Specifies the type of data the axis is handling. The available types are,
Numeric: Renders a numeric axis.
DateTime: Renders a axis that handles date and time.
Category: Renders a axis that renders user provided labels.
Declaration
public HeatMapAxisBuilder ValueType(ValueType value)
Parameters
Returns
