# FreeTextAnnotationProperties

## Content

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

***

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

# Type Alias: FreeTextAnnotationProperties

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

Defines the properties of a free text annotation that displays text directly on a page.
Unlike an ordinary text annotation ([TextAnnotation](../classes/TextAnnotation)),
a free text annotation has no open or closed state.
Instead of being displayed in a pop-up window, the text is always visible.

## Type Declaration

### calloutLine?

> `optional` **calloutLine**: [`Point`](Point)[]

The array of 2 or 3 [Point](Point) structures specifying a callout line attached to the free text annotation.
3 points represent the starting coordinates, the knee point, and the ending coordinates of the line.
2 points represent the starting and ending coordinates of the line.
The coordinates are in default user space relative to the upper left corner of the page's media box,
with the Y (vertical) coordinates increasing from top to bottom.

### defaultAppearance?

> `optional` **defaultAppearance**: [`DefaultAppearanceProperties`](DefaultAppearanceProperties) \| `string`

The apperance that specifies the visual properties (font, font size etc.) used to format
the content of the annotation.
The apperance can be specified as [DefaultAppearanceProperties](DefaultAppearanceProperties) with set of properties like font, fontSize, foreColor or
as a string as it will be stored in a PDF stream: "/DF0 10 Tf 0 0 0 rg".

### justification?

> `optional` **justification**: [`VariableTextJustification`](../enumerations/VariableTextJustification)

The justification to be used in displaying the annotation's text.
See PDF specification for details.

### lineDashPattern?

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

The line dash pattern. Null means a solid line.

### lineEndStyle?

> `optional` **lineEndStyle**: [`LineEndingStyle`](../enumerations/LineEndingStyle)

The style of end callout line.

### lineWidth?

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

The line width in points.

### opacity?

> `optional` **opacity**: `number`

The opacity value to be used in painting the annotation.
This value applies to all visible elements of the annotation in its closed state
(including its background and border) but not to the pop-up window that appears when the annotation is opened.

### textOffsets?

> `optional` **textOffsets**: [`Offsets`](Offsets)

The [Offsets](Offsets) structure that defines
the numerical differences between two rectangles:
the [AnnotationBase#rect](../classes/AnnotationBase#rect) and an inner rectangle contained within that rectangle.
The inner rectangle is where the [FreeTextAnnotation](../classes/FreeTextAnnotation)'s text should be displayed.

Note that if this rectangle is not specified then [AnnotationBase#rect](../classes/AnnotationBase#rect)
is used as the text rectangle.

### type

> **type**: `"freetext"`

## See

[FreeTextAnnotation](../classes/FreeTextAnnotation)