Options
All
  • Public
  • Public/Protected
  • All
Menu

A ShaderEffect can be applied to a RenderableSeries via the BaseRenderableSeries.effect property. The effect modifies the render output of the chart type.

Hierarchy

Implements

Index

Constructors

Protected constructor

  • Creates an instance of the ShaderEffect

    Parameters

    • webAssemblyContext: TSciChart

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

    • seriesEffect: SCRTSeriesEffect

      The native {@link SCRTSeriesEffect} instance that provides the shader effect

    • Optional options: IShaderEffectOptions

      Optional parameters of type IShaderEffectOptions to configure the effect

    Returns ShaderEffect

Properties

propertyChanged

Event handler for when properties change, signalling that the parent SciChartSurface needs to redraw

Readonly Abstract type

Accessors

color

  • get color(): string
  • set color(color: string): void
  • Gets or sets the color property as an HTML Color code

    Returns string

  • Gets or sets the color property as an HTML Color code

    Parameters

    • color: string

    Returns void

intensity

  • get intensity(): number
  • set intensity(intensity: number): void
  • Gets or sets the intensity property

    Returns number

  • Gets or sets the intensity property

    Parameters

    • intensity: number

    Returns void

offset

  • get offset(): Point
  • set offset(offset: Point): void
  • Gets or sets the offset property

    Returns Point

  • Gets or sets the offset property

    Parameters

    Returns void

range

  • get range(): number
  • set range(range: number): void
  • Gets or sets the range property

    Returns number

  • Gets or sets the range property

    Parameters

    • range: number

    Returns void

Methods

delete

  • delete(): void
  • Returns void

getNativeEffect

  • getNativeEffect(): SCRTSeriesEffect
  • Gets the native {@link SCRTSeriesEffect} which contains the shader effect that will be applied in WebGL

    Returns SCRTSeriesEffect

notifyPropertyChanged

  • notifyPropertyChanged(propertyName: string): void
  • Notifies subscribers to propertyChanged that a property has changed and the parent SciChartSurface needs to redraw

    Parameters

    • propertyName: string

    Returns void

toJSON

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

    Returns TEffectDefinition

Generated using TypeDoc