AxisModel API in JavaScript (ES5) HeatMap API control

Interface for a class Axis

Properties

border

AxisLabelBorderModel

Border of the axis labels.

enableTrim

boolean

Enable Trim for heatmap yAxis

increment

number

Specifies the increment for an axis label.

interval

number

Specifies the interval for an axis.

intervalType

string

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.

isInversed

boolean

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

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.

labelIntersectAction

string

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

labelRotation

number

The angle to rotate the axis label

labels

string[]

Options for label assignment.

maxLabelLength

number

Specifies the maximum length of an axis label.

maximum

Object

Specifies the maximum range of an axis.

minimum

Object

Specifies the minimum range of an axis.

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.

showLabelOn

string

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.

textStyle

FontModel

Options for customizing the label text.

title

TitleModel

Title of heat map axis

valueType

string

Specifies the type of data the axis is handling.

• Numeric: Renders a numeric axis.
• DateTime: Renders a dateTime axis.
• Category: Renders a category axis.