Axis API in React HeatMap API component

Properties

border

AxisLabelBorderModel

Border of the axis labels.

enableTrim

boolean

Enable Trim for heatmap yAxis

Defaults to false

increment

number

Specifies the increment for an axis label.

Defaults to 1

interval

number

Specifies the interval for an axis.

Defaults to null

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.

Defaults to ‘Days’

isInversed

boolean

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

Defaults to false

labelFormat

string

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.

Defaults to ”

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

Defaults to Trim

labelRotation

number

The angle to rotate the axis label

Defaults to 0

labels

string[]

Options for label assignment.

maxLabelLength

number

Specifies the maximum length of an axis label.

Defaults to 35.

maximum

Object

Specifies the maximum range of an axis.

Defaults to null

minimum

Object

Specifies the minimum range of an axis.

Defaults to null

multiLevelLabels

MultiLevelLabelsModel[]

Specifies the multi level labels collection for the axis

opposedPosition

boolean

If set to true, the axis will render at the opposite side of its default position.

Defaults to false

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.

Defaults to ‘None’

textStyle

FontModel

Options for customizing the label text.

title

TitleModel

Title of heat map axis

Defaults to ”

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.

Defaults to Category