Represents a circle (ellipse) annotation.

from nutrient import PdfCircleAnnotation

Methods

set_border_style

def set_border_style(self, value: PdfBorderStyle) -> None

Parameters:

NameTypeDescription
valuePdfBorderStyle

set_border_width

def set_border_width(self, value: float) -> None

Parameters:

NameTypeDescription
valuefloat

set_color

def set_color(self, value: Color) -> None

Parameters:

NameTypeDescription
valueColor

set_contents

def set_contents(self, value: str) -> None

Parameters:

NameTypeDescription
valuestr

set_interior_color

def set_interior_color(self, value: Color) -> None

Parameters:

NameTypeDescription
valueColor

set_is_hidden

def set_is_hidden(self, value: bool) -> None

Parameters:

NameTypeDescription
valuebool

set_is_printable

def set_is_printable(self, value: bool) -> None

Parameters:

NameTypeDescription
valuebool

set_opacity

def set_opacity(self, value: float) -> None

Parameters:

NameTypeDescription
valuefloat

set_rect

def set_rect(self, value: Any) -> None

Parameters:

NameTypeDescription
valueAny

set_subject

def set_subject(self, value: str) -> None

Parameters:

NameTypeDescription
valuestr

set_title

def set_title(self, value: str) -> None

Parameters:

NameTypeDescription
valuestr

Properties

border_style

@property
def border_style(self) -> PdfBorderStyle

Type: PdfBorderStyle

Read-only property.


border_width

@property
def border_width(self) -> float

Type: float

Read-only property.


color

@property
def color(self) -> Color

Type: Color

Read-only property.


contents

@property
def contents(self) -> str

Type: str

Read-only property.


creation_date

@property
def creation_date(self) -> str

Type: str

Read-only property.


index

@property
def index(self) -> int

Type: int

Read-only property.


interior_color

@property
def interior_color(self) -> Color

Type: Color

Read-only property.


is_hidden

@property
def is_hidden(self) -> bool

Type: bool

Read-only property.


is_printable

@property
def is_printable(self) -> bool

Type: bool

Read-only property.


modification_date

@property
def modification_date(self) -> str

Type: str

Read-only property.


name

@property
def name(self) -> str

Type: str

Read-only property.


opacity

@property
def opacity(self) -> float

Type: float

Read-only property.


rect

@property
def rect(self) -> Any

Type: Any

Read-only property.


rich_text_contents

@property
def rich_text_contents(self) -> str

Type: str

Read-only property.


subject

@property
def subject(self) -> str

Type: str

Read-only property.


sub_type

@property
def sub_type(self) -> str

Type: str

Read-only property.


title

@property
def title(self) -> str

Type: str

Read-only property.