nonapi
Differences
This shows you the differences between two versions of the page.
| Both sides previous revision Previous revision Next revision | Previous revision | ||
|
nonapi [2022/09/06 17:54] antreas |
nonapi [2023/01/13 13:00] (current) yves [Barcode] |
||
|---|---|---|---|
| Line 23: | Line 23: | ||
| |contrast|//Optional// contrast value to apply as post processing| | |contrast|//Optional// contrast value to apply as post processing| | ||
| **Returns** A file stream that contains the rendered region | **Returns** A file stream that contains the rendered region | ||
| + | |||
| + | **Example** ///tile?sessionId=%%sessionId%%&pathOrUid=%%path%%&timeframe=0&layer=0&channels=0&channelClipping=0,0&gamma=1&x=0&y=0&z=0// | ||
| ==== Region ==== | ==== Region ==== | ||
| Line 44: | Line 46: | ||
| |format|//Optional// parameter representing the resulting image format. Valid values are JPG, JPEG and PNG| | |format|//Optional// parameter representing the resulting image format. Valid values are JPG, JPEG and PNG| | ||
| |quality|//Optional// quality parameter used only for the jpeg format| | |quality|//Optional// quality parameter used only for the jpeg format| | ||
| - | |annotationsLayerType|A comma separated list of extra annotations layer to render| | + | |annotationsLayerType|//Optional// A comma separated list of extra annotations layer to render| |
| - | |rotation|Rotation angle in degrees| | + | |rotation|//Optional// Rotation angle in degrees| |
| - | |flipHorizontal|Whether to flip region horizontally| | + | |flipHorizontal|//Optional// Whether to flip region horizontally| |
| - | |flipVertical|Whether to flip the region vertically| | + | |flipVertical|//Optional// Whether to flip the region vertically| |
| |dpi|//Optional// dpi to resolution for the exported image| | |dpi|//Optional// dpi to resolution for the exported image| | ||
| |postGamma|//Optional// gamma value to apply as post processing| | |postGamma|//Optional// gamma value to apply as post processing| | ||
| Line 53: | Line 55: | ||
| |contrast|//Optional// contrast value to apply as post processing| | |contrast|//Optional// contrast value to apply as post processing| | ||
| **Returns** A file stream that contains the rendered region | **Returns** A file stream that contains the rendered region | ||
| + | |||
| + | **Example** ///region?sessionId=%%sessionId%%&pathOrUid=%%path%%&timeframe=0&layer=0&channels=0&channelClipping=0,0&gamma=1&x=0&y=0&width=1000&height=1000// | ||
| ==== Thumbnail ==== | ==== Thumbnail ==== | ||
| Line 63: | Line 67: | ||
| |h|//Optional// Expected output height of the thumbnail| | |h|//Optional// Expected output height of the thumbnail| | ||
| **Returns** An image | **Returns** An image | ||
| + | |||
| + | |||
| + | **Example** ///thumbnail?sessionId=%%sessionId%%&pathOrUid=%%path%%// | ||
| ==== Macro ==== | ==== Macro ==== | ||
| Line 74: | Line 81: | ||
| |h|//Optional// Expected output height of the macro| | |h|//Optional// Expected output height of the macro| | ||
| **Returns** An image | **Returns** An image | ||
| + | |||
| + | **Example** ///macro?sessionId=%%sessionId%%&pathOrUid=%%path%%// | ||
| ==== Barcode ==== | ==== Barcode ==== | ||
| - | **/barcode** Renders the associated barcode of a slide | + | **/barcode** Renders the associated [[barcode|barcode]] of a slide |
| ^Parameter ^Description^ | ^Parameter ^Description^ | ||
| |**sessionID**|The session id to authenticate with| | |**sessionID**|The session id to authenticate with| | ||
| Line 84: | Line 93: | ||
| |h|//Optional// Expected output height of the barcode| | |h|//Optional// Expected output height of the barcode| | ||
| **Returns** An image | **Returns** An image | ||
| + | |||
| + | **Example** ///barcode?sessionId=%%sessionId%%&pathOrUid=%%path%%// | ||
nonapi.1662476069.txt.gz · Last modified: 2022/09/06 17:54 by antreas
