Class NumberRangeAnimator

Go to JavaScript Charting Documentation

Go to JavaScript Chart Examples

Go to SciChart.js on Github

A class for animating a value of type NumberRange. Used throughout SciChart to animate AxisCore.visibleRange when zooming or panning.

Hierarchy

NumberRangeAnimator

Index

Methods

Methods

Static animate

animate(from: NumberRange, to: NumberRange, durationMs: number, onAnimate: (value: NumberRange) => void, onCompleted: () => void, easingFunction?: TEasingFn, isLog?: boolean): GenericAnimation<NumberRange>

- Defined in src/Core/Animations/NumberRangeAnimator.ts
Animates a NumberRange with a start, to value over a specified duration and with an optional completed and easing function

Parameters
- from: NumberRange
  
  The start value to animate
- to: NumberRange
  
  The end value to animate
- durationMs: number
  
  The duration of the animation in milliseconds
- onAnimate: (value: NumberRange) => void
  
  A callback function which is called with intermediate values
  - - (value: NumberRange): void
    - Parameters
      - value: NumberRange
      Returns void
- onCompleted: () => void
  
  A callback function which is called when the animation completes
  - - (): void
    - Returns void
- Default value easingFunction: TEasingFn = easing.outExpo
  
  An optional easing function. See IEasingMap for a list of values
- Default value isLog: boolean = false
Returns GenericAnimation<NumberRange>

Static interpolate

interpolate(from: NumberRange, to: NumberRange, interpolationFactor: number): NumberRange

- Defined in src/Core/Animations/NumberRangeAnimator.ts
Parameters
- from: NumberRange
- to: NumberRange
- interpolationFactor: number
Returns NumberRange

Static interpolateLog

interpolateLog(from: NumberRange, to: NumberRange, interpolationFactor: number): NumberRange

- Defined in src/Core/Animations/NumberRangeAnimator.ts
Parameters
- from: NumberRange
- to: NumberRange
- interpolationFactor: number
Returns NumberRange

Generated using TypeDoc