DocumentStyle Class
An object representing observed text styles.
New in version 2023-07-31: The similar_font_family, font_style, font_weight, color, and background_color properties.
Constructor
DocumentStyle(**kwargs: Any)Methods
| from_dict |
Converts a dict in the shape of a DocumentStyle to the model itself. |
| to_dict |
Returns a dict representation of DocumentStyle. |
from_dict
Converts a dict in the shape of a DocumentStyle to the model itself.
from_dict(data: Dict) -> DocumentStyleParameters
| Name | Description |
|---|---|
|
data
Required
|
A dictionary in the shape of DocumentStyle. |
Returns
| Type | Description |
|---|---|
|
DocumentStyle |
to_dict
Returns a dict representation of DocumentStyle.
to_dict() -> DictReturns
| Type | Description |
|---|---|
|
dict |
Attributes
background_color
Background color in #rrggbb hexadecimal format.
background_color: str | Nonecolor
Foreground color in #rrggbb hexadecimal format.
color: str | Noneconfidence
Confidence of correctly identifying the style.
confidence: floatfont_style
"normal", "italic".
font_style: str | Nonefont_weight
"normal", "bold".
font_weight: str | Noneis_handwritten
Indicates if the content is handwritten.
is_handwritten: bool | Nonesimilar_font_family
Visually most similar font from among the set of supported font families, with fallback fonts following CSS convention (ex. 'Arial, sans-serif').
similar_font_family: str | Nonespans
Location of the text elements in the concatenated content the style applies to.
spans: List[DocumentSpan]