Skip to content

Commit

Permalink
Merge pull request #1733 from girder/update-doc
Browse files Browse the repository at this point in the history
Update some documentation
  • Loading branch information
manthey authored Dec 3, 2024
2 parents 226d15e + 6a5d992 commit 5872fdd
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion girder_annotation/docs/plottable.rst
Original file line number Diff line number Diff line change
Expand Up @@ -66,7 +66,7 @@ For instance, each of the following has two separate keys with plottable data (s
| | } |
+---------------------------+----------------------------------------------+

For plottable data in the ``meta`` key of a folder, (a) if the name of the most nested key matches the Python regular expression ``r'(?i)(item|image)_(id|name)$'``, then the value of that key will attempt to be resolved to the name or Girder _id of a item within the folder. This will only match items that are included (the ``adjacentItems`` flag affects the results). If a matching item is found, the item's canonical ``name`` and ``_id`` are used rather than the specified value. (b) if the name of the key matches the Python regular expression ``r'(?i)(low|min|high|max)(_|)(x|y)'``, the value is assumed to be a coordinate of an image bounding box. This can be used by clients to show a portion of the image associated with the plottable record.
For plottable data in the ``meta`` key of a folder, (a) if the name of the most nested key matches the Python regular expression ``r'(?i)(item|image)_(id|name)$'``, then the value of that key will attempt to be resolved to the name or Girder _id of a item within the folder. This will only match items that are included (the ``adjacentItems`` flag affects the results). If a matching item is found, the item's canonical ``name`` and ``_id`` are used rather than the specified value. (b) if the name of the key matches the Python regular expression ``r'(?i)((low|min|high|max)(_|)(x|y)|(^(x|y)(1|2)$))'``, the value is assumed to be a coordinate of an image bounding box. This can be used by clients to show a portion of the image associated with the plottable record.

After plottable data is gathered, columns of available data are summarized. Each column contains:

Expand Down

0 comments on commit 5872fdd

Please sign in to comment.