Skip to content

Vizzu / Modules / types/styles / AxisLabel

Interface: AxisLabel

types/styles.AxisLabel

Style settings for the values shown on the axis to display the scale being used or the categories along the axis. Note: textAlign has no effect on the Axis label.

Hierarchy

Properties

angle

Optional angle: null | Angle

Additional rotation of the label.

Inherited from

OrientedLabel.angle


backgroundColor

Optional backgroundColor: null | Color

The background color of the displayed text.

Inherited from

OrientedLabel.backgroundColor


color

Optional color: null | Color

The color of the displayed text.

Inherited from

OrientedLabel.color


fontFamily

Optional fontFamily: null | string

The family of the font. If not set, it inherits the root style font family.

Inherited from

OrientedLabel.fontFamily


fontSize

Optional fontSize: null | Length

The size of the font. Percentage values are relative to the root style font size.

Inherited from

OrientedLabel.fontSize


fontStyle

Optional fontStyle: null | "normal" | "italic" | "oblique"

The style of the font.

Inherited from

OrientedLabel.fontStyle


fontWeight

Optional fontWeight: null | number | "bold" | "normal"

The weight of the font, numbers use the same scale as CSS.

Inherited from

OrientedLabel.fontWeight


maxFractionDigits

Optional maxFractionDigits: null | number

The maximum number of digits in fraction part if the text contains a number.

Inherited from

OrientedLabel.maxFractionDigits


numberFormat

Optional numberFormat: null | "none" | "grouped" | "prefixed"

The format of the number. Only applicable for texts showing numerical data such as marker and axis labels. 'grouped' uses thousand separators (e.g. 1 234 567), 'prefixed' uses scientific notation (e.g. 1.234k).

Inherited from

OrientedLabel.numberFormat


numberScale

Optional numberScale: null | string

Number scale used for prefixed number format.

Inherited from

OrientedLabel.numberScale


orientation

Optional orientation: null | "normal" | "horizontal" | "vertical" | "tangential"

Orientation of the label relatively to the axis or marker it is attached to.

Inherited from

OrientedLabel.orientation


paddingBottom

Optional paddingBottom: null | Length

Bottom padding of the element.

Inherited from

OrientedLabel.paddingBottom


paddingLeft

Optional paddingLeft: null | Length

Left padding of the element.

Inherited from

OrientedLabel.paddingLeft


paddingRight

Optional paddingRight: null | Length

Right padding of the element.

Inherited from

OrientedLabel.paddingRight


paddingTop

Optional paddingTop: null | Length

Top padding of the element.

Inherited from

OrientedLabel.paddingTop


position

Optional position: null | "axis" | "max-edge" | "min-edge"

Label position relatively to the plot.


side

Optional side: null | "positive" | "negative"

Label alignment relatively to the position on the plot.


textAlign

Optional textAlign: null | "center" | "left" | "right"

The alignment of the displayed text.

Inherited from

OrientedLabel.textAlign