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

ISCIUniformHeatmapDataSeriesValues

@protocol ISCIUniformHeatmapDataSeriesValues <ISCIDataSeries>

Defines the interface for 2D uniform heatmap DataSeries value, containing X, Y and Z values.

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

    Declaration

    Objective-C

    @property (readonly, nonatomic) NSInteger xSize;

    Swift

    var xSize: Int { get }
  • Gets the size of 2D heatmap data in Y direction.

    Declaration

    Objective-C

    @property (readonly, nonatomic) NSInteger ySize;

    Swift

    var ySize: Int { get }
  • Gets start X value for 2D heatmap.

    Declaration

    Objective-C

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

    Swift

    var __startX: ISCIComparable! { get }
  • Gets the size for each cell in 2D heatmap in X direction.

    Declaration

    Objective-C

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

    Swift

    var __stepX: ISCIComparable! { get }
  • Gets start Y value for 2D heatmap.

    Declaration

    Objective-C

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

    Swift

    var __startY: ISCIComparable! { get }
  • Gets the size for each cell in 2D heatmap in Y direction.

    Declaration

    Objective-C

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

    Swift

    var __stepY: ISCIComparable! { get }
  • Gets the Z values of this series.

    Declaration

    Objective-C

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

    Swift

    var zValues: ISCIList! { get }
  • Gets the X value for specified index.

    Declaration

    Objective-C

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

    Swift

    func __getXValue(at xIndex: Int) -> ISCIComparable!

    Parameters

    xIndex

    The xIndex to get X value for.

    Return Value

    The X value.

  • Gets the Y value for specified index.

    Declaration

    Objective-C

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

    Swift

    func __getYValue(at yIndex: Int) -> ISCIComparable!

    Parameters

    yIndex

    The yIndex to get Y value for.

    Return Value

    The Y value.

  • Gets the Z value for specified xIndex and yIndex.

    Declaration

    Objective-C

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

    Swift

    func __getZValueAt(x xIndex: Int, y yIndex: Int) -> ISCIComparable!

    Parameters

    xIndex

    The xIndex to get Z value for.

    yIndex

    The yIndex to get Z value for.

    Return Value

    The Z value.

  • Gets xIndex based on index from zValues list.

    Declaration

    Objective-C

    - (NSInteger)getXIndexFromZ:(NSInteger)zIndex;

    Swift

    func getXIndexFrom(z zIndex: Int) -> Int

    Parameters

    zIndex

    The raw zIndex of item from zValues list.

    Return Value

    The xIndex.

  • Gets yIndex based on index from zValues list.

    Declaration

    Objective-C

    - (NSInteger)getYIndexFromZ:(NSInteger)zIndex;

    Swift

    func getYIndexFrom(z zIndex: Int) -> Int

    Parameters

    zIndex

    The raw zIndex of item from zValues list.

    Return Value

    The yIndex.

  • Gets raw zIndex based on xIndex and yIndex.

    Declaration

    Objective-C

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

    Swift

    func getZIndexFrom(x xIndex: Int, y yIndex: Int) -> Int

    Parameters

    xIndex

    The xIndex.

    yIndex

    The yIndex.

    Return Value

    The raw zIndex.