Class Zoom

active

autoActivate

displayClass

div

events

handler

map

StaticTYPE_BUTTON

StaticTYPE_TOGGLE

StaticTYPE_TOOL

activate

• activate(): boolean

  APIMethod: activate Explicitly activates a control and it's associated handler if one has been set. Controls can be deactivated by calling the deactivate() method.

  Returns: {Boolean} True if the control was successfully activated or false if the control was already active.

  Returns boolean

deactivate

• deactivate(): boolean

  APIMethod: deactivate Deactivates a control and it's associated handler if any. The exact effect of this depends on the control itself.

  Returns: {Boolean} True if the control was effectively deactivated or false if the control was already inactive.

  Returns boolean

destroy

• destroy(): void

  Method: destroy The destroy method is used to perform any clean up before the control is dereferenced. Typically this is where event listeners are removed to prevent memory leaks.

  Returns void

draw

• draw(px?: null | Pixel): HTMLElement

  Method: draw The draw method is called when the control is ready to be displayed on the page. If a div has not been created one is created. Controls with a visual component will almost always want to override this method to customize the look of control.

  Parameters: px - {<OpenLayers.Pixel>} The top-left pixel position of the control or null.

  Returns: {DOMElement} A reference to the DIV DOMElement containing the control

  Parameters

  • Optionalpx: null | Pixel

  Returns HTMLElement

setMap

• setMap(map: Map): void

  Method: setMap Set the map property for the control. This is done through an accessor so that subclasses can override this and take special action once they have their map variable set.

  Parameters: map - {<OpenLayers.Map>}

  Parameters

  • map: Map

  Returns void