Demonstrating get_linespecs()

plot_utils.linespecs_demo(line_specs, horizontal_plot=False)[source]

Demonstrate line specifications generated by :func:~`get_linespecs()`.

Parameter

line_speclist<dict>

A list of line specifications. It can be the returned value of get_linespecs().

horizontal_plotbool

Whether or not to demonstrate the line specifications in a horizontal plot.

returns:
  • fig (matplotlib.figure.Figure) – The figure object being created or being passed into this function.

  • ax (matplotlib.axes._subplots.AxesSubplot) – The axes object being created or being passed into this function.