Axis API in React HeatMap API component

Sets and gets the options to customize the axis of the heatmap.

Properties

border

AxisLabelBorderModel

Set and gets the options to customize the border of the axis labels.

enableTrim

boolean

Enables or disables the trimming of the axis labels when the label exceeds maximum length.

Defaults to false

increment

number

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.

Defaults to 1

interval

number

Specifies the interval for an axis. This properties provides an interval between the axis labels.

Defaults to null

intervalType

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.

Defaults to ‘Days’

isInversed

boolean

Enables or disables the axis to be rendered in an inversed manner.

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 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.

Defaults to Trim

labelRotation

number

Sets and gets the angle to rotate the axis label.

Defaults to 0

labels

string[]

Sets and gets the list of texts to be displayed in an axis as labels.

Defaults to null

maxLabelLength

number

Specifies the maximum length of the axis labels.

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[]

Sets and gets the options to customize the multi level labels for an axis.

opposedPosition

boolean

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.

Defaults to false

showLabelOn

LabelType

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.

Defaults to ‘None’

textStyle

FontModel

Sets and gets the options to customize the axis labels.

title

TitleModel

Sets and gets the options to customize the title of heatmap axis.

Defaults to ”

valueType

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.

Defaults to Category