Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface PolarAxisRadial

Axis object that represents a PolarCharts radial dimension, which is depicted as an angle on the Charts center.

Class that represents the radial value interval on a PolarChart.

The Radial Axis is depicted as a continuous line traversing all the way along the outer edge of the PolarChart.

The Radial Axes' ticks are positioned along this line, with the gridlines slicing the PolarChart into equally sized slices.

The Radial Axes' title is positioned next to the charts right side, next to where the [[PolarAmplitudeAxis]] ends.

Here is a list of the most commonly useful methods of Polar Radial Axis:

Index

Methods

Methods

getClockwise

  • getClockwise(): boolean

  • Get whether PolarAxisRadial is clockwise or counterclockwise.

    Returns boolean

    True for clockwise direction, False for counterclockwise.

getDivision

  • getDivision(): number

  • Get how many sections the Radial Axis is divided into by Ticks.

    Returns number

    Amount of sections.

getNorth

  • getNorth(angle: number): number

  • Get rotation of Radial Axis as degree angle that is depicted at North position (horizontally centered, vertically highest).

    Parameters

    • angle: number

    Returns number

    Angle as degrees that is depicted at North position. Defaults to 90.

getStrokeStyle

  • Returns LineStyle

    Axis stroke as a LineStyle object

getTickFormattingFunction

getTickStyle

  • Get style of Axis ticks.

    Returns VisibleTicks

    VisibleTicks object.

getTitle

  • getTitle(): string

  • Returns string

    Axis title string

getTitleFillStyle

getTitleFont

  • Get font of axis labels.

    Returns FontSettings

    FontSettings

setClockwise

  • setClockwise(clockwise: boolean): this

  • Set whether PolarAxisRadial direction is clockwise or counterclockwise.

    Defaults to counterclockwise (false).

    Parameters

    • clockwise: boolean

      True for clockwise direction, False for counterclockwise.

    Returns this

    Object itself for fluent interface.

setDivision

  • setDivision(sectionsCount: number): this

  • Set how many sections the Radial Axis is divided into by Ticks.

    Parameters

    • sectionsCount: number

      Amount of sections.

    Returns this

    Object itself for fluent interface.

setNorth

  • setNorth(angle: number): this

  • Set rotation of Radial Axis by specifying degree angle that is depicted at North position (horizontally centered, vertically highest).

    Example usage:

     // Rotate Radial Axis so that 0 degrees is shown at North position.
 PolarAxisRadial.setNorth(0)

    Parameters

    • angle: number

      Angle as degrees that will be depicted at North position. Defaults to 90.

    Returns this

    Object itself for fluent interface.

setStrokeStyle

setTickFormattingFunction

  • Set Axis tick formatting function. This defines text displayed by each tick.

    Parameters

    Returns this

    Object itself for fluent interface.

setTickStyle

  • Set style of Axis ticks.

    Example usage:

     PolarAxisRadial.setTickStyle( ( ticks: VisibleTicks ) => ticks
     .setLabelFillStyle( new SolidFill({ color: ColorRGBA( 255, 0, 0 ) }) )
 )
    • Pass a completely custom created VisibleTicks object
     PolarAxisRadial.setTickStyle( new VisibleTicks({
     labelFillStyle: new SolidFill({ color: ColorRGBA( 255, 0, 0 ) })
 }) )

    Parameters

    Returns this

    Object itself for fluent interface.

setTitle

  • setTitle(title: string): this

  • Specifies an Axis title string

    Parameters

    • title: string

      Axis title as a string

    Returns this

    Axis itself for fluent interface

setTitleFillStyle

  • Specifies Axis title FillStyle

    Parameters

    Returns this

    Axis itself for fluent interface

setTitleFont