TextAttribute¶
Qualified name: manimpango.attributes.TextAttribute
- class TextAttribute(start_index=0, end_index=-1, *, allow_breaks=None, background_alpha=None, background_color=None, foreground_alpha=None, foreground_color=None, fallback=None, family=None, weight=None, line_height=None)¶
TextAttribute
defines the properties/attributes of the text within a specific range of the text.A
TextAttribute
object can define multiple properties at the same time, for example, it can change thebackground_color
, as well as,foreground_color
. Also, aTextAttribute
can be used for multiple times for different texts. By default, an attribute has an inclusive range from0
to the end of the text-1
, ie.[0, -1]
.Initialize
TextAttribute
.- Parameters
start_index (int, optional) – The start index of the range, by default 0 (start of the string).
end_index (int, optional) – End index of the range. The character at this index is not included in the range, by default -1 (end of the string).
allow_breaks (bool | None) –
background_alpha (float | None) –
foreground_alpha (float | None) –
fallback (bool | None) –
family (str | None) –
weight (Weight | None) –
line_height (float | None) –
Methods
- property allow_breaks: Optional[bool]¶
Whether to break text or not.
If breaks are disabled, the range will be kept in a single run, as far as possible.
- property background_alpha: Optional[float]¶
The background_alpha of the text.
- Raises
ValueError – If the value is not between 0 and 1.
- property background_color: Optional[Tuple[int]]¶
The background color of the region.
If the input is a
str
the value is considered as string representation of color from CSS Specification. The color is then parsed andValueError
is raised if the color is invalid.If the input is a
collections.abc.Iterable
then the items in them are parsed in the order ofred, green, blue
and checked whether they are valid (between 0 and 65535).Returns either
None
or atuple
with 3 elements representing red, green, blue respectively. The value of each items in that tuple ranges from 0 to 65535.- Raises
ValueError – If the value passed isn’t a
collections.abc.Iterable
of 3 elements or a string. Another condition when ValueError is raised is when the color passed is invalid.
- property end_index: int¶
It is the start of the range. The character at this index is not included in the range.
- Raises
ValueError – If the value is not an
int
.
- property fallback: bool¶
Enable or disable fallbacks.
If fallback is disabled, characters will only be used from the closest matching font on the system. No fallback will be done to other fonts on the system that might contain the characters in the text.
- property family: Optional[str]¶
The font family the text should render. Can be a comma seperated list of fonts in a string.
- Raises
ValueError – If value isn’t a str.
- property foreground_alpha: Optional[float]¶
The foreground_alpha of the text.
- Raises
ValueError – If the value is not between 0 and 1.
- property foreground_color: Optional[Tuple[int]]¶
The foreground color attribute.
If the input is a
str
the value is considered as string representation of color from CSS Specification. The color is then parsed andValueError
is raised if the color is invalid.If the input is a
collections.abc.Iterable
then the items in them are parsed in the order ofred, green, blue
and checked whether they are valid (between 0 and 65535).Returns either
None
or atuple
with 3 elements representing red, green, blue respectively. The value of each items in that tuple ranges from 0 to 65535.- Raises
ValueError – If the value passed isn’t a
collections.abc.Iterable
of 3 elements or a string. Another condition when ValueError is raised is when the color passed is invalid.
- property line_height: Optional[float]¶
The line height of the text.
- Raises
ValueError – If value isn’t a float.
- property start_index: int¶
It is the end index of the range.
- Raises
ValueError – If the value is not an
int
.
- property weight: Optional[Weight]¶
The font weight of the text.
- Raises
ValueError – If value isn’t a str.