Class OpenSeadragon.Viewer
- Defined in: openseadragon.js
- Extends OpenSeadragon.ControlDock, OpenSeadragon.EventHandler
Constructor Attributes | Constructor Name and Description |
---|---|
OpenSeadragon.Viewer(options)
The main point of entry into creating a zoomable image on the page.
|
Method Summary
Class Detail
OpenSeadragon.Viewer(options)
The main point of entry into creating a zoomable image on the page.
We have provided an idiomatic javascript constructor which takes
a single object, but still support the legacy positional arguments.
The options below are given in order that they appeared in the constructor
as arguments and we translate a positional call into an idiomatic call.
- Parameters:
- {Object} options
- {String} options.element
- Id of Element to attach to,
- {String} options.xmlPath
- Xpath ( TODO: not sure! ),
- {String} options.prefixUrl
- Url used to prepend to paths, eg button images, etc.
- {Seadragon.Controls[]} options.controls
- Array of Seadragon.Controls,
- {Seadragon.Overlays[]} options.overlays
- Array of Seadragon.Overlays,
- {Seadragon.Controls[]} options.overlayControls
- An Array of ( TODO: not sure! )
Method Detail
-
{OpenSeadragon.Viewer} close()
- Returns:
- {OpenSeadragon.Viewer} Chainable.
-
{Boolean} isDashboardEnabled()
- Returns:
- {Boolean}
-
{Boolean} isFullPage()
- Returns:
- {Boolean}
-
- Returns:
- {Boolean}
-
{Boolean} isOpen()
- Returns:
- {Boolean}
-
{Boolean} isVisible()
- Returns:
- {Boolean}
-
{OpenSeadragon.Viewer} open()
- Returns:
- {OpenSeadragon.Viewer} Chainable.
-
{OpenSeadragon.Viewer} openDzi(dzi)If the string is xml is simply parsed and opened, otherwise the string is treated as an URL and an xml document is requested via ajax, parsed and then opened in the viewer.
- Parameters:
- {String} dzi
- and xml string or the url to a DZI xml document.
- Returns:
- {OpenSeadragon.Viewer} Chainable.
-
{OpenSeadragon.Viewer} openTileSource()
- Returns:
- {OpenSeadragon.Viewer} Chainable.
-
{OpenSeadragon.Viewer} setDashboardEnabled()
- Returns:
- {OpenSeadragon.Viewer} Chainable.
-
{OpenSeadragon.Viewer} setFullPage(fullPage)Toggle full page mode.
- Parameters:
- {Boolean} fullPage
- If true, enter full page mode. If false, exit full page mode.
- Returns:
- {OpenSeadragon.Viewer} Chainable.
-
- Returns:
- {OpenSeadragon.Viewer} Chainable.
-
{OpenSeadragon.Viewer} setVisible()
- Returns:
- {OpenSeadragon.Viewer} Chainable.