iOS Charting Documentation - SciChart iOS Charts SDK v3.x

ISCIUniformHeatmapDataSeries

@protocol ISCIUniformHeatmapDataSeries <ISCIUniformHeatmapDataSeriesValues>

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

  • Gets or sets start X value for 2D heatmap.

    Declaration

    Objective-C

    @property (assign, readwrite, nonatomic) id<ISCIComparable> _Nonnull startX;

    Swift

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

    Declaration

    Objective-C

    @property (assign, readwrite, nonatomic) id<ISCIComparable> _Nonnull stepX;

    Swift

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

    Declaration

    Objective-C

    @property (assign, readwrite, nonatomic) id<ISCIComparable> _Nonnull startY;

    Swift

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

    Declaration

    Objective-C

    @property (assign, readwrite, nonatomic) id<ISCIComparable> _Nonnull stepY;

    Swift

    var __stepY: ISCIComparable { get set }
  • Updates Z Value at specified xIndex and yIndex.

    Declaration

    Objective-C

    - (void)updateZ:(nonnull id<ISCIComparable>)z
                atX:(NSInteger)xIndex
                  y:(NSInteger)yIndex;

    Swift

    func __updateZ(_ z: ISCIComparable, atX xIndex: Int, y yIndex: Int)

    Parameters

    z

    The value to set.

    xIndex

    The xIndex to update at.

    yIndex

    The yIndex to update at.

  • Updates all Z values for this series.

    Declaration

    Objective-C

    - (void)updateZArray:(nonnull NSArray<id<ISCIComparable>> *)zArray;

    Swift

    func __updateZArray(_ zArray: [ISCIComparable])

    Parameters

    zArray

    The new Z value for this series.

  • Updates the range of Z values for this series.

    Declaration

    Objective-C

    - (void)updateZArray:(nonnull NSArray<id<ISCIComparable>> *)zArray
                     atX:(NSInteger)xIndex
                       y:(NSInteger)yIndex;

    Swift

    func __updateZArray(_ zArray: [ISCIComparable], atX xIndex: Int, y yIndex: Int)

    Parameters

    zArray

    The new Z values.

    xIndex

    The xIndex to start update at.

    yIndex

    The yIndex to start update at.

  • Updates all Z values for this series.

    Declaration

    Objective-C

    - (void)updateZValues:(nonnull id<ISCIValues>)zValues;

    Swift

    func update(z zValues: ISCIValues)

    Parameters

    zValues

    The new Z value for this series.

  • Updates the range of Z values for this series.

    Declaration

    Objective-C

    - (void)updateZValues:(nonnull id<ISCIValues>)zValues
                      atX:(NSInteger)xIndex
                        y:(NSInteger)yIndex;

    Swift

    func update(z zValues: ISCIValues, atX xIndex: Int, y yIndex: Int)

    Parameters

    zValues

    The new Z values.

    xIndex

    The xIndex to start update at.

    yIndex

    The yIndex to start update at.