SCIChartSurface Class Reference

#import <SCIChartSurface.h>

Inheritance diagram for SCIChartSurface:
SCIChartSurfaceView <SCIChartSurfaceProtocol> SCIChartSurfaceViewBase

Instance Methods

(void) - drawBackground: [implementation]
 
(CGRect) - chartFrame [implementation]
 
(void) - free [implementation]
 
(void) - attachAxis:IsXAxis:
 Attaches a SCIAxis2D to the SCIChartSurface. More...
 
(void) - detachAxis:
 Detaches a SCIAxis2D instance from the SCIChartSurface. More...
 
(void) - detachRenderableSeries:
 Detaches a SCIRenderableSeries from the SCIChartSurface. More...
 
(void) - attachRenderableSeries:
 Attachs a SCIRenderableSeries to the SciChartSurface. More...
 
- Instance Methods inherited from SCIChartSurfaceViewBase
(void) - setChartTitleLabelInsets:
 
(BOOL) - axisAreasNeedResizing [implementation]
 
- Instance Methods inherited from <SCIChartSurfaceProtocol>
(void) - setChartTitleLabelInsets:
 Set insets for chartTitleLabel on chartTitleView. More...
 
(nonnull UIImage *) - exportToUIImage
 Export current chart surface into UIImage object. More...
 

Class Methods

(void) + setDisplayLinkRunLoopMode:
 
(NSRunLoopMode _Nonnull) + getDisplayLinkRunLoopMode
 
- Class Methods inherited from <SCIChartSurfaceProtocol>
(void) + setRuntimeLicenseKey:
 Sets the License Key for all SCIChartSurface instances. More...
 

Protected Attributes

__weak SCIAxisArea_centerXAxisArea
 
__weak SCIAxisArea_centerYAxisArea
 

Properties

UIColor * backgroundColor
 
SCIRenderSurfaceStylestyle [implementation]
 
- Properties inherited from SCIChartSurfaceViewBase
IBOutlet id< SCIRenderSurfaceProtocol > renderSurface
 
IBOutlet UIView * renderSurfaceSizeView
 
IBOutlet SCIAxisArealeftAxesArea
 
IBOutlet SCIAxisArearightAxesArea
 
IBOutlet SCIAxisAreatopAxesArea
 
IBOutlet SCIAxisAreabottomAxesArea
 
IBOutlet UILabel * chartTitleLabel
 
IBOutlet UIView * chartTitleHolderView
 
float leftAxisAreaSize
 
float rightAxisAreaSize
 
float topAxisAreaSize
 
float bottomAxisAreaSize
 
float leftAxisAreaForcedSize
 
float rightAxisAreaForcedSize
 
float topAxisAreaForcedSize
 
float bottomAxisAreaForcedSize
 
IBOutlet NSLayoutConstraint * leftPanelSize
 
IBOutlet NSLayoutConstraint * leftPanelSizeLimit
 
IBOutlet NSLayoutConstraint * rightPanelSize
 
IBOutlet NSLayoutConstraint * rightPanelSizeLimit
 
IBOutlet NSLayoutConstraint * topPanelSize
 
IBOutlet NSLayoutConstraint * topPanelSizeLimit
 
IBOutlet NSLayoutConstraint * bottomPanelSize
 
IBOutlet NSLayoutConstraint * bottomPanelSizeLimit
 
SCIResizeAxesAreasRequest onLayoutSubviews [implementation]
 
- Properties inherited from <SCIChartSurfaceProtocol>
SCIPenStyle *_Nonnull renderableSeriesAreaBorder
 Defines chart area border thicknes and color. More...
 
SCIBrushStyle *_Nonnull renderableSeriesAreaFill
 Defines background fill color for chart area. More...
 
SCIChartModifierCollectionchartModifiers
 Defines the SCIChartModifier, responsible for zoom, pan or tooltip behaviors. More...
 
SCIAnnotationCollectionannotations
 Attaches an annotation or a SCIAnnotationCollection to the SCIChartSurface. More...
 
SCIAxisCollectionxAxes
 The collection of XAxes when in a multiple Axis scenario. More...
 
SCIAxisCollectionyAxes
 The collection of YAxes when in a multiple Axis scenario. More...
 
SCIRenderableSeriesCollectionrenderableSeries
 Exposes the collection of SCIRenderableSeries on the SCIChartSurface. More...
 
SCIRenderableSeriesCollectionselectedRenderableSeries
 Exposes the collection of selected SCIRenderableSeries on the SCIChartSurface. More...
 
id< SCIViewportManagerProtocolviewportManager
 Defines the SCIViewportManager instance which controls the viewport ranges on chart updates. More...
 
NSString * chartTitle
 Text for chat title. More...
 
UIFont * chartTitleFont
 Font for chart title if you use chartTitle. More...
 
UIColor * chartTitleColor
 Color text for chart title if you use chartTitle. More...
 
NSTextAlignment chartTitleAlignment
 Text aligment for chart title if you use chartTitle. More...
 
UIView * chartTitleView
 Custom view for chart title. More...
 
id< SCIRenderSurfaceProtocol > renderSurface
 
SCIGestureController *_Nonnull gestureController
 Sets or gets gestures handler on surface. More...
 

Method Documentation

§ attachAxis:IsXAxis:()

- (void) attachAxis: (id< SCIAxis2DProtocol >)  axis
IsXAxis: (BOOL)  isXAxis 

Attaches a SCIAxis2D to the SCIChartSurface.

The SCIChartSurface requires that you attach at least one XAxis and a YAxis to the chart. SciChart supports unlimited, multiple, X and Y Axis.

// Objective C Example
id<SCIAxis2D> axis = [[SCINumericAxis alloc] init];
[axis setGrowBy: [[SCIDoubleRange alloc]initWithMin:SCIGeneric(0.1) Max:SCIGeneric(0.1)]];
[surface attachAxis:axis IsXAxis:NO];
axis = [[SCINumericAxis alloc] init];
[surface attachAxis:axis IsXAxis:YES];
// Swift Example
weak var axis = SCINumericAxis()
axis!.growBy = SCIDoubleRange(min: SCIGeneric(0.1), max: SCIGeneric(0.1))
surface.attachAxis(axis, isXAxis: false)
surface.attachAxis(axis, isXAxis: true)
See also
SCIAxisCollection
SCIAxis2D
SCINumericAxis
SCIDateTimeAxis
SCILogarithmicNumericAxis

Provided by category SCIChartSurface(InternalMethods).

§ attachRenderableSeries:()

- (void) attachRenderableSeries: (id< SCIRenderableSeriesProtocol >)  rSeries

Attachs a SCIRenderableSeries to the SciChartSurface.

RenderableSeries are the visual representation of the chart series, while SCIDataSeries are the data representation.

To add a series to a chart, use SCIChartSurface.attachRenderableSeries. Ensure that SCIRenderableSeries DataSeries is an instance of SCIDataSeries to provide the data

// Objective-C Example
SCIXyDataSeries * lineDataSeries = [[SCIXyDataSeries alloc] initWithXType:SCIDataType_Float YType:SCIDataType_Float];
for (int i = 0; i < dataCount; i++) {
double time = 10 * i / (double)dataCount;
double x = time;
double y = arc4random_uniform(20);
[lineDataSeries appendX:SCIGeneric(x) Y:SCIGeneric(y)];
}
[lineRenderSeries.style setLinePen: [[SCIPenSolid alloc] initWithColorCode:0xFF99EE99 Width:0.7]];
[lineRenderSeries setDataSeries:xyData];
[surface attachRenderableSeries:lineRenderSeries];
// Swift Example
let lineDataSeries = SCIXyDataSeries(XType: .Float, YType: .Float)
let dataCount = 20
var i = 0
while i <= dataCount {
let x = 10.0*Float(i)/Float(dataCount)
let y = arc4random_uniform(UInt32(dataCount))
var xValue = Float(x)
var yValue = Float(y)
dataSeries.appendX(SCI_constructGenericTypeWithInfo(&xValue, .Float),
i = i + 1
}
let lineRenderSeries = SCIFastLineRenderableSeries()
lineRenderSeries.dataSeries = dataSeries
lineRenderSeries.style.linePen = SCIPenSolid(colorCode: 0xFF99EE99, width: 0.7)
sciChartSurface.attachRenderableSeries(renderSeries)
See also
SCIFastLineRenderableSeries
SCIDataSeriest

Provided by category SCIChartSurface(InternalMethods).

§ chartFrame()

- (CGRect) chartFrame
implementation

§ detachAxis:()

- (void) detachAxis: (id< SCIAxis2DProtocol >)  axis

Detaches a SCIAxis2D instance from the SCIChartSurface.

Parameters
axisthe SCIAxis2D instance to detach

Provided by category SCIChartSurface(InternalMethods).

§ detachRenderableSeries:()

- (void) detachRenderableSeries: (id< SCIRenderableSeriesProtocol >)  rSeries

Detaches a SCIRenderableSeries from the SCIChartSurface.

Parameters
rSeriesThe SCIRenderableSeries instance to detach

Provided by category SCIChartSurface(InternalMethods).

§ drawBackground:()

- (void) drawBackground: (id< SCIRenderContext2DProtocol >)  context
implementation

§ free()

- (void) free
implementation

§ getDisplayLinkRunLoopMode()

+ (NSRunLoopMode _Nonnull) getDisplayLinkRunLoopMode

§ setDisplayLinkRunLoopMode:()

+ (void) setDisplayLinkRunLoopMode: (NSRunLoopMode _Nonnull)  runLoopMode

Field Documentation

§ _centerXAxisArea

- (__weak SCIAxisArea*) _centerXAxisArea
protected

§ _centerYAxisArea

- (__weak SCIAxisArea*) _centerYAxisArea
protected

Property Documentation

§ backgroundColor

- (UIColor*) backgroundColor
readwritenonatomiccopy

§ style

- (SCIRenderSurfaceStyle*) style
readwritenonatomicassignimplementation

The documentation for this class was generated from the following file: