Skip to content

@smartmaps/maps • Docs

@smartmaps/maps / LayersControl

Class: LayersControl

Extends

  • Control

Constructors

new LayersControl()

new LayersControl(baseLayers, overlays, options): LayersControl

Parameters

• baseLayers: LayersObject = {}

• overlays: LayersObject = {}

• options: Partial\<LayersControlOptions> = {}

Returns

LayersControl

Overrides

Control.constructor

Properties

baseLayersList

protected baseLayersList: HTMLDivElement

container

protected container: HTMLDivElement

handlingClick

protected handlingClick: boolean

lastZIndex

protected lastZIndex: number

layerControlInputs

protected layerControlInputs: HTMLInputElement[]

layers

protected layers: LayersControlLayerContainer[]

protected layersLink: HTMLAnchorElement

map

protected map: Map

options

options: LayersControlOptions

Overrides

Control.options

overlaysList

protected overlaysList: HTMLDivElement

section

protected section: HTMLElement

separator

protected separator: HTMLDivElement

Methods

addBaseLayer()

addBaseLayer(layer, name): this

Parameters

• layer: Layer

• name: string

Returns

this

addItem()

protected addItem(obj): HTMLLabelElement

Parameters

• obj: LayersControlLayerContainer

Returns

HTMLLabelElement

addLayer()

protected addLayer(layer, name, overlay): void

Parameters

• layer: Layer

• name: string

• overlay: boolean = false

Returns

void

addOverlay()

addOverlay(layer, name): this

Parameters

• layer: Layer

• name: string

Returns

this

addTo()

addTo(map): this

Parameters

• map: Map

Returns

this

Overrides

Control.addTo

checkDisabledLayers()

protected checkDisabledLayers(): void

Returns

void

collapse()

collapse(): this

Returns

this

createRadioElement()

protected createRadioElement(obj, checked): HTMLInputElement

Parameters

• obj: LayersControlLayerContainer

• checked: boolean

Returns

HTMLInputElement

expand()

expand(): this

Returns

this

expandIfNotCollapsed()

protected expandIfNotCollapsed(): this

Returns

this

getLayer()

protected getLayer(id): void | LayersControlLayerContainer

Parameters

• id: unknown

Returns

void | LayersControlLayerContainer

initLayout()

protected initLayout(): void

Returns

void

insertLayerIcon()

protected insertLayerIcon(layer, name, checked): void

Parameters

• layer: Layer

• name: string

• checked: boolean

Returns

void

onAdd()

onAdd(map): HTMLElement

Parameters

• map: Map

Returns

HTMLElement

Overrides

Control.onAdd

onInputClick()

protected onInputClick(event): void

Parameters

• event: Event

Returns

void

onLayerChange()

protected onLayerChange(event): void

Parameters

• event: LeafletEvent

Returns

void

onRemove()

onRemove(): void

Returns

void

Overrides

Control.onRemove

refocusOnMap()

protected refocusOnMap(event?): void

Parameters

• event?: void | MouseEvent | DragEvent

Returns

void

removeLayer()

removeLayer(layer): this

Parameters

• layer: Layer

Returns

this

update()

protected update(): this

Returns

this