com.gwidgets.api.leaflet

Class L

java.lang.Object

com.gwidgets.api.leaflet.L

@JsType(isNative=true,
        namespace="<global>")
public class L
extends java.lang.Object

The Master class of leaflet. All leaflet classes should be created through this class. This class transcribes factory methods from the Javascript version. It powers the OOP facilities of Leaflet.

Author:

Zakaria Amine

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	L.control The Class control.
static class	L.CRS The Class CRS.
static class	L.Projection
static class	L.tileLayer Used to load and display tile layers on the map.
static class	L.Transformation The Class Transformation.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	version A constant that represents the Leaflet version in use.

Method Summary

Modifier and Type	Method and Description
static Bounds	bounds(Point topLeft, Point bottomRight) Represents a rectangular area in pixel coordinates.
static Canvas	canvas(RendererOptions options) Creates a SVG renderer with the given options.
static Circle	circle(LatLng latlng, CircleOptions options) A class for drawing circle overlays on a map.
static CircleMarker	circleMarker(LatLng latlng, CircleOptions options) A circle of a fixed size with radius specified in pixels.
static Control	control(ControlOptions options) The base class for all Leaflet controls.
static DivIcon	divIcon(DivIconOptions options) Represents a lightweight icon for markers that uses a simple div element instead of an image.
static FeatureGroup	featureGroup(Layer[] layers) Extended layerGroup that also has mouse events (propagated from members of the group) and a shared bindPopup method.
static GeoJSON	geoJSON(com.google.gwt.core.client.JavaScriptObject geojson, GeoJSONOptions options) Represents a GeoJSON object or an array of GeoJSON objects.
static GridLayer	gridLayer(GridLayerOptions options) Creates a new instance of GridLayer with the supplied options.
static Icon	icon(IconOptions options) Represents an icon to provide when creating a marker.
static ImageOverlay	imageOverlay(java.lang.String imageUrl, LatLngBounds bounds, ImageOverlayOptions options) Used to load and display a single image over specific bounds of the map, implements ILayer interface.
static LatLng	latLng(double latitude, double longitude) Represents a geographical point with a certain latitude and longitude.
static LatLngBounds	latLngBounds(LatLng southWest, LatLng northEast) Represents a rectangular geographical area on a map.
static LayerGroup	layerGroup(Layer[] layers) Used to group several layers and handle them as one.
static Map	map(HTMLElement element, MapOptions options) The central class of the API — it is used to create a map on a page and manipulate it.
static Map	map(java.lang.String id, MapOptions options) The central class of the API — it is used to create a map on a page and manipulate it.
static Marker	marker(LatLng latlng, MarkerOptions options) Marker is used to put markers on the map.
static Point	point(double x, double y, java.lang.Boolean round) Represents a point with x and y coordinates in pixels.
static Polygon	polygon(LatLng[][] latlngs, PolylineOptions options) A class for drawing polygon overlays on a map.
static Polyline	polyline(LatLng[][] latlngs, PolylineOptions options) A class for drawing polyline overlays on a map.
static Popup	popup(PopupOptions options, Layer source) Used to open popups in certain places of the map.
static Rectangle	rectangle(LatLngBounds bounds, PathOptions options) A class for drawing rectangle overlays on a map.
static SVG	svg(RendererOptions options) Creates a SVG renderer with the given options.
static TileLayer	tileLayer(java.lang.String urlTemplate, TileLayerOptions options) Used to load and display tile layers on the map, implements ILayer interface.
static Tooltip	tooltip(TooltipOptions options, Layer source) Instantiates a Tooltip object given an optional options object that describes its appearance and location and an optional source object that is used to tag the tooltip with a reference to the Layer to which it refers.
static L.Transformation	transformation(double a, double b, double c, double d) Represents an affine transformation: a set of coefficients a, b, c, d for transforming a point of a form (x, y) into (a*x + b, c*y + d) and doing the reverse.

Methods inherited from class java.lang.Object

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

Field Detail

version

@JsProperty
public static java.lang.String version

A constant that represents the Leaflet version in use.

Method Detail

map

public static Map map(java.lang.String id,
                      MapOptions options)

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

Parameters:

id - the id of the element

options - map options

Returns:

a new Map object

map

public static Map map(HTMLElement element,
                      MapOptions options)

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

Parameters:

element - the element

options - map options

Returns:

a new Map object

marker

public static Marker marker(LatLng latlng,
                            MarkerOptions options)

Marker is used to put markers on the map.

Parameters:

latlng - the geographical points

options - the marker options

Returns:

a new Marker object

popup

public static Popup popup(PopupOptions options,
                          Layer source)

Used to open popups in certain places of the map. Use openPopup() of the map object to open popups while making sure that only one popup is open at one time (recommended for usability), or use addLayer() to open as many as you want.

Parameters:

options - the pop up options

source - the popup source Layer

Returns:

a new Popup object

tileLayer

public static TileLayer tileLayer(java.lang.String urlTemplate,
                                  TileLayerOptions options)

Used to load and display tile layers on the map, implements ILayer interface.

Parameters:

urlTemplate - the url template

options - the options

Returns:

a new TileLayer object

imageOverlay

public static ImageOverlay imageOverlay(java.lang.String imageUrl,
                                        LatLngBounds bounds,
                                        ImageOverlayOptions options)

Used to load and display a single image over specific bounds of the map, implements ILayer interface.

Parameters:

imageUrl - the image url

bounds - the bounds

options - the ImageOverlay options

Returns:

a new ImageOverlay object

polyline

public static Polyline polyline(LatLng[][] latlngs,
                                PolylineOptions options)

A class for drawing polyline overlays on a map. Extends Path. Use Map.addLayer() to add it to the map.

Parameters:

latlngs - the latlngs array

options - the Polyline options

Returns:

a new Polyline object

polygon

public static Polygon polygon(LatLng[][] latlngs,
                              PolylineOptions options)

A class for drawing polygon overlays on a map. Extends Polyline. Use Map.addLayer() to add it to the map. Note that points you pass when creating a polygon shouldn't have an additional last point equal to the first one — it's better to filter out such points.

Parameters:

latlngs - the latlngs array

options - the Polygon options

Returns:

a new MultiPolyline object

rectangle

public static Rectangle rectangle(LatLngBounds bounds,
                                  PathOptions options)

A class for drawing rectangle overlays on a map. Extends Polygon. Use addLayer() method of the Map object to add it to the map.

Parameters:

bounds - the bounds of the rectangle

options - Rectangle the options

Returns:

a new MultiPolygon object

circle

public static Circle circle(LatLng latlng,
                            CircleOptions options)

A class for drawing circle overlays on a map. Extends Path. Use addLayer() method of the Map object to add it to the map.

Parameters:

latlng - the latlng of the circle on the map

options - the Circle options

Returns:

a new Circle object

circleMarker

public static CircleMarker circleMarker(LatLng latlng,
                                        CircleOptions options)

A circle of a fixed size with radius specified in pixels. Extends Circle. Use addLayer() method of the Map object to add it to the map.

Parameters:

latlng - the latlng

options - the CircleMarker options

Returns:

a new CircleMarker object

layerGroup

public static LayerGroup layerGroup(Layer[] layers)

Used to group several layers and handle them as one. If you add it to the map, any layers added or removed from the group will be added/removed on the map as well. Implements ILayer interface.

Parameters:

layers - the layers array

Returns:

a new LayerGroup object

featureGroup

public static FeatureGroup featureGroup(Layer[] layers)

Extended layerGroup that also has mouse events (propagated from members of the group) and a shared bindPopup method. Implements ILayer interface.

Parameters:

layers - the layers

Returns:

a new FeatureGroup object

geoJSON

public static GeoJSON geoJSON(com.google.gwt.core.client.JavaScriptObject geojson,
                              GeoJSONOptions options)

Represents a GeoJSON object or an array of GeoJSON objects. Allows you to parse GeoJSON data and display it on the map. Extends FeatureGroup.

Parameters:

geojson - the geojson object in GeoJSON format to display on the map (you can alternatively add it later with addData method) and an options object.

options - the GeoJSON options

Returns:

a new GeoJSON object

latLng

public static LatLng latLng(double latitude,
                            double longitude)

Represents a geographical point with a certain latitude and longitude.

Parameters:

latitude - the Latitude in degrees.

longitude - Longitude in degrees.

Returns:

a new LatLng object

latLngBounds

public static LatLngBounds latLngBounds(LatLng southWest,
                                        LatLng northEast)

Represents a rectangular geographical area on a map.

Parameters:

southWest - the south west point

northEast - the north east point

Returns:

a new LatLngBounds object

point

public static Point point(double x,
                          double y,
                          java.lang.Boolean round)

Represents a point with x and y coordinates in pixels.

Parameters:

x - the x coordinate

y - the y coordinate

round - the round

Returns:

a new Point object

bounds

public static Bounds bounds(Point topLeft,
                            Point bottomRight)

Represents a rectangular area in pixel coordinates.

Parameters:

topLeft - The top left corner of the rectangle.

bottomRight - The bottom right corner of the rectangle.

Returns:

a new Bounds object

icon

public static Icon icon(IconOptions options)

Represents an icon to provide when creating a marker.

Parameters:

options - the Icon options

Returns:

a new Icon object

divIcon

public static DivIcon divIcon(DivIconOptions options)

Represents a lightweight icon for markers that uses a simple div element instead of an image.

Parameters:

options - the DivIcon options

Returns:

a new DivIcon object

control

public static Control control(ControlOptions options)

The base class for all Leaflet controls. Implements IControl interface. You can add controls to the map like this:

 control.addTo(map);
       // or
  map.addControl(control);

Parameters:

options - the Control options

Returns:

a new Control object

transformation

public static L.Transformation transformation(double a,
                                              double b,
                                              double c,
                                              double d)

Represents an affine transformation: a set of coefficients a, b, c, d for transforming a point of a form (x, y) into (a*x + b, c*y + d) and doing the reverse. Used by Leaflet in its projections code.

Parameters:

a - the a

b - the b

c - the c

d - the d

Returns:

a new Transformation object

tooltip

public static Tooltip tooltip(TooltipOptions options,
                              Layer source)

Instantiates a Tooltip object given an optional options object that describes its appearance and location and an optional source object that is used to tag the tooltip with a reference to the Layer to which it refers.

Parameters:

options - the tooltip options

source - the source layer

Returns:

the tooltip object

canvas

public static Canvas canvas(RendererOptions options)

Creates a SVG renderer with the given options.

Parameters:

options - the canvas options

Returns:

the canvas object

svg

public static SVG svg(RendererOptions options)

Creates a SVG renderer with the given options.

Parameters:

options - the canvas options

Returns:

the svg object

gridLayer

public static GridLayer gridLayer(GridLayerOptions options)

Creates a new instance of GridLayer with the supplied options.

Parameters:

options - the options

Returns:

the grid layer