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

The LogarithmicTickProvider is a TickProvider implementation for Logarithmic 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 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

isHighPrecisionTicks

isHighPrecisionTicks: boolean = true

logarithmicBase

logarithmicBase: number = 10

parentAxis

parentAxis: AxisCore

Gets the parent Axis this TickProvider is attached to

Accessors

majorTickMode

  • Gets or sets the mode for Major ticks using ELogarithmicMajorTickMode Equally spaced (best for large ranges) or Round numbers (better for small ranges)

    Returns ELogarithmicMajorTickMode

  • Gets or sets the mode for Major ticks using ELogarithmicMajorTickMode Equally spaced (best for large ranges) or Round numbers (better for small ranges)

    Parameters

    Returns void

minorTickMode

  • Gets or sets the mode for minor ticks using ELogarithmicMinorTickMode, Linear (default, best for smaller ranges), Logarithmic (better for very large ranges) or Auto (switches from linear to Logarithmic when the visible range is such that the first linear minor tick would be more than 70% of the major tick)

    Returns ELogarithmicMinorTickMode

  • Gets or sets the mode for minor ticks using ELogarithmicMinorTickMode, Linear (default, best for smaller ranges), Logarithmic (better for very large ranges) or Auto (switches from linear to Logarithmic when the visible range is such that the first linear minor tick would be more than 70% of the major tick)

    Parameters

    Returns void

Methods

attachedToAxis

  • Called when the TickProvider is attached to an Axis

    Parameters

    Returns void

detachedFromAxis

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

    Returns void

getMajorTicks

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

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

    Returns number[]

getMinorTicks

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

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

    Returns number[]

getRoundNumberMajorTicks

  • getRoundNumberMajorTicks(minorDelta: number, majorDelta: number, visibleRange: NumberRange): number[]
  • 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

roundNum

  • roundNum(value: number, difference?: number): number
  • Parameters

    • value: number
    • Optional difference: number

    Returns number

Generated using TypeDoc