back URL Parameters

Advanced configuration of the image annotation tool.

The image annotation tool provides various configuration options in the settings tab as well as different annotation modes. Most of these features can be controlled via URL parameters, too.

URL parameters are the part of the URL in your browser's address bar after the ?. Example: https://biigle.de?myParameter=myValue.

By using URL parameters, you can send your colleagues a link to an image in the image annotation tool and control how the image annotation tool should behave. This can be useful e.g. if you want to conduct an annotation study and want each participant to have the same configuration of the image annotation tool.

Available parameters

Parameter name Description values
annotationOpacity Opacity of annotations on the image. 0.0 - 1.0
mousePosition Show or hide the mouse position on the image. true, false
zoomLevel Show or hide the current zoom level. true, false
scaleLine Show or hide a scale line on the image. true, false
labelTooltip Show or hide the annotation tooltip when you hover over an annotation. true, false
minimap Show or hide the minimap. true, false
annotationMode Set the annotation mode to activate. volare,
randomSamplingNumber Set the number of samples used in random sampling. integer
regularSamplingRows Set the number of rows used in regular sampling. integer
regularSamplingColumns Set the number of columns used in regular sampling. integer
x Set the x position of the center of the viewport. integer
y Set the y position of the center of the viewport. integer
r Set the resolution (zoom) of the viewport. integer
The x, y and r parameters are automatically updated as you modify the viewport. This allows you to store or send a link to the exact same viewport you are currently seeing.


Show an object with a scale line

You want to show a specific object to a colleague, who is also a BIIGLE user, to discuss the object's size. First, center the viewport on the object. The x, y and r URL parameters will automatically update accordingly. Now append the scaleLine parameter, so the scale line indicator is activated for your colleague. Example URL:


Set a starting point for annotating with Lawnmower Mode

You would like some of your colleagues to annotate images using Lawnmower Mode. For comparability, they should all use the same zoom factor. In addition to that, you want to remove distracting elements from the viewport.

Open the first image in the image annotation tool. Now zoom in to the resolution that you want your colleagues to use. You can also use the zoom to original resolution button, which will set the resolution to 100. Next, append the URL parameters to disable distracting elements like the minimap, the mouse position or the zoom level indicator from the viewport. Finally, add the URL parameter for the Lawnmower annotation mode. Example URL:


Set a base configuration for random sampling

You wish to conduct an annotation study using random sampling. Of course every participant should use the exact same number of random annotation samples per image. To do this, configure the randomSamplingNumber parameter with the number of samples. Then append the parameter for the random sampling annotation mode. Example URL: