• Public
  • Public/Protected
  • All

The PaletteProvider interface allows you to perform per-point paletting or coloring of series or data-points in SciChart's High Performance Realtime JavaScript Charts


See derived type IStrokePaletteProvider for coloring line series or strokes. See derived type IFillPaletteProvider for coloring fills or areas.


Implemented by



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.



  • 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


    Returns void


  • onDetached(): void
  • Called when the PaletteProvider instance is detached from a RenderableSeries.

    Returns 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

  • Convert the object to a definition that can be serialized to JSON, or used directly with the builder api

    Returns TPaletteProviderDefinition

Generated using TypeDoc