forked from core-plot/core-plot
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathCPTBarPlot.h
More file actions
225 lines (189 loc) · 7.65 KB
/
CPTBarPlot.h
File metadata and controls
225 lines (189 loc) · 7.65 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
#import "CPTDefinitions.h"
#import "CPTFill.h"
#import "CPTLineStyle.h"
#import "CPTPlot.h"
/// @file
@class CPTMutableNumericData;
@class CPTNumericData;
@class CPTPlotRange;
@class CPTColor;
@class CPTBarPlot;
@class CPTTextLayer;
@class CPTTextStyle;
/// @ingroup plotBindingsBarPlot
/// @{
extern NSString *__nonnull const CPTBarPlotBindingBarLocations;
extern NSString *__nonnull const CPTBarPlotBindingBarTips;
extern NSString *__nonnull const CPTBarPlotBindingBarBases;
extern NSString *__nonnull const CPTBarPlotBindingBarFills;
extern NSString *__nonnull const CPTBarPlotBindingBarLineStyles;
/// @}
/**
* @brief Enumeration of bar plot data source field types
**/
typedef NS_ENUM (NSInteger, CPTBarPlotField) {
CPTBarPlotFieldBarLocation, ///< Bar location on independent coordinate axis.
CPTBarPlotFieldBarTip, ///< Bar tip value.
CPTBarPlotFieldBarBase ///< Bar base (used only if @link CPTBarPlot::barBasesVary barBasesVary @endlink is YES).
};
#pragma mark -
/**
* @brief A bar plot data source.
**/
@protocol CPTBarPlotDataSource<CPTPlotDataSource>
@optional
/// @name Bar Style
/// @{
/** @brief @optional Gets an array of bar fills for the given bar plot.
* @param barPlot The bar plot.
* @param indexRange The range of the data indexes of interest.
* @return An array of bar fills.
**/
-(nullable CPTFillArray *)barFillsForBarPlot:(nonnull CPTBarPlot *)barPlot recordIndexRange:(NSRange)indexRange;
/** @brief @optional Gets a bar fill for the given bar plot.
* This method will not be called if
* @link CPTBarPlotDataSource::barFillsForBarPlot:recordIndexRange: -barFillsForBarPlot:recordIndexRange: @endlink
* is also implemented in the datasource.
* @param barPlot The bar plot.
* @param idx The data index of interest.
* @return The bar fill for the bar with the given index. If the data source returns @nil, the default fill is used.
* If the data source returns an NSNull object, no fill is drawn.
**/
-(nullable CPTFill *)barFillForBarPlot:(nonnull CPTBarPlot *)barPlot recordIndex:(NSUInteger)idx;
/** @brief @optional Gets an array of bar line styles for the given bar plot.
* @param barPlot The bar plot.
* @param indexRange The range of the data indexes of interest.
* @return An array of line styles.
**/
-(nullable CPTLineStyleArray *)barLineStylesForBarPlot:(nonnull CPTBarPlot *)barPlot recordIndexRange:(NSRange)indexRange;
/** @brief @optional Gets a bar line style for the given bar plot.
* This method will not be called if
* @link CPTBarPlotDataSource::barLineStylesForBarPlot:recordIndexRange: -barLineStylesForBarPlot:recordIndexRange: @endlink
* is also implemented in the datasource.
* @param barPlot The bar plot.
* @param idx The data index of interest.
* @return The bar line style for the bar 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.
**/
-(nullable CPTLineStyle *)barLineStyleForBarPlot:(nonnull CPTBarPlot *)barPlot recordIndex:(NSUInteger)idx;
/// @}
/// @name Legends
/// @{
/** @brief @optional Gets the legend title for the given bar plot bar.
* @param barPlot The bar plot.
* @param idx The data index of interest.
* @return The title text for the legend entry for the point with the given index.
**/
-(nullable NSString *)legendTitleForBarPlot:(nonnull CPTBarPlot *)barPlot recordIndex:(NSUInteger)idx;
/** @brief @optional Gets the styled legend title for the given bar plot bar.
* @param barPlot The bar plot.
* @param idx The data index of interest.
* @return The styled title text for the legend entry for the point with the given index.
**/
-(nullable NSAttributedString *)attributedLegendTitleForBarPlot:(nonnull CPTBarPlot *)barPlot recordIndex:(NSUInteger)idx;
/// @}
@end
#pragma mark -
/**
* @brief Bar plot delegate.
**/
@protocol CPTBarPlotDelegate<CPTPlotDelegate>
@optional
/// @name Point Selection
/// @{
/** @brief @optional Informs the delegate that a bar
* @if MacOnly was both pressed and released. @endif
* @if iOSOnly received both the touch down and up events. @endif
* @param plot The bar plot.
* @param idx The index of the
*
* @if MacOnly clicked bar. @endif
* @if iOSOnly touched bar. @endif
**/
-(void)barPlot:(nonnull CPTBarPlot *)plot barWasSelectedAtRecordIndex:(NSUInteger)idx;
/** @brief @optional Informs the delegate that a bar
* @if MacOnly was both pressed and released. @endif
* @if iOSOnly received both the touch down and up events. @endif
* @param plot The bar plot.
* @param idx The index of the
*
* @if MacOnly clicked bar. @endif
* @if iOSOnly touched bar. @endif
* @param event The event that triggered the selection.
**/
-(void)barPlot:(nonnull CPTBarPlot *)plot barWasSelectedAtRecordIndex:(NSUInteger)idx withEvent:(nonnull CPTNativeEvent *)event;
/** @brief @optional Informs the delegate that a bar
* @if MacOnly was pressed. @endif
* @if iOSOnly touch started. @endif
* @param plot The bar plot.
* @param idx The index of the
* @if MacOnly clicked bar. @endif
* @if iOSOnly touched bar. @endif
**/
-(void)barPlot:(nonnull CPTBarPlot *)plot barTouchDownAtRecordIndex:(NSUInteger)idx;
/** @brief @optional Informs the delegate that a bar
* @if MacOnly was pressed. @endif
* @if iOSOnly touch started. @endif
* @param plot The bar plot.
* @param idx The index of the
* @if MacOnly clicked bar. @endif
* @if iOSOnly touched bar. @endif
* @param event The event that triggered the selection.
**/
-(void)barPlot:(nonnull CPTBarPlot *)plot barTouchDownAtRecordIndex:(NSUInteger)idx withEvent:(nonnull CPTNativeEvent *)event;
/** @brief @optional Informs the delegate that a bar
* @if MacOnly was released. @endif
* @if iOSOnly touch ended. @endif
* @param plot The bar plot.
* @param idx The index of the
* @if MacOnly clicked bar. @endif
* @if iOSOnly touched bar. @endif
**/
-(void)barPlot:(nonnull CPTBarPlot *)plot barTouchUpAtRecordIndex:(NSUInteger)idx;
/** @brief @optional Informs the delegate that a bar
* @if MacOnly was released. @endif
* @if iOSOnly touch ended. @endif
* @param plot The bar plot.
* @param idx The index of the
* @if MacOnly clicked bar. @endif
* @if iOSOnly touched bar. @endif
* @param event The event that triggered the selection.
**/
-(void)barPlot:(nonnull CPTBarPlot *)plot barTouchUpAtRecordIndex:(NSUInteger)idx withEvent:(nonnull CPTNativeEvent *)event;
/// @}
@end
#pragma mark -
@interface CPTBarPlot : CPTPlot
/// @name Appearance
/// @{
@property (nonatomic, readwrite, assign) BOOL barWidthsAreInViewCoordinates;
@property (nonatomic, readwrite, strong, nonnull) NSNumber *barWidth;
@property (nonatomic, readwrite, strong, nonnull) NSNumber *barOffset;
@property (nonatomic, readwrite, assign) CGFloat barCornerRadius;
@property (nonatomic, readwrite, assign) CGFloat barBaseCornerRadius;
@property (nonatomic, readwrite, assign) BOOL barsAreHorizontal;
@property (nonatomic, readwrite, strong, nonnull) NSNumber *baseValue;
@property (nonatomic, readwrite, assign) BOOL barBasesVary;
@property (nonatomic, readwrite, copy, nullable) CPTPlotRange *plotRange;
/// @}
/// @name Drawing
/// @{
@property (nonatomic, readwrite, copy, nullable) CPTLineStyle *lineStyle;
@property (nonatomic, readwrite, copy, nullable) CPTFill *fill;
/// @}
/// @name Factory Methods
/// @{
+(nonnull instancetype)tubularBarPlotWithColor:(nonnull CPTColor *)color horizontalBars:(BOOL)horizontal;
/// @}
/// @name Data Ranges
/// @{
-(nullable CPTPlotRange *)plotRangeEnclosingBars;
/// @}
/// @name Bar Style
/// @{
-(void)reloadBarFills;
-(void)reloadBarFillsInIndexRange:(NSRange)indexRange;
-(void)reloadBarLineStyles;
-(void)reloadBarLineStylesInIndexRange:(NSRange)indexRange;
/// @}
@end