Interface ISciChartSurface
Defines the interface to the SciChartSurface, which contains a single IRenderSurface viewport for rendering multiple IRenderableSeries, X and Y IAxis instances, and where each IRenderableSeries may have a IDataSeries data source.
The SciChartSurface may have zero or many IAnnotation and may have IChartModifier to enable interaction with the chart. Where many IChartModifier are used, you may use a ModifierGroupto group them. See Also: IRenderableSeries, IChartModifier, IDataSeries, SciChartSurface, IAxis, IAnnotation
Namespace:
Assembly: .dll
Syntax
public interface ISciChartSurface extends ISciChartSurfaceBase, ISciChartController, ISuspendableWithLock
Methods
addAxisModifierSurface(IAxisModifierSurface axisModifierSurface)
Used internally to add IAxisModifierSurface into this SciChartSurface
Declaration
public abstract void addAxisModifierSurface(IAxisModifierSurface axisModifierSurface)
Parameters
Type | Name | Description |
---|---|---|
IAxisModifierSurface | axisModifierSurface | The axis modifier surface to add |
getAdornerLayer()
Gets the IAdornerLayer instance for this SciChartSurface
Declaration
public abstract IAdornerLayer getAdornerLayer()
Returns
Type | Description |
---|---|
IAdornerLayer | The adorner layer |
getAnnotationOverlaySurface()
Gets the IAnnotationSurface instance for this SciChartSurface which is placed over the chart
Declaration
public abstract IAnnotationSurface getAnnotationOverlaySurface()
Returns
Type | Description |
---|---|
IAnnotationSurface | The overlay annotation surface |
getAnnotationUnderlaySurface()
Gets the IAnnotationSurface instance for this SciChartSurface which is placed under the chart
Declaration
public abstract IAnnotationSurface getAnnotationUnderlaySurface()
Returns
Type | Description |
---|---|
IAnnotationSurface | The underlay annotation surface |
getAnnotations()
Gets the collection of IAnnotation that this SciChartSurface draws
Declaration
public abstract AnnotationCollection getAnnotations()
Returns
Type | Description |
---|---|
AnnotationCollection | The annotation collection |
getChartModifiers()
Gets the collection of IChartModifier that this SciChartSurface uses
Declaration
public abstract ChartModifierCollection getChartModifiers()
Returns
Type | Description |
---|---|
ChartModifierCollection | The chart modifier collection |
getLayoutManager()
Sets the ILayoutManager instance for this SciChartSurface
Declaration
public abstract layoutManagers.ILayoutManager getLayoutManager()
Returns
Type | Description |
---|---|
layoutManagers.ILayoutManager | The layout manager |
getRenderSurface()
Gets the IRenderSurface instance for this SciChartSurface
Declaration
public abstract IRenderSurface getRenderSurface()
Returns
Type | Description |
---|---|
IRenderSurface | The render surface |
getRenderableSeries()
Gets the collection of IRenderableSeries that this SciChartSurface draws
Declaration
public abstract RenderableSeriesCollection getRenderableSeries()
Returns
Type | Description |
---|---|
RenderableSeriesCollection | The RenderableSeries collection |
getRenderableSeriesArea()
Gets the IRenderableSeriesArea instance for this SciChartSurface
Declaration
public abstract IRenderableSeriesArea getRenderableSeriesArea()
Returns
Type | Description |
---|---|
IRenderableSeriesArea | The renderable series area |
getRenderableSeriesAreaBorderStyle()
Gets the border style for SciChartSurface#getRenderableSeriesArea()
Declaration
public abstract PenStyle getRenderableSeriesAreaBorderStyle()
Returns
Type | Description |
---|---|
PenStyle | The border style |
getRenderableSeriesAreaFillStyle()
Gets the fill style for SciChartSurface#getRenderableSeriesArea()
Declaration
public abstract BrushStyle getRenderableSeriesAreaFillStyle()
Returns
Type | Description |
---|---|
BrushStyle | The fill style |
getSelectedRenderableSeries()
Gets the collection of IRenderableSeries that are selected
Declaration
public abstract RenderableSeriesCollection getSelectedRenderableSeries()
Returns
Type | Description |
---|---|
RenderableSeriesCollection | The selected renderable series |
getViewportManager()
Sets the IViewportManager instance for this SciChartSurface
Declaration
public abstract viewportManagers.IViewportManager getViewportManager()
Returns
Type | Description |
---|---|
viewportManagers.IViewportManager | The viewport manager |
getXAxes()
Gets the collection of XAxes IAxis that this SciChartSurface draws
Declaration
public abstract AxisCollection getXAxes()
Returns
Type | Description |
---|---|
AxisCollection | The XAxes collection |
getYAxes()
Gets the collection of YAxes IAxis that this SciChartSurface draws
Declaration
public abstract AxisCollection getYAxes()
Returns
Type | Description |
---|---|
AxisCollection | The YAxes collection |
onSciChartRendered(IRenderContext2D renderContext, IAssetManager2D assetManager, int renderLayer)
Called when rendering one of SciChartSurface layers
Declaration
public abstract void onSciChartRendered(IRenderContext2D renderContext, IAssetManager2D assetManager, int renderLayer)
Parameters
Type | Name | Description |
---|---|---|
IRenderContext2D | renderContext | The IRenderContext2D to use for rendering |
IAssetManager2D | assetManager | The IAssetManager2D to use for rendering |
int | renderLayer | The id of layer |
removeAxisModifierSurface(IAxisModifierSurface axisModifierSurface)
Used internally to removes IAxisModifierSurface from this SciChartSurface
Declaration
public abstract void removeAxisModifierSurface(IAxisModifierSurface axisModifierSurface)
Parameters
Type | Name | Description |
---|---|---|
IAxisModifierSurface | axisModifierSurface | The axis modifier surface to remove |
setLayoutManager(layoutManagers.ILayoutManager layoutManager)
Sets the ILayoutManager instance for this SciChartSurface
Declaration
public abstract void setLayoutManager(layoutManagers.ILayoutManager layoutManager)
Parameters
Type | Name | Description |
---|---|---|
layoutManagers.ILayoutManager | layoutManager | The layoutManager manager |
setRenderSurface(IRenderSurface renderSurface)
Sets the IRenderSurface instance for this SciChartSurface
Declaration
public abstract void setRenderSurface(IRenderSurface renderSurface)
Parameters
Type | Name | Description |
---|---|---|
IRenderSurface | renderSurface | The render surface |
setRenderedListener(ISciChartSurfaceRenderedListener listener)
Sets the ISciChartSurfaceRenderedListener instance for this surface
Declaration
public abstract void setRenderedListener(ISciChartSurfaceRenderedListener listener)
Parameters
Type | Name | Description |
---|---|---|
ISciChartSurfaceRenderedListener | listener | The listener to set |
setViewportManager(viewportManagers.IViewportManager viewportManager)
Sets the IViewportManager instance for this SciChartSurface
Declaration
public abstract void setViewportManager(viewportManagers.IViewportManager viewportManager)
Parameters
Type | Name | Description |
---|---|---|
viewportManagers.IViewportManager | viewportManager | The viewport manager |