Options
All
  • Public
  • Public/Protected
  • All
Menu

Hierarchy

Implements

Index

Constructors

constructor

Properties

Protected deletables

deletables: IDeletable[] = []

Protected destinations

destinations: TSciChartDestination[]

domBackgroundSvgContainer

domBackgroundSvgContainer: SVGSVGElement

The {@link SVGSVGElement} placed on the background and could be used instead of domSvgContainer

domCanvas2D

domCanvas2D: HTMLCanvasElement

domChartRoot

domChartRoot: HTMLDivElement

domDivContainer

domDivContainer: HTMLDivElement

domSeriesBackground

domSeriesBackground: HTMLDivElement

The inner {@link HTMLDivElement} div element placed on the background

domSvgAdornerLayer

domSvgAdornerLayer: SVGSVGElement

The {@link SVGSVGElement} which is the SVG adorner layer canvas, is used for annotation adorners

domSvgContainer

domSvgContainer: SVGSVGElement

The {@link SVGSVGElement} which is the SVG canvas which SciChart adds elements (tooltips, annotations) to

Protected idProperty

idProperty: string = generateGuid()

Protected isDeletedProperty

isDeletedProperty: boolean = false

Readonly painted

painted: EventHandler<any> = new EventHandler<any>()

An event handler which notifies its subscribers when a chart was visually painted a display canvas.

remarks

Not applicable to sub-charts

preRender

preRender: EventHandler<any> = new EventHandler<any>()

An event handler which notifies its subscribers when a render operation starts. Use this to update elements of the chart for the current render. Any updates made here will not trigger a subsequent render.

Readonly renderError

renderError: EventHandler<any> = new EventHandler<any>()

rendered

rendered: EventHandler<boolean> = new EventHandler<boolean>()

An event handler which notifies its subscribers when a render operation has finished. Use this to time render performance, or to update elements of the chart or your UI on redraw.

Readonly resized

resized: EventHandler<Size> = new EventHandler<Size>()

Abstract surfaceType

surfaceType: ESurfaceType

Accessors

id

  • get id(): string
  • set id(value: string): void
  • Gets or sets the SciChartSurface Id

    Returns string

  • Gets or sets the SciChartSurface Id

    Parameters

    • value: string

    Returns void

isDeleted

  • get isDeleted(): boolean
  • Used internally - gets isDeleted flag

    Returns boolean

otherSurfaces

  • Used internally - gets other SciChartSurfaces

    Returns ISciChartSurfaceBase[]

themeProvider

  • Returns IThemeProvider

viewRect

  • get viewRect(): Rect
  • Returns Rect

Methods

addDeletable

  • Add an IDeleteable object to the surface which will have its delete method called when the surface is deleted

    Parameters

    Returns void

Abstract applyTheme

Abstract changeViewportSize

  • changeViewportSize(width: number, height: number): void

Abstract delete

  • delete(): void

Protected getOtherSurfaces

Abstract invalidateElement

  • invalidateElement(options?: { force?: boolean }): void
  • Parameters

    • Optional options: { force?: boolean }
      • Optional force?: boolean

    Returns void

onResize

  • onResize(width: number, height: number): void
  • Parameters

    • width: number
    • height: number

    Returns void

Generated using TypeDoc