Options
All
  • Public
  • Public/Protected
  • All
Menu

The CoordinateCalculatorBase class provides methods for converting between Pixel and Data coordinates

remarks

SciChart's JavaScript Charts perform conversion operations between data-coordinates for all drawing and axis measurements.

You can fetch a CoordinateCalculator instance by calling AxisCore.getCurrentCoordinateCalculator. This will return a unique calculator for the current draw pass.

You can convert pixel to data-coordinates and back by using the following code:

const axis: AxisCore;
const calc = axis.getCurrentCoordinateCalculator();

const pixel = calc.getCoordinate(1.23); // Gets the pixel coordinate for data-value 1.23
const dataValue = cald.getDataValue(pixel); // Performs the inverse operation to get data-value

Use the Coordinate calculators when drawing, placing markers, annotations or if you want to place a tooltip over the chart.

Hierarchy

Implements

Index

Constructors

Protected constructor

  • new CoordinateCalculatorBase(webAssemblyContext: TSciChart | TSciChart3D, viewportDimension: number, visibleMin: number, visibleMax: number, offset: number, hasFlippedCoordinates: boolean, isCategoryCoordinateCalculator?: boolean): CoordinateCalculatorBase
  • Creates an instance of the CoordinateCalculatorBase

    Parameters

    • webAssemblyContext: TSciChart | TSciChart3D

      The {@link TSciChart | SciChart 2D WebAssembly Context} or {@link TSciChart2D | SciChart 2D WebAssembly Context} containing native methods and access to our WebGL2 Engine and WebAssembly numerical methods

    • viewportDimension: number

      The size of the associated Axis at the time of drawing

    • visibleMin: number

      The AxisCore.visibleRange.min at the time of drawing

    • visibleMax: number

      The AxisCore.visibleRange.max at the time of drawing

    • offset: number

      A constant pixel offset used in coordinate calculations

    • hasFlippedCoordinates: boolean

      When true, this calculator has flipped coordinates

    • Default value isCategoryCoordinateCalculator: boolean = false

      When true, this calculator behaves as a Category coordinate calculator, using index not x-value for measuring

    Returns CoordinateCalculatorBase

Properties

Readonly hasFlippedCoordinates

hasFlippedCoordinates: boolean

When true, this coordinate calculator has flipped coordinates

Readonly isCategoryCoordinateCalculator

isCategoryCoordinateCalculator: boolean

When true, this coordinate calculator behaves as a Category coordinate calculator, using index not x-value for measuring

nativeCalculator

nativeCalculator: CoordinateCalculator

Gets the native (WebAssembly) {@link CoordinateCalculator} instance

Readonly offset

offset: number

Gets or sets a constant offset in pixels for all generated coordinates

Readonly viewportDimension

viewportDimension: number

Gets or sets the ViewportDimension, corresponding to the size of the associated Axis at the time of drawing

Readonly visibleMax

visibleMax: number

Gets or sets the Visible maximum value, corresponding to AxisCore.visibleRange.max at the time of drawing

Readonly visibleMin

visibleMin: number

Gets or sets the Visible minimum value, corresponding to AxisCore.visibleRange.min at the time of drawing

Protected webAssemblyContext

webAssemblyContext: TSciChart | TSciChart3D

The {@link TSciChart | SciChart 2D WebAssembly Context} or {@link TSciChart2D | SciChart 2D WebAssembly Context} containing native methods and access to our WebGL2 Engine and WebAssembly numerical methods

Methods

delete

  • delete(): void
  • Deletes native (WebAssembly) memory used by this type, after which it cannot be used.

    remarks

    Call .delete() before finishing with the object to ensure that WebAssmembly memory leaks do not occur.

    All elements within SciChart's High Performance Realtime JavaScript Charts which implement IDeletable must be deleted manually to free native (WebAssembly) memory

    Returns void

getCoordinate

  • getCoordinate(dataValue: number): number
  • Converts the Data-value to a pixel coordinate Performs the inverse operation to getDataValue

    Parameters

    • dataValue: number

      The data-value

    Returns number

    the pixel coordinate

getDataValue

  • getDataValue(coordinate: number): number
  • Converts the pixel coordinate to a Data-value. Performs the inverse operation to getCoordinate

    Parameters

    • coordinate: number

      The pixel coordiante

    Returns number

    the data value

translateBy

  • Translates a NumberRange in Data-coordinates by a specified number of pixels, performing intermediate calculations from data-value to pixel and back to perform the translation

    Parameters

    Returns NumberRange

    The translated range

zoomTranslateBy

  • Zooms a NumberRange by a specified fractional amount

    Parameters

    • minFraction: number

      The fraction to zoom the NumberRange.min by. A fraction of 0.1 zooms the minimum by 10%

    • maxFraction: number

      The fraction to zoom the NumberRange.max by. A fraction of 0.1 zooms the maximum by 10%

    • inputRange: NumberRange

      The NumberRange to zoom

    Returns NumberRange

    The zoomed range

Generated using TypeDoc