Core Plot (macOS)
Cocoa plotting framework for macOS, iOS, and tvOS
CPTDefinitions.h File Reference
#import <TargetConditionals.h>
#import <Availability.h>
+ Include dependency graph for CPTDefinitions.h:
+ This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Classes

struct  CPTRGBAColor
 RGBA color for gradients. More...
 
struct  CPTEdgeInsets
 Edge inset distances for stretchable images. More...
 

Macros

#define CPT_SDK_SUPPORTS_WEAK
 Defined as 1 if the compiler and active SDK support weak references, 0 otherwise. More...
 
#define cpt_weak_property
 A custom definition for automatic reference counting (ARC) weak properties that falls back to assign on older platforms. More...
 
#define cpt_deprecated
 Marks a method declaration as deprecated. More...
 
#define cpt_unused
 Marks a parameter value as unused only in RELEASE builds. More...
 
#define cpt_swift_enum
 Marks a type definition to be imported into Swift as an enumeration. More...
 
#define cpt_swift_struct
 Marks a type definition to be imported into Swift as a structure. More...
 
#define CPTFloat(x)
 Casts a number to CGFloat. More...
 
#define CPTPointMake(x, y)
 A replacement for CGPointMake(), casting each parameter to CGFloat. More...
 
#define CPTSizeMake(w, h)
 A replacement for CGSizeMake(), casting each parameter to CGFloat. More...
 
#define CPTRectMake(x, y, w, h)
 A replacement for CGRectMake(), casting each parameter to CGFloat. More...
 
#define CPTRectInset(rect, dx, dy)
 A replacement for CGRectInset(), casting each offset parameter to CGFloat. More...
 
#define CPTNAN
 The not-a-number constant (NaN), cast to CGFloat. More...
 

Typedefs

typedef NSArray< NSNumber * > CPTNumberArray
 An array of numbers. More...
 
typedef NSMutableArray< NSNumber * > CPTMutableNumberArray
 A mutable array of numbers. More...
 
typedef NSSet< NSNumber * > CPTNumberSet
 A set of numbers. More...
 
typedef NSMutableSet< NSNumber * > CPTMutableNumberSet
 A mutable set of numbers. More...
 
typedef NSArray< NSString * > CPTStringArray
 An array of strings. More...
 
typedef NSMutableArray< NSString * > CPTMutableStringArray
 A mutable array of strings. More...
 
typedef NSArray< NSValue * > CPTValueArray
 An array of values. More...
 
typedef NSMutableArray< NSValue * > CPTMutableValueArray
 A mutable array of values. More...
 
typedef NSDictionary< NSString *, idCPTDictionary
 A dictionary with string keys and object values. More...
 
typedef NSMutableDictionary< NSString *, idCPTMutableDictionary
 A mutable dictionary with string keys and object values. More...
 
typedef void(^ CPTQuickLookImageBlock) (__nonnull CGContextRef context, CGFloat scale, CGRect bounds)
 Render a Quick Look image into the given context. More...
 

Enumerations

enum  CPTNumericType : NSInteger { CPTNumericTypeInteger, CPTNumericTypeFloat, CPTNumericTypeDouble }
 Enumeration of numeric types. More...
 
enum  CPTErrorBarType : NSInteger { CPTErrorBarTypeCustom, CPTErrorBarTypeConstantRatio, CPTErrorBarTypeConstantValue }
 Enumeration of error bar types. More...
 
enum  CPTScaleType : NSInteger {
  CPTScaleTypeLinear, CPTScaleTypeLog, CPTScaleTypeAngular, CPTScaleTypeDateTime,
  CPTScaleTypeCategory, CPTScaleTypeLogModulus
}
 Enumeration of axis scale types. More...
 
enum  CPTCoordinate : NSInteger { CPTCoordinateX = 0, CPTCoordinateY = 1, CPTCoordinateZ = 2, CPTCoordinateNone = NSIntegerMax }
 Enumeration of axis coordinates. More...
 
enum  CPTSign : NSInteger { CPTSignNone = 0, CPTSignPositive = +1, CPTSignNegative = -1 }
 Enumeration of label positioning offset directions. More...
 
enum  CPTRectAnchor : NSInteger {
  CPTRectAnchorBottomLeft, CPTRectAnchorBottom, CPTRectAnchorBottomRight, CPTRectAnchorLeft,
  CPTRectAnchorRight, CPTRectAnchorTopLeft, CPTRectAnchorTop, CPTRectAnchorTopRight,
  CPTRectAnchorCenter
}
 Locations around the edge of a rectangle. More...
 
enum  CPTAlignment : NSInteger {
  CPTAlignmentLeft, CPTAlignmentCenter, CPTAlignmentRight, CPTAlignmentTop,
  CPTAlignmentMiddle, CPTAlignmentBottom
}
 Label and constraint alignment constants. More...
 

Variables

const CPTEdgeInsets CPTEdgeInsetsZero
 Defines a set of stretchable image edge insets where all of the values are zero (0). More...
 
const NSStringDrawingOptions CPTStringDrawingOptions
 String drawing options used when measuring and drawing text. More...
 

Macro Definition Documentation

◆ cpt_deprecated

#define cpt_deprecated

Marks a method declaration as deprecated.

◆ CPT_SDK_SUPPORTS_WEAK

#define CPT_SDK_SUPPORTS_WEAK

Defined as 1 if the compiler and active SDK support weak references, 0 otherwise.

◆ cpt_swift_enum

#define cpt_swift_enum

Marks a type definition to be imported into Swift as an enumeration.

◆ cpt_swift_struct

#define cpt_swift_struct

Marks a type definition to be imported into Swift as a structure.

◆ cpt_unused

#define cpt_unused

Marks a parameter value as unused only in RELEASE builds.

◆ cpt_weak_property

#define cpt_weak_property

A custom definition for automatic reference counting (ARC) weak properties that falls back to assign on older platforms.

◆ CPTFloat

#define CPTFloat (   x)

Casts a number to CGFloat.

Parameters
xThe number to cast.

◆ CPTNAN

#define CPTNAN

The not-a-number constant (NaN), cast to CGFloat.

◆ CPTPointMake

#define CPTPointMake (   x,
 
)

A replacement for CGPointMake(), casting each parameter to CGFloat.

Parameters
xThe x-coordinate of the point.
yThe y-coordinate of the point.

◆ CPTRectInset

#define CPTRectInset (   rect,
  dx,
  dy 
)

A replacement for CGRectInset(), casting each offset parameter to CGFloat.

Parameters
rectThe rectangle to offset.
dxThe x-offset.
dyThe y-offset.

◆ CPTRectMake

#define CPTRectMake (   x,
  y,
  w,
 
)

A replacement for CGRectMake(), casting each parameter to CGFloat.

Parameters
xThe x-coordinate of the rectangle.
yThe y-coordinate of the rectangle.
wThe width of the rectangle.
hThe height of the rectangle.

◆ CPTSizeMake

#define CPTSizeMake (   w,
 
)

A replacement for CGSizeMake(), casting each parameter to CGFloat.

Parameters
wThe width of the size.
hThe height of the size.

Typedef Documentation

◆ CPTDictionary

A dictionary with string keys and object values.

◆ CPTMutableDictionary

A mutable dictionary with string keys and object values.

◆ CPTMutableNumberArray

A mutable array of numbers.

◆ CPTMutableNumberSet

A mutable set of numbers.

◆ CPTMutableStringArray

A mutable array of strings.

◆ CPTMutableValueArray

A mutable array of values.

◆ CPTNumberArray

An array of numbers.

◆ CPTNumberSet

A set of numbers.

◆ CPTQuickLookImageBlock

typedef void(^ CPTQuickLookImageBlock) (__nonnull CGContextRef context, CGFloat scale, CGRect bounds)

Render a Quick Look image into the given context.

◆ CPTStringArray

An array of strings.

◆ CPTValueArray

An array of values.

Enumeration Type Documentation

◆ CPTAlignment

Label and constraint alignment constants.

Enumerator
CPTAlignmentLeft 

Align horizontally to the left side.

CPTAlignmentCenter 

Align horizontally to the center.

CPTAlignmentRight 

Align horizontally to the right side.

CPTAlignmentTop 

Align vertically to the top.

CPTAlignmentMiddle 

Align vertically to the middle.

CPTAlignmentBottom 

Align vertically to the bottom.

◆ CPTCoordinate

Enumeration of axis coordinates.

Enumerator
CPTCoordinateX 

X axis.

CPTCoordinateY 

Y axis.

CPTCoordinateZ 

Z axis.

CPTCoordinateNone 

Invalid coordinate value.

◆ CPTErrorBarType

Enumeration of error bar types.

Enumerator
CPTErrorBarTypeCustom 

Custom error bars.

CPTErrorBarTypeConstantRatio 

Constant ratio error bars.

CPTErrorBarTypeConstantValue 

Constant value error bars.

◆ CPTNumericType

Enumeration of numeric types.

Enumerator
CPTNumericTypeInteger 

Integer.

CPTNumericTypeFloat 

Float.

CPTNumericTypeDouble 

Double.

◆ CPTRectAnchor

Locations around the edge of a rectangle.

Enumerator
CPTRectAnchorBottomLeft 

The bottom left corner.

CPTRectAnchorBottom 

The bottom center.

CPTRectAnchorBottomRight 

The bottom right corner.

CPTRectAnchorLeft 

The left middle.

CPTRectAnchorRight 

The right middle.

CPTRectAnchorTopLeft 

The top left corner.

CPTRectAnchorTop 

The top center.

CPTRectAnchorTopRight 

The top right.

CPTRectAnchorCenter 

The center of the rect.

◆ CPTScaleType

Enumeration of axis scale types.

Enumerator
CPTScaleTypeLinear 

Linear axis scale.

CPTScaleTypeLog 

Logarithmic axis scale.

CPTScaleTypeAngular 

Angular axis scale (not implemented)

CPTScaleTypeDateTime 

Date/time axis scale (not implemented)

CPTScaleTypeCategory 

Category axis scale.

CPTScaleTypeLogModulus 

Log-modulus axis scale.

◆ CPTSign

Enumeration of label positioning offset directions.

Enumerator
CPTSignNone 

No offset.

CPTSignPositive 

Positive offset.

CPTSignNegative 

Negative offset.

Variable Documentation

◆ CPTEdgeInsetsZero

const CPTEdgeInsets CPTEdgeInsetsZero

Defines a set of stretchable image edge insets where all of the values are zero (0).

◆ CPTStringDrawingOptions

const NSStringDrawingOptions CPTStringDrawingOptions

String drawing options used when measuring and drawing text.