CPTLegend.h

Go to the documentation of this file.

#import "CPTBorderedLayer.h"
#import "CPTPlot.h"
 
 
@class CPTFill;
@class CPTLegend;
@class CPTLineStyle;
@class CPTTextStyle;
 
typedef NSString *CPTLegendNotification cpt_swift_struct;
 
 
extern CPTLegendNotification __nonnull const CPTLegendNeedsRedrawForPlotNotification NS_SWIFT_NAME(needsRedrawForPlot);
 
extern CPTLegendNotification __nonnull const CPTLegendNeedsLayoutForPlotNotification NS_SWIFT_NAME(needsLayoutForPlot);
 
extern CPTLegendNotification __nonnull const CPTLegendNeedsReloadEntriesForPlotNotification NS_SWIFT_NAME(needsReloadEntriesForPlot);
 
 
typedef NS_ENUM (NSInteger, CPTLegendSwatchLayout) {
    CPTLegendSwatchLayoutLeft,  
    CPTLegendSwatchLayoutRight, 
    CPTLegendSwatchLayoutTop,   
    CPTLegendSwatchLayoutBottom 
};
 
#pragma mark -
 
@protocol CPTLegendDelegate<CPTLayerDelegate>
 
@optional
 
 
-(nullable CPTFill *)legend:(nonnull CPTLegend *)legend fillForEntryAtIndex:(NSUInteger)idx forPlot:(nonnull CPTPlot *)plot;
 
-(nullable CPTLineStyle *)legend:(nonnull CPTLegend *)legend lineStyleForEntryAtIndex:(NSUInteger)idx forPlot:(nonnull CPTPlot *)plot;
 
-(nullable CPTFill *)legend:(nonnull CPTLegend *)legend fillForSwatchAtIndex:(NSUInteger)idx forPlot:(nonnull CPTPlot *)plot;
 
-(nullable CPTLineStyle *)legend:(nonnull CPTLegend *)legend lineStyleForSwatchAtIndex:(NSUInteger)idx forPlot:(nonnull CPTPlot *)plot;
 
-(BOOL)legend:(nonnull CPTLegend *)legend shouldDrawSwatchAtIndex:(NSUInteger)idx forPlot:(nonnull CPTPlot *)plot inRect:(CGRect)rect inContext:(nonnull CGContextRef)context;
 
 
 
-(void)legend:(nonnull CPTLegend *)legend legendEntryForPlot:(nonnull CPTPlot *)plot wasSelectedAtIndex:(NSUInteger)idx;
 
-(void)legend:(nonnull CPTLegend *)legend legendEntryForPlot:(nonnull CPTPlot *)plot wasSelectedAtIndex:(NSUInteger)idx withEvent:(nonnull CPTNativeEvent *)event;
 
-(void)legend:(nonnull CPTLegend *)legend legendEntryForPlot:(nonnull CPTPlot *)plot touchDownAtIndex:(NSUInteger)idx;
 
-(void)legend:(nonnull CPTLegend *)legend legendEntryForPlot:(nonnull CPTPlot *)plot touchDownAtIndex:(NSUInteger)idx withEvent:(nonnull CPTNativeEvent *)event;
 
-(void)legend:(nonnull CPTLegend *)legend legendEntryForPlot:(nonnull CPTPlot *)plot touchUpAtIndex:(NSUInteger)idx;
 
-(void)legend:(nonnull CPTLegend *)legend legendEntryForPlot:(nonnull CPTPlot *)plot touchUpAtIndex:(NSUInteger)idx withEvent:(nonnull CPTNativeEvent *)event;
 
 
@end
 
#pragma mark -
 
@interface CPTLegend : CPTBorderedLayer
 
@property (nonatomic, readwrite, copy, nullable) CPTTextStyle *textStyle;
@property (nonatomic, readwrite, assign) CGSize swatchSize;
@property (nonatomic, readwrite, copy, nullable) CPTLineStyle *swatchBorderLineStyle;
@property (nonatomic, readwrite, assign) CGFloat swatchCornerRadius;
@property (nonatomic, readwrite, copy, nullable) CPTFill *swatchFill;
 
@property (nonatomic, readwrite, copy, nullable) CPTLineStyle *entryBorderLineStyle;
@property (nonatomic, readwrite, assign) CGFloat entryCornerRadius;
@property (nonatomic, readwrite, copy, nullable) CPTFill *entryFill;
@property (nonatomic, readwrite, assign) CGFloat entryPaddingLeft;
@property (nonatomic, readwrite, assign) CGFloat entryPaddingTop;
@property (nonatomic, readwrite, assign) CGFloat entryPaddingRight;
@property (nonatomic, readwrite, assign) CGFloat entryPaddingBottom;
 
@property (nonatomic, readonly) BOOL layoutChanged;
@property (nonatomic, readwrite, assign) NSUInteger numberOfRows;
@property (nonatomic, readwrite, assign) NSUInteger numberOfColumns;
@property (nonatomic, readwrite, assign) BOOL equalRows;
@property (nonatomic, readwrite, assign) BOOL equalColumns;
@property (nonatomic, readwrite, copy, nullable) CPTNumberArray *rowHeights;
@property (nonatomic, readonly, nullable) CPTNumberArray *rowHeightsThatFit;
@property (nonatomic, readwrite, copy, nullable) CPTNumberArray *columnWidths;
@property (nonatomic, readonly, nullable) CPTNumberArray *columnWidthsThatFit;
@property (nonatomic, readwrite, assign) CGFloat columnMargin;
@property (nonatomic, readwrite, assign) CGFloat rowMargin;
@property (nonatomic, readwrite, assign) CGFloat titleOffset;
@property (nonatomic, readwrite, assign) CPTLegendSwatchLayout swatchLayout;
 
+(nonnull instancetype)legendWithPlots:(nullable CPTPlotArray *)newPlots;
+(nonnull instancetype)legendWithGraph:(nullable __kindof CPTGraph *)graph;
 
-(nonnull instancetype)initWithPlots:(nullable CPTPlotArray *)newPlots;
-(nonnull instancetype)initWithGraph:(nullable __kindof CPTGraph *)graph;
 
-(nonnull CPTPlotArray *)allPlots;
-(nullable CPTPlot *)plotAtIndex:(NSUInteger)idx;
-(nullable CPTPlot *)plotWithIdentifier:(nullable id<NSCopying>)identifier;
 
-(void)addPlot:(nonnull CPTPlot *)plot;
-(void)insertPlot:(nonnull CPTPlot *)plot atIndex:(NSUInteger)idx;
-(void)removePlot:(nonnull CPTPlot *)plot;
-(void)removePlotWithIdentifier:(nullable id<NSCopying>)identifier;
 
-(void)setLayoutChanged;
 
@end