Class Layers

Hierarchy

Control
- Layers

Implements

Index

Classes

Constructors

constructor

Constructors

constructor

new Layers(baseLayers?: any, overlays?: any, options?: LayersOptions): Layers

Overrides Control.constructor
- Defined in src/typings/leaflet/leaflet.d.ts:389
Creates an attribution control with the given layers. Base layers will be switched with radio buttons, while overlays will be switched with checkboxes.

Parameters
- Optional baseLayers: any
- Optional overlays: any
- Optional options: LayersOptions
Returns Layers

Methods

addBaseLayer

addBaseLayer(layer: ILayer, name: string): Layers

- Defined in src/typings/leaflet/leaflet.d.ts:400
Adds a base layer (radio button entry) with the given name to the control.

Parameters
- layer: ILayer
- name: string
Returns Layers

addEventListener

addEventListener(type: string, fn: function, context?: any): Layers
addEventListener(eventMap: any, context?: any): Layers

- Defined in src/typings/leaflet/leaflet.d.ts:414
Parameters
- type: string
- fn: function
  - - (e: LeafletEvent): void
    - Parameters
      - e: LeafletEvent
      Returns void
- Optional context: any
Returns Layers
Implementation of IEventPowered.addEventListener
- Defined in src/typings/leaflet/leaflet.d.ts:423
Parameters
- eventMap: any
- Optional context: any
Returns Layers

addOneTimeEventListener

addOneTimeEventListener(type: string, fn: function, context?: any): Layers

- Defined in src/typings/leaflet/leaflet.d.ts:415
Parameters
- type: string
- fn: function
  - - (e: LeafletEvent): void
    - Parameters
      - e: LeafletEvent
      Returns void
- Optional context: any
Returns Layers

addOverlay

addOverlay(layer: ILayer, name: string): Layers

- Defined in src/typings/leaflet/leaflet.d.ts:405
Adds an overlay (checkbox entry) with the given name to the control.

Parameters
- layer: ILayer
- name: string
Returns Layers

addTo

addTo(map: Map): Control

Inherited from Control.addTo
- Defined in src/typings/leaflet/leaflet.d.ts:326
Adds the control to the map.

Parameters
- map: Map
Returns Control

clearAllEventListeners

clearAllEventListeners(): Layers

Implementation of IEventPowered.clearAllEventListeners
- Defined in src/typings/leaflet/leaflet.d.ts:425
Returns Layers

fire

fire(type: string, data?: any): Layers

Implementation of IEventPowered.fire
- Defined in src/typings/leaflet/leaflet.d.ts:422
Parameters
- type: string
- Optional data: any
Returns Layers

fireEvent

fireEvent(type: string, data?: any): Layers

Implementation of IEventPowered.fireEvent
- Defined in src/typings/leaflet/leaflet.d.ts:418
Parameters
- type: string
- Optional data: any
Returns Layers

getContainer

getContainer(): HTMLElement

Inherited from Control.getContainer
- Defined in src/typings/leaflet/leaflet.d.ts:336
Returns the HTML container of the control.

Returns HTMLElement

getPosition

getPosition(): string

Inherited from Control.getPosition
- Defined in src/typings/leaflet/leaflet.d.ts:321
Returns the current position of the control.

Returns string

hasEventListeners

hasEventListeners(type: string): boolean

Implementation of IEventPowered.hasEventListeners
- Defined in src/typings/leaflet/leaflet.d.ts:417
Parameters
- type: string
Returns boolean

off

off(type: string, fn?: function, context?: any): Layers
off(eventMap?: any, context?: any): Layers

- Defined in src/typings/leaflet/leaflet.d.ts:421
Parameters
- type: string
- Optional fn: function
  - - (e: LeafletEvent): void
    - Parameters
      - e: LeafletEvent
      Returns void
- Optional context: any
Returns Layers
Implementation of IEventPowered.off
- Defined in src/typings/leaflet/leaflet.d.ts:427
Parameters
- Optional eventMap: any
- Optional context: any
Returns Layers

on

on(type: string, fn: function, context?: any): Layers
on(eventMap: any, context?: any): Layers

- Defined in src/typings/leaflet/leaflet.d.ts:419
Parameters
- type: string
- fn: function
  - - (e: LeafletEvent): void
    - Parameters
      - e: LeafletEvent
      Returns void
- Optional context: any
Returns Layers
Implementation of IEventPowered.on
- Defined in src/typings/leaflet/leaflet.d.ts:426
Parameters
- eventMap: any
- Optional context: any
Returns Layers

onAdd

onAdd(map: Map): HTMLElement

Implementation of IControl.onAdd

Inherited from Control.onAdd
- Defined in src/typings/leaflet/leaflet.d.ts:345
Should contain code that creates all the neccessary DOM elements for the control, adds listeners on relevant map events, and returns the element containing the control. Called on map.addControl(control) or control.addTo(map).

Parameters
- map: Map
Returns HTMLElement

onRemove

onRemove(map: Map): void

Implementation of IControl.onRemove

Inherited from Control.onRemove
- Defined in src/typings/leaflet/leaflet.d.ts:352
Optional, should contain all clean up code (e.g. removes control's event listeners). Called on map.removeControl(control) or control.removeFrom(map). The control's DOM container is removed automatically.

Parameters
- map: Map
Returns void

once

once(type: string, fn: function, context?: any): Layers

- Defined in src/typings/leaflet/leaflet.d.ts:420
Parameters
- type: string
- fn: function
  - - (e: LeafletEvent): void
    - Parameters
      - e: LeafletEvent
      Returns void
- Optional context: any
Returns Layers

removeEventListener

removeEventListener(type: string, fn?: function, context?: any): Layers
removeEventListener(eventMap?: any, context?: any): Layers

- Defined in src/typings/leaflet/leaflet.d.ts:416
Parameters
- type: string
- Optional fn: function
  - - (e: LeafletEvent): void
    - Parameters
      - e: LeafletEvent
      Returns void
- Optional context: any
Returns Layers
Implementation of IEventPowered.removeEventListener
- Defined in src/typings/leaflet/leaflet.d.ts:424
Parameters
- Optional eventMap: any
- Optional context: any
Returns Layers

removeFrom

removeFrom(map: Map): Control

Inherited from Control.removeFrom
- Defined in src/typings/leaflet/leaflet.d.ts:331
Removes the control from the map.

Parameters
- map: Map
Returns Control

removeLayer

removeLayer(layer: ILayer): Layers

- Defined in src/typings/leaflet/leaflet.d.ts:410
Remove the given layer from the control.

Parameters
- layer: ILayer
Returns Layers

setPosition

setPosition(position: string): Control

Inherited from Control.setPosition
- Defined in src/typings/leaflet/leaflet.d.ts:316
Sets the position of the control. See control positions.

Parameters
- position: string
Returns Control

Static addInitHook

addInitHook(methodName: string, ...args: any[]): void

Inherited from Class.addInitHook
- Defined in src/typings/leaflet/leaflet.d.ts:297
You can also use the following shortcut when you just need to make one additional method call.

Parameters
- methodName: string
- Rest ...args: any[]
Returns void

Static extend

extend(options: ClassExtendOptions): any

Inherited from Class.extend
- Defined in src/typings/leaflet/leaflet.d.ts:291
You use L.Class.extend to define new classes, but you can use the same method on any class to inherit from it.

Parameters
- options: ClassExtendOptions
Returns any