Options
All
  • Public
  • Public/Protected
  • All
Menu

Class ExtremeResamplerHelper

Go to JavaScript Charting Documentation
Go to JavaScript Chart Examples
Go to SciChart.js on Github

Helper class for functions which optimise drawing

Hierarchy

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Properties

Readonly nativeMergeIndexParams

nativeMergeIndexParams: SCRTDoubleResamplerMergeIndicesParams

Methods

copyValuesByIndexes

  • copyValuesByIndexes(indices: IntVector, xValues: SCRTDoubleVector, yValues: SCRTDoubleVector, y1Values: SCRTDoubleVector, count: number, isCategoryAxis: boolean, isFifoSweeping: boolean, indicesOut: SCRTDoubleVector, xValuesOut: SCRTDoubleVector, yValuesOut: SCRTDoubleVector, y1ValuesOut: SCRTDoubleVector, y1Offset?: number): void

  • Parameters

    • indices: IntVector
    • xValues: SCRTDoubleVector
    • yValues: SCRTDoubleVector
    • y1Values: SCRTDoubleVector
    • count: number
    • isCategoryAxis: boolean
    • isFifoSweeping: boolean
    • indicesOut: SCRTDoubleVector
    • xValuesOut: SCRTDoubleVector
    • yValuesOut: SCRTDoubleVector
    • y1ValuesOut: SCRTDoubleVector
    • Default value y1Offset: number = 0

    Returns void

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

getNativeResamplingMode

  • Parameters

    Returns ResamplingMode

mergeIndexes

  • mergeIndexes(indices: IntVector, size1: number, size2: number, mergedIndicesOut: IntVector): number

  • Parameters

    • indices: IntVector
    • size1: number
    • size2: number
    • mergedIndicesOut: IntVector

    Returns number

needsResampling

  • needsResampling(rp: ResamplingParams, xOriginalValues: SCRTDoubleVector, fillBasicNativeArgs?: boolean, updateResamplingMode?: boolean): boolean

  • Calls native RequiresReduction method to calculate if resampling is needed

    Parameters

    • rp: ResamplingParams

      The resampling params

    • xOriginalValues: SCRTDoubleVector

      XValues

    • Default value fillBasicNativeArgs: boolean = true

      Update nativeArgs if True

    • Default value updateResamplingMode: boolean = false

      Update {@link ResamplingArgs.Resampling} property if True

    Returns boolean

resampleIntoPointSeries

  • resampleIntoPointSeries(wasmContext: TSciChart, rp: ResamplingParams, xOriginalValues: SCRTDoubleVector, yOriginalValues: SCRTDoubleVector, indexesOut: IntVector, indexesResampledOut: SCRTDoubleVector, xResampledValuesOut: SCRTDoubleVector, yResampledValuesOut: SCRTDoubleVector, fillBasicNativeArgs?: boolean): { OutputSplitIndex: number }

  • This method calls does resampling by calling the native resampling methods. It does similar things as WPF AvxExtremeResamplerDoubleDouble.ResampleInternal() method The needsResampling() method must be called before, this is done in SciChartRenderer.resampleSeries

    Parameters

    • wasmContext: TSciChart

      The WebAssembly context

    • rp: ResamplingParams

      The resampling parameters

    • xOriginalValues: SCRTDoubleVector

      The original not resampled X values

    • yOriginalValues: SCRTDoubleVector

      The original not resampled Y values

    • indexesOut: IntVector

      The indices output

    • indexesResampledOut: SCRTDoubleVector
    • xResampledValuesOut: SCRTDoubleVector

      The resampled X values output

    • yResampledValuesOut: SCRTDoubleVector

      The resampled Y values output

    • Default value fillBasicNativeArgs: boolean = true

      If set to True resets and fill nativeArgs with basic properties, you can set it to False if {@link needsResampling()} was called before this method

    Returns { OutputSplitIndex: number }

    indicesVector The resampled vector of indices

    • OutputSplitIndex: number

resetAndFillBasicNativeArgs

  • resetAndFillBasicNativeArgs(rp: ResamplingParams, xOriginalValues: SCRTDoubleVector): void

  • Fills basic native args needed for {@link needsResampling()} and resampleIntoPointSeries methods

    Parameters

    Returns void

Generated using TypeDoc