Options
All
  • Public
  • Public/Protected
  • All
Menu

Class MetadataPaletteProvider

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

Hierarchy

  • MetadataPaletteProvider

Implements

Index

Properties

Methods

Properties

fillPaletteMode

fillPaletteMode: EFillPaletteMode = EFillPaletteMode.SOLID

strokePaletteMode

strokePaletteMode: EStrokePaletteMode = EStrokePaletteMode.SOLID

Methods

onAttached

onDetached

  • onDetached(): void

overrideFillArgb

  • overrideFillArgb(xValue: number, yValue: number, index: number, opacity?: number, metadata?: IColorMetadata): 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: IColorMetadata

      the point metadata

    Returns number

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

overridePointMarkerArgb

  • inheritdoc

    Parameters

    • xValue: number
    • yValue: number
    • index: number
    • Optional opacity: number
    • Optional metadata: IColorMetadata

    Returns TPointMarkerArgb

overrideStrokeArgb

  • overrideStrokeArgb(xValue: number, yValue: number, index: number, opacity?: number, metadata?: IColorMetadata): 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

    • Optional metadata: IColorMetadata

      the point metadata

    Returns number

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

Generated using TypeDoc