Class: DrawerBase

OpenSeadragon.DrawerBase

Base class for Drawers that handle rendering of tiles for an OpenSeadragon.Viewer.
Methods

Constructor

(abstract) new DrawerBase(options)

Parameters:
Name Type Description
options Object Options for this Drawer.
Properties
Name Type Description
viewer OpenSeadragon.Viewer The Viewer that owns this Drawer.
viewport OpenSeadragon.Viewport Reference to Viewer viewport.
element HTMLElement Parent element.
Source:

Methods

(abstract, static) isSupported() → {Boolean}

Source:
Returns:
Whether the drawer implementation is supported by the browser. Must be overridden by extending classes.
Type
Boolean

(abstract) canRotate() → {Boolean}

Source:
Returns:
True if rotation is supported.
Type
Boolean

(abstract) destroy()

Source:

drawDebuggingRect(rect)

Optional public API to draw a rectangle (e.g. for debugging purposes) Child classes can override this method if they wish to support this
Parameters:
Name Type Description
rect OpenSeadragon.Rect
Source:

(abstract) getType() → {String|undefined}

Source:
Returns:
What type of drawer this is. Must be overridden by extending classes.
Type
String | undefined

(abstract) setImageSmoothingEnabled(imageSmoothingEnabledopt)

Parameters:
Name Type Attributes Description
imageSmoothingEnabled Boolean <optional>
 Whether or not the image is drawn smoothly on the canvas; see imageSmoothingEnabled in OpenSeadragon.Options for more explanation.
Source:

viewportCoordToDrawerCoord(point) → {OpenSeadragon.Point}

This function converts the given point from to the drawer coordinate by multiplying it with the pixel density. This function does not take rotation into account, thus assuming provided point is at 0 degree.
Parameters:
Name Type Description
point OpenSeadragon.Point the pixel point to convert
Source:
Returns:
Point in drawer coordinate system.
Type
OpenSeadragon.Point

viewportToDrawerRectangle(rectangle) → {OpenSeadragon.Rect}

Scale from OpenSeadragon viewer rectangle to drawer rectangle (ignoring rotation)
Parameters:
Name Type Description
rectangle OpenSeadragon.Rect The rectangle in viewport coordinate system.
Source:
Returns:
Rectangle in drawer coordinate system.
Type
OpenSeadragon.Rect