Class HeatMapAxisBuilder
Inheritance
System.Object
HeatMapAxisBuilder
Inherited Members
System.Object.ToString()
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
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)
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)
Enable Trim for heatmap yAxis
Declaration
public HeatMapAxisBuilder EnableTrim(bool value)
Parameters
| Type |
Name |
Description |
| System.Boolean |
value |
|
Returns
Increment(Double)
Specifies the increment for an axis label.
Declaration
public HeatMapAxisBuilder Increment(double value)
Parameters
| Type |
Name |
Description |
| System.Double |
value |
|
Returns
Interval(Double)
Specifies the interval for an axis.
Declaration
public HeatMapAxisBuilder Interval(double value)
Parameters
| Type |
Name |
Description |
| System.Double |
value |
|
Returns
IntervalType(IntervalType)
Specifies the types like Years, Months, Days, Hours, Minutes in date time axis.They are,
Years: Defines the interval of the axis in years.
Months: Defines the interval of the axis in months.
Days: Defines the interval of the axis in days.
Hours: Defines the interval of the axis in hours.
Minutes: Defines the interval of the axis in minutes.
Declaration
public HeatMapAxisBuilder IntervalType(IntervalType value)
Parameters
Returns
IsInversed(Boolean)
It specifies whether the axis to be rendered in inversed manner or not.
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 like Rotate45, None and Trim when the axis labels intersect with each other.They are,
None: Shows all the labels.
Rotate45: Rotates the label to 45 degree when it intersects.
Trim : Trim the label when label text width exceed the label width
Declaration
public HeatMapAxisBuilder LabelIntersectAction(LabelIntersectAction value)
Parameters
Returns
LabelRotation(Double)
The angle to rotate the axis label
Declaration
public HeatMapAxisBuilder LabelRotation(double value)
Parameters
| Type |
Name |
Description |
| System.Double |
value |
|
Returns
Labels(String[])
Options for label assignment.
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 an axis label.
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>)
Specifies the multi level labels collection for the axis
Declaration
public HeatMapAxisBuilder MultiLevelLabels(List<HeatMapMultiLevelLabel> value)
Parameters
Returns
OpposedPosition(Boolean)
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)
Defines the axis label display type for date time axis.
None: Axis labels displayed based on the value type.
Years: Define the axis labels display in every year.
Months: Define the axis labels display in every month.
Days: Define the axis labels display in every day.
Hours: Define the axis labels display in every hour.
Declaration
public HeatMapAxisBuilder ShowLabelOn(LabelType value)
Parameters
Returns
TextStyle(Object)
Options for customizing the label text.
Declaration
public HeatMapAxisBuilder TextStyle(object value)
Parameters
| Type |
Name |
Description |
| System.Object |
value |
|
Returns
Title(Object)
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.
Numeric: Renders a numeric axis.
DateTime: Renders a dateTime axis.
Category: Renders a category axis.
Declaration
public HeatMapAxisBuilder ValueType(ValueType value)
Parameters
Returns