Class Layers

Hierarchy (View Summary)

Control
- Layers

Index

Constructors

Properties

Methods

addBaseLayer addOverlay addTo collapse expand getContainer getPosition onAdd? onRemove? remove removeLayer setPosition addInitHook callInitHooks extend include mergeOptions

Constructors

constructor

new Layers(
    baseLayers?: LayersObject,
    overlays?: LayersObject,
    options?: LayersOptions,
): Layers
Parameters
- OptionalbaseLayers: LayersObject
- Optionaloverlays: LayersObject
- Optionaloptions: LayersOptions
Returns Layers
Overrides Control.constructor
- Defined in node_modules/@types/leaflet/index.d.ts:2571

Properties

options

options: LayersOptions

Methods

addBaseLayer

addBaseLayer(layer: Layer, name: string): this
Parameters
- layer: Layer
- name: string
Returns this
- Defined in node_modules/@types/leaflet/index.d.ts:2572

addOverlay

addOverlay(layer: Layer, name: string): this
Parameters
- layer: Layer
- name: string
Returns this
- Defined in node_modules/@types/leaflet/index.d.ts:2573

addTo

addTo(map: Map): this
Parameters
- map: Map
Returns this
Inherited from Control.addTo
- Defined in node_modules/@types/leaflet/index.d.ts:2514

collapse

collapse(): this
Returns this
- Defined in node_modules/@types/leaflet/index.d.ts:2576

expand

expand(): this
Returns this
- Defined in node_modules/@types/leaflet/index.d.ts:2575

getContainer

getContainer(): undefined | HTMLElement
Returns undefined | HTMLElement
Inherited from Control.getContainer
- Defined in node_modules/@types/leaflet/index.d.ts:2513

getPosition

getPosition(): ControlPosition
Returns ControlPosition
Inherited from Control.getPosition
- Defined in node_modules/@types/leaflet/index.d.ts:2511

`Optional`onAdd

onAdd(map: Map): HTMLElement
Parameters
- map: Map
Returns HTMLElement
Inherited from Control.onAdd
- Defined in node_modules/@types/leaflet/index.d.ts:2518

`Optional`onRemove

onRemove(map: Map): void
Parameters
- map: Map
Returns void
Inherited from Control.onRemove
- Defined in node_modules/@types/leaflet/index.d.ts:2519

remove

remove(): this
Returns this
Inherited from Control.remove
- Defined in node_modules/@types/leaflet/index.d.ts:2515

removeLayer

removeLayer(layer: Layer): this
Parameters
- layer: Layer
Returns this
- Defined in node_modules/@types/leaflet/index.d.ts:2574

setPosition

setPosition(position: ControlPosition): this
Parameters
- position: ControlPosition
Returns this
Inherited from Control.setPosition
- Defined in node_modules/@types/leaflet/index.d.ts:2512

`Static`addInitHook

addInitHook(initHookFn: () => void): any
Parameters
- initHookFn: () => void
Returns any
Inherited from Control.addInitHook
- Defined in node_modules/@types/leaflet/index.d.ts:13
addInitHook(methodName: string, ...args: any[]): any
Parameters
- methodName: string
- ...args: any[]
Returns any
Inherited from Control.addInitHook
- Defined in node_modules/@types/leaflet/index.d.ts:14

`Static`callInitHooks

callInitHooks(): void
Returns void
Inherited from Control.callInitHooks
- Defined in node_modules/@types/leaflet/index.d.ts:16

`Static`extend

extend<T extends object, Options extends ControlOptions = ControlOptions>(
props: T,
): new (...args: any[]) => T & typeof Control
Type Parameters
- T extends object
- Options extends ControlOptions = ControlOptions
Parameters
- props: T
Returns new (...args: any[]) => T & typeof Control
Inherited from Control.extend
- Defined in node_modules/@types/leaflet/index.d.ts:2507

`Static`include

include(props: any): any
Parameters
- props: any
Returns any
Inherited from Control.include
- Defined in node_modules/@types/leaflet/index.d.ts:10

`Static`mergeOptions

mergeOptions(props: any): any
Parameters
- props: any
Returns any
Inherited from Control.mergeOptions
- Defined in node_modules/@types/leaflet/index.d.ts:11