Layer

All Known Implementing Classes:

Canvas, Circle, CircleMarker, DivIcon, FeatureGroup, GeoJSON, GridLayer, Icon, ImageOverlay, LayerGroup, Marker, Polygon, Polyline, Popup, Rectangle, Renderer, SVG, TileLayer, Tooltip, WMS
```
@JsType(isNative=true)
public interface Layer
```
Represents an object attached to a particular location (or a set of locations) on a map. Implemented by tile layers, markers, popups, image overlays, vector layers and layer groups.

Author:

Zakaria Amine

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`L`	`addTo(Map map)` Adds the tooltip to the given map
`L`	`bindPopup(HTMLElement content, PopupOptions options)` Binds a popup to the layer with the passed content and sets up the neccessary event listeners.
`L`	`bindPopup(java.lang.String id, PopupOptions options)` Binds a popup to the layer with the passed content and sets up the neccessary event listeners.
`L`	`bindTooltip(HTMLElement content, TooltipOptions options)` Binds a tooltip to the layer with the passed *content and sets up the neccessary event listeners.
`L`	`bindTooltip(java.lang.String content, TooltipOptions options)` Binds a tooltip to the layer with the passed *content and sets up the neccessary event listeners.
`L`	`bindTooltip(Tooltip content, TooltipOptions options)` Binds a tooltip to the layer with the passed content and sets up the neccessary event listeners.
`L`	`closePopup()` Closes the popup bound to this layer if it is open.
`L`	`closeTooltip()` Closes the tooltip bound to this layer if it is open.
`HTMLElement`	`getPane(java.lang.String name)` Returns the HTMLElement representing the named pane on the map.
`Popup`	`getPopup()` Returns the popup bound to this layer.
`Tooltip`	`getTooltip()` Returns the tooltip bound to this layer.
`boolean`	`isPopupOpen()` Returns true if the popup bound to this layer is currently open.
`boolean`	`isTooltipOpen()` Returns true if the tooltip bound to this layer is currently open.
`L`	`openPopup(LatLng latlng)` Opens the bound popup at the specificed latlng or at the default popup anchor if no latlng is passed.
`L`	`openTooltip(LatLng latlng)` Opens the bound tooltip at the specificed latlng or at the default tooltip anchor if no latlng is passed.
`L`	`remove()` Removes the tooltip from the map it is currently active on.
`L`	`removeFrom(Map map)` Removes the tooltip from the given map
`L`	`setPopupContent(HTMLElement content)` Sets the content of the popup bound to this layer.
`L`	`setPopupContent(Popup content)` Sets the content of the popup bound to this layer.
`L`	`setPopupContent(java.lang.String content)` Sets the content of the popup bound to this layer.
`L`	`setTooltipContent(HTMLElement content)` Sets the content of the tooltip bound to this layer.
`L`	`setTooltipContent(java.lang.String content)` Sets the content of the tooltip bound to this layer.
`L`	`setTooltipContent(Tooltip content)` Sets the content of the tooltip bound to this layer.
`L`	`togglePopup()` Opens or closes the popup bound to this layer depending on its current state.
`L`	`toggleTooltip()` Opens or closes the tooltip bound to this layer depending on its current state.
`L`	`unbindPopup()` Removes the popup previously bound with bindPopup.
`L`	`unbindTooltip()` Removes the tooltip previously bound with *bindTooltip.

- Method Detail
  - bindPopup
```
L bindPopup(HTMLElement content,
            PopupOptions options)
```
    Binds a popup to the layer with the passed content and sets up the neccessary event listeners.
    
    Parameters:
    
    HTMLElement - the element on which to binds the pop up
    
    PopupOptions - the popup options
    
    Returns:
    
    the L class
  - bindPopup
```
L bindPopup(java.lang.String id,
            PopupOptions options)
```
    Binds a popup to the layer with the passed content and sets up the neccessary event listeners.
    
    Parameters:
    
    String - the id of the element
    
    PopupOptions - the popup options
    
    Returns:
    
    the L class
  - unbindPopup
```
L unbindPopup()
```
    Removes the popup previously bound with bindPopup.
    
    Returns:
    
    the L class
  - openPopup
```
L openPopup(LatLng latlng)
```
    Opens the bound popup at the specificed latlng or at the default popup anchor if no latlng is passed.
    
    Parameters:
    
    LatLng - the latlng where to open the pop up
    
    Returns:
    
    the L class
  - closePopup
```
L closePopup()
```
    Closes the popup bound to this layer if it is open.
    
    Returns:
    
    the L class
  - togglePopup
```
L togglePopup()
```
    Opens or closes the popup bound to this layer depending on its current state.
    
    Returns:
    
    the L class
  - isPopupOpen
```
boolean isPopupOpen()
```
    Returns true if the popup bound to this layer is currently open.
    
    Returns:
    
    true if pop up is open false if closed
  - setPopupContent
```
L setPopupContent(java.lang.String content)
```
    Sets the content of the popup bound to this layer.
    
    Parameters:
    
    String - content of the popup as a String
    
    Returns:
    
    the L class
  - setPopupContent
```
L setPopupContent(HTMLElement content)
```
    Sets the content of the popup bound to this layer.
    
    Parameters:
    
    HTMLElement - content of the popup as a HTMLElement
    
    Returns:
    
    the L class
  - setPopupContent
```
L setPopupContent(Popup content)
```
    Sets the content of the popup bound to this layer.
    
    Parameters:
    
    HTMLElement - content of the popup as a Popup Object
    
    Returns:
    
    the L class
  - getPopup
```
Popup getPopup()
```
    Returns the popup bound to this layer.
    
    Returns:
    
    Popup the Pop bound to this layer.
  - bindTooltip
```
L bindTooltip(java.lang.String content,
              TooltipOptions options)
```
    Binds a tooltip to the layer with the passed *content and sets up the neccessary event listeners. If a Function is passed it will receive the layer as the first argument and should return a String or HTMLElement.
    
    Parameters:
    
    String - the tooltip content as a string
    
    TooltipOptions - the options object of this tooltip
    
    Returns:
    
    the L class
  - bindTooltip
```
L bindTooltip(HTMLElement content,
              TooltipOptions options)
```
    Binds a tooltip to the layer with the passed *content and sets up the neccessary event listeners. If a Function is passed it will receive the layer as the first argument and should return a String or HTMLElement.
    
    Parameters:
    
    HTMLElement - the tooltip content as a HTMLElement object
    
    TooltipOptions - the options object of this tooltip
    
    Returns:
    
    the L class
  - bindTooltip
```
L bindTooltip(Tooltip content,
              TooltipOptions options)
```
    Binds a tooltip to the layer with the passed content and sets up the neccessary event listeners. If a Function is passed it will receive the layer as the first argument and should return a String or HTMLElement.
    
    Parameters:
    
    HTMLElement - the tooltip content as a ToolTip object
    
    TooltipOptions - the options object of this tooltip
    
    Returns:
    
    the L class
  - unbindTooltip
```
L unbindTooltip()
```
    Removes the tooltip previously bound with *bindTooltip.
    
    Returns:
    
    the L class
  - openTooltip
```
L openTooltip(LatLng latlng)
```
    Opens the bound tooltip at the specificed latlng or at the default tooltip anchor if no latlng is passed.
    
    Parameters:
    
    LatLng - the latlng where the tooltip is opened
    
    Returns:
    
    the L class
  - closeTooltip
```
L closeTooltip()
```
    Closes the tooltip bound to this layer if it is open.
    
    Returns:
    
    the L class
  - toggleTooltip
```
L toggleTooltip()
```
    Opens or closes the tooltip bound to this layer depending on its current state.
    
    Returns:
    
    the L class
  - isTooltipOpen
```
boolean isTooltipOpen()
```
    Returns true if the tooltip bound to this layer is currently open.
    
    Returns:
    
    boolean true if tooltip is open, false otherwise
  - setTooltipContent
```
L setTooltipContent(java.lang.String content)
```
    Sets the content of the tooltip bound to this layer.
    
    Parameters:
    
    String - the content of the tooltip as a string
    
    Returns:
    
    the L class
  - setTooltipContent
```
L setTooltipContent(HTMLElement content)
```
    Sets the content of the tooltip bound to this layer.
    
    Parameters:
    
    HTMLElement - the content of the tooltip as a HTMLELement object
    
    Returns:
    
    the L class
  - setTooltipContent
```
L setTooltipContent(Tooltip content)
```
    Sets the content of the tooltip bound to this layer.
    
    Parameters:
    
    Tooltip - the content of the tooltip as a Tooltip object
    
    Returns:
    
    the L class
  - getTooltip
```
Tooltip getTooltip()
```
    Returns the tooltip bound to this layer.
    
    Returns:
    
    ToolTip the tooltip
  - addTo
```
L addTo(Map map)
```
    Adds the tooltip to the given map
    
    Parameters:
    
    Map - the map object to which to add this toolltip
    
    Returns:
    
    the L class
  - remove
```
L remove()
```
    Removes the tooltip from the map it is currently active on.
    
    Returns:
    
    the L class
  - removeFrom
```
L removeFrom(Map map)
```
    Removes the tooltip from the given map
    
    Parameters:
    
    Map - the map object from which to remove this toolltip
    
    Returns:
    
    the L class
  - getPane
```
HTMLElement getPane(java.lang.String name)
```
    Returns the HTMLElement representing the named pane on the map. If name is omitted, returns the pane for this layer.
    
    Parameters:
    
    Map - the map object from which to remove this toolltip
    
    Returns:
    
    HTMLElement the element

Interface Layer

Method Summary

Method Detail

bindPopup

bindPopup

unbindPopup

openPopup

closePopup

togglePopup

isPopupOpen

setPopupContent

setPopupContent

setPopupContent

getPopup

bindTooltip

bindTooltip

bindTooltip

unbindTooltip

openTooltip

closeTooltip

toggleTooltip

isTooltipOpen

setTooltipContent

setTooltipContent

setTooltipContent

getTooltip

addTo

remove

removeFrom

getPane