# CircleAnnotationProperties

## Content

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

***

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

# Type Alias: CircleAnnotationProperties

> **CircleAnnotationProperties** = [`MarkupAnnotationProperties`](MarkupAnnotationProperties) & `object`

Defines properties of a circle annotation, which displays a circle on a page.
When opened, they display a pop-up window containing the text of the associated note.

## Type Declaration

### borderEffect?

> `optional` **borderEffect**: [`BorderEffectProperties`](BorderEffectProperties)

The [BorderEffectProperties](BorderEffectProperties) object defining effect applied to the annotation.

### fillColor?

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

The fill color.
Not specified means no fill.

### lineDashPattern?

> `optional` **lineDashPattern**: `number`[]

The line dash pattern.
Not specified means solid line.

### lineWidth?

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

The line width in points.
Not specified means 1.

### type

> **type**: `"circle"`

## See

[CircleAnnotation](../classes/CircleAnnotation)