Skip to content

Commit 914a60e

Browse files
author
Sonja Stockhaus
committed
dpi & figsize documentation update
1 parent 7fc7488 commit 914a60e

File tree

1 file changed

+11
-4
lines changed

1 file changed

+11
-4
lines changed

src/spatialdata_plot/pl/basic.py

Lines changed: 11 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -525,15 +525,22 @@ def show(
525525
526526
Parameters
527527
----------
528+
coordinate_systems :
529+
Name(s) of the coordinate system(s) to be plotted. If None, all coordinate systems are plotted.
530+
If a coordinate system doesn't contain any relevant elements (as specified in the render_* calls),
531+
it is automatically not plotted.
532+
figsize :
533+
Size of the figure (width, height) in inches. The size of the actual canvas may deviate from this,
534+
depending on the dpi! In matplotlib, the actual figure size (in pixels) is dpi * figsize.
535+
If None, the default of matlotlib is used (6.4, 4.8)
536+
dpi :
537+
Resolution of the plot in dots per inch (as in matplotlib).
538+
If None, the default of matplotlib is used (100.0).
528539
ax :
529540
Matplotlib axes object to plot on. If None, a new figure is created.
530541
Works only if there is one image in the SpatialData object.
531542
ncols :
532543
Number of columns in the figure. Default is 4.
533-
width :
534-
Width of each subplot. Default is 4.
535-
height :
536-
Height of each subplot. Default is 3.
537544
538545
Returns
539546
-------

0 commit comments

Comments
 (0)