Options
All
  • Public
  • Public/Protected
  • All
Menu

The IStrokePaletteProvider interface allows you to perform per-point paletting or coloring of series or data-points in Line Charts and JavaScript chart types which have a stroke line or outline

remarks

See type IFillPaletteProvider for per data-point coloring of fills or areas.

Hierarchy

Implemented by

Index

Properties

Readonly strokePaletteMode

strokePaletteMode: EStrokePaletteMode

Gets the stroke palette mode

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

overrideStrokeArgb

  • overrideStrokeArgb(xValue: number, yValue: number, index: number, opacity?: number): number
  • Called by SciChart and may be used to override the color of a line segment or stroke outline 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

    Returns number

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

Generated using TypeDoc