MacOS/c_p_t_axis_8h_source.html

#import "CPTAxisLabel.h"

#import "CPTDefinitions.h"

#import "CPTFill.h"

#import "CPTLayer.h"

#import "CPTLimitBand.h"

#import "CPTPlotRange.h"

#import "CPTTextStyle.h"


@class CPTAxis;

@class CPTAxisSet;

@class CPTAxisTitle;

@class CPTGridLines;

@class CPTLineCap;

@class CPTLineStyle;

@class CPTPlotSpace;

@class CPTPlotArea;

@class CPTShadow;


typedef NS_ENUM (NSInteger, CPTAxisLabelingPolicy) {

    CPTAxisLabelingPolicyNone,

    CPTAxisLabelingPolicyLocationsProvided,

    CPTAxisLabelingPolicyFixedInterval,

    CPTAxisLabelingPolicyAutomatic,

    CPTAxisLabelingPolicyEqualDivisions

};


typedef NSArray<__kindof CPTAxis *> CPTAxisArray;


typedef NSMutableArray<__kindof CPTAxis *> CPTMutableAxisArray;


#pragma mark -


@protocol CPTAxisDelegate<CPTLayerDelegate>


@optional


-(BOOL)axisShouldRelabel:(nonnull CPTAxis *)axis;


-(void)axisDidRelabel:(nonnull CPTAxis *)axis;


-(BOOL)axis:(nonnull CPTAxis *)axis shouldUpdateAxisLabelsAtLocations:(nonnull CPTNumberSet *)locations;


-(BOOL)axis:(nonnull CPTAxis *)axis shouldUpdateMinorAxisLabelsAtLocations:(nonnull CPTNumberSet *)locations;


-(void)axis:(nonnull CPTAxis *)axis labelWasSelected:(nonnull CPTAxisLabel *)label;


-(void)axis:(nonnull CPTAxis *)axis labelWasSelected:(nonnull CPTAxisLabel *)label withEvent:(nonnull CPTNativeEvent *)event;


-(void)axis:(nonnull CPTAxis *)axis minorTickLabelWasSelected:(nonnull CPTAxisLabel *)label;


-(void)axis:(nonnull CPTAxis *)axis minorTickLabelWasSelected:(nonnull CPTAxisLabel *)label withEvent:(nonnull CPTNativeEvent *)event;


-(void)axis:(nonnull CPTAxis *)axis labelTouchDown:(nonnull CPTAxisLabel *)label;


-(void)axis:(nonnull CPTAxis *)axis labelTouchDown:(nonnull CPTAxisLabel *)label withEvent:(nonnull CPTNativeEvent *)event;


-(void)axis:(nonnull CPTAxis *)axis labelTouchUp:(nonnull CPTAxisLabel *)label;


-(void)axis:(nonnull CPTAxis *)axis labelTouchUp:(nonnull CPTAxisLabel *)label withEvent:(nonnull CPTNativeEvent *)event;


-(void)axis:(nonnull CPTAxis *)axis minorTickTouchDown:(nonnull CPTAxisLabel *)label;


-(void)axis:(nonnull CPTAxis *)axis minorTickTouchDown:(nonnull CPTAxisLabel *)label withEvent:(nonnull CPTNativeEvent *)event;


-(void)axis:(nonnull CPTAxis *)axis minorTickTouchUp:(nonnull CPTAxisLabel *)label;


-(void)axis:(nonnull CPTAxis *)axis minorTickTouchUp:(nonnull CPTAxisLabel *)label withEvent:(nonnull CPTNativeEvent *)event;


@end


#pragma mark -


@interface CPTAxis : CPTLayer


@property (nonatomic, readwrite, copy, nullable) CPTLineStyle *axisLineStyle;

@property (nonatomic, readwrite, assign) CPTCoordinate coordinate;

@property (nonatomic, readwrite, strong, nonnull) NSNumber *labelingOrigin;

@property (nonatomic, readwrite, assign) CPTSign tickDirection;

@property (nonatomic, readwrite, copy, nullable) CPTPlotRange *visibleRange;

@property (nonatomic, readwrite, copy, nullable) CPTPlotRange *visibleAxisRange;

@property (nonatomic, readwrite, copy, nullable) CPTLineCap *axisLineCapMin;

@property (nonatomic, readwrite, copy, nullable) CPTLineCap *axisLineCapMax;


@property (nonatomic, readwrite, copy, nullable) CPTTextStyle *titleTextStyle;

@property (nonatomic, readwrite, strong, nullable) CPTAxisTitle *axisTitle;

@property (nonatomic, readwrite, assign) CGFloat titleOffset;

@property (nonatomic, readwrite, copy, nullable) NSString *title;

@property (nonatomic, readwrite, copy, nullable) NSAttributedString *attributedTitle;

@property (nonatomic, readwrite, assign) CGFloat titleRotation;

@property (nonatomic, readwrite, assign) CPTSign titleDirection;

@property (nonatomic, readwrite, strong, nullable) NSNumber *titleLocation;

@property (nonatomic, readonly, nonnull) NSNumber *defaultTitleLocation;


@property (nonatomic, readwrite, assign) CPTAxisLabelingPolicy labelingPolicy;

@property (nonatomic, readwrite, assign) CGFloat labelOffset;

@property (nonatomic, readwrite, assign) CGFloat minorTickLabelOffset;

@property (nonatomic, readwrite, assign) CGFloat labelRotation;

@property (nonatomic, readwrite, assign) CGFloat minorTickLabelRotation;

@property (nonatomic, readwrite, assign) CPTAlignment labelAlignment;

@property (nonatomic, readwrite, assign) CPTAlignment minorTickLabelAlignment;

@property (nonatomic, readwrite, copy, nullable) CPTTextStyle *labelTextStyle;

@property (nonatomic, readwrite, copy, nullable) CPTTextStyle *minorTickLabelTextStyle;

@property (nonatomic, readwrite, assign) CPTSign tickLabelDirection;

@property (nonatomic, readwrite, assign) CPTSign minorTickLabelDirection;

@property (nonatomic, readwrite, strong, nullable) NSFormatter *labelFormatter;

@property (nonatomic, readwrite, strong, nullable) NSFormatter *minorTickLabelFormatter;

@property (nonatomic, readwrite, strong, nullable) CPTAxisLabelSet *axisLabels;

@property (nonatomic, readwrite, strong, nullable) CPTAxisLabelSet *minorTickAxisLabels;

@property (nonatomic, readonly) BOOL needsRelabel;

@property (nonatomic, readwrite, strong, nullable) CPTPlotRangeArray *labelExclusionRanges;

@property (nonatomic, readwrite, strong, nullable) CPTShadow *labelShadow;

@property (nonatomic, readwrite, strong, nullable) CPTShadow *minorTickLabelShadow;


@property (nonatomic, readwrite, strong, nullable) NSNumber *majorIntervalLength;

@property (nonatomic, readwrite, assign) CGFloat majorTickLength;

@property (nonatomic, readwrite, copy, nullable) CPTLineStyle *majorTickLineStyle;

@property (nonatomic, readwrite, strong, nullable) CPTNumberSet *majorTickLocations;

@property (nonatomic, readwrite, assign) NSUInteger preferredNumberOfMajorTicks;


@property (nonatomic, readwrite, assign) NSUInteger minorTicksPerInterval;

@property (nonatomic, readwrite, assign) CGFloat minorTickLength;

@property (nonatomic, readwrite, copy, nullable) CPTLineStyle *minorTickLineStyle;

@property (nonatomic, readwrite, strong, nullable) CPTNumberSet *minorTickLocations;


@property (nonatomic, readwrite, copy, nullable) CPTLineStyle *majorGridLineStyle;

@property (nonatomic, readwrite, copy, nullable) CPTLineStyle *minorGridLineStyle;

@property (nonatomic, readwrite, copy, nullable) CPTPlotRange *gridLinesRange;


@property (nonatomic, readwrite, copy, nullable) CPTFillArray *alternatingBandFills;

@property (nonatomic, readwrite, strong, nullable) NSNumber *alternatingBandAnchor;

@property (nonatomic, readonly, nullable) CPTLimitBandArray *backgroundLimitBands;


@property (nonatomic, readwrite, strong, nullable) CPTPlotSpace *plotSpace;


@property (nonatomic, readwrite, assign) BOOL separateLayers;

@property (nonatomic, readwrite, cpt_weak_property, nullable) CPTPlotArea *plotArea;

@property (nonatomic, readonly, cpt_weak_property, nullable) CPTGridLines *minorGridLines;

@property (nonatomic, readonly, cpt_weak_property, nullable) CPTGridLines *majorGridLines;

@property (nonatomic, readonly, nullable) CPTAxisSet *axisSet;


-(void)updateAxisTitle;


-(void)relabel;

-(void)setNeedsRelabel;

-(void)updateMajorTickLabels;

-(void)updateMinorTickLabels;


-(nullable CPTNumberSet *)filteredMajorTickLocations:(nullable CPTNumberSet *)allLocations;

-(nullable CPTNumberSet *)filteredMinorTickLocations:(nullable CPTNumberSet *)allLocations;


-(void)addBackgroundLimitBand:(nullable CPTLimitBand *)limitBand;

-(void)removeBackgroundLimitBand:(nullable CPTLimitBand *)limitBand;

-(void)removeAllBackgroundLimitBands;


@end


#pragma mark -


@interface CPTAxis(AbstractMethods)


-(CGPoint)viewPointForCoordinateValue:(nullable NSNumber *)coordinateValue;


-(void)drawGridLinesInContext:(nonnull CGContextRef)context isMajor:(BOOL)major;


-(void)drawBackgroundBandsInContext:(nonnull CGContextRef)context;

-(void)drawBackgroundLimitsInContext:(nonnull CGContextRef)context;


@end