A trading range plot data source. More...

#import <CPTTradingRangePlot.h>

Inheritance diagram for <CPTTradingRangePlotDataSource>:

Collaboration diagram for <CPTTradingRangePlotDataSource>:

Public Instance Methods
Bar Fills
(nullable CPTFillArray *)	- increaseFillsForTradingRangePlot:recordIndexRange:
	(Optional) Gets a range of fills used with a candlestick plot when close >= open for the given plot. More...

(nullable CPTFill *)	- increaseFillForTradingRangePlot:recordIndex:
	(Optional) Gets the fill used with a candlestick plot when close >= open for the given plot. This method will not be called if -increaseFillsForTradingRangePlot:recordIndexRange: is also implemented in the datasource. More...

(nullable CPTFillArray *)	- decreaseFillsForTradingRangePlot:recordIndexRange:
	(Optional) Gets a range of fills used with a candlestick plot when close < open for the given plot. More...

(nullable CPTFill *)	- decreaseFillForTradingRangePlot:recordIndex:
	(Optional) Gets the fill used with a candlestick plot when close < open for the given plot. This method will not be called if -decreaseFillsForTradingRangePlot:recordIndexRange: is also implemented in the datasource. More...

(nullable CPTNumberArray *)	- barWidthsForTradingRangePlot:recordIndexRange:
	(Optional) Gets an array of bar widths for the given trading range plot. More...

(nullable NSNumber *)	- barWidthForTradingRangePlot:recordIndex:
	(Optional) Gets a bar width for the given trading range plot. This method will not be called if -barWidthsForTradingRangePlot:recordIndexRange: is also implemented in the datasource. More...

Bar Line Styles
(nullable CPTLineStyleArray *)	- lineStylesForTradingRangePlot:recordIndexRange:
	(Optional) Gets a range of line styles used to draw candlestick or OHLC symbols for the given trading range plot. More...

(nullable CPTLineStyle *)	- lineStyleForTradingRangePlot:recordIndex:
	(Optional) Gets the line style used to draw candlestick or OHLC symbols for the given trading range plot. This method will not be called if -lineStylesForTradingRangePlot:recordIndexRange: is also implemented in the datasource. More...

(nullable CPTLineStyleArray *)	- increaseLineStylesForTradingRangePlot:recordIndexRange:
	(Optional) Gets a range of line styles used to outline candlestick symbols when close >= open for the given trading range plot. More...

(nullable CPTLineStyle *)	- increaseLineStyleForTradingRangePlot:recordIndex:
	(Optional) Gets the line style used to outline candlestick symbols when close >= open for the given trading range plot. This method will not be called if -increaseLineStylesForTradingRangePlot:recordIndexRange: is also implemented in the datasource. More...

(nullable CPTLineStyleArray *)	- decreaseLineStylesForTradingRangePlot:recordIndexRange:
	(Optional) Gets a range of line styles used to outline candlestick symbols when close < open for the given trading range plot. More...

(nullable CPTLineStyle *)	- decreaseLineStyleForTradingRangePlot:recordIndex:
	(Optional) Gets the line style used to outline candlestick symbols when close < open for the given trading range plot. This method will not be called if -decreaseLineStylesForTradingRangePlot:recordIndexRange: is also implemented in the datasource. More...

Public Instance Methods inherited from <CPTPlotDataSource>
(NSUInteger)	- numberOfRecordsForPlot:
	(Required) The number of data points for the plot. More...

(nullable NSArray *)	- numbersForPlot:field:recordIndexRange:
	(Optional) Gets a range of plot data for the given plot and field. Implement one and only one of the optional methods in this section. More...

(nullable id)	- numberForPlot:field:recordIndex:
	(Optional) Gets a plot data value for the given plot and field. Implement one and only one of the optional methods in this section. More...

(nullable double *)	- doublesForPlot:field:recordIndexRange:
	(Optional) Gets a range of plot data for the given plot and field. Implement one and only one of the optional methods in this section. More...

(double)	- doubleForPlot:field:recordIndex:
	(Optional) Gets a plot data value for the given plot and field. Implement one and only one of the optional methods in this section. More...

(nullable CPTNumericData *)	- dataForPlot:field:recordIndexRange:
	(Optional) Gets a range of plot data for the given plot and field. Implement one and only one of the optional methods in this section. More...

(nullable CPTNumericData *)	- dataForPlot:recordIndexRange:
	(Optional) Gets a range of plot data for all fields of the given plot simultaneously. Implement one and only one of the optional methods in this section. More...

(nullable CPTLayerArray *)	- dataLabelsForPlot:recordIndexRange:
	(Optional) Gets a range of data labels for the given plot. More...

(nullable CPTLayer *)	- dataLabelForPlot:recordIndex:
	(Optional) Gets a data label for the given plot. This method will not be called if -dataLabelsForPlot:recordIndexRange: is also implemented in the datasource. More...

Public Instance Methods inherited from <NSObject>
(NSString *)	- description

(NSUInteger)	- hash

(BOOL)	- isEqual:

Detailed Description

A trading range plot data source.

Method Documentation

◆ barWidthForTradingRangePlot:recordIndex:

- (nullable NSNumber *) barWidthForTradingRangePlot:	(nonnull CPTTradingRangePlot *)	plot
recordIndex:	(NSUInteger)	idx

(Optional) Gets a bar width for the given trading range plot. This method will not be called if -barWidthsForTradingRangePlot:recordIndexRange: is also implemented in the datasource.

Parameters

plot	The trading range plot.
idx	The data index of interest.

Returns: The bar width for the bar with the given index. If the data source returns nil, the default barWidth is used.

◆ barWidthsForTradingRangePlot:recordIndexRange:

- (nullable CPTNumberArray *) barWidthsForTradingRangePlot:	(nonnull CPTTradingRangePlot *)	plot
recordIndexRange:	(NSRange)	indexRange

(Optional) Gets an array of bar widths for the given trading range plot.

Parameters

plot	The trading range plot.
indexRange	The range of the data indexes of interest.

Returns: An array of bar widths.

◆ decreaseFillForTradingRangePlot:recordIndex:

- (nullable CPTFill *) decreaseFillForTradingRangePlot:	(nonnull CPTTradingRangePlot *)	plot
recordIndex:	(NSUInteger)	idx

(Optional) Gets the fill used with a candlestick plot when close < open for the given plot. This method will not be called if -decreaseFillsForTradingRangePlot:recordIndexRange: is also implemented in the datasource.

Parameters

plot	The trading range plot.
idx	The data index of interest.

Returns: The bar fill for the bar with the given index. If the data source returns nil, the default decrease fill is used. If the data source returns an NSNull object, no fill is drawn.

◆ decreaseFillsForTradingRangePlot:recordIndexRange:

- (nullable CPTFillArray *) decreaseFillsForTradingRangePlot:	(nonnull CPTTradingRangePlot *)	plot
recordIndexRange:	(NSRange)	indexRange

(Optional) Gets a range of fills used with a candlestick plot when close < open for the given plot.

Parameters

plot	The trading range plot.
indexRange	The range of the data indexes of interest.

◆ decreaseLineStyleForTradingRangePlot:recordIndex:

- (nullable CPTLineStyle *) decreaseLineStyleForTradingRangePlot:	(nonnull CPTTradingRangePlot *)	plot
recordIndex:	(NSUInteger)	idx

(Optional) Gets the line style used to outline candlestick symbols when close < open for the given trading range plot. This method will not be called if -decreaseLineStylesForTradingRangePlot:recordIndexRange: is also implemented in the datasource.

Parameters

plot	The trading range plot.
idx	The data index of interest.

Returns: The line line style for the symbol with the given index. If the data source returns nil, the default decrease line style is used. If the data source returns an NSNull object, no line is drawn.

◆ decreaseLineStylesForTradingRangePlot:recordIndexRange:

- (nullable CPTLineStyleArray *) decreaseLineStylesForTradingRangePlot:	(nonnull CPTTradingRangePlot *)	plot
recordIndexRange:	(NSRange)	indexRange

(Optional) Gets a range of line styles used to outline candlestick symbols when close < open for the given trading range plot.

Parameters

plot	The trading range plot.
indexRange	The range of the data indexes of interest.

Returns: An array of line styles.

◆ increaseFillForTradingRangePlot:recordIndex:

- (nullable CPTFill *) increaseFillForTradingRangePlot:	(nonnull CPTTradingRangePlot *)	plot
recordIndex:	(NSUInteger)	idx

(Optional) Gets the fill used with a candlestick plot when close >= open for the given plot. This method will not be called if -increaseFillsForTradingRangePlot:recordIndexRange: is also implemented in the datasource.

Parameters

plot	The trading range plot.
idx	The data index of interest.

Returns: The bar fill for the bar with the given index. If the data source returns nil, the default increase fill is used. If the data source returns an NSNull object, no fill is drawn.

◆ increaseFillsForTradingRangePlot:recordIndexRange:

- (nullable CPTFillArray *) increaseFillsForTradingRangePlot:	(nonnull CPTTradingRangePlot *)	plot
recordIndexRange:	(NSRange)	indexRange

(Optional) Gets a range of fills used with a candlestick plot when close >= open for the given plot.

Parameters

plot	The trading range plot.
indexRange	The range of the data indexes of interest.

Returns: An array of fills.

◆ increaseLineStyleForTradingRangePlot:recordIndex:

- (nullable CPTLineStyle *) increaseLineStyleForTradingRangePlot:	(nonnull CPTTradingRangePlot *)	plot
recordIndex:	(NSUInteger)	idx

(Optional) Gets the line style used to outline candlestick symbols when close >= open for the given trading range plot. This method will not be called if -increaseLineStylesForTradingRangePlot:recordIndexRange: is also implemented in the datasource.

Parameters

plot	The trading range plot.
idx	The data index of interest.

Returns: The line line style for the symbol with the given index. If the data source returns nil, the default increase line style is used. If the data source returns an NSNull object, no line is drawn.

◆ increaseLineStylesForTradingRangePlot:recordIndexRange:

- (nullable CPTLineStyleArray *) increaseLineStylesForTradingRangePlot:	(nonnull CPTTradingRangePlot *)	plot
recordIndexRange:	(NSRange)	indexRange

(Optional) Gets a range of line styles used to outline candlestick symbols when close >= open for the given trading range plot.

Parameters

plot	The trading range plot.
indexRange	The range of the data indexes of interest.

Returns: An array of line styles.

◆ lineStyleForTradingRangePlot:recordIndex:

- (nullable CPTLineStyle *) lineStyleForTradingRangePlot:	(nonnull CPTTradingRangePlot *)	plot
recordIndex:	(NSUInteger)	idx

(Optional) Gets the line style used to draw candlestick or OHLC symbols for the given trading range plot. This method will not be called if -lineStylesForTradingRangePlot:recordIndexRange: is also implemented in the datasource.

Parameters

plot	The trading range plot.
idx	The data index of interest.

Returns: The line style for the symbol with the given index. If the data source returns nil, the default line style is used. If the data source returns an NSNull object, no line is drawn.

◆ lineStylesForTradingRangePlot:recordIndexRange:

- (nullable CPTLineStyleArray *) lineStylesForTradingRangePlot:	(nonnull CPTTradingRangePlot *)	plot
recordIndexRange:	(NSRange)	indexRange

(Optional) Gets a range of line styles used to draw candlestick or OHLC symbols for the given trading range plot.

Parameters

plot	The trading range plot.
indexRange	The range of the data indexes of interest.

Returns: An array of line styles.

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

Source/CPTTradingRangePlot.h

Public Instance Methods

Detailed Description

Method Documentation

◆ barWidthForTradingRangePlot:recordIndex:

◆ barWidthsForTradingRangePlot:recordIndexRange:

◆ decreaseFillForTradingRangePlot:recordIndex:

◆ decreaseFillsForTradingRangePlot:recordIndexRange:

◆ decreaseLineStyleForTradingRangePlot:recordIndex:

◆ decreaseLineStylesForTradingRangePlot:recordIndexRange:

◆ increaseFillForTradingRangePlot:recordIndex:

◆ increaseFillsForTradingRangePlot:recordIndexRange:

◆ increaseLineStyleForTradingRangePlot:recordIndex:

◆ increaseLineStylesForTradingRangePlot:recordIndexRange:

◆ lineStyleForTradingRangePlot:recordIndex:

◆ lineStylesForTradingRangePlot:recordIndexRange: