arviz_plots.backend.plotly.legend

Contents

arviz_plots.backend.plotly.legend#

arviz_plots.backend.plotly.legend(target, kwarg_list, label_list, title=None, artist_type='line', artist_kwargs=None, **kwargs)[source]#

Generate a legend with plotly.

Parameters:
targetplotly.graph_objects.Figure

The figure to add the legend to

kwarg_listlist

List of style dictionaries for each legend entry

label_listlist

List of labels for each legend entry

titlestr, optional

Title of the legend

artist_typestr, optional

Type of visual to use for legend entries. Currently only “line” is supported.

artist_kwargsdict, optional

Additional kwargs passed to all visuals

**kwargsdict

Additional kwargs passed to legend configuration

Returns:
None

The legend is added to the target figure inplace