SCIUniformHeatmapDataSeries Class Reference

DataSeries for SCIFastUniformHeatmapRenderableSeries. More...

#import <SCIUniformHeatmapDataSeries.h>

Inheritance diagram for SCIUniformHeatmapDataSeries:
<SCIUniformHeatmapDataSeriesProtocol> <SCIDataSeriesProtocol>

Instance Methods

(void) - dataSeriesChanged
 Calls onDataSeriesChanged callback. More...
 
(nonnull instancetype) - initWithTypeX:Y:Z:SizeX:Y:StartX:StepX:StartY:StepY:
 Only initializers below should be used for creating an instance of SCIUniformHeatmapDataSeries. More...
 
(nonnull instancetype) - initWithZValues:StartX:StepX:StartY:StepY:
 
(nonnull instancetype) - initWithTypeX:Y:Z:SizeX:Y:RangeX:Y:
 
- Instance Methods inherited from <SCIUniformHeatmapDataSeriesProtocol>
(nonnull id< SCIArrayControllerProtocol >) - xIndices
 Return an instance of SCIArrayController of x values. More...
 
(nonnull id< SCIArrayControllerProtocol >) - yIndices
 Return an instance of SCIArrayController of y values. More...
 
(nonnull SCIArrayController2D *) - zValues
 Return an instance of SCIArrayController2D of z values. More...
 
(int) - sizeX
 Count of x Values. More...
 
(int) - sizeY
 Count of y Values. More...
 
(void) - updateZAtXIndex:yIndex:withValue:
 Updates Z Value at specified xIndex and yIndex. More...
 
(void) - updateZValues:
 Updates Z values for this data series. More...
 
(void) - updateZValues:Size:
 
(void) - updateRangeZAtXIndex:yIndex:withValues:
 Updates the range of Z values for this series. More...
 
(void) - updateRangeZAtXIndex:yIndex:withValues:count:
 
- Instance Methods inherited from <SCIDataSeriesProtocol>
(void) - addObserver:
 Callback is called every time when somthing chages in data series (appending new values, removing, inserting). More...
 
(void) - removeObserver:
 
(SCIDataType- xType
 Returns type of x column. More...
 
(SCIDataType- yType
 Returns type of y column. More...
 
(nonnull id< SCIRangeProtocol >) - getXRange
 Returns range with min and max values. More...
 
(nonnull id< SCIRangeProtocol >) - getYRange
 Returns range with min and max values. More...
 
(SCIDataSeriesType- dataSeriesType
 Return current type of data series. More...
 
(nonnull id< SCIArrayControllerProtocol >) - xValues
 Return SCIArrayController for x Column. More...
 
(nonnull id< SCIArrayControllerProtocol >) - yValues
 Return SCIArrayController for y Column. More...
 
(SCIGenericType- YMin
 Return min y value from y Column. More...
 
(SCIGenericType- YMax
 Return max y value from y Column. More...
 
(SCIGenericType- XMin
 Return min x value from x Column. More...
 
(SCIGenericType- XMax
 Return max x value from x Column. More...
 
(BOOL) - hasValues
 Returns YES if the dataSeries has any values. More...
 
(int) - count
 Use to return count of appended data. More...
 
(BOOL) - isSorted
 Returns YES if data which was appended is sorted. More...
 
(BOOL) - isFifo
 Returns YES if data series uses FIFO principle. More...
 
(void) - clear
 Use to clear all data in all arrayControllers, also should clear dataDestributionCalculator. More...
 
(nonnull SCIIndexRange *) - getIndicesRangeWithVisibleRange:
 Converts range of values to the range of indices. More...
 
(nonnull id< SCIRangeProtocol >) - getWindowYRangeWithXRange:
 Returns y range for some specific x range. More...
 
(nonnull id< SCIRangeProtocol >) - getWindowYRangeWithXRange:GetPositiveRange:
 
(nonnull id< SCIRangeProtocol >) - getWindowYRangeWithIndexRange:
 Returns y range of values for some specific x range of indices. More...
 
(nonnull id< SCIRangeProtocol >) - getWindowYRangeWithIndexRange:GetPositiveRange:
 
(int) - findIndexForValue:Mode:
 Get index of value in SCIArrayController. More...
 
(void) - removeAt:
 Delete some value at index. More...
 
(void) - removeValue:
 Delete particular value from xColumn. More...
 
(void) - removeRangeFrom:Count:
 Remove some "count" of values starting from "startIndex". More...
 
(nullable id< SCIDataSeriesProtocol >) - clone
 Returns copy of current instance. More...
 
(nonnull id< SCIPointSeriesProtocol >) - toPointSeriesWithResamplingMode:SCIIndexRange:ViewportWidth:IsCategoryAxis:VisibleRange:Resampler:
 For private using. More...
 
(double) - getYMinAt:ExistingYMin:
 For private using. More...
 
(double) - getYMaxAt:ExistingYMax:
 For private using. More...
 

Properties

id< SCIPointSeriesProtocollastPointSeries
 Last resampled point series which was used for drawing the dataSeries. More...
 
id< SCIDataDistributionCalculatorProtocoldataDistributionCalculator
 Data distribution calculator for current data series. More...
 
- Properties inherited from <SCIUniformHeatmapDataSeriesProtocol>
id< SCIRangeProtocolxRange
 Range of x Values. More...
 
id< SCIRangeProtocolyRange
 Range of y Values. More...
 
SCIGenericType stepX
 The step of x values. More...
 
SCIGenericType stepY
 The step of y values. More...
 
SCIGenericType startX
 The start of x values. More...
 
SCIGenericType startY
 The start of y values. More...
 
- Properties inherited from <SCIDataSeriesProtocol>
int fifoCapacity
 After setting the property if previously data series wasn't fifo xColumn and yColumn will be recreated with type SCIArrayControllerFIFO. More...
 
BOOL acceptUnsortedData
 Allowing to accept unsorted data. More...
 
NSString * seriesName
 SeriesName is shown in legend modifier and tooltip modifier. More...
 
id< SCIPointSeriesProtocollastPointSeries
 Last resampled point series which was used for drawing the dataSeries. More...
 

Detailed Description

DataSeries for SCIFastUniformHeatmapRenderableSeries.

It is specific data series which doesn't have direct method to change the data of x, y, z columns. The size of x and y clomns define on initializing. Also the step of values defines on initializing too.

See also
SCIFastUniformHeatmapRenderableSeries

Method Documentation

◆ dataSeriesChanged()

- (void) dataSeriesChanged

Calls onDataSeriesChanged callback.

◆ initWithTypeX:Y:Z:SizeX:Y:RangeX:Y:()

- (nonnull instancetype) initWithTypeX: (SCIDataType typeX
Y: (SCIDataType typeY
Z: (SCIDataType typeZ
SizeX: (int)  sizeX
Y: (int)  sizeY
RangeX: (id< SCIRangeProtocol > _Nonnull)  rangeX
Y: (id< SCIRangeProtocol > _Nonnull)  rangeY 

◆ initWithTypeX:Y:Z:SizeX:Y:StartX:StepX:StartY:StepY:()

- (nonnull instancetype) initWithTypeX: (SCIDataType typeX
Y: (SCIDataType typeY
Z: (SCIDataType typeZ
SizeX: (int)  sizeX
Y: (int)  sizeY
StartX: (SCIGenericType startX
StepX: (SCIGenericType stepX
StartY: (SCIGenericType startY
StepY: (SCIGenericType stepY 

Only initializers below should be used for creating an instance of SCIUniformHeatmapDataSeries.

Based on sizeX and sizeY defining a size of Z column.

let range = SCIDoubleRange(min: SCIGeneric(0), max: SCIGeneric(1))
var size: Int32 = 100
let heatmapDataSeries = SCIUniformHeatmapDataSeries(typeX: .float, y: .float, z: .float, sizeX: size, y: size, rangeX: range, y: range)

Only initializers below should be used for creating an instance of SCIUniformHeatmapDataSeries. Based on sizeX and sizeY defining a size of Z column.

var size: Int32 = 100
let heatmapDataSeries = SCIUniformHeatmapDataSeries(typeX: .float, y: .float, z: .float, sizeX: size, y: size, startX: SCIGeneric(0), stepX: SCIGeneric(0.1), startY: SCIGeneric(0), stepY: SCIGeneric(0.1))

◆ initWithZValues:StartX:StepX:StartY:StepY:()

- (nonnull instancetype) initWithZValues: (SCIArrayController2D *_Nonnull)  array2D
StartX: (SCIGenericType startX
StepX: (SCIGenericType stepX
StartY: (SCIGenericType startY
StepY: (SCIGenericType stepY 

Property Documentation

◆ dataDistributionCalculator

- (id<SCIDataDistributionCalculatorProtocol>) dataDistributionCalculator
readwritenonatomicstrong

Data distribution calculator for current data series.

◆ lastPointSeries

- (id<SCIPointSeriesProtocol>) lastPointSeries
readwritenonatomicstrong

Last resampled point series which was used for drawing the dataSeries.


The documentation for this class was generated from the following file: