nannyml.plots.components.figure module

class nannyml.plots.components.figure.Figure(title: str, x_axis_title: str, y_axis_title: str, y_axis_limit: Optional[List] = None, metric_style: str = 'step', subplot_args: Optional[Dict[str, Any]] = None, **kwargs)[source]

Bases: plotly.graph_objs._figure.Figure

Extending the Plotly Figure class functionality.

Creates a new Figure.

SUPPORTED_METRIC_STYLES = ['step']
add_alert(data: Union[numpy.ndarray, pandas.core.series.Series], name: str, color: str = Colors.RED_IMPERIAL, indices: Optional[Union[numpy.ndarray, pandas.core.series.Series]] = None, start_dates: Optional[Union[numpy.ndarray, pandas.core.series.Series]] = None, end_dates: Optional[Union[numpy.ndarray, pandas.core.series.Series]] = None, subplot_args: Optional[Dict[str, Any]] = None, **kwargs)[source]
add_confidence_band(upper_confidence_boundaries, lower_confidence_boundaries, name, indices=None, start_dates=None, end_dates=None, color=Colors.RED_IMPERIAL, with_additional_endpoint: bool = False, subplot_args: Optional[Dict[str, Any]] = None, **kwargs)[source]
add_metric(data: Union[numpy.ndarray, pandas.core.series.Series], name: str, color: str, indices: Optional[Union[numpy.ndarray, pandas.core.series.Series]] = None, start_dates: Optional[Union[numpy.ndarray, pandas.core.series.Series]] = None, end_dates: Optional[Union[numpy.ndarray, pandas.core.series.Series]] = None, hover: Optional[nannyml.plots.components.hover.Hover] = None, subplot_args: Optional[Dict[str, Any]] = None, **kwargs)[source]
add_period_separator(x, color=Colors.GRAY_DARK, subplot_args: Optional[Dict[str, Any]] = None, **kwargs)[source]
add_threshold(data, name, indices=None, start_dates=None, end_dates=None, color=Colors.RED_IMPERIAL, with_additional_endpoint: bool = False, subplot_args: Optional[Dict[str, Any]] = None, **kwargs)[source]