format_sub_plot_number_upper_case_letter

format_sub_plot_number_upper_case_letter(sub_plot_number: int, size: int | None = None) → str[source]

Format sub_plot_number into an upper case letter, that can be used as label.

Parameters:

sub_plot_number (int) – Number of the subplot starting at One.
size (None | int) – Size of the axes array (number of plots). Defaults to None

Returns:

Upper case label for a sub plot.

Return type:

str

Examples

>>> print(format_sub_plot_number_upper_case_letter(1))
A

>>> print(format_sub_plot_number_upper_case_letter(26))
Z

>>> print(format_sub_plot_number_upper_case_letter(27))
AA

>>> print(format_sub_plot_number_upper_case_letter(1, 26))
AA

>>> print(format_sub_plot_number_upper_case_letter(2, 26))
AB

>>> print(format_sub_plot_number_upper_case_letter(26, 26))
AZ

>>> print(format_sub_plot_number_upper_case_letter(27, 50))
BA