Skip to content

Clarify na_color docstring for groups= filtering behavior #639

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
timtreis wants to merge 1 commit into from
+15 −12
Closed

Clarify na_color docstring for groups= filtering behavior #639

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
27 changes: 15 additions & 12 deletions src/spatialdata_plot/pl/basic.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -226,10 +226,11 @@ def render_shapes(
Palette for discrete annotations. Can be a dictionary mapping category names to colors, a list of valid
color names (must match the number of groups), a single named palette or matplotlib colormap name, or
``None``. If element is None, broadcasting behaviour is attempted (use the same values for all elements).
na_color : ColorLike | None, default "default" (gets set to "lightgray")
Color to be used for NA values, if present. Can either be a named color ("red"), a hex representation
("#000000ff") or a list of floats that represent RGB/RGBA values (1.0, 0.0, 0.0, 1.0). When None, the values
won't be shown.
na_color : ColorLike | None, optional
Color for NA values and, when ``groups`` is set, for non-matching elements. When omitted, non-matching
elements are hidden. Pass any explicit color (e.g. ``"lightgray"``) to show them in that color instead.
Accepts a named color (``"red"``), a hex string (``"#000000ff"``), or an RGB/RGBA list
(``[1.0, 0.0, 0.0, 1.0]``). Pass ``None`` to make NA values fully transparent.
outline_width : float | int | tuple[float | int, float | int], optional
Width of the border. If 2 values are given (tuple), 2 borders are shown with these widths (outer & inner).
If `outline_color` and/or `outline_alpha` are used to indicate that one/two outlines should be drawn, the
Expand Down Expand Up @@ -419,10 +420,11 @@ def render_points(
color names (must match the number of groups), a single named palette or matplotlib colormap name, or
``None``. If `element` is `None`, broadcasting behaviour is attempted (use the same values for all
elements).
na_color : ColorLike | None, default "default" (gets set to "lightgray")
Color to be used for NA values, if present. Can either be a named color ("red"), a hex representation
("#000000ff") or a list of floats that represent RGB/RGBA values (1.0, 0.0, 0.0, 1.0). When None, the values
won't be shown.
na_color : ColorLike | None, optional
Color for NA values and, when ``groups`` is set, for non-matching points. When omitted, non-matching
points are hidden. Pass any explicit color (e.g. ``"lightgray"``) to show them in that color instead.
Accepts a named color (``"red"``), a hex string (``"#000000ff"``), or an RGB/RGBA list
(``[1.0, 0.0, 0.0, 1.0]``). Pass ``None`` to make NA values fully transparent.
cmap : Colormap | str | None, optional
Colormap for continuous annotations using 'color', see :class:`matplotlib.colors.Colormap`. If
no palette is given and `color` refers to a categorical, the colors are sampled from this colormap.
Expand Down Expand Up @@ -765,10 +767,11 @@ def render_labels(
For categorical data, use ``palette`` instead.
norm : Normalize | None, optional
Colormap normalization for continuous annotations, see :class:`matplotlib.colors.Normalize`.
na_color : ColorLike | None, default "default" (gets set to "lightgray")
Color to be used for NAs values, if present. Can either be a named color ("red"), a hex representation
("#000000ff") or a list of floats that represent RGB/RGBA values (1.0, 0.0, 0.0, 1.0). When None, the values
won't be shown.
na_color : ColorLike | None, optional
Color for NA values and, when ``groups`` is set, for non-matching labels. When omitted, non-matching
labels are hidden. Pass any explicit color (e.g. ``"lightgray"``) to show them in that color instead.
Accepts a named color (``"red"``), a hex string (``"#000000ff"``), or an RGB/RGBA list
(``[1.0, 0.0, 0.0, 1.0]``). Pass ``None`` to make NA values fully transparent.
outline_alpha : float | int, default 0.0
Alpha value for the outline of the labels. Invisible by default.
fill_alpha : float | int | None, optional
Expand Down
Loading