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

SCIBaseGridDataSeries3D

@interface SCIBaseGridDataSeries3D
    : SCIDataSeries3D <ISCIGridDataSeries3DValues>

Defines a base class for 3D GridDataSeries.




indexCalculator

Gets the SCIIndexCalculator which is used to map indices.

Declaration

Objective-C

@property (nonatomic, readonly) SCIIndexCalculator *_Nonnull indexCalculator;

Swift

var indexCalculator: SCIIndexCalculator { get }




-initWithXType:yType:zType:xSize:zSize:

Creates a new BaseGridDataSeries3D instance.

Declaration

Objective-C

- (nonnull instancetype)initWithXType:(SCIDataType)xType
                                yType:(SCIDataType)yType
                                zType:(SCIDataType)zType
                                xSize:(NSInteger)xSize
                                zSize:(NSInteger)zSize;

Swift

init(xType: SCIDataType, yType: SCIDataType, zType: SCIDataType, xSize: Int, zSize: Int)

Parameters

`xType`	The type of `X-Data`.
`yType`	The type of `Y-Data`.
`zType`	The type of `Z-Data`.
`xSize`	The size of the X.
`zSize`	The size of the Z.

-updateYValue:atXIndex:zIndex:
Updates Y values at specified position.
Declaration
Objective-C

- (void)updateYValue:(nonnull id<ISCIComparable>)yValue atXIndex:(NSInteger)xIndex zIndex:(NSInteger)zIndex;
Parameters

yValue

The new yValue.

xIndex

The xIndex of point to update.

zIndex

The zIndex of point to update.
-pushArrayRow:
Pushes a row into the data series, which discards one old row in a First In First Out fashion. use this method to scroll the SCIGridData in the Z-direction.
Declaration
Objective-C

- (void)pushArrayRow:(nonnull NSArray<id<ISCIComparable>> *)array;
Parameters

array

The row with new values.
-pushValuesRow:
Pushes a row into the data series, which discards one old row in a First In First Out fashion. use this method to scroll the SCIGridData in the Z-direction.
Declaration
Objective-C

- (void)pushValuesRow:(nonnull id<ISCIValues>)values;
Swift

func push(_ values: ISCIValues)
Parameters

values

The row with new values.
-setArrayRow:at:
Sets the row at the specified Z index.
Declaration
Objective-C

- (void)setArrayRow:(nonnull NSArray<id<ISCIComparable>> *)row at:(NSInteger)index;
Parameters

index

The z-index to use.

row

The row with new values.
-setValuesRow:at:
Sets the row at the specified Z index.
Declaration
Objective-C

- (void)setValuesRow:(nonnull id<ISCIValues>)row at:(NSInteger)index;
Swift

func set(_ row: ISCIValues, at index: Int)
Parameters

index

The z-index to use.

row

The row with new values.
-copyFromArray:
Copies array to this instance.
Declaration
Objective-C

- (void)copyFromArray:(nonnull NSArray<id<ISCIComparable>> *)array;
Parameters

array

The array to copy from.
-copyFromValues:
Copies values to this instance.
Declaration
Objective-C

- (void)copyFromValues:(nonnull id<ISCIValues>)values;
Swift

func copy(from values: ISCIValues)
Parameters

values

Values to copy from.

`yValue`	The new yValue.
`xIndex`	The xIndex of point to update.
`zIndex`	The zIndex of point to update.

`index`	The z-index to use.
`row`	The row with new values.

`index`	The z-index to use.
`row`	The row with new values.