CaptionParameters
CaptionParameters class
Module: aspose_barcode.generation.caption_parameters
Caption parameters.
Constructors
| Name | Description |
|---|---|
| init |
Methods
| Name | Return Type | Static | Description |
|---|---|---|---|
| str | str | No | String representation of the CaptionParameters object. |
| font | Optional[FontUnit] | No | Caption font. Default value: Arial 8pt regular. |
Properties
| Name | Type | Description |
|---|---|---|
| alignment | TextAlignment | Caption test horizontal alignment. Default valueAlignment.Center. |
| no_wrap | bool | Specify word wraps (line breaks) within text. |
| padding | Optional[Padding] | Captions paddings. Default value for CaptionAbove: 5pt 5pt 0 5pt. Default value for CaptionBelow: 0 5pt 5pt 5pt. |
| text | Optional[str] | Caption text. Default value: empty string. |
| text_color | Tuple[int, int, int] | Caption text color, representation of an RGB tuple. Default value (0,0,0). |
| visible | bool | Caption text visibility. Default value: false. |
CaptionParameters Constructor
__init__(self, _java_class)
| Parameter | Type | Description |
|---|---|---|
_java_class | `` |
CaptionParameters.str
__str__(self) -> str
String representation of the CaptionParameters object.
Return Type: str
CaptionParameters.font
font(self) -> Optional[FontUnit]
Caption font. Default value: Arial 8pt regular.
Return Type: Optional[FontUnit]
CaptionParameters.alignment
Type: TextAlignment
Caption test horizontal alignment. Default valueAlignment.Center.
Caption test horizontal alignment. Default valueAlignment.Center.
| Parameter | Type | Description |
|---|---|---|
value | TextAlignment |
CaptionParameters.no_wrap
Type: bool
Specify word wraps (line breaks) within text.
Returns: bool
Specify word wraps (line breaks) within text.
| Parameter | Type | Description |
|---|---|---|
value | bool |
CaptionParameters.padding
Type: Optional[Padding]
Captions paddings. Default value for CaptionAbove: 5pt 5pt 0 5pt. Default value for CaptionBelow: 0 5pt 5pt 5pt.
Captions paddings. Default value for CaptionAbove: 5pt 5pt 0 5pt. Default value for CaptionBelow: 0 5pt 5pt 5pt.
| Parameter | Type | Description |
|---|---|---|
value | Padding |
CaptionParameters.text
Type: Optional[str]
Caption text. Default value: empty string.
Caption text. Default value: empty string.
| Parameter | Type | Description |
|---|---|---|
value | str |
CaptionParameters.text_color
Type: Tuple[int, int, int]
Caption text color, representation of an RGB tuple. Default value (0,0,0).
Caption text color, representation of an RGB tuple. Default value (0,0,0).
| Parameter | Type | Description |
|---|---|---|
value | Tuple[int, int, int] |
CaptionParameters.visible
Type: bool
Caption text visibility. Default value: false.
Caption text visibility. Default value: false.
| Parameter | Type | Description |
|---|---|---|
value | bool |