ISciChartSurfaceBase Interface Members
The following tables list the members exposed by ISciChartSurfaceBase.
Public Properties
Name | Description | |
---|---|---|
ChartTitle | Gets or sets an optional Chart Title, displayed above the chart surface | |
ClipModifierSurface | Gets or sets a value whether to clip the ChartModifierSurface property to bounds. Default | |
DebugWhyDoesntSciChartRender | Gets or sets a flag whether SciChart should output rendering exceptions and 'Why Scichart Doesn't Render' reasons to the Debug Console. Default is True. | |
EnableMultiThreadedRendering | Gets or sets a value indicating if SciChart can use Multi-Threaded rendering (where available). This will seek to use multiple cores to speed up the drawing process but will result in higher CPU usage. This is recommended if the bottleneck is drawing, but not recommended if the bottleneck is some other process e.g. simulation or computation | |
IsDisposed | True if the SciChartSurfaceBase has been disposed. If so do not draw! | |
IsSuspended | Gets a value indicating whether updates for the target are currently suspended (Inherited from SciChart.Core.Framework.ISuspendable) | |
IsVisible | Gets the a value indicating whether this ISciChartSurfaceBase is visible | |
ModifierSurface | Gets the ModifierSurface, which is used to draw primitives for the Chart Modifiers | |
RenderPriority | Gets or sets the RenderPriority. The default is RenderPriority.Normal | |
RenderSurface | Gets or sets the RenderSurface implementation that this SciChartSurfaceBase uses. Default implementation for a SciChartSurface is a SciChart.Drawing.HighSpeedRasterizer.HighSpeedRenderSurface, however SciChart supports additional render surfaces, providing high quality software and high speed hardware accelerated or 3D renderers. | |
Services | Gets the SciChart.Core.Utility.ServiceContainer which provides access to services throughout SciChart. ServiceContainers are created one per SciChartSurface instance, and shared between peripheral components such as SciChart.Charting.Visuals.Axes.AxisBase, SciChart.Charting.Visuals.RenderableSeries.BaseRenderableSeries, SciChart.Charting.ChartModifiers.ChartModifierBase instances. For a full list of available services, see the remarks on SciChart.Core.Utility.ServiceContainer | |
SyncRoot | A synchronization object which is locked during a render pass. If you lock this SciChart will not render and will be blocked on the UI thread until the lock is released. This is used internally by DataSeries to lock the SciChartSurface when bulk updates are done. |
Public Methods
Name | Description | |
---|---|---|
DecrementSuspend | Called by IUpdateSuspender each time a target suspender is disposed. When the final target suspender has been disposed, ResumeUpdates is called (Inherited from SciChart.Core.Framework.ISuspendable) | |
ExportToBitmapSource | Overloaded. Export snapshot of current SciChartSurfaceBase to System.Windows.Media.Imaging.BitmapSource | |
ExportToFile | Overloaded. Saves snapshot of current SciChartSurfaceBase to file | |
ExportToStream | Overloaded. Saves snapshot of current SciChartSurfaceBase to Stream | |
InvalidateElement | Asynchronously requests that the element redraws itself plus children. Will be ignored if the element is ISuspendable and currently IsSuspended (within a SuspendUpdates/ResumeUpdates call) (Inherited from SciChart.Core.Framework.IInvalidatableElement) | |
OnSciChartRendered | Raises the SciChartSurfaceBase.Rendered event, fired at the end of a render pass immediately before presentation to the screen | |
ResumeUpdates | Resumes updates on the target, intended to be called by IUpdateSuspender (Inherited from SciChart.Core.Framework.ISuspendable) | |
SetMouseCursor | Sets a Cursor on the SciChartSurface | |
SuspendUpdates | Suspends drawing updates on the target until the returned object is disposed, when a final draw call will be issued (Inherited from SciChart.Core.Framework.ISuspendable) |
Public Events
See Also