DsPdfJS API v9.1.0

DsPdfJS API / PenProperties

Type Alias: PenProperties

PenProperties = object

Provides settings for creating a new Pen.

Properties

basePen?

optional basePen: Pen | null

A reference to the pen used as the base for the new pen.

color?

optional color: Color

The pen color. The default is Black. Overrides the value from base pen if PenProperties.basePen is specified.

dashOffset?

optional dashOffset: number

The distance within the dash pattern where a dash begins. The default value is 0. Overrides the value from base pen if PenProperties.basePen is specified.

dashPattern?

optional dashPattern: number[] | null

The custom dash pattern of lines drawn with this pen. Overrides the value from base pen if PenProperties.basePen is specified.

dashStyle?

optional dashStyle: DashStyle

The style of dashed lines drawn with this pen. Overrides the value from base pen if PenProperties.basePen is specified.

lineCap?

optional lineCap: PenLineCap

The line cap style specifies the shape to be used at the ends of open subpaths (and dashes, if any) when they are stroked. Overrides the value from base pen if PenProperties.basePen is specified.

lineJoin?

optional lineJoin: PenLineJoin

The line join style specifies the shape to be used at the corners of paths that are stroked. Overrides the value from base pen if PenProperties.basePen is specified.

miterLimit?

optional miterLimit: number

A maximum on the ratio of the miter length to the pen width. When the limit is exceeded, the join is converted from a miter to a bevel. Overrides the value from base pen if PenProperties.basePen is specified.

width?

optional width: number

The pen width, in units used for drawing. The default is 1. Overrides the value from base pen if PenProperties.basePen is specified.