mirror/openseadragon
1
0
Fork 0
mirror of https://github.com/openseadragon/openseadragon.git synced 2025-01-19 17:21:50 +03:00
Code Issues Projects Releases Wiki Activity

Fix mistakes in doc.

Browse Source
This commit is contained in:
Antoine Vandecreme 2014-03-18 13:05:21 -04:00
parent 71618a39f7
commit 2473c809b2
1 changed files with 4 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
src/openseadragon.js
View File

@ -137,10 +137,10 @@
* {@link OpenSeadragon.LegacyTileSource}. * {@link OpenSeadragon.LegacyTileSource}.
* *
* @property {Array} overlays Array of objects defining permanent overlays of * @property {Array} overlays Array of objects defining permanent overlays of
* the viewer. The overlays added via this options and later removed with * the viewer. The overlays added via this option and later removed with
* {@link OpenSeadragon.Viewer#removeOverlay} will be added back when a new * {@link OpenSeadragon.Viewer#removeOverlay} will be added back when a new
* image is opened. * image is opened.
* To add overlays which can be definitly removed, one must use * To add overlays which can be definitively removed, one must use
* {@link OpenSeadragon.Viewer#addOverlay} * {@link OpenSeadragon.Viewer#addOverlay}
* If displaying a sequence of images, the overlays can be associated * If displaying a sequence of images, the overlays can be associated
* with a specific page by passing the overlays array to the page's * with a specific page by passing the overlays array to the page's
@ -149,13 +149,13 @@
* * x, y, (or px, py for pixel coordinates) to define the location. * * x, y, (or px, py for pixel coordinates) to define the location.
* * width, height in point if using x,y or in pixels if using px,py. If width * * width, height in point if using x,y or in pixels if using px,py. If width
* and height are specified, the overlay size is adjusted when zooming, * and height are specified, the overlay size is adjusted when zooming,
* otherwise the size stay the size of the content (or the size defined by CSS). * otherwise the size stays the size of the content (or the size defined by CSS).
* * className to associate a class to the overlay * * className to associate a class to the overlay
* * id to set the overlay element. If an element with this id already exists, * * id to set the overlay element. If an element with this id already exists,
* it is reused, otherwise it is created. If not specified, a new element is * it is reused, otherwise it is created. If not specified, a new element is
* created. * created.
* * placement a string to define the relative position to the viewport. * * placement a string to define the relative position to the viewport.
* Only used if no width and height are specified. Default: TOP_LEFT. * Only used if no width and height are specified. Default: 'TOP_LEFT'.
* See {@link OpenSeadragon.OverlayPlacement} for possible values. * See {@link OpenSeadragon.OverlayPlacement} for possible values.
* *
* @property {String} [xmlPath=null] * @property {String} [xmlPath=null]