Class HeatMapAxis
Namespace: Syncfusion.EJ2.HeatMap
Assembly: Syncfusion.EJ2.dll
Syntax
public class HeatMapAxis : EJTagHelperConstructors
HeatMapAxis()
Declaration
public HeatMapAxis()Properties
Border
Set and gets the options to customize the border of the axis labels.
Declaration
public HeatMapAxisLabelBorder Border { get; set; }Property Value
| Type | Description |
|---|---|
| HeatMapAxisLabelBorder | The default value is null |
ContentTemplate
To get or set value for ContentTemplate.
Declaration
public MvcTemplate<object> ContentTemplate { get; set; }Property Value
| Type |
|---|
| Syncfusion.EJ2.MvcTemplate<System.Object> |
EnableTrim
Enables or disables the trimming of the axis labels when the label exceeds maximum length.
Declaration
public bool EnableTrim { get; set; }Property Value
| Type | Description |
|---|---|
| System.Boolean | The default value is false |
Increment
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 double Increment { get; set; }Property Value
| Type | Description |
|---|---|
| System.Double | The default value is 1 |
Interval
Specifies the interval for an axis. This properties provides an interval between the axis labels.
Declaration
public double Interval { get; set; }Property Value
| Type | Description |
|---|---|
| System.Double | The default value is Double.NaN |
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 IntervalType IntervalType { get; set; }Property Value
| Type | Description |
|---|---|
| IntervalType | The default value is IntervalType.Days |
IsInversed
Enables or disables the axis to be rendered in an inversed manner.
Declaration
public bool IsInversed { get; set; }Property Value
| Type | Description |
|---|---|
| System.Boolean | The default value is false |
LabelFormat
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 string LabelFormat { get; set; }Property Value
| Type | Description |
|---|---|
| System.String | The default value is "" |
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 LabelIntersectAction LabelIntersectAction { get; set; }Property Value
| Type | Description |
|---|---|
| LabelIntersectAction | The default value is LabelIntersectAction.Trim |
LabelRotation
Sets and gets the angle to rotate the axis label.
Declaration
public double LabelRotation { get; set; }Property Value
| Type | Description |
|---|---|
| System.Double | The default value is 0 |
Labels
Sets and gets the list of texts to be displayed in an axis as labels.
Declaration
public string[] Labels { get; set; }Property Value
| Type | Description |
|---|---|
| System.String[] | The default value is null |
Maximum
Specifies the maximum range of an axis.
Declaration
public object Maximum { get; set; }Property Value
| Type | Description |
|---|---|
| System.Object | The default value is null |
MaxLabelLength
Specifies the maximum length of the axis labels.
Declaration
public double MaxLabelLength { get; set; }Property Value
| Type | Description |
|---|---|
| System.Double | The default value is 35 |
Minimum
Specifies the minimum range of an axis.
Declaration
public object Minimum { get; set; }Property Value
| Type | Description |
|---|---|
| System.Object | The default value is null |
MultiLevelLabels
Sets and gets the options to customize the multi level labels for an axis.
Declaration
public List<HeatMapMultiLevelLabel> MultiLevelLabels { get; set; }Property Value
| Type | Description |
|---|---|
| System.Collections.Generic.List<HeatMapMultiLevelLabel> | The default value is null |
OpposedPosition
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 bool OpposedPosition { get; set; }Property Value
| Type | Description |
|---|---|
| System.Boolean | The default value is false |
ShowLabelOn
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 LabelType ShowLabelOn { get; set; }Property Value
| Type | Description |
|---|---|
| LabelType | The default value is LabelType.None |
TextStyle
Sets and gets the options to customize the axis labels.
Declaration
public object TextStyle { get; set; }Property Value
| Type | Description |
|---|---|
| System.Object | The default value is null |
Title
Sets and gets the options to customize the title of heatmap axis.
Declaration
public object Title { get; set; }Property Value
| Type | Description |
|---|---|
| System.Object | The default value is null |
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 ValueType ValueType { get; set; }Property Value
| Type | Description |
|---|---|
| ValueType | The default value is Syncfusion.EJ2.HeatMap.ValueType.Category |