Creates an instance of a SciChartSurfaceBase
The SciChart 2D WebAssembly Context or SciChart 3D WebAssembly Context containing native methods and access to our WebGL2 WebAssembly Rendering Engine
A list of TSciChartSurfaceCanvases to draw to
An ObservableArray of IChartModifierBase derived types. Chart Modifiers provide behavior such as zooming, panning, tooltips, legends and more in SciChart's High Performance Realtime JavaScript Charts. You can use our built in modifiers (see derived types of ChartModifierBase, or create your own for custom interaction behavior.
The {@link HTMLCanvasElement} which is the HTML5 canvas which SciChart draws overlays (cursors, tooltips) to
The {@link HTMLCanvasElement} which is the WebGL canvas that SciChart draws to
The {@link HTMLDivElement} which is the dom chart root
The inner {@link HTMLDivElement} div element
The {@link SVGSVGElement} which is the SVG adorner layer canvas, is used for annotation adorners
The {@link SVGSVGElement} which is the SVG canvas which SciChart adds elements (tooltips, annotations) to
The MouseManager subscribes to mouse events on the domChartRoot and routes them to components within SciChart
For serialization Only. The name of the onCreated function applied by the builder api
A propertyChanged EventHandler. See EventHandler for how to subscribe to and be notified when a property changes on the SciChartSurfaceBase
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.
Global property defining whether the WebGL render target is anti-aliased or not. This will affect all SciChartSurfaces (2D & 3D) in the application.
Gets or sets the application-wide default theme. See IThemeProvider for details
Defines if the shared wasmContext (WebAssembly Context) should be deleted after all of the surfaces that use it are deleted.
The master WebGL canvas
Defines a delay of the shared wasmContext auto-dispose if autoDisposeWasmContext is enabled.
Gets or sets the SciChartSurface Background as an HTML color code
Gets or sets the SciChartSurface Background as an HTML color code
Gets or sets the SciChartSurface Id
Gets or sets the SciChartSurface Id
Used internally - gets isDeleted flag
Used internally - gets isInitialized flag
Gets a value indicating whether updates for the target are currently suspended
Used internally - gets other SciChartSurfaces
Used internally - gets the previous IThemeProvider
Gets the Series View Rect, a rectangle relative to the entire size of the SciChartSurfaceBase
Gets the Surface Type. See ESurfaceType for list of values
A unique ID for this suspendable instance. Consider using the generateGuid function to ensure this is unique
Used internally - gets the previous IThemeProvider
When overridden in a derived type, applies an HTML color code or CSS background to surface background
The HTML color code
Applies a theme (defined by IThemeProvider) to the current element
The theme data to apply
Attaches a ChartModifierBase2D to the SciChartSurfaceBase
Changes the Viewport Size of the SciChartSurfaceBase
Called by IUpdateSuspender each time a target suspender is resumed. When the final target suspender has been resumed, resumeUpdates is called
Detaches a ChartModifierBase2D from the SciChartSurfaceBase
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.
Creates a promise which resolves when the chart is updated to the next fully rendered state
The name of the property which has changed
Called when the Dpi changes in the browser. This could be due to user zooming the browser, or changing DPI settings in Windows, or moving the browser containing SciChart to another monitor
The TDpiChangedEventArgs containing info about the Dpi Changed event
USED INTERNALLY. Resumes updates on the target
Used internally - sets destinations
Used internally, the flag is set after SciChartSurfaceBase is initialized
Sets the Series View Rect, a rectangle relative to the entire size of the SciChartSurfaceBase
Suspends drawing updates on the target until the returned object IUpdateSuspender.resume is called, when a final draw call will be issued
Used internally, updates background after switching between different SciChartSurfaces
Used internally - updates watermark
Causes SciChart to always use its built in community non-commercial license. This stops it attempting to look for the license wizard Usage of the community license constitutes acceptance of the terms at https://www.scichart.com/community-licensing/
Deletes the shared wasmContext (WebAssembly Context) used by the charts instantiated with SciChartSurface.create or SciChart3DSurface.create.
Sets function that will be called by the framework to validate a runtime license from the server, if you need to add additional handling, such as custom authentication. The request sent to the server must include the queryString section passed in, which does not come with a leading ?
Sets the runtime license key. Use for full licenses or trials only, not developer licenses.
Sets the endpoint for validating a runtime license key with the server. Must be a relative path.
Generated using TypeDoc
'){kind=link}
The base class for a 2D Cartesian SciChartSurface or 3D Cartesian SciChart3DSurface within SciChart - High Performance Realtime JavaScript Charts
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