ISciChartSurface Interface Members
The following tables list the members exposed by ISciChartSurface.
Public Properties
Name | Description | |
---|---|---|
AdornerLayerCanvas | Gets the Adorner Layer over the chart | |
AnnotationOverlaySurface | Gets the Annotation Canvas over the chart | |
Annotations | Gets the SciChart.Charting.Visuals.Annotations.AnnotationCollection which provides renderable annotations over the SciChartSurface | |
AnnotationUnderlaySurface | Gets the Annotation Canvas under the chart | |
ChartModifier | Gets or sets the current ChartModifier, which alters the behaviour of the chart | |
ChartTitle | Gets or sets an optional Chart Title, displayed above the chart surface (Inherited from SciChart.Charting.Visuals.ISciChartSurfaceBase) | |
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. (Inherited from SciChart.Charting.Visuals.ISciChartSurfaceBase) | |
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 (Inherited from SciChart.Charting.Visuals.ISciChartSurfaceBase) | |
GridLinesPanel | Gets the GridLinesPanel where gridlines are drawn | |
IsDisposed | True if the SciChartSurfaceBase has been disposed. If so do not draw! (Inherited from SciChart.Charting.Visuals.ISciChartSurfaceBase) | |
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 (Inherited from SciChart.Charting.Visuals.ISciChartSurfaceBase) | |
LicenseDaysRemaining | Gets the number of license days remaining | |
ModifierSurface | Gets the ModifierSurface, which is used to draw primitives for the Chart Modifiers (Inherited from SciChart.Charting.Visuals.ISciChartSurfaceBase) | |
RenderableSeries | Gets the collection of RenderableSeries that this SciChartSurface draws. | |
RenderPriority | Gets or sets the RenderPriority. The default is RenderPriority.Normal (Inherited from SciChart.Charting.Visuals.ISciChartSurfaceBase) | |
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. (Inherited from SciChart.Charting.Visuals.ISciChartSurfaceBase) | |
RootGrid | Gets the Root Grid that hosts the SciChart RenderSurface, GridLinesPanel, X-Axis and Y-Axes (Left and right) | |
SelectedRenderableSeries | Gets the collection of RenderableSeries that are selected. | |
SeriesSource | The SeriesSource property allows data-binding to a collection of SciChart.Charting.Model.ChartSeries.IChartSeriesViewModel instances, for pairing of SciChart.Charting.Model.DataSeries.DataSeries<TX,TY> with SciChart.Charting.Visuals.RenderableSeries.IRenderableSeries | |
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 (Inherited from SciChart.Charting.Visuals.ISciChartSurfaceBase) | |
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. (Inherited from SciChart.Charting.Visuals.ISciChartSurfaceBase) | |
ViewportManager | Gets or sets the current ViewportManager, which alters the behaviour of the viewport (X,Y range) when the chart is rendered | |
XAxes | Gets the collection of X-Axis SciChart.Charting.Visuals.Axes.IAxis that this SciChartSurface measures against | |
XAxis | Gets or sets the XAxis control on the SciChartSurface | |
YAxes | Gets the collection of Y-Axis SciChart.Charting.Visuals.Axes.IAxis that this SciChartSurface measures against | |
YAxis | Gets or sets the primary YAxis control on the SciChartSurface (default side=Right) | |
ZoomHistoryManager | Gets or sets the current ZoomHistoryManager, which is responsible for VisibleRange history for all axes | |
ZoomState | Gets or sets the ZoomState of the SciChartSurface, e.g. if user is zooming, or not |
Public Methods
Name | Description | |
---|---|---|
AnimateZoomExtents | Zooms to extents with the specified animation duration (Inherited from SciChart.Charting.Visuals.ISciChartController) | |
AnimateZoomExtentsX | Zooms the chart to the extents of the data in the X-Direction (Inherited from SciChart.Charting.Visuals.ISciChartController) | |
AnimateZoomExtentsY | Zooms the chart to the extents of the data in the Y-Direction, accounting for the current data in view in the X-direction (Inherited from SciChart.Charting.Visuals.ISciChartController) | |
AttachDataSeries | Attaches listeners for DataSeries.DataSeriesChanged | |
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) | |
DetachDataSeries | Detaches listeners for DataSeries.DataSeriesChanged | |
Dispose | Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources. (Inherited from System.IDisposable) | |
ExportToBitmapSource | Export snapshot of current SciChartSurface to System.Windows.Media.Imaging.BitmapSource | |
ExportToFile | Saves snapshot of current SciChartSurfaceBase to file (Inherited from SciChart.Charting.Visuals.ISciChartSurfaceBase) | |
ExportToStream | Saves snapshot of current SciChartSurfaceBase to Stream (Inherited from SciChart.Charting.Visuals.ISciChartSurfaceBase) | |
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) | |
OnArrangeSciChart | Preparations for a render pass, called internally, returns the viewport size | |
OnAxisAlignmentChanged | Called internally by SciChart when SciChart.Charting.Visuals.Axes.IAxis.AxisAlignment changes. Allows the SciChartSurface to reposition the axis, e.g. at the top, left, bottom, right | |
OnIsCenterAxisChanged | Called internally by SciChart when SciChart.Charting.Visuals.Axes.IAxis.IsCenterAxis changes. Allows the SciChartSurface to place the axis in the center of chart | |
OnSciChartRendered | Raises the SciChartSurfaceBase.Rendered event, fired at the end of a render pass immediately before presentation to the screen (Inherited from SciChart.Charting.Visuals.ISciChartSurfaceBase) | |
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 (Inherited from SciChart.Charting.Visuals.ISciChartSurfaceBase) | |
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) | |
ZoomExtents | Zooms the chart to the extents of the data, plus any X or Y Grow By fraction set on the X and Y Axes (Inherited from SciChart.Charting.Visuals.ISciChartController) | |
ZoomExtentsX | Zooms the chart to the extents of the data in the X-Direction (Inherited from SciChart.Charting.Visuals.ISciChartController) | |
ZoomExtentsY | Zooms the chart to the extents of the data in the Y-Direction, accounting for the current data in view in the X-direction (Inherited from SciChart.Charting.Visuals.ISciChartController) |
Extension Methods
Name | Description | |
---|---|---|
SafeDispose | Checks for null and if not null, calls Dispose |
Public Events
Name | Description | |
---|---|---|
AnnotationsCollectionNewCollectionAssigned | Event raised when Annotations DependencyProperty is changed | |
AxisAlignmentChanged | Event raised when alignment of any axis changed | |
XAxesCollectionNewCollectionAssigned | Event raised when XAxes DependnecyProperty is changed | |
YAxesCollectionNewCollectionAssigned | Event raised when YAxes DependnecyProperty is changed |
See Also