MarkAlphabeticalBadges

class MarkAlphabeticalBadges[source]

Functor to mark sequentially-lettered badges.

This class renders markers as letters overlaid onto a circular badge with a slightly larger circular underlay.

__init__(start: str = 'a', step: int = 1, **kwargs) → None[source]

Initialize functor.

Parameters:

  • start (str, default "a") –

    The starting number for the alphabetical badges.

    Pass “A” for uppercase letters.

  • step (int, default 1) – The step size for the alphabetical badges.

  • kwargs (dict) – Additional kwargs forward to __call__.

Methods

__init__(start: str = 'a', step: int = 1, **kwargs) → None[source]

Initialize functor.

Parameters:

  • start (str, default "a") –

    The starting number for the alphabetical badges.

    Pass “A” for uppercase letters.

  • step (int, default 1) – The step size for the alphabetical badges.

  • kwargs (dict) – Additional kwargs forward to __call__.

__call__(x: float, y: float, ax: Axes | None = None, *, color: str = 'black', color_accent: str | None = None, color_letter: Tuple | str = 'color_accent', color_badge: Tuple | str = 'color', color_underlay: Tuple | str = 'color_accent', letter_edgewidth: float = 1, marker_badge: str = 'o', marker_underlay: str = 'o', markersize: float = 22, scale_letter: float = 0.4, scale_badge: float = 0.8, **kwargs) → None[source]

Draw lettered badge marker at specified location.

Alphabetical values increment with each call to this functor.

Parameters:

  • x (float) – The x-coordinate where the alphabetical badge will be placed.

  • y (float) – The y-coordinate where the alphabetical badge will be placed.

  • ax (mpl_axes.Axes, optional) – The axes object on which to draw the marker. If None, plt.gca() will be used.

  • color (str, default "black") – The primary color for the glyph.

  • color_accent (Optional[str], optional) –

    The default accent color for the glyph.

    If color is “white”, defaults “black”. Otherwise, defaults “white”.

  • color_letter (Union[str, tuple], default "white") – The color of the letter.

  • color_badge (Union[str, tuple], default "color") –

    The color of the badge.

    If “color”, primary color will be substituted.

  • color_underlay (Union[str, tuple], default "color_accent") –

    The color of the underlay.

    If “color_accent”, accent color will be substituted.

  • letter_edgewidth (float, default 1) – The edge width of the letter marker.

  • marker_badge (str, default "o") – The marker style for the badge.

  • marker_underlay (str, default "o") – The marker style for the underlay.

  • markersize (float, default 22) – Size for glyph’s largest marker element.

  • scale_letter (float, default 0.4) – The scaling factor for the letter size.

  • scale_badge (float, default 0.8) – The scaling factor for the badge size.

  • **kwargs (dict, optional) – Additional keyword arguments forward to matplotlib plot.

Return type:

None