PTBorderStyle

@interface PTBorderStyle : NSObject

BorderStyle structure specifies the characteristics of the annotation’s border. The border is specified as a rounded rectangle.

  • Creates a new border style with given parameters.

    Note

    If the corner radii are 0, the border has square (not rounded) corners; if the border width is 0, no border is drawn.

    Declaration

    Objective-C

    - (instancetype)initWithS:(PTBdStyle)s
                      b_width:(double)b_width
                         b_hr:(double)b_hr
                         b_vr:(double)b_vr;

    Swift

    init!(s: PTBdStyle, b_width: Double, b_hr: Double, b_vr: Double)

    Parameters

    s

    The border style.

    b_width

    The border width expressed in the default user space.

    b_hr

    The horizontal corner radius expressed in the default user space.

    b_vr

    The vertical corner radius expressed in the default user space.

    b_dash

    An array of numbers defining a pattern of dashes and gaps to be used in drawing the border. The dash array is specified in the same format as in the line dash pattern parameter of the graphics state except that the phase is assumed to be 0.

  • Undocumented

    Declaration

    Objective-C

    - (instancetype)initWithS: (PTBdStyle)s b_width:  (double)b_width b_hr:  (double)b_hr b_vr:  (double)b_vr b_dash:  (NSMutableArray*)b_dash;

    Swift

    init!(s: PTBdStyle, b_width: Double, b_hr: Double, b_vr: Double, b_dash: NSMutableArray!)
  • Declaration

    Objective-C

    - (PTBdStyle)GetStyle;

    Swift

    func getStyle() -> PTBdStyle

    Return Value

    the border style.

  • Sets the border style.

    Declaration

    Objective-C

    - (void)SetStyle:(PTBdStyle)style;

    Swift

    func setStyle(_ style: PTBdStyle)
  • Declaration

    Objective-C

    - (double)GetHR;

    Swift

    func getHR() -> Double

    Return Value

    horizontal corner radius.

  • Sets horizontal corner radius.

    Declaration

    Objective-C

    - (void)SetHR:(double)horizontal_radius;

    Swift

    func setHR(_ horizontal_radius: Double)

    Parameters

    horizontal_radius

    A number representing the value of the horizontal radius to set the annotation to.

  • Declaration

    Objective-C

    - (double)GetVR;

    Swift

    func getVR() -> Double

    Return Value

    vertical corner radius.

  • Sets vertical corner radius.

    Declaration

    Objective-C

    - (void)SetVR:(double)vertical_radius;

    Swift

    func setVR(_ vertical_radius: Double)

    Parameters

    vertical_radius

    A number representing the value of the vertical radius to set the annotation to.

  • Declaration

    Objective-C

    - (double)GetWidth;

    Swift

    func getWidth() -> Double

    Return Value

    the border width.

  • Sets the border width

    Declaration

    Objective-C

    - (void)SetWidth:(double)width;

    Swift

    func setWidth(_ width: Double)

    Parameters

    width

    A number representing the width value to set the annotation to.

  • See

    BorderStyle()

    Declaration

    Objective-C

    - (NSMutableArray *)GetDash;

    Swift

    func getDash() -> NSMutableArray!

    Return Value

    the border dash pattern.

  • Sets the border dash pattern.

    See

    BorderStyle()

    Declaration

    Objective-C

    - (void)SetDash:(NSMutableArray *)dash;

    Swift

    func setDash(_ dash: NSMutableArray!)