Options
All
  • Public
  • Public/Protected
  • All
Menu

Used internally - a drawing provider performs drawing for a specific chart-type or series using our WebAssembly WebGL rendering engine

Type parameters

Hierarchy

Implements

Index

Constructors

Protected constructor

  • Creates an instance of the BaseSeriesDrawingProvider

    Parameters

    • webAssemblyContext: TSciChart

      The {@link TSciChart | SciChart 2D WebAssembly Context} containing native methods and access to our WebGL2 Engine and WebAssembly numerical methods

    • parentSeries: T

      the parent Renderable Series which this drawing provider is attached to

    Returns BaseSeriesDrawingProvider

Properties

Protected palettingState

palettingState: TPalettingState

The Colour Paletting State object.

Protected parentSeries

parentSeries: T

The Parent RenderableSeries

Protected webAssemblyContext

webAssemblyContext: TSciChart

The {@link TSciChart | SciChart 2D WebAssembly Context} containing native methods and access to our WebGL2 Engine and WebAssembly numerical methods

Methods

applyStrokeFillPaletting

  • applyStrokeFillPaletting(stroke: string, strokePen: ISCRTPen, fill: string, fillBrush: ISCRTBrush, opacity: number, usePalette?: boolean, resetPenBrushColors?: boolean): void
  • Parameters

    • stroke: string
    • strokePen: ISCRTPen
    • fill: string
    • fillBrush: ISCRTBrush
    • opacity: number
    • Default value usePalette: boolean = false
    • Default value resetPenBrushColors: boolean = true

    Returns void

applyStrokePaletting

  • applyStrokePaletting(strokePen: ISCRTPen): void
  • Helper function to apply color-paletting to a {@link UIntVector} - where each element in the vector is an ARGB color that defines stroke of the series

    Parameters

    • strokePen: ISCRTPen

      the current pen, as type {@link SCRTPen}

    Returns void

    the new {@link UIntVector} with ARGB colors

createSolidBrush

  • createSolidBrush(htmlColorCode: string, opacity: number): SCRTBrush
  • Creates a native {@link SCRTBrush} Solid Color Brush from html color code string passed in

    Parameters

    • htmlColorCode: string

      The HTML Color code

    • opacity: number

      The opacity factor

    Returns SCRTBrush

delete

  • delete(): void
  • Deletes native (WebAssembly) memory used by this type, after which it cannot be used.

    remarks

    Call .delete() before finishing with the object to ensure that WebAssmembly memory leaks do not occur.

    All elements within SciChart's High Performance Realtime JavaScript Charts which implement IDeletable must be deleted manually to free native (WebAssembly) memory

    Returns void

Abstract draw

Protected isGradientFillPaletting

  • Parameters

    Returns boolean

onAttachSeries

  • onAttachSeries(): void
  • Called when this drawing provider instance is attached to a RenderableSeries. Override in derived classes to perform one-time setup

    Returns void

onDetachSeries

  • onDetachSeries(): void
  • Called when this drawing provider instance is detached from a RenderableSeries. Override in derived classes to perform tear-down

    Returns void

onDpiChanged

  • Called when the Dpi changes in the browser. This could be due to user zooming the browser, or changing DPI settings in Windows, or moving the browser containing SciChart to another monitor

    Parameters

    Returns void

onSeriesPropertyChange

  • onSeriesPropertyChange(propertyName: string): void

Protected overridePaletteProviderColors

  • overridePaletteProviderColors(rs: IRenderableSeries, xValue: number, yValue: number, index: number, opacity?: number, metadata?: IPointMetadata): { fill: number; stroke: number }
  • Parameters

    Returns { fill: number; stroke: number }

    • fill: number
    • stroke: number

Protected seriesHasDataChanges

  • seriesHasDataChanges(): void
  • Returns void

Generated using TypeDoc