Class: MapTool

MapTool

The parent class for all the map tools.
It is abstract and not intended to be instantiated.
Some interface methods to implement:
1. onAdd: optional, a callback method to do some prepares before enabled when the map tool is added to a map
2. onEnable: optional, called when the map tool is enabled, used to setup the context such as adding more event listeners other than the map, disabling map's default handlers (draggable, scrollWheelZoom, etc) and creating temporary layers.
3. getEvents: required, provide an event map to register event listeners on the map.
4. onDisable: optional, called when the map tool is disabled, used to cleanup such as unregistering event listeners, enable map's original handlers and remove temporary layers.

(abstract) new MapTool() [source]

Extends:
Mixes From:
Fires:

Methods

  • addTo(map) [source]

    • Adds the map tool to a map.
    Parameter Type Description
    map Map
    Fires:
    Returns:
    MapTool: this

  • getMap() [source]

    • Gets the map it added to.
    Returns:
    Map: map

  • enable() [source]

    • Enable the map tool.
    Fires:
    Returns:
    MapTool: this

  • disable() [source]

    • Disable the map tool
    Fires:
    Returns:
    MapTool: this

  • isEnabled() [source]

    • Returns whether the tool is enabled
    Returns:
    Boolean: true | false

  • (mixin) on(eventsOn, handler, contextopt) [source]

    • Register a handler function to be called whenever this event is fired. 
    foo.on('mousedown mousemove mouseup', onMouseEvent, foo);
    Parameter Type Default Description
    eventsOn String event types to register, seperated by space if more than one.
    handler function handler function to be called
    context opt Object null the context of the handler
    Mixes From:
    Returns:
    Any: this

  • (mixin) addEventListener(eventTypes, handler, contextopt) [source]

    • Alias for on
    Parameter Type Default Description
    eventTypes String event types to register, seperated by space if more than one.
    handler function handler function to be called
    context opt Object null the context of the handler
    Mixes From:
    Returns:
    : this

  • (mixin) once(eventTypes, handler, contextopt) [source]

    • Same as on, except the listener will only get fired once and then removed. 
    foo.once('mousedown mousemove mouseup', onMouseEvent, foo);
    Parameter Type Default Description
    eventTypes String event types to register, seperated by space if more than one.
    handler function listener handler
    context opt Object null the context of the handler
    Mixes From:
    Returns:
    : this

  • (mixin) off(eventsOff, handler, contextopt) [source]

    • Unregister the event handler for the specified event types. 
    foo.off('mousedown mousemove mouseup', onMouseEvent, foo);
    Parameter Type Default Description
    eventsOff String event types to unregister, seperated by space if more than one.
    handler function listener handler
    context opt Object null the context of the handler
    Mixes From:
    Returns:
    : this

  • (mixin) removeEventListener(eventTypes, handler, contextopt) [source]

    • Alias for off
    Parameter Type Default Description
    eventTypes String event types to unregister, seperated by space if more than one.
    handler function listener handler
    context opt Object null the context of the handler
    Mixes From:
    Returns:
    : this

  • (mixin) listens(eventType, hanlderopt, contextopt) [source]

    • Returns listener's count registered for the event type.
    Parameter Type Default Description
    eventType String an event type
    hanlder opt function null listener function
    context opt Object null the context of the handler
    Mixes From:
    Returns:
    Number:

  • (mixin) getListeningEvents() [source]

    • Get all the listening event types
    Mixes From:
    Returns:
    Array.<String>: events

  • (mixin) copyEventListeners(target) [source]

    • Copy all the event listener to the target object
    Parameter Type Description
    target Object target object to copy to.
    Mixes From:
    Returns:
    : this

  • (mixin) fire(eventType, param) [source]

    • Fire an event, causing all handlers for that event name to run.
    Parameter Type Description
    eventType String an event type to fire
    param Object parameters for the listener function.
    Mixes From:
    Returns:
    : this

  • (inherited) callInitHooks() [source]

    • Visit and call all the init hooks defined on Class and its parents.
    Inherited From:
    Returns:
    Class: this

  • (inherited) setOptions(options) [source]

    • Merges options with the default options of the object.
    Parameter Type Description
    options Object options to set
    Inherited From:
    Returns:
    Class: this

  • (inherited) config(conf) [source]

    • 1. Return object's options if no parameter is provided.
    2. update an option and enable/disable the handler if a handler with the same name existed. 
    // Get marker's options;
var options = marker.config();
// Set map's option "draggable" to false and disable map's draggable handler.
map.config('draggable', false);
// You can update more than one options like this:
map.config({
    'scrollWheelZoom' : false,
    'doubleClickZoom' : false
});
    Parameter Type Description
    conf Object config to update
    Inherited From:
    Returns:
    Class: this

  • (inherited) onConfig() [source]

    • Default callback when config is called
    Inherited From:

    Events

  • add [source]

    • add event.
    Properties:
    Name Type Description
    type String add
    target MapTool map tool
    Source:

  • enable [source]

    • enable event.
    Properties:
    Name Type Description
    type String enable
    target MapTool map tool
    Source:

  • disable [source]

    • disable event.
    Properties:
    Name Type Description
    type String disable
    target MapTool map tool
    Source:

  • remove [source]

    • remove event.
    Properties:
    Name Type Description
    type String remove
    target MapTool map tool
    Source: