iOS & macOS Charting Documentation - SciChart iOS & macOS Charts SDK v4.x

ISCIChartSurface

@protocol ISCIChartSurface <ISCIChartSurfaceBase, ISCIChartController>

Defines the interface to the SCIChartSurface, which contains a single ISCIRenderSurface viewport for rendering multiple ISCIRenderableSeries, X and Y ISCIAxis instances, and where each ISCIRenderableSeries may have a ISCIDataSeries data source. The SCIChartSurface may have zero or many ISCIAnnotation as well as ISCIChartModifiers to enable interaction with the chart. Where many ISCIChartModifier are used, you may use a SCIModifierGroup to group them.

See

SCIChartSurface.

See

ISCIDataSeries.

See

ISCIRenderableSeries.

See

ISCIAxis.

See

ISCIChartModifier.

See

ISCIAnnotation.


                        
                        
                        zoomState

Gets the SCIZoomState for SCIChartSurface.

Declaration

Objective-C

@property (nonatomic, readonly) SCIZoomState zoomState;

Swift

var zoomState: SCIZoomState { get }


                        
                        
                        annotations

Gets the collection of ISCIAnnotation that this SCIChartSurface draws.

Declaration

Objective-C

@property (nonatomic, strong) SCIAnnotationCollection *_Nonnull annotations;

Swift

var annotations: SCIAnnotationCollection { get set }


                        
                        
                        xAxes

Gets the collection of XAxes ISCIAxis that this SCIChartSurface draws.

Declaration

Objective-C

@property (nonatomic, strong) SCIAxisCollection *_Nonnull xAxes;

Swift

var xAxes: SCIAxisCollection { get set }


                        
                        
                        yAxes

Gets the collection of YAxes ISCIAxis that this SCIChartSurface draws.

Declaration

Objective-C

@property (nonatomic, strong) SCIAxisCollection *_Nonnull yAxes;

Swift

var yAxes: SCIAxisCollection { get set }


                        
                        
                        renderableSeries

Gets the collection of ISCIRenderableSeries that this SCIChartSurface draws.

Declaration

Objective-C

@property (nonatomic, strong) SCIRenderableSeriesCollection *_Nonnull renderableSeries;

Swift

var renderableSeries: SCIRenderableSeriesCollection { get set }


                        
                        
                        selectedRenderableSeries

Gets the collection of ISCIRenderableSeries that are selected.

Declaration

Objective-C

@property (nonatomic, strong, readonly) SCIRenderableSeriesCollection *_Nonnull selectedRenderableSeries;

Swift

var selectedRenderableSeries: SCIRenderableSeriesCollection { get }


                        
                        
                        chartModifiers

Gets the collection of ISCIChartModifier that this SCIChartSurface uses.

Declaration

Objective-C

@property (nonatomic, strong) SCIChartModifierCollection *_Nonnull chartModifiers;

Swift

var chartModifiers: SCIChartModifierCollection { get set }


                        
                        
                        renderSurface

Gets or sets the ISCIRenderSurface instance for this SCIChartSurface

Declaration

Objective-C

@property (nonatomic, strong) id<ISCIRenderSurface> _Nonnull renderSurface;

Swift

var renderSurface: any ISCIRenderSurface { get set }


                        
                        
                        viewportManager

Gets or sets the ISCIViewportManager instance for this SCIChartSurface.

Declaration

Objective-C

@property (nonatomic, strong) id<ISCIViewportManager> _Nonnull viewportManager;

Swift

var viewportManager: any ISCIViewportManager { get set }


                        
                        
                        layoutManager

Gets or sets the ISCILayoutManager instance for this SCIChartSurface.

Declaration

Objective-C

@property (nonatomic, strong) id<ISCILayoutManager> _Nonnull layoutManager;

Swift

var layoutManager: any ISCILayoutManager { get set }


                        
                        
                        renderableSeriesArea

Gets the ISCIRenderableSeriesArea instance for this SCIChartSurface.

Declaration

Objective-C

@property (nonatomic, strong, readonly) id<ISCIRenderableSeriesArea> _Nonnull renderableSeriesArea;

Swift

var renderableSeriesArea: any ISCIRenderableSeriesArea { get }


                        
                        
                        adornerLayer

Gets the ISCIAdornerLayer instance for this SCIChartSurface.

Declaration

Objective-C

@property (nonatomic, strong, readonly) id<ISCIAdornerLayer> _Nonnull adornerLayer;

Swift

var adornerLayer: any ISCIAdornerLayer { get }


                        
                        
                        renderableSeriesAreaBorderStyle

Gets the border style for SCIChartSurface.renderableSeriesArea.

Declaration

Objective-C

@property (nonatomic, strong) SCIPenStyle *_Nonnull renderableSeriesAreaBorderStyle;

Swift

var renderableSeriesAreaBorderStyle: SCIPenStyle { get set }


                        
                        
                        renderableSeriesAreaFillStyle

Gets the fill style for SCIChartSurface.renderableSeriesArea.

Declaration

Objective-C

@property (nonatomic, strong) SCIBrushStyle *_Nonnull renderableSeriesAreaFillStyle;

Swift

var renderableSeriesAreaFillStyle: SCIBrushStyle { get set }


                        
                        
                        -addAxisModifierSurface:

Used internally to add ISCIAxisModifierSurface into this SCIChartSurface.

Declaration

Objective-C

- (void)addAxisModifierSurface:
    (nonnull id<ISCIAxisModifierSurface>)axisModifierSurface;

Swift

func add(_ axisModifierSurface: any ISCIAxisModifierSurface)

Parameters


                                    axisModifierSurface

The axis modifier surface to add.


                        
                        
                        -removeAxisModifierSurface:

Used internally to remove ISCIAxisModifierSurface from this SCIChartSurface.

Declaration

Objective-C

- (void)removeAxisModifierSurface:
    (nonnull id<ISCIAxisModifierSurface>)axisModifierSurface;

Swift

func remove(_ axisModifierSurface: any ISCIAxisModifierSurface)

Parameters


                                    axisModifierSurface

The axis modifier surface to remove.


                        
                        
                        -onSciChartRendered:

Processes SCIRenderedMessage which is raised at at the end of render pass.

Declaration

Objective-C

- (void)onSciChartRendered:(nonnull SCIRenderedMessage *)renderedMessage;

Swift

func onSciChartRendered(_ renderedMessage: SCIRenderedMessage)

Parameters


                                    renderedMessage

The SCIRenderedMessage instance.


                        
                        
                        -setRenderedListener:

Sets the ISCIChartSurfaceRenderedListener instance for this surface.

Declaration

Objective-C

- (void)setRenderedListener:(nullable SCIChartSurfaceRenderedListener)listener;

Swift

func setRenderedListener(_ listener: SCIChartSurfaceRenderedListener?)

Parameters


                                    listener

The listener to set.


                        
                        
                        -updateZoomState:

Sets the SCIZoomState for this surface.

Declaration

Objective-C

- (void)updateZoomState:(SCIZoomState)updatedZoomState;

Swift

func update(_ updatedZoomState: SCIZoomState)

Parameters


                                    updatedZoomState

The SCIZoomState instance.


                        
                        
                        -setDisableTouchEvent:

Sets the userInteractionEnabled for this surface.

Declaration

Objective-C

- (void)setDisableTouchEvent:(BOOL)disableTouchEvent;

Swift

func setDisableTouchEvent(_ disableTouchEvent: Bool)

Parameters


                                    disableTouchEvent

A Boolean value that determines whether user touch event are ignored or not. YES - If you want to ignore touch events (i.e., user interaction is disabled). NO - If you want to recognise touch events (i.e., user interaction is enabled).