Gets the SciChartSurface Background as an HTML color code
Used internally
Gets Chart Modifier Groups, is used for sharing events between chart modifiers
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.
Controls the rendering of {@link SiCharSurface.title}
Gets or sets if the clipping mode of the sub-chart
Gets or sets the ECoordinateMode used when calculating the actual position based on the subPosition
The {@link SVGSVGElement} placed on the background and could be used instead of domSvgContainer
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 inner {@link HTMLDivElement} div element placed on the background
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
Gets the ISciChartSurfaceBase Id
Used internally - gets isDeleted flag
Gets a value indicating whether updates for the target are currently suspended
Gets or Sets whether other surfaces, including the parent, will be visible underneath this surface
Gets or sets if the subchart is visible, allowing you to hide a subchart without removing it from the parent surface
Used internally to prevent redraw attamps if the webGL context ahs been lost
Used internally - gets or sets the LayoutManager
The MouseManager subscribes to mouse events on the domChartRoot and routes them to components within SciChart
Used internally - gets other SciChartSurfaces
Gets or sets the Padding between the ISciChartSurface and its inner elements, in order top, right, bottom, left
The parent ISciChartSurface, if this is a subChart
Gets or sets the parent chart AxisId used to determine which X Axis should be used when calculating the actual position based on the subPosition if coordinateMode is DataValue
Gets or sets the parent chart AxisId used to determine which Y Axis should be used when calculating the actual position based on the subPosition if coordinateMode is DataValue
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.
An event handler which notifies its subscribers when an error occurs during chart rendering. A listener receives the error object via params.
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.
An event handler which notifies its subscribers when a chart root element was resized.
Gets or sets scale property for all sections It is necessary if the scale transformation is being used for html areas around the subchart For example, style = { width: "50%", transform: scale(2), transformOrigin: 'left top' }
Gets the Series View Rect, a rectangle relative to the entire size of the SciChartSurfaceBase
The {@link HTMLDivElement} which is the dom sub-chart root
Gets the sub-chart counter value
A rectangle defining the position and size of a subchart. If coordinateMode is Relative (the default) then the values give the size as a proportion of the parent div, and all properties must be between 0 and 1 inclusive. If coordinateMode is DataValue, values will be converted to coordinates using parentXAxisId and parentYAxisId. Subchart will be clpped to the parent SeriesViewRect Can only be set if this is a subChart.
Gets the Surface Type. See ESurfaceType for list of values
Used internally - gets the previous IThemeProvider
Gets or sets the title text style and placement for the SciChartSurface as TChartTitleStyle
The SciChart 2D WebAssembly Context containing native methods and access to our WebGL2 Engine and WebAssembly numerical methods
Add an IDeleteable object to the surface which will have its delete method called when the surface is deleted
Used internally - Adds a sub-chart
Applies a theme (defined by IThemeProvider) to the current element
The theme data to apply
Changes the Viewport Size of the SciChartSurfaceBase
Deletes native (WebAssembly) memory used by this type, after which it cannot be used.
Runs the drawing loop. Get context and pass drawing to SciChartRenderer
Gets the default XAxis, which is the first one X axis attached to the surface.
Gets the default YAxis, which is the first one Y axis attached to the surface.
Gets the main WebGL or 2D canvas
Gets the sub-chart container
Gets the sub-chart rect on the parent surface. Defines the viewport size of the sub-surface. TThis rect is a subset of the SciChartSubSurface.subPosition considering the SubChart Wrapper content areas
Gets or sets the drawing order for surfaces and their subsurfaces. This allows for a parent surface to draw over a subsurface. This does not affect the drawing order of separate surfaces - use z-index on the container div to control that.
Gets the XAxis which matches the axisId. Returns undefined if not axis found
The AxisId to search for
Gets the YAxis which matches the axisId. Returns undefined if no axis found
The AxisId to search for
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.
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
Changes the Viewport Size of the SciChartSurfaceBase
Resumes updates on the target
Used internally, the flag is set after SciChartSurfaceBase is initialized
Suspends updates on the target
Recalculate the position of the subChart. Call if you update the size of html elements in the wrapper
An optional animation duration. Default value is 0, which means 'no animation'
An optional easing function for animations. See TEasingFn for a list of values
Generated using TypeDoc
Gets the adjusted padding between the SciChartSurface and its inner elements, in order top, right, bottom, left Defines a resulting padding accordingly to DPI scaling.