atomica.plotting.reorder_legend

atomica.plotting.reorder_legend(figs, order=None)[source]

Change the order of an existing legend

Parameters
  • figs – Figure, or list of figures, containing legends for which the order should be changed

  • order

    Specification of the order in which to render the legend entries. This can be - The string ‘reverse’ which will reverse the order of the legend - A list of indices mapping old position to new position. For example, if the

    original label order was [‘a,’b’,’c’], then order=[1,0,2] would result in [‘b’,’a’,’c’]. If a partial list is provided, then only a subset of the legend entries will appear. This allows this function to be used to remove legend entries as well.

Return type

None