Core Plot (iOS and tvOS)
Cocoa plotting framework for macOS, iOS, and tvOS
CPTTextLayer Class Reference

A Core Animation layer that displays text drawn in a uniform style. More...

#import <CPTTextLayer.h>

+ Inheritance diagram for CPTTextLayer:
+ Collaboration diagram for CPTTextLayer:

Public Instance Methods

Initialization
(nonnull instancetype) - initWithText:
 Initializes a newly allocated CPTTextLayer object with the provided text and the default text style. More...
 
(nonnull instancetype) - initWithText:style:
 Initializes a newly allocated CPTTextLayer object with the provided text and style. This is the designated initializer. More...
 
(nonnull instancetype) - initWithAttributedText:
 Initializes a newly allocated CPTTextLayer object with the provided styled text. More...
 
(nullable instancetype) - initWithCoder:
 Returns an object initialized from data in a given unarchiver. More...
 
(nonnull instancetype) - initWithLayer:
 Override to copy or initialize custom fields of the specified layer. More...
 
(nonnull instancetype) - initWithFrame: [implementation]
 Initializes a newly allocated CPTTextLayer object with the provided frame rectangle. More...
 
Layout
(CGSize- sizeThatFits
 Determine the minimum size needed to fit the text. More...
 
(void) - sizeToFit
 Resizes the layer to fit its contents leaving a narrow margin on all four sides. More...
 
- Public Instance Methods inherited from CPTBorderedLayer
(nonnull instancetype) - initWithFrame: [implementation]
 Initializes a newly allocated CPTBorderedLayer object with the provided frame rectangle. More...
 
(void) - renderBorderedLayerAsVectorInContext:
 Draws the fill and border of a CPTBorderedLayer into the given graphics context. More...
 
(void) - sublayerMarginLeft:top:right:bottom: [implementation]
 Increases the sublayer margin on all four sides by half the width of the border line style. More...
 
- Public Instance Methods inherited from CPTAnnotationHostLayer
(void) - addAnnotation:
 Adds an annotation to the receiver. More...
 
(void) - removeAnnotation:
 Removes an annotation from the receiver. More...
 
(void) - removeAllAnnotations
 Removes all annotations from the receiver. More...
 
(BOOL- pointingDeviceDownEvent:atPoint: [implementation]
 Informs the receiver that the user has touched the screen. More...
 
(BOOL- pointingDeviceUpEvent:atPoint: [implementation]
 Informs the receiver that the user has lifted their finger off the screen. More...
 
(BOOL- pointingDeviceDraggedEvent:atPoint: [implementation]
 Informs the receiver that the user has moved their finger while touching the screen. More...
 
(BOOL- pointingDeviceCancelledEvent: [implementation]
 Informs the receiver that tracking of touches has been cancelled for any reason. More...
 
- Public Instance Methods inherited from CPTLayer
(nonnull instancetype) - init [implementation]
 Initializes a newly allocated CPTLayer object with an empty frame rectangle. More...
 
(void) - logLayers
 Logs this layer and all of its sublayers. More...
 
(BOOL- pointingDeviceDownEvent:atPoint: [implementation]
 
(BOOL- pointingDeviceUpEvent:atPoint: [implementation]
 
(BOOL- pointingDeviceDraggedEvent:atPoint: [implementation]
 
(BOOL- pointingDeviceCancelledEvent: [implementation]
 
(nullable CPTNativeImage *) - imageOfLayer
 Gets an image of the layer contents. More...
 
(void) - setNeedsDisplayAllLayers
 Recursively marks this layer and all sublayers as needing to be redrawn. More...
 
(void) - renderAsVectorInContext:
 Draws layer content into the provided graphics context. More...
 
(void) - recursivelyRenderInContext:
 Draws layer content and the content of all sublayers into the provided graphics context. More...
 
(void) - layoutAndRenderInContext:
 Updates the layer layout if needed and then draws layer content and the content of all sublayers into the provided graphics context. More...
 
(nonnull NSData *) - dataForPDFRepresentationOfLayer
 Draws layer content and the content of all sublayers into a PDF document. More...
 
(void) - applySublayerMaskToContext:forSublayer:withOffset:
 Recursively sets the clipping path of the given graphics context to the sublayer masking paths of its superlayers. More...
 
(void) - applyMaskToContext:
 Sets the clipping path of the given graphics context to mask the content. More...
 
(void) - pixelAlign
 Align the receiver’s position with pixel boundaries. More...
 
(void) - layoutSublayers [implementation]
 Updates the layout of all sublayers. Sublayers fill the super layer’s bounds minus any padding. More...
 
- Public Instance Methods inherited from CALayer
(BOOL- containsPoint:
 
(void) - drawInContext:
 
(id- init
 
(id- initWithLayer
 
(void) - layoutSublayers
 
(void) - setNeedsDisplay
 
(void) - setNeedsDisplayInRect:
 
(void) - setNeedsLayout
 
- Public Instance Methods inherited from NSObject
(Class- classForCoder
 
(id- copy
 
(void) - dealloc
 
(void) - finalize
 
(id- init
 
(id- mutableCopy
 
- Public Instance Methods inherited from <NSObject>
(NSString *) - description
 
(NSUInteger- hash
 
(BOOL- isEqual:
 
User Interaction

Properties

NSStringtext
 The text to display. More...
 
CPTTextStyletextStyle
 The text style used to draw the text. More...
 
NSAttributedStringattributedText
 The styled text to display. More...
 
CGSize maximumSize
 The maximum size of the layer. The default is {0.0, 0.0}. More...
 
- Properties inherited from CPTBorderedLayer
CPTLineStyleborderLineStyle
 The line style for the layer border. More...
 
CPTFillfill
 The fill for the layer background. More...
 
BOOL inLayout
 Set to YES when changing the layout of this layer. Otherwise, if masking the border, all layout property changes will be passed to the superlayer. More...
 
- Properties inherited from CPTAnnotationHostLayer
CPTAnnotationArrayannotations
 An array of annotations attached to this layer. More...
 
- Properties inherited from CPTLayer
CPTGraphgraph
 The graph for the layer. More...
 
CGFloat paddingLeft
 Amount to inset the left side of each sublayer. More...
 
CGFloat paddingTop
 Amount to inset the top of each sublayer. More...
 
CGFloat paddingRight
 Amount to inset the right side of each sublayer. More...
 
CGFloat paddingBottom
 Amount to inset the bottom of each sublayer. More...
 
id< NSCopying, NSCoding, NSObjectidentifier
 An object used to identify the layer in collections. More...
 
CGFloat contentsScale
 The scale factor applied to the layer. More...
 
BOOL useFastRendering
 If YES, subclasses should optimize their drawing for speed over precision. More...
 
CPTShadowshadow
 The shadow drawn under the layer content. If nil (the default), no shadow is drawn. More...
 
CGSize shadowMargin
 The maximum margin size needed to fully enclose the layer shadow. More...
 
BOOL masksToBorder
 If YES, a sublayer mask is applied to clip sublayer content to the inside of the border. More...
 
CGPathRef outerBorderPath
 A drawing path that encompasses the outer boundary of the layer border. More...
 
CGPathRef innerBorderPath
 A drawing path that encompasses the inner boundary of the layer border. More...
 
CGPathRef maskingPath
 A drawing path that encompasses the layer content including any borders. Set to NULL when no masking is desired. More...
 
CGPathRef sublayerMaskingPath
 A drawing path that encompasses the layer content excluding any borders. Set to NULL when no masking is desired. More...
 
CPTSublayerSetsublayersExcludedFromAutomaticLayout
 A set of sublayers that should be excluded from the automatic sublayer layout. More...
 
- Properties inherited from CALayer
CGPoint anchorPoint
 
CGRect bounds
 
CGFloat contentsScale
 
CGFloat cornerRadius
 
id delegate
 
CGRect frame
 
BOOL masksToBounds
 
BOOL needsDisplayOnBoundsChange
 
BOOL opacity
 
BOOL opaque
 
- Properties inherited from <CAMediaTiming>
BOOL autoreverses
 
CFTimeInterval beginTime
 
CFTimeInterval duration
 
NSStringfillMode
 
float repeatCount
 
id repeatDuration
 
float speed
 
CFTimeInterval timeOffset
 

Additional Inherited Members

- Public Class Methods inherited from CALayer
(id+ layer
 
- Public Class Methods inherited from NSObject
(id+ alloc
 
(Class+ class
 
(void) + initialize
 
(void) + load
 
(id+ new
 
- Public Class Methods inherited from <NSSecureCoding>
(BOOL+ supportsSecureCoding:
 

Detailed Description

A Core Animation layer that displays text drawn in a uniform style.

Method Documentation

◆ initWithAttributedText:

- (nonnull instancetype) initWithAttributedText: (nullable NSAttributedString *)  newText

Initializes a newly allocated CPTTextLayer object with the provided styled text.

Parameters
newTextThe styled text to display.
Returns
The initialized CPTTextLayer object.

◆ initWithCoder:

- (nullable instancetype) initWithCoder: (nonnull NSCoder *)  coder

Returns an object initialized from data in a given unarchiver.

Parameters
coderAn unarchiver object.
Returns
An object initialized from data in a given unarchiver.

Reimplemented from CPTLayer.

◆ initWithFrame:

- (nonnull instancetype) initWithFrame: (CGRect __unused)  newFrame
implementation

Initializes a newly allocated CPTTextLayer object with the provided frame rectangle.

The initialized layer will have the following properties:

Parameters
newFrameThe frame rectangle.
Returns
The initialized CPTTextLayer object.

◆ initWithLayer:

- (nonnull instancetype) initWithLayer: (nonnull id layer

Override to copy or initialize custom fields of the specified layer.

Parameters
layerThe layer from which custom fields should be copied.
Returns
A layer instance with any custom instance variables copied from layer.

Reimplemented from CPTLayer.

◆ initWithText:

- (nonnull instancetype) initWithText: (nullable NSString *)  newText

Initializes a newly allocated CPTTextLayer object with the provided text and the default text style.

Parameters
newTextThe text to display.
Returns
The initialized CPTTextLayer object.

◆ initWithText:style:

- (nonnull instancetype) initWithText: (nullable NSString *)  newText
style: (nullable CPTTextStyle *)  newStyle 

Initializes a newly allocated CPTTextLayer object with the provided text and style. This is the designated initializer.

Parameters
newTextThe text to display.
newStyleThe text style used to draw the text.
Returns
The initialized CPTTextLayer object.

◆ sizeThatFits

- (CGSize) sizeThatFits

Determine the minimum size needed to fit the text.

◆ sizeToFit

- (void) sizeToFit

Resizes the layer to fit its contents leaving a narrow margin on all four sides.

Property Documentation

◆ attributedText

- (nullable NSAttributedString *) attributedText
readwritenonatomiccopy

The styled text to display.

Assigning a new value to this property also sets the value of the text property to the same string, without formatting information. It also replaces the textStyle with a style matching the first position (location 0) of the styled text. Insert newline characters ('\n') at the line breaks to display multi-line text.

◆ maximumSize

- (CGSize) maximumSize
readwritenonatomicassign

The maximum size of the layer. The default is {0.0, 0.0}.

A text layer will size itself to fit its text drawn with its text style unless it exceeds this size. If the width and/or height of this size is less than or equal to zero (0.0), no size limit will be enforced in the corresponding dimension. The maximum layer size includes any padding applied to the layer.

◆ text

- (nullable NSString *) text
readwritenonatomiccopy

The text to display.

Assigning a new value to this property also sets the value of the attributedText property to nil. Insert newline characters ('\n') at the line breaks to display multi-line text.

◆ textStyle

- (nullable CPTTextStyle *) textStyle
readwritenonatomicstrong

The text style used to draw the text.

Assigning a new value to this property also sets the value of the attributedText property to nil.


The documentation for this class was generated from the following files: