Options
All
  • Public
  • Public/Protected
  • All
Menu
summary

Defines the interface to a 2D Cartesian SciChartSurface or 3D Cartesian SciChart3DSurface within SciChart - High Performance Realtime JavaScript Charts

remarks

See derived types SciChartSurface (2D Charts) and SciChart3DSurface (3D Charts) for more specific instructions on how to use the SciChartSurface and create a 2D or 3D JavaScript Chart

Hierarchy

Implemented by

Index

Properties

domBackgroundSvgContainer

domBackgroundSvgContainer: SVGSVGElement

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

Readonly domCanvas2D

domCanvas2D: HTMLCanvasElement

The {@link HTMLCanvasElement} which is the HTML5 canvas which SciChart draws overlays (cursors, tooltips) to

Readonly domChartRoot

domChartRoot: HTMLDivElement

The {@link HTMLDivElement} which is the dom chart root

Readonly domDivContainer

domDivContainer: HTMLDivElement

The inner {@link HTMLDivElement} div element

Readonly 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

Readonly id

id: string

Gets the ISciChartSurfaceBase Id

Readonly isDeleted

isDeleted: boolean

Used internally - gets isDeleted flag

Readonly otherSurfaces

otherSurfaces: ISciChartSurfaceBase[]

Used internally - gets other SciChartSurfaces

preRender

preRender: 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.

renderError

renderError: EventHandler<any>

An event handler which notifies its subscribers when an error occurs during chart rendering. A listener receives the error object via params.

rendered

rendered: 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.

resized

resized: EventHandler<Size>

An event handler which notifies its subscribers when a chart root element was resized.

surfaceType

surfaceType: ESurfaceType

Gets the Surface Type. See ESurfaceType for list of values

Readonly themeProvider

themeProvider: IThemeProvider

Used internally - gets the previous IThemeProvider

Readonly viewRect

viewRect: 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

applyTheme

  • Applies a theme (defined by IThemeProvider) to the current element

    Parameters

    Returns void

changeViewportSize

  • changeViewportSize(width: number, height: number): void
  • Changes the Viewport Size of the SciChartSurfaceBase

    Parameters

    • width: number
    • height: number

    Returns void

delete

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

    Parameters

    • Optional clearHtml: boolean

    Returns void

invalidateElement

  • invalidateElement(options?: { force?: boolean }): void
  • Call invalidateElement() to trigger a redraw of the SciChartSurfaceBase. SciChart's WebGL WebAssembly rendering engine will schedule a redraw a the next time the renderer is free.

    Parameters

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

    Returns void

onResize

  • onResize(width: number, height: number): void
  • Changes the Viewport Size of the SciChartSurfaceBase

    Parameters

    • width: number
    • height: number

    Returns void

Generated using TypeDoc