iOS & macOS Charting Documentation - SciChart iOS & macOS Charts SDK v4.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 (nonatomic, strong) NS_REFINED_FOR_SWIFT id<ISCIComparable> startX;
  • Gets or sets the size for each cell in 2D heatmap in X direction.

    Declaration

    Objective-C

    @property (nonatomic, strong) NS_REFINED_FOR_SWIFT id<ISCIComparable> stepX;
  • Gets or sets start Y value for 2D heatmap.

    Declaration

    Objective-C

    @property (nonatomic, strong) NS_REFINED_FOR_SWIFT id<ISCIComparable> startY;
  • Gets or sets the size for each cell in 2D heatmap in Y direction.

    Declaration

    Objective-C

    @property (nonatomic, strong) NS_REFINED_FOR_SWIFT id<ISCIComparable> stepY;
  • Updates Z Value at specified xIndex and yIndex.

    Declaration

    Objective-C

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

    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;

    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;

    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.