Source code for highcharts_core.options.legend.title

from typing import Optional

from validator_collection import validators

from highcharts_core import constants
from highcharts_core.metaclasses import HighchartsMeta


[docs]class LegendTitle(HighchartsMeta): """A title to be added on top of the legend.""" def __init__(self, **kwargs): self._style = None self._text = None self.style = kwargs.get('style', None) self.text = kwargs.get('text', None) @property def style(self) -> Optional[str]: """CSS styling to apply to the title. Defaults to ``'{constants.DEFAULT_LEGEND.get('title', {}).get('style')}'``. :rtype: :class:`str` or :obj:`None <python:None>` """ return self._style @style.setter def style(self, value): self._style = validators.string(value, allow_empty = True, coerce_value = True) @property def text(self) -> Optional[str]: """A text or HTML string for the tite. :rtype: :class:`str <python:str>` or :obj:`None <python:None>` """ return self._text @text.setter def text(self, value): self._text = validators.string(value, allow_empty = True) @classmethod def _get_kwargs_from_dict(cls, as_dict): kwargs = { 'style': as_dict.get('style', None), 'text': as_dict.get('text', None) } return kwargs def _to_untrimmed_dict(self, in_cls = None) -> dict: untrimmed = { 'style': self.style, 'text': self.text } return untrimmed