PdfPen Class

File
wijmo.pdf.js
Module
wijmo.pdf

Determines an object used to stroke paths and text.

Constructor

Properties

Methods

Constructor

constructor

constructor(colorOrBrushOrOptions?: any, width?: number, dashPattern?: PdfDashPattern, cap?: PdfLineCapStyle, join?: PdfLineJoinStyle, miterLimit?: number): PdfPen

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
Returns
PdfPen

Properties

brush

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

Type
PdfBrush

cap

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

Type
PdfLineCapStyle

color

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

Type
Color

dashPattern

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

Type
PdfDashPattern

join

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

Type
PdfLineJoinStyle

miterLimit

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.

Type
number

width

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

Type
number

Methods

clone

clone(): PdfPen

Creates a copy of this PdfPen.

Returns
PdfPen

equals

equals(value: PdfPen): boolean

Determines whether the specified PdfPen instance is equal to the current one.

Parameters
Returns
boolean