Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface IAdvancedPaletteProvider

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

Hierarchy

Index

Properties

Methods

Properties

Optional isRangeIndependant

isRangeIndependant: boolean

Set true if the paletting does not depend on the visible Range. This prevents the palette being recalculated if only the visible range changes.

Methods

applyPaletting

  • applyPaletting(palettingState: TPalettingState, xValues: SCRTDoubleVector, yValues: SCRTDoubleVector, indexes: SCRTDoubleVector, startIndex: number, count: number): void

  • Parameters

    • palettingState: TPalettingState
    • xValues: SCRTDoubleVector
    • yValues: SCRTDoubleVector
    • indexes: SCRTDoubleVector
    • startIndex: number
    • count: number

    Returns void

onAttached

  • Called when the PaletteProvider instance is attached to a RenderableSeries. Use this to be notified when attached and keep a reference to the parent series

    Parameters

    Returns void

onDetached

  • onDetached(): void

Optional shouldUpdatePalette

  • shouldUpdatePalette(): boolean

  • Called once before the per-vertex loop starts.

    Returns boolean

    true if paletting should be forced to run. If this exists and returns false, the existing paletting state is reused if possible. If this does NOT exist, the palette will be recalculated on every render. This default will change in v4. Use this to force the palette to be recalculated if some external parameter to it changes.

Optional toJSON

Generated using TypeDoc