arviz_plots.backend.plotly.legend

arviz_plots.backend.plotly.legend(plot_collection, kwarg_list, label_list, title=None, visual_type='line', visual_kwargs=None, legend_dim=None, update_visuals=True, **kwargs)

Generate a legend with plotly.

Parameters:

plot_collectionPlotCollection

The PlotCollection for which a legend should be generated

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

legend_dimstr or tuple of str, optional

update_visualsbool, default True

**kwargsdict

Additional kwargs passed to legend configuration

Returns:

None

The legend is added to the target figure inplace