Fix enums doc.

This commit is contained in:
Antoine Vandecreme 2016-04-10 19:01:30 -04:00
parent 55e0811294
commit 4bf7b62939
2 changed files with 7 additions and 2 deletions

View File

@ -42,6 +42,7 @@
* @member OverlayPlacement * @member OverlayPlacement
* @memberof OpenSeadragon * @memberof OpenSeadragon
* @static * @static
* @readonly
* @type {Object} * @type {Object}
* @property {Number} CENTER * @property {Number} CENTER
* @property {Number} TOP_LEFT * @property {Number} TOP_LEFT
@ -57,8 +58,10 @@
/** /**
* An enumeration of possible ways to handle overlays rotation * An enumeration of possible ways to handle overlays rotation
* @member OverlayRotationMode
* @memberOf OpenSeadragon * @memberOf OpenSeadragon
* @static * @static
* @readonly
* @property {Number} NO_ROTATION The overlay ignore the viewport rotation. * @property {Number} NO_ROTATION The overlay ignore the viewport rotation.
* @property {Number} EXACT The overlay use CSS 3 transforms to rotate with * @property {Number} EXACT The overlay use CSS 3 transforms to rotate with
* the viewport. If the overlay contains text, it will get rotated as well. * the viewport. If the overlay contains text, it will get rotated as well.
@ -66,11 +69,11 @@
* taking the size of the bounding box of the rotated bounds. * taking the size of the bounding box of the rotated bounds.
* Only valid for overlays with Rect location and scalable in both directions. * Only valid for overlays with Rect location and scalable in both directions.
*/ */
$.OverlayRotationMode = { $.OverlayRotationMode = $.freezeObject({
NO_ROTATION: 1, NO_ROTATION: 1,
EXACT: 2, EXACT: 2,
BOUNDING_BOX: 3 BOUNDING_BOX: 3
}; });
/** /**
* @class Overlay * @class Overlay

View File

@ -35,8 +35,10 @@
/** /**
* An enumeration of positions to anchor an element. * An enumeration of positions to anchor an element.
* @member Placement
* @memberOf OpenSeadragon * @memberOf OpenSeadragon
* @static * @static
* @readonly
* @property {OpenSeadragon.Placement} CENTER * @property {OpenSeadragon.Placement} CENTER
* @property {OpenSeadragon.Placement} TOP_LEFT * @property {OpenSeadragon.Placement} TOP_LEFT
* @property {OpenSeadragon.Placement} TOP * @property {OpenSeadragon.Placement} TOP