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

A base class for Delta Calculators within SciChart's 2D & 3D Charts.

description

The DeltaCalculator is responsible for calculating the min and max deltas on an axis.

A delta is the spacing between two gridlines, so the Major Delta is the spacing between major grid lines and the Minor Delta is the spacing between minor gridlines.

This calculator class computes these and they are later stored on AxisCore.minorDelta and AxisCore.majorDelta properties.

Hierarchy

Index

Properties

parentAxis

parentAxis: AxisCore

The parent AxisCore. This will be set once attachedToAxis is called

Methods

attachedToAxis

  • Called when the DeltaCalculator is attached to an Axis

    Parameters

    • axis: AxisCore

      The Axis we are attached to.

    Returns void

detachedFromAxis

  • detachedFromAxis(): void
  • Called when the DeltaCalculator is detached from Axis

    Returns void

Abstract getDeltaFromRange

  • getDeltaFromRange(min: number, max: number, minorsPerMajor: number, maxTicks: number): NumberRange
  • Gets a Delta from a visiblerange and with the provided properties

    Parameters

    • min: number

      the AxisCore.visibleRange minimum

    • max: number

      the AxisCore.visibleRange maximum

    • minorsPerMajor: number

      A hint of how many minor gridlines you want per major gridline

    • maxTicks: number

      A hint of the maximum number of major gridlines you want on the axis (result will vary depending on zoom level)

    Returns NumberRange

Generated using TypeDoc