com.gwidgets.api.leaflet

Class Map

java.lang.Object

com.gwidgets.api.leaflet.Map

@JsType(isNative=true)
public class Map
extends java.lang.Object

The central class of the API — it is used to create a map on a page and manipulate it.

Author:

Zakaria Amine

Method Summary

Modifier and Type	Method and Description
L	addControl(IControl control) Adds the given control to the map.
L	addLayer(ILayer layer, java.lang.Boolean insertAtTheBottom) Adds the given layer to the map.
L	clearAllEventListeners() Clear all event listeners.
L	closePopup(Popup popup) Closes the popup previously opened with openPopup
LatLng	containerPointToLatLng(Point point) Returns the geographical coordinates of a given map container point.
Point	containerPointToLayerPoint(Point point) Converts the point relative to the map container to a point relative to the map layer.
java.lang.Boolean	eachLayer(Function action, com.google.gwt.core.client.JavaScriptObject context) Iterates over the layers of the map, optionally specifying context of the iterator function.
L	fire(java.lang.String type) Fires an event of the specified type.
L	fitBounds(LatLngBounds bounds, FitBoundsOptions options) Sets a map view that contains the given geographical bounds with the maximum zoom level possible.
L	fitWorld(FitBoundsOptions options) Sets a map view that mostly contains the whole world with the maximum zoom level possible.
LatLngBounds	getBounds() Returns the LatLngBounds of the current map view.
java.lang.Number	getBoundsZoom(LatLngBounds bounds, java.lang.Boolean inside) Returns the maximum zoom level on which the given bounds fit to the map view in its entirety.
LatLng	getCenter() Returns the geographical center of the map view.
HTMLElement	getContainer() Returns the container element of the map.
java.lang.Number	getMaxZoom() Returns the maximum zoom level of the map.
java.lang.Number	getMinZoom() Returns the minimum zoom level of the map.
MapPanes	getPanes() Returns an object with different map panes (to render overlays in).
Bounds	getPixelBounds() Returns the bounds of the current map view in projected pixel coordinates (sometimes useful in layer and overlay implementations).
Point	getPixelOrigin() Returns the projected pixel coordinates of the top left point of the map layer (useful in custom layer and overlay implementations).
Point	getSize() Returns the current size of the map container.
java.lang.Number	getZoom() Returns the current zoom of the map view.
java.lang.Boolean	hasLayer(ILayer layer) Returns true if the given layer is currently added to the map.
L	invalidateSize(java.lang.Boolean options) Checks if the map container size changed and updates the map if so — call it after you've changed the map size dynamically, also animating pan by default.
L	invalidateSize(ZoomPanOptions options2) Checks if the map container size changed and updates the map if so — call it after you've changed the map size dynamically, also animating pan by default.
Point	latLngToContainerPoint(LatLng latlng) Returns the map container point that corresponds to the given geographical coordinates.
Point	latLngToLayerPoint(LatLng latlng) Returns the map layer point that corresponds to the given geographical coordinates (useful for placing overlays on the map).
Point	layerPointToContainerPoint(Point point) Converts the point relative to the map layer to a point relative to the map container.
LatLng	layerPointToLatLng(Point point) Returns the geographical coordinates of a given map layer point.
L	locate(LocateOptions options) Tries to locate the user using the Geolocation API, firing a locationfound event with location data on success or a locationerror event on failure, and optionally sets the map view to the user's location with respect to detection accuracy (or to the world view if geolocation failed).
Point	mouseEventToContainerPoint(MouseEvent event) Returns the pixel coordinates of a mouse click (relative to the top left corner of the map) given its event object.
LatLng	mouseEventToLatLng(MouseEvent event) Returns the geographical coordinates of the point the mouse clicked on given the click's event object.
Point	mouseEventToLayerPoint(MouseEvent event) Returns the pixel coordinates of a mouse click relative to the map layer given its event object.
L	off(java.lang.String type, Function fn) the listener will only get fired once and then removed.
L	on(java.lang.String type, Function fn) Adds a set of type/listener pairs.
L	once(java.lang.String type, Function fn) Once.
L	openPopup(HTMLElement el, LatLng latlng, PopupOptions options) Creates a popup with the specified options and opens it in the given point on a map.
L	openPopup(Popup popup) Opens the specified popup while closing the previously opened (to make sure only one is opened at one time for usability).
L	openPopup(java.lang.String html, LatLng latlng, PopupOptions options) Creates a popup with the specified options and opens it in the given point on a map.
L	panBy(Point point, PanOptions options) Pans the map by a given number of pixels (animated).
L	panInsideBounds(LatLngBounds bounds) Pans the map to the closest view that would lie inside the given bounds (if it's not already), controlling the animation using the options specific, if any.
L	panTo(LatLng latlng, PanOptions options) Pans the map to a given center.
Point	project(LatLng latlng, java.lang.Number zoom) Projects the given geographical coordinates to absolute pixel coordinates for the given zoom level (current zoom level by default).
L	remove() Destroys the map and clears all related event listeners.
L	removeControl(IControl control) Removes the given control from the map.
L	removeLayer(ILayer layer) Removes the given layer from the map.
L	setMaxBounds(LatLngBounds bounds, ZoomPanOptions options) Restricts the map view to the given bounds .
L	setView(LatLng center, java.lang.Number zoom, ZoomPanOptions options) Sets the view of the map (geographical center and zoom) with the given animation options.
L	setZoom(java.lang.Number zoom, ZoomOptions options) Sets the zoom of the map.
L	setZoomAround(LatLng latlng, java.lang.Number zoom, ZoomOptions options) Zooms the map while keeping a specified point on the map stationary (e.g.
L	stopLocate() Stops watching location previously initiated by map.locate({watch: true}) and aborts resetting the map view if map.locate was called with {setView: true}.
LatLng	unproject(Point point, java.lang.Number zoom) Projects the given absolute pixel coordinates to geographical coordinates for the given zoom level (current zoom level by default).
L	whenReady(Function fn, java.lang.Object context) Runs the given callback when the map gets initialized with a place and zoom, or immediately if it happened already, optionally passing a function context.
L	zoomIn(java.lang.Number delta, ZoomOptions options) Increases the zoom of the map by delta (1 by default).
L	zoomOut(java.lang.Number delta, ZoomOptions options) Decreases the zoom of the map by delta (1 by default).

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

setView

@JsMethod
public L setView(LatLng center,
                            java.lang.Number zoom,
                            ZoomPanOptions options)

Sets the view of the map (geographical center and zoom) with the given animation options.

Parameters:

center - the center

zoom - the zoom

options - the map options

Returns:

the L class

setZoom

@JsMethod
public L setZoom(java.lang.Number zoom,
                            ZoomOptions options)

Sets the zoom of the map.

Parameters:

zoom - the zoom

options - the zoom options

Returns:

the L class

zoomIn

@JsMethod
public L zoomIn(java.lang.Number delta,
                           ZoomOptions options)

Increases the zoom of the map by delta (1 by default).

Parameters:

delta - the delta

options - the zoom options

Returns:

the L class

zoomOut

@JsMethod
public L zoomOut(java.lang.Number delta,
                            ZoomOptions options)

Decreases the zoom of the map by delta (1 by default).

Parameters:

delta - the delta

options - the zoom options

Returns:

the L class

setZoomAround

@JsMethod
public L setZoomAround(LatLng latlng,
                                  java.lang.Number zoom,
                                  ZoomOptions options)

Zooms the map while keeping a specified point on the map stationary (e.g. used internally for scroll zoom and double-click zoom).

Parameters:

latlng - the latlng

zoom - the zoom

options - the zoom options

Returns:

the L class

fitBounds

@JsMethod
public L fitBounds(LatLngBounds bounds,
                              FitBoundsOptions options)

Sets a map view that contains the given geographical bounds with the maximum zoom level possible.

Parameters:

bounds - the bounds

options - the options

Returns:

the L class

fitWorld

@JsMethod
public L fitWorld(FitBoundsOptions options)

Sets a map view that mostly contains the whole world with the maximum zoom level possible.

Parameters:

options - the options

Returns:

the L class

panTo

@JsMethod
public L panTo(LatLng latlng,
                          PanOptions options)

Pans the map to a given center. Makes an animated pan if new center is not more than one screen away from the current one.

Parameters:

latlng - the latlng

options - the options

Returns:

the L class

panInsideBounds

@JsMethod
public L panInsideBounds(LatLngBounds bounds)

Pans the map to the closest view that would lie inside the given bounds (if it's not already), controlling the animation using the options specific, if any.

Parameters:

bounds - the bounds

Returns:

the L class

panBy

@JsMethod
public L panBy(Point point,
                          PanOptions options)

Pans the map by a given number of pixels (animated).

Parameters:

point - the point

options - the options

Returns:

the L class

invalidateSize

@JsMethod
public L invalidateSize(java.lang.Boolean options)

Checks if the map container size changed and updates the map if so — call it after you've changed the map size dynamically, also animating pan by default.

Parameters:

options - the options

Returns:

the L class

invalidateSize

@JsMethod
public L invalidateSize(ZoomPanOptions options2)

Checks if the map container size changed and updates the map if so — call it after you've changed the map size dynamically, also animating pan by default. If options.pan is false, panning will not occur. If options.debounceMoveend is true, it will delay moveend event so that it doesn't happen often even if the method is called many times in a row.

Parameters:

options2 - the options 2

Returns:

the L class

setMaxBounds

@JsMethod
public L setMaxBounds(LatLngBounds bounds,
                                 ZoomPanOptions options)

Restricts the map view to the given bounds .

Parameters:

bounds - the bounds

options - the options

Returns:

the L class

locate

@JsMethod
public L locate(LocateOptions options)

Tries to locate the user using the Geolocation API, firing a locationfound event with location data on success or a locationerror event on failure, and optionally sets the map view to the user's location with respect to detection accuracy (or to the world view if geolocation failed).

Parameters:

options - the locateOptions

Returns:

the l

stopLocate

@JsMethod
public L stopLocate()

Stops watching location previously initiated by map.locate({watch: true}) and aborts resetting the map view if map.locate was called with {setView: true}.

Returns:

the L class

remove

@JsMethod
public L remove()

Destroys the map and clears all related event listeners.

Returns:

the L class

getCenter

@JsMethod
public LatLng getCenter()

Returns the geographical center of the map view.

Returns:

the center

getZoom

@JsMethod
public java.lang.Number getZoom()

Returns the current zoom of the map view.

Returns:

the zoom

getMinZoom

@JsMethod
public java.lang.Number getMinZoom()

Returns the minimum zoom level of the map.

Returns:

the min zoom

getMaxZoom

@JsMethod
public java.lang.Number getMaxZoom()

Returns the maximum zoom level of the map.

Returns:

the max zoom

getBounds

@JsMethod
public LatLngBounds getBounds()

Returns the LatLngBounds of the current map view.

Returns:

the bounds

getBoundsZoom

@JsMethod
public java.lang.Number getBoundsZoom(LatLngBounds bounds,
                                                 java.lang.Boolean inside)

Returns the maximum zoom level on which the given bounds fit to the map view in its entirety. If inside (optional) is set to true, the method instead returns the minimum zoom level on which the map view fits into the given bounds in its entirety.

Parameters:

bounds - the bounds

inside - the inside

Returns:

the bounds zoom

getSize

@JsMethod
public Point getSize()

Returns the current size of the map container.

Returns:

the size

getPixelBounds

@JsMethod
public Bounds getPixelBounds()

Returns the bounds of the current map view in projected pixel coordinates (sometimes useful in layer and overlay implementations).

Returns:

the pixel bounds

getPixelOrigin

@JsMethod
public Point getPixelOrigin()

Returns the projected pixel coordinates of the top left point of the map layer (useful in custom layer and overlay implementations).

Returns:

the pixel origin

addLayer

@JsMethod
public L addLayer(ILayer layer,
                             java.lang.Boolean insertAtTheBottom)

Adds the given layer to the map.

Parameters:

layer - the layer

insertAtTheBottom - the insert at the bottom flag

Returns:

the L class

removeLayer

@JsMethod
public L removeLayer(ILayer layer)

Removes the given layer from the map.

Parameters:

layer - the layer

Returns:

the L class

hasLayer

@JsMethod
public java.lang.Boolean hasLayer(ILayer layer)

Returns true if the given layer is currently added to the map.

Parameters:

layer - the layer

Returns:

true/false

eachLayer

@JsMethod
public java.lang.Boolean eachLayer(Function action,
                                              com.google.gwt.core.client.JavaScriptObject context)

Iterates over the layers of the map, optionally specifying context of the iterator function.

Parameters:

action - the action function

context - the context

Returns:

true/false

openPopup

@JsMethod
public L openPopup(Popup popup)

Opens the specified popup while closing the previously opened (to make sure only one is opened at one time for usability).

Parameters:

popup - the popup

Returns:

the L class

openPopup

@JsMethod
public L openPopup(java.lang.String html,
                              LatLng latlng,
                              PopupOptions options)

Creates a popup with the specified options and opens it in the given point on a map.

Parameters:

html - the html

latlng - the latlng

options - the options

Returns:

the L class

openPopup

@JsMethod
public L openPopup(HTMLElement el,
                              LatLng latlng,
                              PopupOptions options)

Creates a popup with the specified options and opens it in the given point on a map.

Parameters:

el - the el

latlng - the latlng

options - the options

Returns:

the L class

closePopup

@JsMethod
public L closePopup(Popup popup)

Closes the popup previously opened with openPopup

Parameters:

popup - the popup

Returns:

the L class

addControl

@JsMethod
public L addControl(IControl control)

Adds the given control to the map.

Parameters:

control - the control

Returns:

the L class

removeControl

@JsMethod
public L removeControl(IControl control)

Removes the given control from the map.

Parameters:

control - the control

Returns:

the L class

latLngToLayerPoint

@JsMethod
public Point latLngToLayerPoint(LatLng latlng)

Returns the map layer point that corresponds to the given geographical coordinates (useful for placing overlays on the map).

Parameters:

latlng - the latlng

Returns:

the point

layerPointToLatLng

@JsMethod
public LatLng layerPointToLatLng(Point point)

Returns the geographical coordinates of a given map layer point.

Parameters:

point - the point

Returns:

the lat lng

containerPointToLayerPoint

@JsMethod
public Point containerPointToLayerPoint(Point point)

Converts the point relative to the map container to a point relative to the map layer.

Parameters:

point - the point

Returns:

the point

layerPointToContainerPoint

@JsMethod
public Point layerPointToContainerPoint(Point point)

Converts the point relative to the map layer to a point relative to the map container.

Parameters:

point - the point

Returns:

the point

latLngToContainerPoint

@JsMethod
public Point latLngToContainerPoint(LatLng latlng)

Returns the map container point that corresponds to the given geographical coordinates.

Parameters:

latlng - the latlng

Returns:

the point

containerPointToLatLng

@JsMethod
public LatLng containerPointToLatLng(Point point)

Returns the geographical coordinates of a given map container point.

Parameters:

point - the point

Returns:

the lat lng

project

@JsMethod
public Point project(LatLng latlng,
                                java.lang.Number zoom)

Projects the given geographical coordinates to absolute pixel coordinates for the given zoom level (current zoom level by default).

Parameters:

latlng - the latlng

zoom - the zoom

Returns:

the point

unproject

@JsMethod
public LatLng unproject(Point point,
                                   java.lang.Number zoom)

Projects the given absolute pixel coordinates to geographical coordinates for the given zoom level (current zoom level by default).

Parameters:

point - the point

zoom - the zoom

Returns:

the lat lng

mouseEventToContainerPoint

@JsMethod
public Point mouseEventToContainerPoint(MouseEvent event)

Returns the pixel coordinates of a mouse click (relative to the top left corner of the map) given its event object.

Parameters:

event - the event

Returns:

the point

mouseEventToLayerPoint

@JsMethod
public Point mouseEventToLayerPoint(MouseEvent event)

Returns the pixel coordinates of a mouse click relative to the map layer given its event object.

Parameters:

event - the event

Returns:

the point

mouseEventToLatLng

@JsMethod
public LatLng mouseEventToLatLng(MouseEvent event)

Returns the geographical coordinates of the point the mouse clicked on given the click's event object.

Parameters:

event - the event

Returns:

the lat lng

getContainer

@JsMethod
public HTMLElement getContainer()

Returns the container element of the map.

Returns:

the container

getPanes

@JsMethod
public MapPanes getPanes()

Returns an object with different map panes (to render overlays in).

Returns:

the panes

whenReady

@JsMethod
public L whenReady(Function fn,
                              java.lang.Object context)

Runs the given callback when the map gets initialized with a place and zoom, or immediately if it happened already, optionally passing a function context.

Parameters:

fn - the callback

context - the context

Returns:

the L class

clearAllEventListeners

@JsMethod
public L clearAllEventListeners()

Clear all event listeners.

Returns:

the L class

on

@JsMethod
public L on(java.lang.String type,
                       Function fn)

Adds a set of type/listener pairs.

Parameters:

type - the type

fn - the callback function

Returns:

the L class

once

@JsMethod
public L once(java.lang.String type,
                         Function fn)

Once.

Parameters:

type - the type

fn - the callback function

Returns:

the L class

off

@JsMethod
public L off(java.lang.String type,
                        Function fn)

the listener will only get fired once and then removed.

Parameters:

type - the type

fn - the callback function

Returns:

the L class

fire

@JsMethod
public L fire(java.lang.String type)

Fires an event of the specified type. You can optionally provide an data object — the first argument of the listener function will contain its properties.

Parameters:

type - the type

Returns:

the L class