Options
All
  • Public
  • Public/Protected
  • All
Menu

Defines a drop-shadow shader effect that may be applied to a RenderableSeries

remarks

To apply a Shadow effect to a chart series, use the following code:

const effect = new ShadowEffect(wasmContext, {
  range: 1,
  brightness: 100,
  offset: new Point(10, 10)
});
const lineSeries = new FastLineRenderableSeries(wasmContext, { stroke, effect });

Note that effects implement IDeletable and must be manually deleted to free webassembly / native memory

Hierarchy

Implements

Index

Constructors

constructor

  • Creates an instance of the ShadowEffect

    Parameters

    • webAssemblyContext: TSciChart

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

    • Optional options: IShadowEffectOptions

      Optional parameters of type IShaderEffectOptions to configure the effect

    Returns ShadowEffect

Properties

propertyChanged

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

Readonly type

type: Shadow = EShaderEffectType.Shadow

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

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

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