Options
All
  • Public
  • Public/Protected
  • All
Menu
summary

The NumericTickProvider is a TickProvider implementation for Numeric 2D or 3D Axis.

description

TickProviders are responsible for calculating the interval between major and minor gridlines, ticks and labels.

  • The method getMajorTicks returns an array of major ticks (data-values values where SciChart will place labels and major gridlines.
  • The method getMinorTicks returns an array of minor ticks (data-values values where SciChart will place minor gridlines.
  • The method isParamsValid performs some sanity checks.
  • The method calculateTicks performs the actual calculation

Override these methods to create custom implementations of Tick intervals in SciChart

remarks

See also TickProvider for the base implementation.

Hierarchy

Index

Constructors

constructor

Properties

parentAxis

parentAxis: AxisCore

Gets the parent Axis this TickProvider is attached to

Methods

attachedToAxis

  • Called when the TickProvider is attached to an Axis

    Parameters

    Returns void

Protected calculateTicks

  • calculateTicks(visibleRange: NumberRange, delta: number, majorDelta: number): number[]
  • summary

    Performs the Numeric tick calculation

    Parameters

    • visibleRange: NumberRange

      The current AxisCore.visibleRange which is the minimum / maximum range visible on the Axis.

    • delta: number

      The delta we are calculating for (could be major or minor delta)

    • majorDelta: number

      The current AxisCore.majorDelta which is the difference between major gridlines requested by the Axis

    Returns number[]

detachedFromAxis

  • detachedFromAxis(): void
  • Called when the TickProvider is attached from an Axis

    Returns void

getMajorTicks

  • getMajorTicks(minorDelta: number, majorDelta: number, visibleRange: NumberRange): number[]
  • inheritdoc

    Parameters

    • minorDelta: number
    • majorDelta: number
    • visibleRange: NumberRange

    Returns number[]

getMinorTicks

  • getMinorTicks(minorDelta: number, majorDelta: number, visibleRange: NumberRange): number[]
  • inheritdoc

    Parameters

    • minorDelta: number
    • majorDelta: number
    • visibleRange: NumberRange

    Returns number[]

Protected isParamsValid

  • summary

    Performs sanity checks to see if parameters are valid.

    description

    If this method returns false, then we should not process or compute major/minor gridlines, but instead should return empty array [] in getMajorTicks / getMinorTicks

    Parameters

    Returns boolean

Generated using TypeDoc