Skip to content

Reject legend_loc='on data' loudly in pl.show() #649

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

Merged
timtreis merged 2 commits into from
May 8, 2026
+3 −6
Merged

Reject legend_loc='on data' loudly in pl.show() #649

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
f8c41a9
Reject legend_loc='on data' loudly in pl.show()
timtreis May 8, 2026
e9d9972
Shorten legend_loc='on data' error message
timtreis May 8, 2026
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
3 changes: 3 additions & 0 deletions src/spatialdata_plot/pl/basic.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1147,6 +1147,9 @@ def show(
legend_fontoutline = legend_params.get("fontoutline", legend_fontoutline)
na_in_legend = legend_params.get("na_in_legend", na_in_legend)

if legend_loc == "on data":
raise ValueError("legend_loc='on data' is not supported in spatialdata-plot.")

legend_params_obj = LegendParams(
legend_fontsize=legend_fontsize,
legend_fontweight=legend_fontweight,
Expand Down
6 changes: 0 additions & 6 deletions src/spatialdata_plot/pl/render.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1153,12 +1153,6 @@ def _draw_channel_legend(
palette_dict[entry.channel_name] = entry.color_hex

legend_loc = legend_params.legend_loc
if legend_loc == "on data":
logger.warning(
"legend_loc='on data' is not supported for channel legends (no scatter coordinates); "
"falling back to 'right margin'."
)
legend_loc = "right margin"

categories = pd.Categorical(list(palette_dict))

Expand Down
Loading