mark_inlaid_asterisk

mark_inlaid_asterisk(x: float | Sequence[float], y: float | Sequence[float], ax: Axes | None = None, *, asterisk_edgewidth: float = 1, color: str = 'black', color_accent: str = 'white', color_asterisk_edge: Tuple | str = ('color', 0.7), color_asterisk_face: Tuple | str = ('color', 0.7), color_badge: Tuple | str = ('color', 0.3), color_underlay: Tuple | str = 'color_accent', marker: Tuple = (6, 2, 0), marker_badge: str = 'o', marker_underlay: str = 'o', linecolor: str = 'none', markersize: float = 22, scale_asterisk: float = 0.3, scale_badge: float = 0.8, **kwargs) → None[source]

Draw asterisk badge marker(s) at specified location(s) on a matplotlib p lot.

This function stacks matplotlib markers to render an asterisk overlaid onto a circular badge with a slightly larger circular underlay.

Parameters:

x (float or sequence of floats) – The x-coordinate(s) where the asterisk badge(s) will be placed.
y (float or sequence of floats) – The y-coordinate(s) where the asterisk badge(s) will be placed.
ax (mpl_axes.Axes, optional) – The axes object on which to draw the markers. If None, plt.gca() will be used.
asterisk_edgewidth (float, default 1) – The edge width of the asterisk marker.
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_asterisk_edge (Union[str, tuple], default ("color", 0.7)) –
The edge color of the asterisk marker.

If “color”, primary color will be substituted.
color_asterisk_face (Union[str, tuple], default ("color", 0.7)) –
The face color of the asterisk marker.

If “color”, primary color will be substituted.
color_badge (Union[str, tuple], default ("color", 0.3)) –
The color of the badge.

If “color”, primary color will be substituted.
color_underlay (Union[str, tuple], default "white") – The color of the underlay.
marker (tuple, default (6, 2, 0)) – The marker style for the asterisk. Default is 6 points, rotated 0 degrees.
marker_badge (str, default "o") – The marker style for the badge.
marker_underlay (str, default "o") – The marker style for the underlay.
linecolor (str, default "none") – The color of the line connecting markers, if any.
markersize (float, default 22) – Size for glyph’s largest marker element.
scale_asterisk (float, default 0.3) – The scaling factor for the asterisk 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