ISCIUniformHeatmapDataSeriesValues Protocol Reference


                        
                        
                        xSize

Gets the size of 2D heatmap data in X direction.

Declaration

Objective-C

@property (nonatomic, readonly) NSInteger xSize;


                        
                        
                        ySize

Gets the size of 2D heatmap data in Y direction.

Declaration

Objective-C

@property (nonatomic, readonly) NSInteger ySize;


                        
                        
                        startX

Gets start X value for 2D heatmap.

Declaration

Objective-C

@property (nonatomic, strong, readonly) NS_REFINED_FOR_SWIFT id<ISCIComparable> startX;


                        
                        
                        stepX

Gets the size for each cell in 2D heatmap in X direction.

Declaration

Objective-C

@property (nonatomic, strong, readonly) NS_REFINED_FOR_SWIFT id<ISCIComparable> stepX;


                        
                        
                        startY

Gets start Y value for 2D heatmap.

Declaration

Objective-C

@property (nonatomic, strong, readonly) NS_REFINED_FOR_SWIFT id<ISCIComparable> startY;


                        
                        
                        stepY

Gets the size for each cell in 2D heatmap in Y direction.

Declaration

Objective-C

@property (nonatomic, strong, readonly) NS_REFINED_FOR_SWIFT id<ISCIComparable> stepY;


                        
                        
                        zValues

Gets the Z values of this series.

Declaration

Objective-C

@property (nonatomic, strong, readonly) id<ISCIList> _Nonnull zValues;


                        
                        
                        -getXValueAt:

Gets the X value for specified index.

Declaration

Objective-C

- (nonnull id<ISCIComparable>)getXValueAt:(NSInteger)xIndex;

Parameters


                                    xIndex

The xIndex to get X value for.

Return Value

The X value.


                        
                        
                        -getYValueAt:

Gets the Y value for specified index.

Declaration

Objective-C

- (nonnull id<ISCIComparable>)getYValueAt:(NSInteger)yIndex;

Parameters


                                    yIndex

The yIndex to get Y value for.

Return Value

The Y value.


                        
                        
                        -getZValueAtX:y:

Gets the Z value for specified xIndex and yIndex.

Declaration

Objective-C

- (nonnull id<ISCIComparable>)getZValueAtX:(NSInteger)xIndex
                                         y:(NSInteger)yIndex;

Parameters

`xIndex`	The xIndex to get Z value for.
`yIndex`	The yIndex to get Z value for.

Return Value

The Z value.


                        
                        
                        -getXIndexFromZ:

Gets xIndex based on index from zValues list.

Declaration

Objective-C

- (NSInteger)getXIndexFromZ:(NSInteger)zIndex;

Parameters


                                    zIndex

The raw zIndex of item from zValues list.

Return Value

The xIndex.


                        
                        
                        -getYIndexFromZ:

Gets yIndex based on index from zValues list.

Declaration

Objective-C

- (NSInteger)getYIndexFromZ:(NSInteger)zIndex;

Parameters


                                    zIndex

The raw zIndex of item from zValues list.

Return Value

The yIndex.


                        
                        
                        -getZIndexFromX:y:

Gets raw zIndex based on xIndex and yIndex.

Declaration

Objective-C

- (NSInteger)getZIndexFromX:(NSInteger)xIndex y:(NSInteger)yIndex;

Parameters

`xIndex`	The xIndex.
`yIndex`	The yIndex.

Return Value

The raw zIndex.