Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface AxisLabel

Style settings for the values shown on the axis to display the scale being used or the categories along the axis.

Hierarchy

Index

Properties

Optional angle

angle: Angle

Additional rotation of the label.

Optional backgroundColor

backgroundColor: Color

The background color of the displayed text.

Optional color

color: Color

The color of the displayed text.

Optional fontFamily

fontFamily: string

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

Optional fontSize

fontSize: Length

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

Optional fontStyle

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

The style of the font.

Optional fontWeight

fontWeight: number | "normal" | "bold"

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

Optional numberFormat

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.

Optional orientation

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

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

Optional paddingBottom

paddingBottom: Length

Bottom padding of the element.

Optional paddingLeft

paddingLeft: Length

Left padding of the element.

Optional paddingRight

paddingRight: Length

Right padding of the element.

Optional paddingTop

paddingTop: Length

Top padding of the element.

Optional position

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

Label position relatively to the plot.

Optional side

side: "positive" | "negative"

Label alignment relatively to the position on the plot.

Optional textAlign

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

The alignment of the displayed text.

Generated using TypeDoc