Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface IFillPaletteProvider

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

The IFillPaletteProvider interface allows you to perform per-point paletting or coloring of series or data-points in Mountain, Column, Candlestick Charts and JavaScript chart types which have a fill or body

remarks

See type IStrokePaletteProvider for per data-point coloring of strokes or outlines

Hierarchy

Implemented by

Index

Properties

Methods

Properties

fillPaletteMode

fillPaletteMode: EFillPaletteMode

Gets the stroke palette mode

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

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

overrideFillArgb

  • overrideFillArgb(xValue: number, yValue: number, index: number, opacity?: number, metadata?: IPointMetadata): number

  • Called by SciChart and may be used to override the color of filled polygon in various chart types.

    remarks

    WARNING: CALLED PER-VERTEX, MAY RESULT IN PERFORMANCE DEGREDATION IF COMPLEX CODE EXECUTED HERE

    Parameters

    • xValue: number

      the current XValue

    • yValue: number

      the current YValue

    • index: number

      the current index to the data

    • Optional opacity: number

      the current opacity

    • Optional metadata: IPointMetadata

      the point metadata

    Returns number

    an ARGB color code, e.g. 0xFFFF0000 would be red, or 'undefined' for default colouring

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