Control options.
A control is a visible widget with a DOM element in a fixed position on the
screen. They can involve user input (buttons), or be informational only;
the position is determined using CSS. By default these are placed in the
container with CSS class name ol-overlaycontainer-stopevent, but can use
any outside DOM element.
This is the base class for controls. You can use it for simple custom controls by creating the element with listeners, creating an instance:
var myControl = new ol.control.Control({element: myElement});
and then adding this to the map.
The main advantage of having this as a control rather than a simple separate
DOM element is that preventing propagation is handled for you. Controls
will also be ol.Objects in a ol.Collection, so you can use their
methods.
You can also extend this base for your own control class. See examples/custom-controls for an example of how to do this.
stable
Listen for a certain type of event.
The event type or array of event types.
The listener function.
Optional opt_this: ObjectThe object to use as this in listener.
Unique key for the listener. If called with an array of event types as the first argument, the return will be an array of keys.
stable
Listen once for a certain type of event.
The event type or array of event types.
The listener function.
Optional opt_this: ObjectThe object to use as this in listener.
Unique key for the listener. If called with an array of event types as the first argument, the return will be an array of keys.
stable
Remove the control from its current map and attach it to the new map. Subclasses may set up event handlers to get notified about changes to the map here.
Map.
stable
Sets a collection of key-value pairs. Note that this changes any existing properties and adds new ones (it does not remove any existing properties).
Values.
Optional opt_silent: booleanUpdate without triggering an event.
stable
This function is used to set a target element for the control. It has no
effect if it is called after the control has been added to the map (i.e.
after setMap is called on the control). If no target is set in the
options passed to the control constructor and if setTarget is not called
then the control is added to the map's overlay container.
Target.
Static unRemoves an event listener using the key returned by on() or once().
Note that using the ol.Observable.unByKey static function is to
be preferred.
stable
Generated using TypeDoc
Classdesc
A control is a visible widget with a DOM element in a fixed position on the screen. They can involve user input (buttons), or be informational only; the position is determined using CSS. By default these are placed in the container with CSS class name
ol-overlaycontainer-stopevent, but can use any outside DOM element.This is the base class for controls. You can use it for simple custom controls by creating the element with listeners, creating an instance:
and then adding this to the map.
The main advantage of having this as a control rather than a simple separate DOM element is that preventing propagation is handled for you. Controls will also be
ol.Objects in aol.Collection, so you can use their methods.You can also extend this base for your own control class. See examples/custom-controls for an example of how to do this.
Param: options
Control options.
Api
stable