---
title: "PdfAnnotation"
canonical_url: "https://www.nutrient.io/api/python/editors/pdf/annotations/pdf-annotation/"
md_url: "https://www.nutrient.io/api/python/editors/pdf/annotations/pdf-annotation.md"
last_updated: "2026-06-08T15:25:21.250Z"
description: "Represents a base annotation in a PDF document."
---

Represents a base annotation in a PDF document.

```python

from nutrient_sdk import PdfAnnotation

```

## Construction

`PdfAnnotation` cannot be instantiated directly. Obtain instances through static factory methods or via other SDK classes.

## Properties

### blend_mode

```python

@property
def blend_mode(self) -> str

```

The blend mode of the annotation (e.g., "Normal", "Multiply"). Returns an empty string if no blend mode is explicitly set on the annotation, which indicates the default/unspecified blend mode.

**Type:** `str`

*Read-only property.*

---

### border_effect

```python

@property
def border_effect(self) -> str

```

The border effect style (e.g., "S" for solid/no effect, "C" for cloudy).

**Type:** `str`

*Read-only property.*

---

### border_effect_intensity

```python

@property
def border_effect_intensity(self) -> float

```

The border effect intensity (0 = no effect, higher values = more pronounced).

**Type:** `float`

*Read-only property.*

---

### border_style

```python

@property
def border_style(self) -> PdfBorderStyle

@border_style.setter
def border_style(self, value: PdfBorderStyle) -> None

```

The border style of the annotation.

**Type:** [`PdfBorderStyle`](/api/python/enums/pdf-border-style/)

---

### border_width

```python

@property
def border_width(self) -> float

@border_width.setter
def border_width(self, value: float) -> None

```

The border width of the annotation in points.

**Type:** `float`

---

### color

```python

@property
def color(self) -> Color

@color.setter
def color(self, value: Color) -> None

```

The annotation color.

**Type:** [`Color`](/api/python/types/color/)

---

### contents

```python

@property
def contents(self) -> str

@contents.setter
def contents(self, value: str) -> None

```

The annotation's text contents.

**Type:** `str`

---

### index

```python

@property
def index(self) -> int

```

The 0-based index of this annotation in the page's annotation array.

**Type:** `int`

*Read-only property.*

---

### is_hidden

```python

@property
def is_hidden(self) -> bool

@is_hidden.setter
def is_hidden(self, value: bool) -> None

```

Whether the annotation is hidden.

**Type:** `bool`

---

### is_printable

```python

@property
def is_printable(self) -> bool

@is_printable.setter
def is_printable(self, value: bool) -> None

```

Whether the annotation is printable.

**Type:** `bool`

---

### modification_date

```python

@property
def modification_date(self) -> str

```

The annotation's modification date.

**Type:** `str`

*Read-only property.*

---

### name

```python

@property
def name(self) -> str

```

The annotation's unique name/identifier.

**Type:** `str`

*Read-only property.*

---

### rect

```python

@property
def rect(self) -> Optional[RectF]

@rect.setter
def rect(self, value: Optional[RectF]) -> None

```

The rectangle that defines the location and size of the annotation on the page.

**Type:** `Optional[RectF]`

---

### sub_type

```python

@property
def sub_type(self) -> str

```

The annotation subtype (e.g., "Text", "Link", "Highlight").

**Type:** `str`

*Read-only property.*

---

### title

```python

@property
def title(self) -> str

@title.setter
def title(self, value: str) -> None

```

The annotation's title/author.

**Type:** `str`

---

## Inheritors

- [`PdfLinkAnnotation`](/api/python/editors/pdf/annotations/pdf-link-annotation/)

- [`PdfMarkupAnnotation`](/api/python/editors/pdf/annotations/pdf-markup-annotation/)

- [`PdfWidgetAnnotation`](/api/python/editors/pdf/annotations/pdf-widget-annotation/)

---

## Related pages

- [All public classes import directly from the top-level package:](/api/python/editors/pdf/annotations.md)
- [Pdf Circle Annotation](/api/python/editors/pdf/annotations/pdf-circle-annotation.md)
- [Pdf Line Annotation](/api/python/editors/pdf/annotations/pdf-line-annotation.md)
- [Pdf Annotation Collection](/api/python/editors/pdf/annotations/pdf-annotation-collection.md)
- [Pdf Free Text Annotation](/api/python/editors/pdf/annotations/pdf-free-text-annotation.md)
- [Pdf Link Annotation](/api/python/editors/pdf/annotations/pdf-link-annotation.md)
- [Pdf Highlight Annotation](/api/python/editors/pdf/annotations/pdf-highlight-annotation.md)
- [Pdf Markup Annotation](/api/python/editors/pdf/annotations/pdf-markup-annotation.md)
- [Pdf Redact Annotation](/api/python/editors/pdf/annotations/pdf-redact-annotation.md)
- [Pdf Shape Annotation](/api/python/editors/pdf/annotations/pdf-shape-annotation.md)
- [Pdf Square Annotation](/api/python/editors/pdf/annotations/pdf-square-annotation.md)
- [Pdf Squiggly Annotation](/api/python/editors/pdf/annotations/pdf-squiggly-annotation.md)
- [Pdf Stamp Annotation](/api/python/editors/pdf/annotations/pdf-stamp-annotation.md)
- [Pdf Strike Out Annotation](/api/python/editors/pdf/annotations/pdf-strike-out-annotation.md)
- [Pdf Text Annotation](/api/python/editors/pdf/annotations/pdf-text-annotation.md)
- [Pdf Underline Annotation](/api/python/editors/pdf/annotations/pdf-underline-annotation.md)
- [Pdf Widget Annotation](/api/python/editors/pdf/annotations/pdf-widget-annotation.md)