Class OpenSeadragon.Control
- Defined in: openseadragon.js
| Constructor Attributes | Constructor Name and Description |
|---|---|
|
OpenSeadragon.Control(element, anchor, container)
A Control represents any interface element which is meant to allow the user
to interact with the zoomable interface.
|
Method Summary
Class Detail
OpenSeadragon.Control(element, anchor, container)
A Control represents any interface element which is meant to allow the user
to interact with the zoomable interface. Any control can be anchored to any
element.
- Parameters:
- {Element} element
- - the contol element to be anchored in the container.
- {OpenSeadragon.ControlAnchor} anchor
- - the location to anchor at.
- {Element} container
- - the element to control will be anchored too.
Field Detail
{OpenSeadragon.ControlAnchor}
anchor
- the position of the control
relative to the container.
{Element}
container
- the element within with the control is
positioned.
{Element}
element
- the element providing the user interface with
some type of control. Eg a zoom-in button
{Element}
wrapper
- a nuetral element surrounding the control
element.
Method Detail
-
destroy()Removes the control from the container.
-
{Boolean} isVisible()Determines if the control is currently visible.
- Returns:
- {Boolean} true if currenly visible, false otherwise.
-
setOpacity(opactiy)Sets the opacity level for the control.
- Parameters:
- {Number} opactiy
- - a value between 1 and 0 inclusively.
-
setVisible(visible)Toggles the visibility of the control.
- Parameters:
- {Boolean} visible
- - true to make visible, false to hide.