# DrawPolygonOptions

## Content

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

***

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

# Type Alias: DrawPolygonOptions

> **DrawPolygonOptions** = `object`

Provides options for drawing and filling a polygon.

## Properties

### brushBounds?

> `optional` **brushBounds**: [`Bounds`](Bounds) \| `null`

The optional bounds for the fill brush.

***

### brushTransform?

> `optional` **brushTransform**: [`Transform`](../classes/Transform) \| `null`

The transformation applied to the brush.

***

### fillBrush?

> `optional` **fillBrush**: [`Brush`](../classes/Brush) \| `null`

A reference to the brush to fill the interior of the polygon.
This property has a priority over the [DrawPolygonOptions.fillColor](#fillcolor).

***

### fillColor?

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

The color to fill the interior of the polygon.
This property is ignored if the [DrawPolygonOptions.fillBrush](#fillbrush) is assigned.

***

### fillMode?

> `optional` **fillMode**: [`FillMode`](../enumerations/FillMode)

The fill mode ("Alternate" by default).

***

### 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 existing value if [DrawPolygonOptions.strokePen](#strokepen) is specified.

***

### lineColor?

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

The color of the polygon outline.
Overrides the existing value if [DrawPolygonOptions.strokePen](#strokepen) is specified.

***

### lineJoin?

> `optional` **lineJoin**: [`PenLineJoin`](../enumerations/PenLineJoin)

The line join style specifies the shape to be used at the corners of line segments.
Overrides the existing value if [DrawPolygonOptions.strokePen](#strokepen) is specified.

***

### lineStyle?

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

The style of dashed pen to draw the polygon outline.
Overrides the existing value if [DrawPolygonOptions.strokePen](#strokepen) is specified.

***

### lineWidth?

> `optional` **lineWidth**: `number`

The width of the line pen to draw the polygon outline, in units used for drawing.
Overrides the existing value if [DrawPolygonOptions.strokePen](#strokepen) is specified.

***

### strokePen?

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

A reference to the pen to draw the polygon outline.