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.
  • Provides default instance of SCISolidPenStyle.

    Declaration

    Objective-C

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

    Swift

    class var `default`: SCIPenStyle { get }
  • Provides transparent (clear) instance of SCISolidPenStyle.

    Declaration

    Objective-C

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

    Swift

    class var transparent: SCIPenStyle { get }
  • Gets the ARGB color code.

    Declaration

    Objective-C

    @property (nonatomic, readonly) unsigned int colorCode;

    Swift

    var colorCode: UInt32 { get }
  • Gets the ARGB color.

    Declaration

    Objective-C

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

    Swift

    var color: UIColor { get }
  • Gets the stroke dash pattern.

    Declaration

    Objective-C

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

    Swift

    var strokeDashArray: [NSNumber]? { get }
  • Gets the value indicating whether the pen should use antialiased or no.

    Declaration

    Objective-C

    @property (nonatomic, readonly) BOOL antiAliasing;

    Swift

    var antiAliasing: Bool { get }
  • Gets the stroke thickness in pixels.

    Declaration

    Objective-C

    @property (nonatomic, readonly) float thickness;

    Swift

    var thickness: Float { get }
  • Gets the ISCIStrokePaint which might be used to draw this Pen on CGContextRef.

    Declaration

    Objective-C

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

    Swift

    var paint: ISCIStrokePaint { get }
  • Creates a new SCIPenStyle instance.

    Declaration

    Objective-C

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

    Swift

    init(thickness: Float, antiAliasing: Bool, strokeDashArray: [NSNumber]?)

    Parameters

    antiAliasing

    The value indicating whether the pen should use antialiasing or no.

    thickness

    The stroke thickness in pixels.

    strokeDashArray

    The stroke dash pattern.

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

    Declaration

    Objective-C

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

    Swift

    func isEqual(to penStyle: SCIPenStyle?) -> Bool

    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.