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

Readonly domCanvas2D

domCanvas2D: HTMLCanvasElement

Readonly domChartRoot

domChartRoot: HTMLDivElement

Readonly domDivContainer

domDivContainer: HTMLDivElement

Readonly id

id: string

Readonly isDeleted

isDeleted: boolean

Readonly otherSurfaces

otherSurfaces: ISciChartSurfaceBase[]

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.

Readonly themeProvider

themeProvider: IThemeProvider

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

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
  • Parameters

    • Optional clearHtml: boolean

    Returns void

invalidateElement

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

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

    Returns void

Generated using TypeDoc