# region Imports
from __future__ import annotations
from typing import Tuple
from ooo.dyn.awt.font_strikeout import FontStrikeoutEnum
from ooo.dyn.style.case_map import CaseMapEnum
from ooo.dyn.awt.font_relief import FontReliefEnum
from ooodev.format.inner.direct.write.char.font.font_effects import FontEffects as CharFontEffects
from ooodev.format.inner.direct.write.char.font.font_effects import FontLine
from ooodev.utils.color import Color
from ooodev.utils.data_type.intensity import Intensity
# endregion Imports
[docs]class FontEffects(CharFontEffects):
"""
Character Font Effects for a chart data labels.
Any properties starting with ``prop_`` set or get current instance values.
All methods starting with ``fmt_`` can be used to chain together font properties.
Many properties can be chained together.
.. seealso::
- :ref:`help_chart2_format_direct_series_labels_font_effects`
.. versionadded:: 0.9.4
"""
[docs] def __init__(
self,
*,
color: Color | None = None,
transparency: Intensity | int | None = None,
overline: FontLine | None = None,
underline: FontLine | None = None,
strike: FontStrikeoutEnum | None = None,
word_mode: bool | None = None,
case: CaseMapEnum | None = None,
relief: FontReliefEnum | None = None,
outline: bool | None = None,
hidden: bool | None = None,
shadowed: bool | None = None,
) -> None:
"""
Font options used in styles.
Args:
color (:py:data:`~.utils.color.Color`, optional): The value of the text color.
If value is ``-1`` the automatic color is applied.
transparency (Intensity, int, optional): The transparency value from ``0`` to ``100`` for the font color.
overline (FontLine, optional): Character overline values.
underline (FontLine, optional): Character underline values.
strike (FontStrikeoutEnum, optional): Determines the type of the strike out of the character.
word_mode(bool, optional): If ``True``, the underline and strike-through properties are not applied
to white spaces.
case (CaseMapEnum, optional): Specifies the case of the font.
relief (FontReliefEnum, optional): Specifies the relief of the font.
outline (bool, optional): Specifies if the font is outlined.
hidden (bool, optional): Specifies if the font is hidden.
shadowed (bool, optional): Specifies if the characters are formatted and displayed with a shadow effect.
Returns:
None:
See Also:
- :ref:`help_chart2_format_direct_series_labels_font_effects`
"""
super().__init__(
color=color,
transparency=transparency,
overline=overline,
underline=underline,
strike=strike,
word_mode=word_mode,
case=case,
relief=relief,
outline=outline,
hidden=hidden,
shadowed=shadowed,
)
def _supported_services(self) -> Tuple[str, ...]:
try:
return self._supported_services_values
except AttributeError:
self._supported_services_values = ("com.sun.star.chart2.DataSeries", "com.sun.star.chart2.DataPoint")
return self._supported_services_values