gncpy.plotting.set_title_label

set_title_label(fig, ax_num, opts, ttl=None, x_lbl=None, y_lbl=None, z_lbl=None, use_local=False)[source]

Sets the figure/window title, and axis labels with the given options.

Parameters:

  • fig (matplot figure object) – Current figure to edit.

  • ax_num (int) – Index into the axes object to modify.

  • opts (dict) – Standard dictionary from plotting.init_plotting_opts().

  • ttl (string, optional) – Title string to use. This is set to the proper size, family, and style. It also becomes the window title. The default is None.

  • x_lbl (string, optional) – Label for the x-axis. This is set to the proper size, family, and style. The default is None.

  • y_lbl (string, optional) – Label for the y-axis. This is set to the proper size, family, and style. The default is None.

  • z_lbl (string, optional) – Label for the z-axis. This is set to the proper size, family, and style. The default is None.

  • use_local (bool, optional) – Flag indicating if the local title or suptitle should be set. The default is False.

Return type:

None.