com.gwidgets.api.leaflet

Class Layers

java.lang.Object

com.gwidgets.api.leaflet.Control

com.gwidgets.api.leaflet.Layers

All Implemented Interfaces:

IControl

@JsType(isNative=true)
public class Layers
extends Control

The layers control gives users the ability to switch between different base layers and switch overlays on/off

Author:

Zakaria Amine

Method Summary

Modifier and Type	Method and Description
L	addBaseLayer(ILayer layer, java.lang.String name) Adds a base layer (radio button entry) with the given name to the control.
L	addOverlay(ILayer layer, java.lang.String name) Adds an overlay (checkbox entry) with the given name to the control.
static L	clearAllEventListeners() Clear all event listeners.
static L	fire(java.lang.String type) Fires an event of the specified type.
static L	off(java.lang.String type, Function fn) the listener will only get fired once and then removed.
static L	on(java.lang.String type, Function fn) Adds a set of type/listener pairs
static L	once(java.lang.String type, Function fn) Once.
L	removeLayer(ILayer layer) Remove the given layer from the control.

Methods inherited from class com.gwidgets.api.leaflet.Control

addTo, getContainer, getPosition, onAdd, onRemove, removeFrom, setPosition

Methods inherited from class java.lang.Object

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

Method Detail

addBaseLayer

@JsMethod
public L addBaseLayer(ILayer layer,
                                 java.lang.String name)

Adds a base layer (radio button entry) with the given name to the control.

Parameters:

layer - the layer

name - the name

Returns:

the l

addOverlay

@JsMethod
public L addOverlay(ILayer layer,
                               java.lang.String name)

Adds an overlay (checkbox entry) with the given name to the control.

Parameters:

layer - the layer

name - the name

Returns:

the l

removeLayer

@JsMethod
public L removeLayer(ILayer layer)

Remove the given layer from the control.

Parameters:

layer - the layer

Returns:

the l

clearAllEventListeners

@JsMethod
public static L clearAllEventListeners()

Clear all event listeners.

Returns:

the L class

on

@JsMethod
public static 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 static L once(java.lang.String type,
                                Function fn)

Once.

Parameters:

type - the type

fn - the callback function

Returns:

the L class

off

@JsMethod
public static 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 static 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