# PenProperties

## Content

[**DsPdfJS API v9.1.3**](../README)

***

[DsPdfJS API](../globals) / PenProperties

# Type Alias: PenProperties

> **PenProperties** = `object`

Provides settings for creating a new [Pen](../classes/Pen).

## Properties

### basePen?

> `optional` **basePen**: [`Pen`](../classes/Pen) \| `null`

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

***

### color?

> `optional` **color**: [`Color`](Color)

The pen color. The default is Black.
Overrides the value from base pen if [PenProperties.basePen](#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](#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](#basepen) is specified.

***

### dashStyle?

> `optional` **dashStyle**: [`DashStyle`](../enumerations/DashStyle)

The style of dashed lines drawn with this pen.
Overrides the value from base pen if [PenProperties.basePen](#basepen) is specified.

***

### lineCap?

> `optional` **lineCap**: [`PenLineCap`](../enumerations/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](#basepen) is specified.

***

### lineJoin?

> `optional` **lineJoin**: [`PenLineJoin`](../enumerations/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](#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](#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](#basepen) is specified.