Global

Methods

xOpatParseConfiguration(postData, i18n, supportsPost) → {*|Object}

Client-side parsing of the viewer session configuration
Parameters:
Name Type Description
postData object post data available to the viewer if any
i18n i18next translation context
supportsPost whether the server implementation supports post data
Source:
Returns:
Type
* | Object

Type Definitions

Type:
Object
Source:

ScaleBarConfig

Type:
object
Properties:
Name Type Description
viewer OpenSeadragon.Viewer The viewer to attach this Scalebar to.
type OpenSeadragon.ScalebarType The scale bar type. Default: microscopy
pixelsPerMeter Number | undefined The pixels per meter of the zoomable image at the original image size. If null, the scale bar is not displayed. default: null
pixelsPerMeterX Number | undefined The measurement in vertical units, need to specify both X, Y if general not given
pixelsPerMeterY Number | undefined The measurement in horizontal units, need to specify both X, Y if general not given
magnification Number | undefined The maximum magnification availeble in the image (e.g. 20 for 20x or 40 for 40x magnification)
(String} minWidth The minimal width of the scale bar as a CSS string (ex: 100px, 1em, 1% etc...) default: 150px
location OpenSeadragon.ScalebarLocation The location of the scale bar inside the viewer. default: bottom left
xOffset Integer Offset location of the scale bar along x. default: 5
yOffset Integer Offset location of the scale bar along y. default: 5
stayInsideImage Boolean When set to true, keep the scale bar inside the image when zooming out. default: true
color String The color of the scale bar using a color name or the hexadecimal format (ex: black or #000000) default: black
fontColor String The font color. default: black
backgroundColor String The background color. default: none
fontSize String The font size. default: not set
fontFamily String The font-family. default: not set
barThickness String The thickness of the scale bar in px. default: 2
sizeAndTextRenderer function A function which will be
destroy boolean
Author:
Source:

xoClientSetup

The Client App static configuration
Type:
Object
Source:

xoEnv

xOpat Static configuration: 'ENV'
Source:

xoServerConfig

The Server configuration. This object is here just for the reference and to provide default values; the server shall set up these properties accordingly.
Type:
Object
Source: