Skip to content

Commit

Permalink
Add missing show_overlaps option to plots.xml input file documentation (
Browse files Browse the repository at this point in the history
  • Loading branch information
johvincau authored Jul 3, 2024
1 parent 391450c commit 653d883
Showing 1 changed file with 12 additions and 0 deletions.
12 changes: 12 additions & 0 deletions docs/source/io_formats/plots.rst
Original file line number Diff line number Diff line change
Expand Up @@ -151,6 +151,18 @@ attributes or sub-elements. These are not used in "voxel" plots:

*Default*: 255 255 255 (white)

:show_overlaps:
Indicates whether overlapping regions of different cells are shown.

*Default*: None

:overlap_color:
Specifies the RGB color of overlapping regions of different cells. Does not
do anything if ``show_overlaps`` is "false" or not specified. Should be 3
integers separated by spaces.

*Default*: 255 0 0 (red)

:meshlines:
The ``meshlines`` sub-element allows for plotting the boundaries of a
regular mesh on top of a plot. Only one ``meshlines`` element is allowed per
Expand Down

0 comments on commit 653d883

Please sign in to comment.