SCIMultiPointLabelFormatParams Class Reference


                        
                        
                        annotation

Gets the annotation this label belongs to.

Objective-C

@property (nonatomic, weak, readonly, nullable) SCIMultiPointAnnotationBase *annotation;

Swift

weak var annotation: SCIMultiPointAnnotationBase? { get }


                        
                        
                        label

Gets the label being formatted.

Objective-C

@property (nonatomic, readonly) SCIMultiPointLabel *_Nonnull label;

Swift

var label: SCIMultiPointLabel { get }


                        
                        
                        labelIndex

Gets the index of this label in the annotation’s labels.

Objective-C

@property (nonatomic, readonly) NSInteger labelIndex;

Swift

var labelIndex: Int { get }


                        
                        
                        anchorMode

Gets the resolved anchor mode. An axis-anchored label reports Point or Segment here, depending on how its position is derived.

Objective-C

@property (nonatomic, readonly) SCIMultiPointLabelAnchorMode anchorMode;

Swift

var anchorMode: SCIMultiPointLabelAnchorMode { get }


                        
                        
                        anchorValuePoint

Gets the anchor position in data values.

Objective-C

@property (nonatomic, readonly) CGPoint anchorValuePoint;

Swift

var anchorValuePoint: CGPoint { get }


                        
                        
                        anchorPixelPoint

Gets the anchor position in screen coordinates.

Objective-C

@property (nonatomic, readonly) CGPoint anchorPixelPoint;

Swift

var anchorPixelPoint: CGPoint { get }


                        
                        
                        tangentValue

Gets the direction of the anchor segment in data values.

Note

Not normalised. Always (1, 0) for a point-anchored label.

Objective-C

@property (nonatomic, readonly) CGPoint tangentValue;

Swift

var tangentValue: CGPoint { get }


                        
                        
                        tangentPixel

Gets the direction of the anchor segment in screen coordinates.

Objective-C

@property (nonatomic, readonly) CGPoint tangentPixel;

Swift

var tangentPixel: CGPoint { get }


                        
                        
                        valuePoints

Gets all of the annotation’s base points, in data values.

Objective-C

@property (nonatomic, readonly) NSArray<SCIComparablePoint *> *_Nonnull valuePoints;

Swift

var valuePoints: [SCIComparablePoint] { get }


                        
                        
                        defaultText

Gets the label’s static text, or an empty string when it has none.

Objective-C

@property (nonatomic, readonly) NSString *_Nonnull defaultText;

Swift

var defaultText: String { get }