5.20193.637
PdfPen Wijmo API Class

PdfPen Class

Determines an object used to stroke paths and text.

Heirarchy

  • PdfPen

Constructors

constructor

  • Initializes a new instance of the PdfPen class with the specified color or brush or JavaScript object.

    The first argument can accept the following values:

    Parameters

    • Optional colorOrBrushOrOptions: any

      The color or brush or JavaScript object to use.

    • Optional width: number

      The width to use.

    • Optional dashPattern: PdfDashPattern

      The dash pattern to use.

    • Optional cap: PdfLineCapStyle

      The line cap style to use.

    • Optional join: PdfLineJoinStyle

      The line join style to use.

    • Optional miterLimit: number

      The miter limit to use.

    Returns PdfPen

Properties

brush

brush: PdfBrush

Gets or sets the brush used to stroke paths. Takes precedence over the color property, if defined.

cap

Gets or sets the shape that shall be used at the open ends of a stroked path. The default value is Butt.

color

color: Color

Gets or sets the color used to stroke paths. The default color is black.

dashPattern

dashPattern: PdfDashPattern

Gets the dash pattern used to stroke paths. The default value is a solid line.

join

Gets or sets the shape to be used at the corners of a stroked path. The default value is Miter.

miterLimit

miterLimit: number

Determines the maximum value of the miter length to the line width ratio, when the line join is converted from miter to bevel. The default value is 10.

width

width: number

Gets or sets the line width used to stroke paths, in points. The default width is 1.

Methods

clone

  • Creates a copy of this PdfPen.

    Returns PdfPen

    A copy of this pen.

equals

  • equals(value: PdfPen): boolean
  • Determines whether the specified PdfPen instance is equal to the current one.

    Parameters

    Returns boolean

    true if the specified object is equal to the current one, otherwise false.