Class HeatMapCommonAxis

Specifies the heatmap common axis.

Inheritance
System.Object
Syncfusion.Blazor.SfBaseComponent
HeatMapCommonAxis
HeatMapXAxis
HeatMapYAxis
Namespace: Syncfusion.Blazor.HeatMap
Assembly: Syncfusion.Blazor.dll
Syntax
public class HeatMapCommonAxis : SfBaseComponent

Constructors

HeatMapCommonAxis()

Declaration
public HeatMapCommonAxis()

Properties

Border

Defines the axis border.

Declaration
public HeatMapAxisLabelBorder Border { get; set; }
Property Value
Type Description
HeatMapAxisLabelBorder

EnableTrim

Enable Trim for heatmap yAxis.

Declaration
public bool EnableTrim { get; set; }
Property Value
Type Description
System.Boolean

Increment

Specifies the increment for an axis label.

Declaration
public double Increment { get; set; }
Property Value
Type Description
System.Double

Interval

Specifies the interval for an axis label.

Declaration
public int Interval { get; set; }
Property Value
Type Description
System.Int32

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 IntervalType IntervalType { get; set; }
Property Value
Type Description
IntervalType

IsInversed

Specifies whether the axis to be rendered in the inversed manner or not.

Declaration
public bool IsInversed { get; set; }
Property Value
Type Description
System.Boolean

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 represents the axis label, e.g, 20°C.

Declaration
public string LabelFormat { get; set; }
Property Value
Type Description
System.String

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 degrees when it intersects.
  • Trim:Trim the label when label text width exceeds the label width.
Declaration
public LabelIntersectAction LabelIntersectAction { get; set; }
Property Value
Type Description
LabelIntersectAction

LabelRotation

Specifies the angle to rotate the axis label.

Declaration
public int LabelRotation { get; set; }
Property Value
Type Description
System.Int32

Labels

Specifies the options for label assignment.

Declaration
public string[] Labels { get; set; }
Property Value
Type Description
System.String[]

Maximum

Specifies the maximum range of an axis.

Declaration
public object Maximum { get; set; }
Property Value
Type Description
System.Object

MaxLabelLength

Specifies the maximum length of an axis label.

Declaration
public int MaxLabelLength { get; set; }
Property Value
Type Description
System.Int32

Minimum

Specifies the minimum range of an axis.

Declaration
public object Minimum { get; set; }
Property Value
Type Description
System.Object

MultiLevelLabels

Specifies the multi-level labels collection for the axis.

Declaration
public List<HeatMapMultiLevelLabel> MultiLevelLabels { get; set; }
Property Value
Type Description
System.Collections.Generic.List<HeatMapMultiLevelLabel>

ShowLabelOn

Defines the axis label display type for date-time axis.

  • None:Axis labels are displayed based on the value type.
  • Years:Defines the axis labels display in years.
  • Months: Defines the axis labels display in months.
  • Days:Defines the axis labels display in days.
  • Hours:Defines the axis labels display in hours.
Declaration
public LabelType ShowLabelOn { get; set; }
Property Value
Type Description
LabelType

ValueType

Specifies the type of data the axis handles.

  • Numeric:Renders a numeric axis.
  • DateTime:Renders a dateTime axis.
  • Category:Renders a category axis.
Declaration
public ValueType ValueType { get; set; }
Property Value
Type Description
ValueType

Methods

OnInitializedAsync()

Declaration
protected override Task OnInitializedAsync()
Returns
Type Description
System.Threading.Tasks.Task
Overrides
Syncfusion.Blazor.SfBaseComponent.OnInitializedAsync()