Skip to content
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

Update some documentation #1733

Merged
merged 1 commit into from
Dec 3, 2024
Merged

Update some documentation #1733

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
2 changes: 1 addition & 1 deletion girder_annotation/docs/plottable.rst
View file
Open in desktop
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
Loading