Text Object Options
text_object_options
get_bold() -> bool
get bold
Returns:
| Type | Description |
|---|---|
bool
|
bool |
get_color() -> int
get color
Returns:
| Type | Description |
|---|---|
int
|
int |
get_draw_on_top() -> bool
get draw on top
Returns:
| Type | Description |
|---|---|
bool
|
bool |
get_element_type() -> text_element_type
get_font_name() -> str
get font name
Returns:
| Type | Description |
|---|---|
str
|
str |
get_height() -> float
get height
Returns:
| Type | Description |
|---|---|
float
|
float |
get_height_relative() -> bool
get height relative
Returns:
| Type | Description |
|---|---|
bool
|
bool |
get_italic() -> bool
get italic
Returns:
| Type | Description |
|---|---|
bool
|
bool |
get_text() -> str
get text
Returns:
| Type | Description |
|---|---|
str
|
str |
get_thickness() -> float
get thickness
Returns:
| Type | Description |
|---|---|
float
|
float |
set_bold(value: bool) -> None
set bold
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
value
|
bool
|
value |
required |
Returns:
| Type | Description |
|---|---|
None
|
None |
set_color(color: int) -> None
set color
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
color
|
int
|
color |
required |
Returns:
| Type | Description |
|---|---|
None
|
None |
set_draw_on_top(value: bool) -> None
set draw on top
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
value
|
bool
|
value |
required |
Returns:
| Type | Description |
|---|---|
None
|
None |
set_element_type(element_type: text_element_type) -> None
set element type
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
element_type
|
text_element_type
|
element_type |
required |
Returns:
| Type | Description |
|---|---|
None
|
None |
set_font_name(font_name: str) -> None
set font name
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
font_name
|
str
|
font_name |
required |
Returns:
| Type | Description |
|---|---|
None
|
None |
set_height(height: float) -> None
set height
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
height
|
float
|
height |
required |
Returns:
| Type | Description |
|---|---|
None
|
None |
set_height_relative(value: bool) -> None
set height relative
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
value
|
bool
|
value |
required |
Returns:
| Type | Description |
|---|---|
None
|
None |
set_italic(value: bool) -> None
set italic
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
value
|
bool
|
value |
required |
Returns:
| Type | Description |
|---|---|
None
|
None |
set_text(text: str) -> None
set text
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
text
|
str
|
text |
required |
Returns:
| Type | Description |
|---|---|
None
|
None |
set_thickness(thickness: float) -> None
set thickness
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
thickness
|
float
|
thickness |
required |
Returns:
| Type | Description |
|---|---|
None
|
None |