MarkRomanBadges

class MarkRomanBadges

Functor to mark roman numeral badges numbered by itertools-like count.

This class renders markers as roman numerals overlaid onto a circular badge with a slightly larger circular underlay. Both lower and uppercase numerals are supported.

Notes

Due to unicode limitations values greater than twelve will not display correctly. Numeral representation for zero is not supported.

__init__(start: int = 1, step: int = 1, *, upper: bool = False, **kwargs) → None

Initialize functor.

Parameters:

• start (int, default 1) –

  The starting number for the numerical badges.

  Must be between 1 and 12, inclusive.

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

• upper (bool, default False) – Should numerals be uppercase?

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

Methods

Attributes

ftor

__init__(start: int = 1, step: int = 1, *, upper: bool = False, **kwargs) → None

Initialize functor.

Parameters:

• start (int, default 1) –

  The starting number for the numerical badges.

  Must be between 1 and 12, inclusive.

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

• upper (bool, default False) – Should numerals be uppercase?

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

ftor = <outset.mark._MarkAlphabeticalBadges.MarkAlphabeticalBadges object>

__call__(x: float, y: float, ax: Axes | None = None, *, color: str = 'black', color_accent: str | None = None, color_numeral: Tuple | str = 'color_accent', color_badge: Tuple | str = 'color', color_underlay: Tuple | str = 'color_accent', marker_badge: str = 'o', marker_underlay: str = 'o', markersize: float = 22, numeral_edgewidth: float = 0, scale_numeral: float = 0.4, scale_badge: float = 0.8, **kwargs) → None

Draw roman numeral badge marker at specified location.

Numeral values increment with each call to this functor.

Parameters:

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

• y (float) – The y-coordinate where the numerical 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_numeral (Union[str, tuple], default "white") – The color of the numeral.

• 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.

• 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.

• numeral_edgewidth (float, default 1) – The edge width of the numeral marker.

• scale_numeral (float, default 0.4) – The scaling factor for the numeral 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