mirror/openseadragon
1
0
Fork 0
mirror of https://github.com/openseadragon/openseadragon.git synced 2024-11-25 14:46:10 +03:00
Code Issues Projects Releases Wiki Activity

Updating the documentation

Browse Source
This commit is contained in:
houseofyin 2013-06-01 16:09:04 -04:00
parent aca25d1979
commit dc7bc6920c
1 changed files with 12 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
src/control.js
View File

@ -53,17 +53,23 @@ $.ControlAnchor = {
* to interact with the zoomable interface. Any control can be anchored to any * to interact with the zoomable interface. Any control can be anchored to any
* element. * element.
* @class * @class
* @param {Element} element - the contol element to be anchored in the container. * @param {Element} element - the control element to be anchored in the container.
* @param {OpenSeadragon.ControlAnchor} anchor - the location to anchor at. * @param {Object} options - All required and optional settings for configuring a control element
* @param {OpenSeadragon.ControlAnchor} [options.anchor=OpenSeadragon.ControlAnchor.NONE] - the position of the control
* relative to the container.
* @param {Boolean} [options.attachToViewer=true] - Whether the control should be added directly to the viewer, or
* directly to the container
* @param {Boolean} [options.autoFade=true] - Whether the control should have the autofade behavior
* @param {Element} container - the element to control will be anchored too. * @param {Element} container - the element to control will be anchored too.
* *
* @property {Element} element - the element providing the user interface with * @property {Element} element - the element providing the user interface with
* some type of control. Eg a zoom-in button * some type of control. Eg a zoom-in button
* @property {OpenSeadragon.ControlAnchor} anchor - the position of the control * @property {OpenSeadragon.ControlAnchor} anchor - the position of the control
* relative to the container. * relative to the container.
* @property {Element} container - the element within with the control is * @property {Boolean} autoFade - Whether the control should have the autofade behavior
* @property {Element} container - the element within with the control is
* positioned. * positioned.
* @property {Element} wrapper - a nuetral element surrounding the control * @property {Element} wrapper - a neutral element surrounding the control
* element. * element.
*/ */
$.Control = function ( element, options, container ) { $.Control = function ( element, options, container ) {