SCIAxisCollection Class Reference


                        
                        
                        -initWithCollection:

Initializes a new instance of SCIAxisCollection class.

Objective-C

- (nonnull instancetype)initWithCollection:
    (nonnull NSArray<id<ISCIAxis>> *)collection;

Swift

init(collection: [any ISCIAxis])


                                    collection

The collections with items to add.


                        
                        
                        primaryAxis

Gets the primary axis in the collection. This is the first axis that has ISCIAxis.isPrimaryAxis set to YES, or nil - if none exists.

Objective-C

@property (nonatomic, strong, readonly, nullable) id<ISCIAxis> primaryAxis;

Swift

var primaryAxis: (any ISCIAxis)? { get }


                        
                        
                        hasPrimaryAxis

Gets the value indicating whether this collection has primary axis.

Objective-C

@property (nonatomic, readonly) BOOL hasPrimaryAxis;

Swift

var hasPrimaryAxis: Bool { get }

YES - if any of the Axes in the collection have ISCIAxis.isPrimaryAxis set to YES.


                        
                        
                        defaultAxis

Gets the default axis, which is equal to the axis with the DEFAULT_AXIS_ID, else - nil.

Objective-C

@property (nonatomic, strong, readonly) id<ISCIAxis> _Nonnull defaultAxis;

Swift

var defaultAxis: any ISCIAxis { get }


                        
                        
                        -getAxisById:

Gets the axis specified by id if it exists, otherwise returns nil.

Objective-C

- (nonnull id<ISCIAxis>)getAxisById:(nonnull NSString *)axisId;

Swift

func getAxisById(_ axisId: String) -> any ISCIAxis


                                    axisId

The axis id.

The axis with specified id if it exists, otherwise returns nil.


                        
                        
                        -getAxisById:assertAxisExists:

Gets the axis specified by id if it exists, otherwise returns nil.

Objective-C

- (nonnull id<ISCIAxis>)getAxisById:(nonnull NSString *)axisId
                   assertAxisExists:(BOOL)assertAxisExists;

Swift

func getAxisById(_ axisId: String, assertAxisExists: Bool) -> any ISCIAxis

`axisId`	The axis id.
`assertAxisExists`	If set to YES assert and throw if the axis does not exist.

The axis with specified id if it exists, otherwise returns nil.