BarChartRace.get_period_label

BarChartRace.get_period_label(period_label: Union[bool, Dict[str, Union[int, float, str]]]) → Union[bool, Dict[str, Union[int, float, str]]]

Parameters for period annotation on charts, dict will be passed to kwargs in matplotlib.ax.text()

Parameters

period_label (typing.Union[bool,typing.Dict[str,typing.Union[int,float,str]]]) – If True or dict, use the index as the text label

Raises

ValueError – x and y must be supplied as a minimum

Returns

Returns True or dict will be passed to kwargs in matplotlib.ax.text()

Return type

typing.Union[bool,typing.Dict[str,typing.Union[int,float,str]]]