CPTPlot.h

Go to the documentation of this file.

#import "CPTAnnotationHostLayer.h"
#import "CPTDefinitions.h"
#import "CPTNumericDataType.h"
 
 
@class CPTLegend;
@class CPTMutableNumericData;
@class CPTNumericData;
@class CPTPlot;
@class CPTPlotArea;
@class CPTPlotSpace;
@class CPTPlotSpaceAnnotation;
@class CPTPlotRange;
@class CPTTextStyle;
 
typedef NSString *CPTPlotBinding cpt_swift_struct;
 
extern CPTPlotBinding __nonnull const CPTPlotBindingDataLabels;
 
typedef NS_ENUM (NSInteger, CPTPlotCachePrecision) {
    CPTPlotCachePrecisionAuto,   
    CPTPlotCachePrecisionDouble, 
    CPTPlotCachePrecisionDecimal 
};
 
typedef NSArray<__kindof CPTPlot *> CPTPlotArray;
 
typedef NSMutableArray<__kindof CPTPlot *> CPTMutablePlotArray;
 
#pragma mark -
 
@protocol CPTPlotDataSource<NSObject>
 
 
-(NSUInteger)numberOfRecordsForPlot:(nonnull CPTPlot *)plot;
 
@optional
 
-(nullable NSArray *)numbersForPlot:(nonnull CPTPlot *)plot field:(NSUInteger)fieldEnum recordIndexRange:(NSRange)indexRange;
 
-(nullable id)numberForPlot:(nonnull CPTPlot *)plot field:(NSUInteger)fieldEnum recordIndex:(NSUInteger)idx;
 
-(nullable double *)doublesForPlot:(nonnull CPTPlot *)plot field:(NSUInteger)fieldEnum recordIndexRange:(NSRange)indexRange NS_RETURNS_INNER_POINTER;
 
-(double)doubleForPlot:(nonnull CPTPlot *)plot field:(NSUInteger)fieldEnum recordIndex:(NSUInteger)idx;
 
-(nullable CPTNumericData *)dataForPlot:(nonnull CPTPlot *)plot field:(NSUInteger)fieldEnum recordIndexRange:(NSRange)indexRange;
 
-(nullable CPTNumericData *)dataForPlot:(nonnull CPTPlot *)plot recordIndexRange:(NSRange)indexRange;
 
 
 
-(nullable CPTLayerArray *)dataLabelsForPlot:(nonnull CPTPlot *)plot recordIndexRange:(NSRange)indexRange;
 
-(nullable CPTLayer *)dataLabelForPlot:(nonnull CPTPlot *)plot recordIndex:(NSUInteger)idx;
 
 
@end
 
#pragma mark -
 
@protocol CPTPlotDelegate<CPTLayerDelegate>
 
@optional
 
 
-(void)plot:(nonnull CPTPlot *)plot dataLabelWasSelectedAtRecordIndex:(NSUInteger)idx;
 
-(void)plot:(nonnull CPTPlot *)plot dataLabelWasSelectedAtRecordIndex:(NSUInteger)idx withEvent:(nonnull CPTNativeEvent *)event;
 
-(void)plot:(nonnull CPTPlot *)plot dataLabelTouchDownAtRecordIndex:(NSUInteger)idx;
 
-(void)plot:(nonnull CPTPlot *)plot dataLabelTouchDownAtRecordIndex:(NSUInteger)idx withEvent:(nonnull CPTNativeEvent *)event;
 
-(void)plot:(nonnull CPTPlot *)plot dataLabelTouchUpAtRecordIndex:(NSUInteger)idx;
 
-(void)plot:(nonnull CPTPlot *)plot dataLabelTouchUpAtRecordIndex:(NSUInteger)idx withEvent:(nonnull CPTNativeEvent *)event;
 
 
 
-(void)didFinishDrawing:(nonnull CPTPlot *)plot;
 
 
@end
 
#pragma mark -
 
@interface CPTPlot : CPTAnnotationHostLayer
 
@property (nonatomic, readwrite, cpt_weak_property, nullable) id<CPTPlotDataSource> dataSource;
 
@property (nonatomic, readwrite, copy, nullable) NSString *title;
@property (nonatomic, readwrite, copy, nullable) NSAttributedString *attributedTitle;
 
@property (nonatomic, readwrite, strong, nullable) CPTPlotSpace *plotSpace;
 
@property (nonatomic, readonly, nullable) CPTPlotArea *plotArea;
 
@property (nonatomic, readonly) BOOL dataNeedsReloading;
 
@property (nonatomic, readonly) NSUInteger cachedDataCount;
@property (nonatomic, readonly) BOOL doublePrecisionCache;
@property (nonatomic, readwrite, assign) CPTPlotCachePrecision cachePrecision;
@property (nonatomic, readonly) CPTNumericDataType doubleDataType;
@property (nonatomic, readonly) CPTNumericDataType decimalDataType;
 
@property (nonatomic, readonly) BOOL needsRelabel;
@property (nonatomic, readwrite, assign) BOOL adjustLabelAnchors;
@property (nonatomic, readwrite, assign) BOOL showLabels;
@property (nonatomic, readwrite, assign) CGFloat labelOffset;
@property (nonatomic, readwrite, assign) CGFloat labelRotation;
@property (nonatomic, readwrite, assign) NSUInteger labelField;
@property (nonatomic, readwrite, copy, nullable) CPTTextStyle *labelTextStyle;
@property (nonatomic, readwrite, strong, nullable) NSFormatter *labelFormatter;
@property (nonatomic, readwrite, strong, nullable) CPTShadow *labelShadow;
 
@property (nonatomic, readwrite, assign) BOOL alignsPointsToPixels;
 
@property (nonatomic, readwrite, assign) BOOL drawLegendSwatchDecoration;
 
-(void)setNeedsRelabel;
-(void)relabel;
-(void)relabelIndexRange:(NSRange)indexRange;
-(void)repositionAllLabelAnnotations;
-(void)reloadDataLabels;
-(void)reloadDataLabelsInIndexRange:(NSRange)indexRange;
 
-(void)setDataNeedsReloading;
-(void)reloadData;
-(void)reloadDataIfNeeded;
-(void)reloadDataInIndexRange:(NSRange)indexRange;
-(void)insertDataAtIndex:(NSUInteger)idx numberOfRecords:(NSUInteger)numberOfRecords;
-(void)deleteDataInIndexRange:(NSRange)indexRange;
-(void) reloadPlotData NS_SWIFT_NAME(CPTPlot.reloadPlotData());
 
-(void)reloadPlotDataInIndexRange:(NSRange) indexRange NS_SWIFT_NAME(CPTPlot.reloadPlotData(inIndexRange:));
 
 
+(nonnull id)nilData;
-(nullable id)numbersFromDataSourceForField:(NSUInteger)fieldEnum recordIndexRange:(NSRange)indexRange;
-(BOOL)loadNumbersForAllFieldsFromDataSourceInRecordIndexRange:(NSRange)indexRange;
 
-(nullable CPTMutableNumericData *)cachedNumbersForField:(NSUInteger)fieldEnum;
-(nullable NSNumber *)cachedNumberForField:(NSUInteger)fieldEnum recordIndex:(NSUInteger)idx;
-(double)cachedDoubleForField:(NSUInteger)fieldEnum recordIndex:(NSUInteger)idx;
-(NSDecimal)cachedDecimalForField:(NSUInteger)fieldEnum recordIndex:(NSUInteger)idx;
-(nullable NSArray *)cachedArrayForKey:(nonnull NSString *)key;
-(nullable id)cachedValueForKey:(nonnull NSString *)key recordIndex:(NSUInteger)idx;
 
-(void)cacheNumbers:(nullable id)numbers forField:(NSUInteger)fieldEnum;
-(void)cacheNumbers:(nullable id)numbers forField:(NSUInteger)fieldEnum atRecordIndex:(NSUInteger)idx;
-(void)cacheArray:(nullable NSArray *)array forKey:(nonnull NSString *)key;
-(void)cacheArray:(nullable NSArray *)array forKey:(nonnull NSString *)key atRecordIndex:(NSUInteger)idx;
 
-(nullable CPTPlotRange *)plotRangeForField:(NSUInteger)fieldEnum;
-(nullable CPTPlotRange *)plotRangeForCoordinate:(CPTCoordinate)coord;
-(nullable CPTPlotRange *)plotRangeEnclosingField:(NSUInteger)fieldEnum;
-(nullable CPTPlotRange *)plotRangeEnclosingCoordinate:(CPTCoordinate)coord;
 
-(NSUInteger)numberOfLegendEntries;
-(nullable NSString *)titleForLegendEntryAtIndex:(NSUInteger)idx;
-(nullable NSAttributedString *)attributedTitleForLegendEntryAtIndex:(NSUInteger)idx;
-(void)drawSwatchForLegend:(nonnull CPTLegend *)legend atIndex:(NSUInteger)idx inRect:(CGRect)rect inContext:(nonnull CGContextRef)context;
 
@end
 
#pragma mark -
 
@interface CPTPlot(AbstractMethods)
 
-(NSUInteger)numberOfFields;
-(nonnull CPTNumberArray *)fieldIdentifiers;
-(nonnull CPTNumberArray *)fieldIdentifiersForCoordinate:(CPTCoordinate)coord;
-(CPTCoordinate)coordinateForFieldIdentifier:(NSUInteger)field;
 
-(void)positionLabelAnnotation:(nonnull CPTPlotSpaceAnnotation *)label forIndex:(NSUInteger)idx;
 
-(NSUInteger)dataIndexFromInteractionPoint:(CGPoint)point;
 
@end