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 PolarAxisAmplitude ends.

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

Hierarchy

Methods

  • Get whether PolarAxisRadial is clockwise or counterclockwise.

    Returns

    True for clockwise direction, False for counterclockwise.

    Returns boolean

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

    Returns

    Amount of sections.

    Returns number

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

    Returns

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

    Parameters

    • angle: number

    Returns number

  • Get theme effect enabled on component or disabled.

    A theme can specify an Effect to add extra visual oomph to chart applications, like Glow effects around data or other components. Whether this effect is drawn above a particular component can be configured using the setEffect method.

     // Example, disable theme effect from a particular component.
    Component.setEffect(false)

    For the most part, theme effects are enabled by default on most components.

    Theme effect is configured with effect property.

    Returns

    Boolean that describes whether drawing the theme effect is enabled around the component or not.

    Returns boolean

  • Set whether PolarAxisRadial direction is clockwise or counterclockwise.

    Defaults to counterclockwise (false).

    Returns

    Object itself for fluent interface.

    Parameters

    • clockwise: boolean

      True for clockwise direction, False for counterclockwise.

    Returns PolarAxisRadial

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

    Returns

    Object itself for fluent interface.

    Parameters

    • sectionsCount: number

      Amount of sections.

    Returns PolarAxisRadial

  • 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)

    Returns

    Object itself for fluent interface.

    Parameters

    • angle: number

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

    Returns PolarAxisRadial

  • Set theme effect enabled on component or disabled.

    A theme can specify an Effect to add extra visual oomph to chart applications, like Glow effects around data or other components. Whether this effect is drawn above a particular component can be configured using the setEffect method.

     // Example, disable theme effect from a particular component.
    Component.setEffect(false)

    For the most part, theme effects are enabled by default on most components.

    Theme effect is configured with effect property.

    Returns

    Object itself.

    Parameters

    • enabled: boolean

      Theme effect enabled

    Returns PolarAxisRadial