Skip to content

Vizzu / Modules / vizzu / Styles / AxisLabel

Interface: AxisLabel

vizzu.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: Angle

Additional rotation of the label.

Inherited from

OrientedLabel.angle


backgroundColor

Optional backgroundColor: Color

The background color of the displayed text.

Inherited from

OrientedLabel.backgroundColor


color

Optional color: Color

The color of the displayed text.

Inherited from

OrientedLabel.color


fontFamily

Optional fontFamily: string

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

Inherited from

OrientedLabel.fontFamily


fontSize

Optional fontSize: Length

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

Inherited from

OrientedLabel.fontSize


fontStyle

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

The style of the font.

Inherited from

OrientedLabel.fontStyle


fontWeight

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

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

Inherited from

OrientedLabel.fontWeight


maxFractionDigits

Optional maxFractionDigits: number

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

Inherited from

OrientedLabel.maxFractionDigits


numberFormat

Optional numberFormat: "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, 'prefixed' uses scientific notation.

Inherited from

OrientedLabel.numberFormat


numberScale

Optional numberScale: string

Number scale used for prefixed number format.

Inherited from

OrientedLabel.numberScale


orientation

Optional orientation: "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: Length

Bottom padding of the element.

Inherited from

OrientedLabel.paddingBottom


paddingLeft

Optional paddingLeft: Length

Left padding of the element.

Inherited from

OrientedLabel.paddingLeft


paddingRight

Optional paddingRight: Length

Right padding of the element.

Inherited from

OrientedLabel.paddingRight


paddingTop

Optional paddingTop: Length

Top padding of the element.

Inherited from

OrientedLabel.paddingTop


position

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

Label position relatively to the plot.


side

Optional side: "positive" | "negative"

Label alignment relatively to the position on the plot.


textAlign

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

The alignment of the displayed text.

Inherited from

OrientedLabel.textAlign