Surface Background as an HTML color code;
Optional - Properties of the canvas border
The clipping mode of the sub-chart
Gets or sets the TSubSurfaceCoordinateMode used when calculating the actual position based on the subPosition.
Optional - the option of disabling / enabling scaling of the SciChartSurfaceBase. If false - the SciChartSurfaceBase will take the height and width of parent div without scaling.
The engine has an internal loop based on requestAnimationFrame which triggers a chart draw on any surfaces that have been invalidated. If you have your own requestAnimationFrame based drawing you wish to synchronise with, you can disable the engine loop by setting this to true. If you do this you are then responsible for calling webassemblyContext.TSRRequestDraw() which will immediately draw all surfaces belonging to the webassemblyContext that have been invalidated. Note that 2D and 3D charts, and all charts created using createSingle have separate webassemblyContexts so you must call TSRRequestDraw() on each one. This setting is applied to the webassembly context when a chart is created, so for SciChartSurface.create this will change the behaviour of all existing charts created using SciChartSurface.create.
Optional - when true, charts that are out of the viewport will be frozen (pausing rendering). Data updates can resume Once the chart is in view again, rendering will resume. This can be useful for performance optimization.
Optional - the height aspect ratio of the SciChartSurfaceBase. By default SciChart will scale to fit the parent Div. However if height of the div is not provided it will use width/height aspect ratio to calculate the height. The default ratio is 3/2.
Allows you to set custom Id for the surface;
Whether other surfaces, including the parent, will be visible underneath this surface
Sets if the subchart is visible, allowing you to hide a subchart without removing it from the parent surface
Optional - Prove a layoutManager to customise the axis layout. Use CentralAxesLayoutManager for an easy way to configure central axes.
Allows you to customize the loading elements or animation as part of the HTML page / DOM when a SciChartSurface or SciChart3DSurface is loading WebAssembly.
Set to false for disabling.
Optional - Padding between the SciChartSurface and its inner elements. Default 10
Sets the AxisId used to determing which X Axis should be used when calculating the actual position based on the subPosition if coordinateMode is DataValue
Sets the AxisId used to determing which Y Axis should be used when calculating the actual position based on the subPosition if coordinateMode is DataValue
A rectangle defining the position and size of a subchart. First two points define xStart and yStart, second two are width and height. 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. See {@link addSubChart}
Gets or sets scale property for all sections
An id or div element that will wrap the subchart. This can contain top, left, bottom and right section divs. The chart will shrink to fit the sections
Optional - The theme applied to the SciChartSurfaceBase on startup
Optional a title for the SciChartSurface
The title text style and placement for the SciChartSurface as TChartTitleStyle
Sets a touch-action property to the canvas style.
Useful if touch interactions in browser should be configured.
https://developer.mozilla.org/en-US/docs/Web/CSS/touch-action
Optional - Properties of the viewport border (where series are drawn)
Optional - the width aspect ratio of the SciChartSurfaceBase. By default SciChart will scale to fit the parent Div. However if height of the div is not provided it will use width/height aspect ratio to calculate the height. The default ratio is 3/2.
Generated using TypeDoc
Optional - An EAutoColorMode which controls how often series colours set to AUTO_COLOR will be resolved. Default OnAddRemoveSeries