Class: Scale

Scale

Based on scale control of Leaflet, a simple scale control that shows the scale of the current center of screen in metric (m/km) and imperial (mi/ft) systems.

new control.Scale() [source] 

var scale = new Scale({
    position : 'bottom-left',
    maxWidth : 160,
    metric : true,
    imperial : true,
    containerClass : null
}).addTo(map);
Extends:
Fires:

Members

  • (constant) options

    • Properties:
    Name Type Default Description
    options opt Object null options
    Properties
    Name Type Default Description
    position opt String | Object "bottom-left" position of the scale control.
    maxWidth opt Number 100 max width of the scale control.
    metric opt Boolean true Whether to show the metric scale line (m/km).
    imperial opt Boolean false Whether to show the imperial scale line (mi/ft).
    containerClass opt String | Object null scalControl's container div's CSS class
    Source:

    Methods

  • buildOn(map) [source]

    • method to build DOM of the control
    Parameter Type Description
    map Map map to build on
    Returns:
    HTMLDOMElement:

  • (inherited) addTo(map) [source]

    • Adds the control to a map.
    Parameter Type Description
    map Map
    Inherited From:
    Fires:
    Returns:
    control.Control: this

  • (inherited) update() [source]

    • update control container
    Inherited From:
    Returns:
    control.Control: this

  • (inherited) getMap() [source]

    • Get the map that the control is added to.
    Inherited From:
    Returns:
    Map:

  • (inherited) getPosition() [source]

    • Get the position of the control
    Inherited From:
    Returns:
    Object:

  • (inherited) setPosition(position) [source]

    • update the control's position
    Parameter Type Description
    position String | Object can be one of 'top-left', 'top-right', 'bottom-left', 'bottom-right' or a position object like {'top': 40,'left': 60}
    Inherited From:
    Fires:
    Returns:
    control.Control: this

  • (inherited) getContainerPoint() [source]

    • Get the container point of the control.
    Inherited From:
    Returns:
    Point:

  • (inherited) getContainer() [source]

    • Get the control's container. Container is a div element wrapping the control's dom and decides the control's position and display.
    Inherited From:
    Returns:
    HTMLElement:

  • (inherited) getDOM() [source]

    • Get html dom element of the control
    Inherited From:
    Returns:
    HTMLElement:

  • (inherited) show() [source]

    • Show
    Inherited From:
    Returns:
    control.Control: this

  • (inherited) hide() [source]

    • Hide
    Inherited From:
    Returns:
    control.Control: this

  • (inherited) isVisible() [source]

    • Whether the control is visible
    Inherited From:
    Returns:
    Boolean:

  • (inherited) remove() [source]

    • Remove itself from the map
    Inherited From:
    Fires:
    Returns:
    control.Control: this

  • (inherited) 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:
    Inherited From:
    Returns:
    Any: this

  • (inherited) 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:
    Inherited From:
    Returns:
    : this

  • (inherited) 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:
    Inherited From:
    Returns:
    : this

  • (inherited) 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:
    Inherited From:
    Returns:
    : this

  • (inherited) 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:
    Inherited From:
    Returns:
    : this

  • (inherited) 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:
    Inherited From:
    Returns:
    Number:

  • (inherited) copyEventListeners(target) [source]

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

  • (inherited) 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:
    Inherited 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

  • (inherited) add [source]

    • add event.
    Inherited From:
    Properties:
    Name Type Description
    type String add
    target control.Control the control instance
    Inherited From:
    Source:

  • (inherited) remove [source]

    • remove event.
    Inherited From:
    Properties:
    Name Type Description
    type String remove
    target control.Control the control instance
    Inherited From:
    Source:

  • (inherited) positionchange [source]

    • Control's position update event.
    Inherited From:
    Properties:
    Name Type Description
    type String positionchange
    target control.Control the control instance
    position Object Position of the control, eg:{"top" : 100, "left" : 50}
    Inherited From:
    Source: