SCIAxisCollection Class Reference

Provides functionality for AxisCollection class. More...

#import <SCIAxisCollection.h>

Inheritance diagram for SCIAxisCollection:
SCIObservableCollection

Instance Methods

(id) - initWithAxisCollection:Parent:IsXAxisCollection:
 
(id) - initWithParent:IsXAxisCollection:
 
(id< SCIAxis2DProtocol >) - getAxisById:
 Gets axis by Id from the AxisCollection. More...
 
(id< SCIAxis2DProtocol >) - getAxisById:AssertAxisExist:
 
(BOOL) - hasPrimaryAxis
 Checks whether the current AxisCollection has a primary axis - the main one in axis collection. More...
 
(id< SCIAxis2DProtocol >) - primaryAxis
 Gets current PrimaryAxis - the main one in axis collection. More...
 
(id< SCIAxis2DProtocol >) - defaultAxis
 Gets the default Axis from the AxisCollection. More...
 
(void) - add:
 Inserts axis into the AxisCollection. More...
 
(BOOL) - remove:
 Removes the axis instance from this collection. More...
 
(id< SCIAxis2DProtocol >) - itemAt:
 Gets axis by index from the AxisCollection. More...
 
(void) - insert:At:
 Inserts axis into the AxisCollection at specified position. More...
 
(BOOL) - contains:
 Checks whether axis collection contains the axis or not. More...
 
(int) - indexOf:
 Returns the index of the first occurrence of the specified axis in this collection. More...
 
(void) - setAxis:atIndex:
 Replaces the axis at the specified position in this collection with the specified element. More...
 
(id< SCIAxis2DProtocol >) - objectAtIndexedSubscript:
 
(void) - setObject:atIndexedSubscript:
 
- Instance Methods inherited from SCIObservableCollection
(void) - clear
 Removes all objects from collection. More...
 
(void) - add:
 Add object into SCIObservableCollection. More...
 
(BOOL) - remove:
 Removes object instance from this collection. More...
 
(void) - removeAt:
 Removes objects instance from collection. More...
 
(void) - insert:At:
 Insert object into SCIObservableCollection at Index. More...
 
(ObjectType) - firstObject
 Return first object from SCIObservableCollection. More...
 
(void) - setObject:atIndex:
 Replaces the element at the specified position in this collection with the specified element. More...
 
(BOOL) - contains:
 Return YES If item is in collection. More...
 
(int) - indexOf:
 Returns the index of the first occurrence of the specified element in this collection. More...
 
(void) - addObserver:
 Add observer for the collection. More...
 
(void) - removeObserver:
 Remove observer for the collection. More...
 
(void) - setObject:atIndexedSubscript:
 
(void) - sendCallbacks: [implementation]
 

Properties

SCIChartSurfaceparent
 

Additional Inherited Members

- Protected Attributes inherited from SCIObservableCollection
 __pad0__: NSObject <NSFastEnumeration>- (int)count
 
package NSMutableArray * _objects
 
NSMutableArray< SCICollectionObserver * > * _observers
 

Detailed Description

Provides functionality for AxisCollection class.

Method Documentation

◆ add:()

- (void) add: (id< SCIAxis2DProtocol >)  item

Inserts axis into the AxisCollection.

Parameters
itemItem to insert into AxisCollection
self.chartSurface.xAxes.addItem(axis)
See also
SCIAxis2DProtocol

◆ contains:()

- (BOOL) contains: (id< SCIAxis2DProtocol >)  item

Checks whether axis collection contains the axis or not.

Parameters
itemItem to check in AxisCollection
let exist = self.chartSurface.xAxes.conains(axis)
See also
SCIAxis2DProtocol

◆ defaultAxis()

- (id <SCIAxis2DProtocol>) defaultAxis

Gets the default Axis from the AxisCollection.

◆ getAxisById:()

- (id <SCIAxis2DProtocol>) getAxisById: (NSString *)  axisId

Gets axis by Id from the AxisCollection.

Parameters
axisIdAxisId used when searching for an axis
let axis = self.chartSurface.xAxes.getAxisById("xAxis")
See also
SCIAxis2D

◆ getAxisById:AssertAxisExist:()

- (id <SCIAxis2DProtocol>) getAxisById: (NSString *)  axisId
AssertAxisExist: (BOOL)  assert 

◆ hasPrimaryAxis()

- (BOOL) hasPrimaryAxis

Checks whether the current AxisCollection has a primary axis - the main one in axis collection.

This is the axis which is responsible for drawing grid lines on the chart view @discussion By default this is the first axis in the collection

◆ indexOf:()

- (int) indexOf: (id< SCIAxis2DProtocol >)  item

Returns the index of the first occurrence of the specified axis in this collection.

Returns
Returns the index of the first occurrence, otherwise returns -1.

◆ initWithAxisCollection:Parent:IsXAxisCollection:()

- (id) initWithAxisCollection: (NSArray< id< SCIAxis2DProtocol >> *)  axes
Parent: (SCIChartSurface *)  parent
IsXAxisCollection: (BOOL)  isXAxisCollection 

◆ initWithParent:IsXAxisCollection:()

- (id) initWithParent: (SCIChartSurface *)  parent
IsXAxisCollection: (BOOL)  isXAxisCollection 

◆ insert:At:()

- (void) insert: (id< SCIAxis2DProtocol >)  item
At: (int)  index 

Inserts axis into the AxisCollection at specified position.

Parameters
itemItem to insert into AxisCollection
indexPosition where axis will be placed
self.chartSurface.xAxes.insertItem(axis, at: 3)
See also
SCIAxis2DProtocol

◆ itemAt:()

- (id <SCIAxis2DProtocol>) itemAt: (int)  index

Gets axis by index from the AxisCollection.

Parameters
indexIndex used when retrieving for an axis
let axis = self.chartSurface.xAxes.itemAt(2)
See also
SCIAxis2DProtocol

Implements SCIObservableCollection.

◆ objectAtIndexedSubscript:()

- (id <SCIAxis2DProtocol>) objectAtIndexedSubscript: (unsigned int)  idx

Implements SCIObservableCollection.

Provided by category SCIAxisCollection(Indexing).

◆ primaryAxis()

- (id <SCIAxis2DProtocol>) primaryAxis

Gets current PrimaryAxis - the main one in axis collection.

This is the axis which is responsible for drawing grid lines on the chart view @discussion By default this is the first axis in the collection

◆ remove:()

- (BOOL) remove: (id< SCIAxis2DProtocol >)  item

Removes the axis instance from this collection.

Parameters
itemAxis instance to be deleted from the collection, if present in it.
Returns
Return YES If item is removed, otherwise NO

◆ setAxis:atIndex:()

- (void) setAxis: (id< SCIAxis2DProtocol >)  axis
atIndex: (unsigned int)  index 

Replaces the axis at the specified position in this collection with the specified element.

Parameters
axisaxis to be stored at the specified position
indexindex of the element to replace

◆ setObject:atIndexedSubscript:()

- (void) setObject: (id< SCIAxis2DProtocol >)  obj
atIndexedSubscript: (unsigned int)  idx 

Provided by category SCIAxisCollection(Indexing).

Property Documentation

◆ parent

- (SCIChartSurface*) parent
readwritenonatomicweak

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