From 6a5d9928d636330bd5d5b325e035538e4e8aabd7 Mon Sep 17 00:00:00 2001 From: David Manthey Date: Tue, 3 Dec 2024 08:21:28 -0500 Subject: [PATCH] Update some documentation --- girder_annotation/docs/plottable.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/girder_annotation/docs/plottable.rst b/girder_annotation/docs/plottable.rst index 891e066eb..bcd68f66f 100644 --- a/girder_annotation/docs/plottable.rst +++ b/girder_annotation/docs/plottable.rst @@ -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: