iOS & macOS Charting Documentation - SciChart iOS & macOS Charts SDK v4.x

SCIPenStyle

@interface SCIPenStyle : SCIStyle <NSCopying>

Defines a base class for specifying of 2D line style used to draw lines on the ISCIRenderSurface.

Warning

Designed to be an abstract class, hence should be used for inheritance only. No direct initializations.

See

SCISolidPenStyle.

See

SCILinearGradientPenStyle.

See

SCIRadialGradientPenStyle.

See

SCITexturePenStyle.


                        
                        
                        DEFAULT

Provides default instance of SCISolidPenStyle.

Declaration

Objective-C

@property (class, nonatomic, readonly) SCIPenStyle *_Nonnull DEFAULT;

TRANSPARENT
Provides transparent (clear) instance of SCISolidPenStyle.
Declaration
Objective-C

@property (class, nonatomic, readonly) SCIPenStyle *_Nonnull TRANSPARENT;


                        
                        
                        colorCode

Gets the ARGB color code.

Declaration

Objective-C

@property (nonatomic, readonly) unsigned int colorCode;


                        
                        
                        color

Gets the ARGB color.

Declaration

Objective-C

@property (nonatomic, readonly) UIColor *_Nonnull color;


                        
                        
                        strokeDashArray

Gets the stroke dash pattern.

Declaration

Objective-C

@property (nonatomic, strong, readonly, nullable) NSArray<NSNumber *> *strokeDashArray;

antiAliasing
Gets the value indicating whether the pen should use antialiased or no.
Declaration
Objective-C

@property (nonatomic, readonly) BOOL antiAliasing;
thickness
Gets the stroke thickness in pixels.
Declaration
Objective-C

@property (nonatomic, readonly) float thickness;
paint
Gets the ISCIStrokePaint which might be used to draw this Pen on CGContextRef.
Declaration
Objective-C

@property (nonatomic, readonly) id<ISCIStrokePaint> _Nonnull paint;


                        
                        
                        -initWithThickness:antiAliasing:strokeDashArray:

Creates a new SCIPenStyle instance.

Declaration

Objective-C

- (nonnull instancetype)initWithThickness:(float)thickness
                             antiAliasing:(BOOL)antiAliasing
                          strokeDashArray:
                              (nullable NSArray<NSNumber *> *)strokeDashArray;

Parameters

`antiAliasing`	The value indicating whether the pen should use antialiasing or no.
`thickness`	The stroke thickness in pixels.
`strokeDashArray`	The stroke dash pattern.


                        
                        
                        -isEqualToPenStyle:

Returns a Boolean value that indicates whether the receiver and a given object are equal.

Declaration

Objective-C

- (BOOL)isEqualToPenStyle:(nullable SCIPenStyle *)penStyle;

Parameters


                                    penStyle

The pen style to be compared to the receiver. May be nil, in which case this method returns NO.

Return Value

YES if the receiver and anObject are equal, otherwise - NO.