Note

This is the documentation for the current state of the development branch of Qiskit Experiments. The documentation or APIs here can change prior to being released.

BaseDrawer.filled_y_area¶

abstract BaseDrawer.filled_y_area(x_data, y_ub, y_lb, name=None, label=None, legend=False, **options)[source]¶

Draw filled area as a function of x-values.

Parameters:

x_data (Sequence[float]) – X values.
y_ub (Sequence[float]) – The upper boundary of Y values.
y_lb (Sequence[float]) – The lower boundary of Y values.
name (Union[str, int, float, None]) – Name of this series.
label (Optional[str]) – Optional legend label to override name and series_params.
legend (bool) – Whether the drawn area must have a legend entry. Defaults to False. The series label in the legend will be label if it is not None. If it is, then series_params is searched for a "label" entry for the series identified by name. If this is also None, then name is used as the fallback. If no name is provided, then no legend entry is generated.
options – Valid options for the drawer backend API.