Class HeatMapCommonAxis
Configures the axis of HeatMap
Inheritance
System.Object
HeatMapCommonAxis
Implements
System.IDisposable
Assembly: Syncfusion.Blazor.dll
Syntax
public class HeatMapCommonAxis : BaseComponent, IDisposable
Constructors
HeatMapCommonAxis()
Declaration
public HeatMapCommonAxis()
Properties
Border
Border of the axis labels.
Declaration
public HeatMapAxisLabelBorder Border { get; set; }
Property Value
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.
Declaration
public double Interval { get; set; }
Property Value
Type |
Description |
System.Double |
|
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
IsInversed
It specifies whether the axis to be rendered in inversed manner or not.
Declaration
public bool IsInversed { get; set; }
Property Value
Type |
Description |
System.Boolean |
|
jsProperty
Declaration
protected override string jsProperty { get; set; }
Property Value
Type |
Description |
System.String |
|
Overrides
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 |
|
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 LabelIntersectAction LabelIntersectAction { get; set; }
Property Value
LabelRotation
The angle to rotate the axis label
Declaration
public double LabelRotation { get; set; }
Property Value
Type |
Description |
System.Double |
|
Labels
Options for label assignment.
Declaration
public string[] Labels { get; set; }
Property Value
Type |
Description |
System.String[] |
|
mainParent
Declaration
protected override BaseComponent mainParent { get; set; }
Property Value
Overrides
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 double MaxLabelLength { get; set; }
Property Value
Type |
Description |
System.Double |
|
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
OpposedPosition
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 |
|
ShowLabelOn
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 LabelType ShowLabelOn { get; set; }
Property Value
TextStyle
Options for customizing the label text.
Declaration
public FontModel TextStyle { get; set; }
Property Value
Title
Declaration
public TitleModel Title { get; set; }
Property Value
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 ValueType ValueType { get; set; }
Property Value
Methods
GetJSNamespace()
Declaration
public string GetJSNamespace()
Returns
Type |
Description |
System.String |
|
OnInitializedAsync()
Declaration
protected override Task OnInitializedAsync()
Returns
Type |
Description |
System.Threading.Tasks.Task |
|
Overrides
Declaration
protected override Task OnParametersSetAsync()
Returns
Type |
Description |
System.Threading.Tasks.Task |
|
updateChildProperties(String, Object)
Declaration
public void updateChildProperties(string key, object value)
Parameters
Type |
Name |
Description |
System.String |
key |
|
System.Object |
value |
|
Implements
System.IDisposable