Defines one axis used with by series. These instances will be found both on the Chart and the Series instances, and may be shared between Series instances.

Hierarchy

  • Axis

Properties

formatPattern?: string

The format pattern to use with this axis. Use the type to determine which type of formatter to use.

Returns

String

gapBetweenMajorTicks?: number

Accessors

  • get businessCalendar(): BusinessCalendar
  • The calendar with the business hours and holidays to transform plot data against. Defaults to null, or no transform.

    Returns BusinessCalendar

    dh.calendar.BusinessCalendar

  • get color(): string
  • Returns string

  • get formatType(): number
  • The type for this axis. See AxisFormatType enum for more details.

    Returns number

    int

  • get id(): string
  • The unique id for this axis.

    Returns string

    String

  • get invert(): boolean
  • Returns boolean

  • get label(): string
  • The label for this axis.

    Returns string

    String

  • get labelFont(): string
  • Returns string

  • get log(): boolean
  • Returns boolean

  • get majorTickLocations(): number[]
  • Returns number[]

  • get majorTicksVisible(): boolean
  • Returns boolean

  • get maxRange(): number
  • Returns number

  • get minRange(): number
  • Returns number

  • get minorTickCount(): number
  • Returns number

  • get minorTicksVisible(): boolean
  • Returns boolean

  • get position(): number
  • The position for this axis. See AxisPosition enum for more details.

    Returns number

    int

  • get tickLabelAngle(): number
  • Returns number

  • get ticksFont(): string
  • Returns string

  • get timeAxis(): boolean
  • Returns boolean

  • get type(): number
  • The type for this axis, indicating how it will be drawn. See AxisType enum for more details.

    Returns number

    int

Methods

  • Indicates that this axis is only widthInPixels wide, so any extra data can be downsampled out, if this can be done losslessly. The second two arguments represent the current zoom range of this axis, and if provided, most of the data outside of this range will be filtered out automatically and the visible width mapped to that range. When the UI zooms, pans, or resizes, this method should be called again to update these three values to ensure that data is correct and current.

    Parameters

    • Optional pixelCount: number
    • Optional min: unknown
    • Optional max: unknown

    Returns void