Options
All
  • Public
  • Public/Protected
  • All
Menu

Class PolarAxisTick

Implementation of Polar Axis Tick.

Index

Constructors

Properties

Methods

Constructors

constructor

  • new PolarAxisTick(tickLevel: AxisTickLevel, value: number, _removeFromAxis: RemoveHandler<AbstractAxisTick>, _restoreToAxis: RestoreHandler<AbstractAxisTick>, _scale: RadialScale, _labelLayer: LayerXY, _gridlineLayer: LayerXY, gridline: Arc | Line, tickline: Line, label?: Text): PolarAxisTick

  • Parameters

    • tickLevel: AxisTickLevel

      AxisTickLevel tick belongs to.

    • value: number

      Position of Tick on Axis.

    • _removeFromAxis: RemoveHandler<AbstractAxisTick>

      Remove handler for Tick.

    • _restoreToAxis: RestoreHandler<AbstractAxisTick>

      Restore handler for Tick.

    • _scale: RadialScale

      Scale for shapes.

    • _labelLayer: LayerXY

      Layer for rendering Label.

    • _gridlineLayer: LayerXY
    • gridline: Arc | Line

      Shape for rendering Tick gridline (type depends on PolarAxis).

    • tickline: Line

      Shape for rendering Tick line. Not using LineCollection for simplicity.

    • label: Text

      Optionally injectable Tick Label shape. Injection can be useful to reuse Tick shapes for performance.

    Returns PolarAxisTick

Properties

Readonly gridline

gridline : Arc | Line

Shape for rendering Tick gridline (type depends on PolarAxis).

Readonly label

label : Text

Optionally injectable Tick Label shape. Injection can be useful to reuse Tick shapes for performance.

tickLevel

tickLevel : AxisTickLevel

AxisTickLevel tick belongs to.

Readonly tickline

tickline : Line

Shape for rendering Tick line. Not using LineCollection for simplicity.

value

value : number

Position of Tick on Axis.

Methods

_isOld

  • _isOld(): boolean

  • Is the tick marked as old.

    Returns boolean

    Old mark status

_setOld

  • _setOld(isOld: boolean): this

  • Mark or remove "old" mark.

    Old mark is used when updating axis to reuse old ticks. Any tick marked as old after ticks are updated will be disposed and removed.

    Parameters

    • isOld: boolean

      Is the tick marked as old

    Returns this

    This for fluid interface

dispose

  • dispose(): this

  • Disposes all tick sub-elements

    Returns this

    This for fluid interface

isDisposed

  • isDisposed(): boolean

  • Returns boolean

    True if all sub-elements are disposed, false if not.

restore

  • restore(): this

  • Restores all custom tick sub-elements

    Returns this

    This for fluid interface