Skip to main content

ZarrLayer

Leaflet Zarr tile layer using the shared ZarrLayerProvider.

Remarks

This class extends L.GridLayer to create a custom tile layer that fetches and renders tiles from a Zarr data source using the ZarrLayerProvider.

Param

Configuration options for the Zarr layer. Instance of LeafletLayerOptions.

Extends

  • GridLayer

Constructors

Constructor

new ZarrLayer(options): ZarrLayer;

Parameters

ParameterType
optionsLeafletLayerOptions & GridLayerOptions

Returns

ZarrLayer

Overrides

L.GridLayer.constructor

Methods

_removeTile()

_removeTile(key): any;

Parameters

ParameterType
keystring

Returns

any


_tileCoordsToKey()

protected _tileCoordsToKey(coords): string;

Parameters

ParameterType
coordsCoords

Returns

string

Inherited from

L.GridLayer._tileCoordsToKey

_wrapCoords()

protected _wrapCoords(parameter): Coords;

Parameters

ParameterType
parameterCoords

Returns

Coords

Inherited from

L.GridLayer._wrapCoords

addEventListener()

Call Signature

addEventListener(
type,
fn,
context?): this;

Alias for on(...)

Adds a listener function (fn) to a particular event type of the object. You can optionally specify the context of the listener (object the this keyword will point to). You can also pass several space-separated types (e.g. 'click dblclick').

Parameters
ParameterType
type"baselayerchange" | "overlayadd" | "overlayremove"
fnLayersControlEventHandlerFn
context?any
Returns

this

Inherited from
L.GridLayer.addEventListener

Call Signature

addEventListener(
type,
fn,
context?): this;

Alias for on(...)

Adds a listener function (fn) to a particular event type of the object. You can optionally specify the context of the listener (object the this keyword will point to). You can also pass several space-separated types (e.g. 'click dblclick').

Parameters
ParameterType
type"layeradd" | "layerremove"
fnLayerEventHandlerFn
context?any
Returns

this

Inherited from
L.GridLayer.addEventListener

Call Signature

addEventListener(
type,
fn,
context?): this;

Alias for on(...)

Adds a listener function (fn) to a particular event type of the object. You can optionally specify the context of the listener (object the this keyword will point to). You can also pass several space-separated types (e.g. 'click dblclick').

Parameters
ParameterType
type| "error" | "zoomlevelschange" | "unload" | "viewreset" | "load" | "zoomstart" | "movestart" | "zoom" | "move" | "zoomend" | "moveend" | "autopanstart" | "dragstart" | "drag" | "add" | "remove" | "loading" | "update" | "down" | "predrag"
fnLeafletEventHandlerFn
context?any
Returns

this

Inherited from
L.GridLayer.addEventListener

Call Signature

addEventListener(
type,
fn,
context?): this;

Alias for on(...)

Adds a listener function (fn) to a particular event type of the object. You can optionally specify the context of the listener (object the this keyword will point to). You can also pass several space-separated types (e.g. 'click dblclick').

Parameters
ParameterType
type"resize"
fnResizeEventHandlerFn
context?any
Returns

this

Inherited from
L.GridLayer.addEventListener

Call Signature

addEventListener(
type,
fn,
context?): this;

Alias for on(...)

Adds a listener function (fn) to a particular event type of the object. You can optionally specify the context of the listener (object the this keyword will point to). You can also pass several space-separated types (e.g. 'click dblclick').

Parameters
ParameterType
type"popupopen" | "popupclose"
fnPopupEventHandlerFn
context?any
Returns

this

Inherited from
L.GridLayer.addEventListener

Call Signature

addEventListener(
type,
fn,
context?): this;

Alias for on(...)

Adds a listener function (fn) to a particular event type of the object. You can optionally specify the context of the listener (object the this keyword will point to). You can also pass several space-separated types (e.g. 'click dblclick').

Parameters
ParameterType
type"tooltipopen" | "tooltipclose"
fnTooltipEventHandlerFn
context?any
Returns

this

Inherited from
L.GridLayer.addEventListener

Call Signature

addEventListener(
type,
fn,
context?): this;

Alias for on(...)

Adds a listener function (fn) to a particular event type of the object. You can optionally specify the context of the listener (object the this keyword will point to). You can also pass several space-separated types (e.g. 'click dblclick').

Parameters
ParameterType
type"locationerror"
fnErrorEventHandlerFn
context?any
Returns

this

Inherited from
L.GridLayer.addEventListener

Call Signature

addEventListener(
type,
fn,
context?): this;

Alias for on(...)

Adds a listener function (fn) to a particular event type of the object. You can optionally specify the context of the listener (object the this keyword will point to). You can also pass several space-separated types (e.g. 'click dblclick').

Parameters
ParameterType
type"locationfound"
fnLocationEventHandlerFn
context?any
Returns

this

Inherited from
L.GridLayer.addEventListener

Call Signature

addEventListener(
type,
fn,
context?): this;

Alias for on(...)

Adds a listener function (fn) to a particular event type of the object. You can optionally specify the context of the listener (object the this keyword will point to). You can also pass several space-separated types (e.g. 'click dblclick').

Parameters
ParameterType
type| "click" | "dblclick" | "mousedown" | "mouseup" | "mouseover" | "mouseout" | "mousemove" | "contextmenu" | "preclick"
fnLeafletMouseEventHandlerFn
context?any
Returns

this

Inherited from
L.GridLayer.addEventListener

Call Signature

addEventListener(
type,
fn,
context?): this;

Alias for on(...)

Adds a listener function (fn) to a particular event type of the object. You can optionally specify the context of the listener (object the this keyword will point to). You can also pass several space-separated types (e.g. 'click dblclick').

Parameters
ParameterType
type"keypress" | "keydown" | "keyup"
fnLeafletKeyboardEventHandlerFn
context?any
Returns

this

Inherited from
L.GridLayer.addEventListener

Call Signature

addEventListener(
type,
fn,
context?): this;

Alias for on(...)

Adds a listener function (fn) to a particular event type of the object. You can optionally specify the context of the listener (object the this keyword will point to). You can also pass several space-separated types (e.g. 'click dblclick').

Parameters
ParameterType
type"zoomanim"
fnZoomAnimEventHandlerFn
context?any
Returns

this

Inherited from
L.GridLayer.addEventListener

Call Signature

addEventListener(
type,
fn,
context?): this;

Alias for on(...)

Adds a listener function (fn) to a particular event type of the object. You can optionally specify the context of the listener (object the this keyword will point to). You can also pass several space-separated types (e.g. 'click dblclick').

Parameters
ParameterType
type"dragend"
fnDragEndEventHandlerFn
context?any
Returns

this

Inherited from
L.GridLayer.addEventListener

Call Signature

addEventListener(
type,
fn,
context?): this;

Alias for on(...)

Adds a listener function (fn) to a particular event type of the object. You can optionally specify the context of the listener (object the this keyword will point to). You can also pass several space-separated types (e.g. 'click dblclick').

Parameters
ParameterType
type"tileloadstart" | "tileunload" | "tileload" | "tileabort"
fnTileEventHandlerFn
context?any
Returns

this

Inherited from
L.GridLayer.addEventListener

Call Signature

addEventListener(
type,
fn,
context?): this;

Alias for on(...)

Adds a listener function (fn) to a particular event type of the object. You can optionally specify the context of the listener (object the this keyword will point to). You can also pass several space-separated types (e.g. 'click dblclick').

Parameters
ParameterType
type"tileerror"
fnTileErrorEventHandlerFn
context?any
Returns

this

Inherited from
L.GridLayer.addEventListener

Call Signature

addEventListener(
type,
fn,
context?): this;

Alias for on(...)

Adds a listener function (fn) to a particular event type of the object. You can optionally specify the context of the listener (object the this keyword will point to). You can also pass several space-separated types (e.g. 'click dblclick').

Parameters
ParameterType
typestring
fnLeafletEventHandlerFn
context?any
Returns

this

Inherited from
L.GridLayer.addEventListener

Call Signature

addEventListener(eventMap): this;

Alias for on(...)

Adds a set of type/listener pairs, e.g. {click: onClick, mousemove: onMouseMove}

Parameters
ParameterType
eventMapLeafletEventHandlerFnMap
Returns

this

Inherited from
L.GridLayer.addEventListener

addEventParent()

addEventParent(obj): this;

Adds an event parent - an Evented that will receive propagated events

Parameters

ParameterType
objEvented

Returns

this

Inherited from

L.GridLayer.addEventParent

addInteractiveTarget()

addInteractiveTarget(targetEl): this;

Parameters

ParameterType
targetElHTMLElement

Returns

this

Inherited from

L.GridLayer.addInteractiveTarget

addOneTimeEventListener()

Call Signature

addOneTimeEventListener(
type,
fn,
context?): this;

Alias for once(...)

Behaves as on(...), except the listener will only get fired once and then removed.

Parameters
ParameterType
type"baselayerchange" | "overlayadd" | "overlayremove"
fnLayersControlEventHandlerFn
context?any
Returns

this

Inherited from
L.GridLayer.addOneTimeEventListener

Call Signature

addOneTimeEventListener(
type,
fn,
context?): this;

Alias for once(...)

Behaves as on(...), except the listener will only get fired once and then removed.

Parameters
ParameterType
type"layeradd" | "layerremove"
fnLayerEventHandlerFn
context?any
Returns

this

Inherited from
L.GridLayer.addOneTimeEventListener

Call Signature

addOneTimeEventListener(
type,
fn,
context?): this;

Alias for once(...)

Behaves as on(...), except the listener will only get fired once and then removed.

Parameters
ParameterType
type| "error" | "zoomlevelschange" | "unload" | "viewreset" | "load" | "zoomstart" | "movestart" | "zoom" | "move" | "zoomend" | "moveend" | "autopanstart" | "dragstart" | "drag" | "add" | "remove" | "loading" | "update" | "down" | "predrag"
fnLeafletEventHandlerFn
context?any
Returns

this

Inherited from
L.GridLayer.addOneTimeEventListener

Call Signature

addOneTimeEventListener(
type,
fn,
context?): this;

Alias for once(...)

Behaves as on(...), except the listener will only get fired once and then removed.

Parameters
ParameterType
type"resize"
fnResizeEventHandlerFn
context?any
Returns

this

Inherited from
L.GridLayer.addOneTimeEventListener

Call Signature

addOneTimeEventListener(
type,
fn,
context?): this;

Alias for once(...)

Behaves as on(...), except the listener will only get fired once and then removed.

Parameters
ParameterType
type"popupopen" | "popupclose"
fnPopupEventHandlerFn
context?any
Returns

this

Inherited from
L.GridLayer.addOneTimeEventListener

Call Signature

addOneTimeEventListener(
type,
fn,
context?): this;

Alias for once(...)

Behaves as on(...), except the listener will only get fired once and then removed.

Parameters
ParameterType
type"tooltipopen" | "tooltipclose"
fnTooltipEventHandlerFn
context?any
Returns

this

Inherited from
L.GridLayer.addOneTimeEventListener

Call Signature

addOneTimeEventListener(
type,
fn,
context?): this;

Alias for once(...)

Behaves as on(...), except the listener will only get fired once and then removed.

Parameters
ParameterType
type"locationerror"
fnErrorEventHandlerFn
context?any
Returns

this

Inherited from
L.GridLayer.addOneTimeEventListener

Call Signature

addOneTimeEventListener(
type,
fn,
context?): this;

Alias for once(...)

Behaves as on(...), except the listener will only get fired once and then removed.

Parameters
ParameterType
type"locationfound"
fnLocationEventHandlerFn
context?any
Returns

this

Inherited from
L.GridLayer.addOneTimeEventListener

Call Signature

addOneTimeEventListener(
type,
fn,
context?): this;

Alias for once(...)

Behaves as on(...), except the listener will only get fired once and then removed.

Parameters
ParameterType
type| "click" | "dblclick" | "mousedown" | "mouseup" | "mouseover" | "mouseout" | "mousemove" | "contextmenu" | "preclick"
fnLeafletMouseEventHandlerFn
context?any
Returns

this

Inherited from
L.GridLayer.addOneTimeEventListener

Call Signature

addOneTimeEventListener(
type,
fn,
context?): this;

Alias for once(...)

Behaves as on(...), except the listener will only get fired once and then removed.

Parameters
ParameterType
type"keypress" | "keydown" | "keyup"
fnLeafletKeyboardEventHandlerFn
context?any
Returns

this

Inherited from
L.GridLayer.addOneTimeEventListener

Call Signature

addOneTimeEventListener(
type,
fn,
context?): this;

Alias for once(...)

Behaves as on(...), except the listener will only get fired once and then removed.

Parameters
ParameterType
type"zoomanim"
fnZoomAnimEventHandlerFn
context?any
Returns

this

Inherited from
L.GridLayer.addOneTimeEventListener

Call Signature

addOneTimeEventListener(
type,
fn,
context?): this;

Alias for once(...)

Behaves as on(...), except the listener will only get fired once and then removed.

Parameters
ParameterType
type"dragend"
fnDragEndEventHandlerFn
context?any
Returns

this

Inherited from
L.GridLayer.addOneTimeEventListener

Call Signature

addOneTimeEventListener(
type,
fn,
context?): this;

Alias for once(...)

Behaves as on(...), except the listener will only get fired once and then removed.

Parameters
ParameterType
type"tileloadstart" | "tileunload" | "tileload" | "tileabort"
fnTileEventHandlerFn
context?any
Returns

this

Inherited from
L.GridLayer.addOneTimeEventListener

Call Signature

addOneTimeEventListener(
type,
fn,
context?): this;

Alias for once(...)

Behaves as on(...), except the listener will only get fired once and then removed.

Parameters
ParameterType
type"tileerror"
fnTileErrorEventHandlerFn
context?any
Returns

this

Inherited from
L.GridLayer.addOneTimeEventListener

Call Signature

addOneTimeEventListener(
type,
fn,
context?): this;

Alias for once(...)

Behaves as on(...), except the listener will only get fired once and then removed.

Parameters
ParameterType
typestring
fnLeafletEventHandlerFn
context?any
Returns

this

Inherited from
L.GridLayer.addOneTimeEventListener

Call Signature

addOneTimeEventListener(eventMap): this;

Alias for once(...)

Behaves as on(...), except the listener will only get fired once and then removed.

Parameters
ParameterType
eventMapLeafletEventHandlerFnMap
Returns

this

Inherited from
L.GridLayer.addOneTimeEventListener

addTo()

addTo(map): this;

Parameters

ParameterType
mapMap | LayerGroup<any>

Returns

this

Inherited from

L.GridLayer.addTo

beforeAdd()?

optional beforeAdd(map): this;

Parameters

ParameterType
mapMap

Returns

this

Inherited from

L.GridLayer.beforeAdd

bindPopup()

bindPopup(content, options?): this;

Parameters

ParameterType
content(layer) => Content | Content | Popup
options?PopupOptions

Returns

this

Inherited from

L.GridLayer.bindPopup

bindTooltip()

bindTooltip(content, options?): this;

Parameters

ParameterType
contentContent | (layer) => Content | Tooltip
options?TooltipOptions

Returns

this

Inherited from

L.GridLayer.bindTooltip

bringToBack()

bringToBack(): this;

Returns

this

Inherited from

L.GridLayer.bringToBack

bringToFront()

bringToFront(): this;

Returns

this

Inherited from

L.GridLayer.bringToFront

clearAllEventListeners()

clearAllEventListeners(): this;

Alias for off()

Removes all listeners to all events on the object.

Returns

this

Inherited from

L.GridLayer.clearAllEventListeners

closePopup()

closePopup(): this;

Returns

this

Inherited from

L.GridLayer.closePopup

closeTooltip()

closeTooltip(): this;

Returns

this

Inherited from

L.GridLayer.closeTooltip

createTile()

createTile(coords, done): HTMLCanvasElement;

Parameters

ParameterType
coordsCoords
doneDoneCallback

Returns

HTMLCanvasElement

Overrides

L.GridLayer.createTile

fire()

fire(
type,
data?,
propagate?): this;

Fires an event of the specified type. You can optionally provide a data object — the first argument of the listener function will contain its properties. The event might can optionally be propagated to event parents.

Parameters

ParameterType
typestring
data?any
propagate?boolean

Returns

this

Inherited from

L.GridLayer.fire

fireEvent()

fireEvent(
type,
data?,
propagate?): this;

Alias for fire(...)

Fires an event of the specified type. You can optionally provide a data object — the first argument of the listener function will contain its properties. The event might can optionally be propagated to event parents.

Parameters

ParameterType
typestring
data?any
propagate?boolean

Returns

this

Inherited from

L.GridLayer.fireEvent

getAttribution()?

optional getAttribution(): string | null;

Returns

string | null

Inherited from

L.GridLayer.getAttribution

getContainer()

getContainer(): HTMLElement | null;

Returns

HTMLElement | null

Inherited from

L.GridLayer.getContainer

getEvents()?

optional getEvents(): object;

Returns

object

Inherited from

L.GridLayer.getEvents

getPane()

getPane(name?): HTMLElement | undefined;

Parameters

ParameterType
name?string

Returns

HTMLElement | undefined

Inherited from

L.GridLayer.getPane

getPopup()

getPopup(): Popup | undefined;

Returns

Popup | undefined

Inherited from

L.GridLayer.getPopup

getTileSize()

getTileSize(): Point;

Returns

Point

Inherited from

L.GridLayer.getTileSize

getTooltip()

getTooltip(): Tooltip | undefined;

Returns

Tooltip | undefined

Inherited from

L.GridLayer.getTooltip

hasEventListeners()

hasEventListeners(type): boolean;

Alias for listens(...)

Returns true if a particular event type has any listeners attached to it.

Parameters

ParameterType
typestring

Returns

boolean

Inherited from

L.GridLayer.hasEventListeners

isLoading()

isLoading(): boolean;

Returns

boolean

Inherited from

L.GridLayer.isLoading

isPopupOpen()

isPopupOpen(): boolean;

Returns

boolean

Inherited from

L.GridLayer.isPopupOpen

isTooltipOpen()

isTooltipOpen(): boolean;

Returns

boolean

Inherited from

L.GridLayer.isTooltipOpen

listens()

Call Signature

listens(type, propagate?): boolean;

Returns true if a particular event type has any listeners attached to it.

Parameters
ParameterType
type| "error" | "tileloadstart" | "baselayerchange" | "overlayadd" | "overlayremove" | "layeradd" | "layerremove" | "zoomlevelschange" | "unload" | "viewreset" | "load" | "zoomstart" | "movestart" | "zoom" | "move" | "zoomend" | "moveend" | "autopanstart" | "dragstart" | "drag" | "add" | "remove" | "loading" | "update" | "down" | "predrag" | "resize" | "popupopen" | "tooltipopen" | "tooltipclose" | "locationerror" | "locationfound" | "click" | "dblclick" | "mousedown" | "mouseup" | "mouseover" | "mouseout" | "mousemove" | "contextmenu" | "preclick" | "keypress" | "keydown" | "keyup" | "zoomanim" | "dragend" | "tileunload" | "tileload" | "tileabort" | "tileerror"
propagate?boolean
Returns

boolean

Inherited from
L.GridLayer.listens

Call Signature

listens(
type,
fn,
context?,
propagate?): boolean;

Returns true if a particular event type has any listeners attached to it.

Parameters
ParameterType
type"baselayerchange" | "overlayadd" | "overlayremove"
fnLayersControlEventHandlerFn
context?any
propagate?boolean
Returns

boolean

Inherited from
L.GridLayer.listens

Call Signature

listens(
type,
fn,
context?,
propagate?): boolean;

Returns true if a particular event type has any listeners attached to it.

Parameters
ParameterType
type"layeradd" | "layerremove"
fnLayerEventHandlerFn
context?any
propagate?boolean
Returns

boolean

Inherited from
L.GridLayer.listens

Call Signature

listens(
type,
fn,
context?,
propagate?): boolean;

Returns true if a particular event type has any listeners attached to it.

Parameters
ParameterType
type| "error" | "zoomlevelschange" | "unload" | "viewreset" | "load" | "zoomstart" | "movestart" | "zoom" | "move" | "zoomend" | "moveend" | "autopanstart" | "dragstart" | "drag" | "add" | "remove" | "loading" | "update" | "down" | "predrag"
fnLeafletEventHandlerFn
context?any
propagate?boolean
Returns

boolean

Inherited from
L.GridLayer.listens

Call Signature

listens(
type,
fn,
context?,
propagate?): boolean;

Returns true if a particular event type has any listeners attached to it.

Parameters
ParameterType
type"resize"
fnResizeEventHandlerFn
context?any
propagate?boolean
Returns

boolean

Inherited from
L.GridLayer.listens

Call Signature

listens(
type,
fn,
context?,
propagate?): boolean;

Returns true if a particular event type has any listeners attached to it.

Parameters
ParameterType
type"popupopen" | "popupclose"
fnPopupEventHandlerFn
context?any
propagate?boolean
Returns

boolean

Inherited from
L.GridLayer.listens

Call Signature

listens(
type,
fn,
context?,
propagate?): boolean;

Returns true if a particular event type has any listeners attached to it.

Parameters
ParameterType
type"tooltipopen" | "tooltipclose"
fnTooltipEventHandlerFn
context?any
propagate?boolean
Returns

boolean

Inherited from
L.GridLayer.listens

Call Signature

listens(
type,
fn,
context?,
propagate?): boolean;

Returns true if a particular event type has any listeners attached to it.

Parameters
ParameterType
type"locationerror"
fnErrorEventHandlerFn
context?any
propagate?boolean
Returns

boolean

Inherited from
L.GridLayer.listens

Call Signature

listens(
type,
fn,
context?,
propagate?): boolean;

Returns true if a particular event type has any listeners attached to it.

Parameters
ParameterType
type"locationfound"
fnLocationEventHandlerFn
context?any
propagate?boolean
Returns

boolean

Inherited from
L.GridLayer.listens

Call Signature

listens(
type,
fn,
context?,
propagate?): boolean;

Returns true if a particular event type has any listeners attached to it.

Parameters
ParameterType
type| "click" | "dblclick" | "mousedown" | "mouseup" | "mouseover" | "mouseout" | "mousemove" | "contextmenu" | "preclick"
fnLeafletMouseEventHandlerFn
context?any
propagate?boolean
Returns

boolean

Inherited from
L.GridLayer.listens

Call Signature

listens(
type,
fn,
context?,
propagate?): boolean;

Returns true if a particular event type has any listeners attached to it.

Parameters
ParameterType
type"keypress" | "keydown" | "keyup"
fnLeafletKeyboardEventHandlerFn
context?any
propagate?boolean
Returns

boolean

Inherited from
L.GridLayer.listens

Call Signature

listens(
type,
fn,
context?,
propagate?): boolean;

Returns true if a particular event type has any listeners attached to it.

Parameters
ParameterType
type"zoomanim"
fnZoomAnimEventHandlerFn
context?any
propagate?boolean
Returns

boolean

Inherited from
L.GridLayer.listens

Call Signature

listens(
type,
fn,
context?,
propagate?): boolean;

Returns true if a particular event type has any listeners attached to it.

Parameters
ParameterType
type"dragend"
fnDragEndEventHandlerFn
context?any
propagate?boolean
Returns

boolean

Inherited from
L.GridLayer.listens

Call Signature

listens(
type,
fn,
context?,
propagate?): boolean;

Returns true if a particular event type has any listeners attached to it.

Parameters
ParameterType
type"tileloadstart" | "tileunload" | "tileload" | "tileabort"
fnTileEventHandlerFn
context?any
propagate?boolean
Returns

boolean

Inherited from
L.GridLayer.listens

Call Signature

listens(
type,
fn,
context?,
propagate?): boolean;

Returns true if a particular event type has any listeners attached to it.

Parameters
ParameterType
type"tileerror"
fnTileEventHandlerFn
context?any
propagate?boolean
Returns

boolean

Inherited from
L.GridLayer.listens

Call Signature

listens(
type,
fn,
context?,
propagate?): boolean;

Returns true if a particular event type has any listeners attached to it.

Parameters
ParameterType
typestring
fnLeafletEventHandlerFn
context?any
propagate?boolean
Returns

boolean

Inherited from
L.GridLayer.listens

load()

load(): Promise<boolean>;

Loads the Zarr layer and returns a promise that resolves when the layer is ready.

Returns

Promise<boolean>

A promise that resolves to true when the layer is ready.


off()

Call Signature

off(
type,
fn?,
context?): this;

Removes a previously added listener function. If no function is specified, it will remove all the listeners of that particular event from the object. Note that if you passed a custom context to on, you must pass the same context to off in order to remove the listener.

Parameters
ParameterType
type"baselayerchange" | "overlayadd" | "overlayremove"
fn?LayersControlEventHandlerFn
context?any
Returns

this

Inherited from
L.GridLayer.off

Call Signature

off(
type,
fn?,
context?): this;

Removes a previously added listener function. If no function is specified, it will remove all the listeners of that particular event from the object. Note that if you passed a custom context to on, you must pass the same context to off in order to remove the listener.

Parameters
ParameterType
type"layeradd" | "layerremove"
fn?LayerEventHandlerFn
context?any
Returns

this

Inherited from
L.GridLayer.off

Call Signature

off(
type,
fn?,
context?): this;

Removes a previously added listener function. If no function is specified, it will remove all the listeners of that particular event from the object. Note that if you passed a custom context to on, you must pass the same context to off in order to remove the listener.

Parameters
ParameterType
type| "error" | "zoomlevelschange" | "unload" | "viewreset" | "load" | "zoomstart" | "movestart" | "zoom" | "move" | "zoomend" | "moveend" | "autopanstart" | "dragstart" | "drag" | "add" | "remove" | "loading" | "update" | "down" | "predrag"
fn?LeafletEventHandlerFn
context?any
Returns

this

Inherited from
L.GridLayer.off

Call Signature

off(
type,
fn?,
context?): this;

Removes a previously added listener function. If no function is specified, it will remove all the listeners of that particular event from the object. Note that if you passed a custom context to on, you must pass the same context to off in order to remove the listener.

Parameters
ParameterType
type"resize"
fn?ResizeEventHandlerFn
context?any
Returns

this

Inherited from
L.GridLayer.off

Call Signature

off(
type,
fn?,
context?): this;

Removes a previously added listener function. If no function is specified, it will remove all the listeners of that particular event from the object. Note that if you passed a custom context to on, you must pass the same context to off in order to remove the listener.

Parameters
ParameterType
type"popupopen" | "popupclose"
fn?PopupEventHandlerFn
context?any
Returns

this

Inherited from
L.GridLayer.off

Call Signature

off(
type,
fn?,
context?): this;

Removes a previously added listener function. If no function is specified, it will remove all the listeners of that particular event from the object. Note that if you passed a custom context to on, you must pass the same context to off in order to remove the listener.

Parameters
ParameterType
type"tooltipopen" | "tooltipclose"
fn?TooltipEventHandlerFn
context?any
Returns

this

Inherited from
L.GridLayer.off

Call Signature

off(
type,
fn?,
context?): this;

Removes a previously added listener function. If no function is specified, it will remove all the listeners of that particular event from the object. Note that if you passed a custom context to on, you must pass the same context to off in order to remove the listener.

Parameters
ParameterType
type"locationerror"
fn?ErrorEventHandlerFn
context?any
Returns

this

Inherited from
L.GridLayer.off

Call Signature

off(
type,
fn?,
context?): this;

Removes a previously added listener function. If no function is specified, it will remove all the listeners of that particular event from the object. Note that if you passed a custom context to on, you must pass the same context to off in order to remove the listener.

Parameters
ParameterType
type"locationfound"
fn?LocationEventHandlerFn
context?any
Returns

this

Inherited from
L.GridLayer.off

Call Signature

off(
type,
fn?,
context?): this;

Removes a previously added listener function. If no function is specified, it will remove all the listeners of that particular event from the object. Note that if you passed a custom context to on, you must pass the same context to off in order to remove the listener.

Parameters
ParameterType
type| "click" | "dblclick" | "mousedown" | "mouseup" | "mouseover" | "mouseout" | "mousemove" | "contextmenu" | "preclick"
fn?LeafletMouseEventHandlerFn
context?any
Returns

this

Inherited from
L.GridLayer.off

Call Signature

off(
type,
fn?,
context?): this;

Removes a previously added listener function. If no function is specified, it will remove all the listeners of that particular event from the object. Note that if you passed a custom context to on, you must pass the same context to off in order to remove the listener.

Parameters
ParameterType
type"keypress" | "keydown" | "keyup"
fn?LeafletKeyboardEventHandlerFn
context?any
Returns

this

Inherited from
L.GridLayer.off

Call Signature

off(
type,
fn?,
context?): this;

Removes a previously added listener function. If no function is specified, it will remove all the listeners of that particular event from the object. Note that if you passed a custom context to on, you must pass the same context to off in order to remove the listener.

Parameters
ParameterType
type"zoomanim"
fn?ZoomAnimEventHandlerFn
context?any
Returns

this

Inherited from
L.GridLayer.off

Call Signature

off(
type,
fn?,
context?): this;

Removes a previously added listener function. If no function is specified, it will remove all the listeners of that particular event from the object. Note that if you passed a custom context to on, you must pass the same context to off in order to remove the listener.

Parameters
ParameterType
type"dragend"
fn?DragEndEventHandlerFn
context?any
Returns

this

Inherited from
L.GridLayer.off

Call Signature

off(
type,
fn?,
context?): this;

Removes a previously added listener function. If no function is specified, it will remove all the listeners of that particular event from the object. Note that if you passed a custom context to on, you must pass the same context to off in order to remove the listener.

Parameters
ParameterType
type"tileloadstart" | "tileunload" | "tileload" | "tileabort"
fn?TileEventHandlerFn
context?any
Returns

this

Inherited from
L.GridLayer.off

Call Signature

off(
type,
fn?,
context?): this;

Removes a previously added listener function. If no function is specified, it will remove all the listeners of that particular event from the object. Note that if you passed a custom context to on, you must pass the same context to off in order to remove the listener.

Parameters
ParameterType
type"tileerror"
fn?TileErrorEventHandlerFn
context?any
Returns

this

Inherited from
L.GridLayer.off

Call Signature

off(
type,
fn?,
context?): this;

Removes a previously added listener function. If no function is specified, it will remove all the listeners of that particular event from the object. Note that if you passed a custom context to on, you must pass the same context to off in order to remove the listener.

Parameters
ParameterType
typestring
fn?LeafletEventHandlerFn
context?any
Returns

this

Inherited from
L.GridLayer.off

Call Signature

off(eventMap): this;

Removes a set of type/listener pairs.

Parameters
ParameterType
eventMapLeafletEventHandlerFnMap
Returns

this

Inherited from
L.GridLayer.off

Call Signature

off(): this;

Removes all listeners to all events on the object.

Returns

this

Inherited from
L.GridLayer.off

on()

Call Signature

on(
type,
fn,
context?): this;

Adds a listener function (fn) to a particular event type of the object. You can optionally specify the context of the listener (object the this keyword will point to). You can also pass several space-separated types (e.g. 'click dblclick').

Parameters
ParameterType
type"baselayerchange" | "overlayadd" | "overlayremove"
fnLayersControlEventHandlerFn
context?any
Returns

this

Inherited from
L.GridLayer.on

Call Signature

on(
type,
fn,
context?): this;

Adds a listener function (fn) to a particular event type of the object. You can optionally specify the context of the listener (object the this keyword will point to). You can also pass several space-separated types (e.g. 'click dblclick').

Parameters
ParameterType
type"layeradd" | "layerremove"
fnLayerEventHandlerFn
context?any
Returns

this

Inherited from
L.GridLayer.on

Call Signature

on(
type,
fn,
context?): this;

Adds a listener function (fn) to a particular event type of the object. You can optionally specify the context of the listener (object the this keyword will point to). You can also pass several space-separated types (e.g. 'click dblclick').

Parameters
ParameterType
type| "error" | "zoomlevelschange" | "unload" | "viewreset" | "load" | "zoomstart" | "movestart" | "zoom" | "move" | "zoomend" | "moveend" | "autopanstart" | "dragstart" | "drag" | "add" | "remove" | "loading" | "update" | "down" | "predrag"
fnLeafletEventHandlerFn
context?any
Returns

this

Inherited from
L.GridLayer.on

Call Signature

on(
type,
fn,
context?): this;

Adds a listener function (fn) to a particular event type of the object. You can optionally specify the context of the listener (object the this keyword will point to). You can also pass several space-separated types (e.g. 'click dblclick').

Parameters
ParameterType
type"resize"
fnResizeEventHandlerFn
context?any
Returns

this

Inherited from
L.GridLayer.on

Call Signature

on(
type,
fn,
context?): this;

Adds a listener function (fn) to a particular event type of the object. You can optionally specify the context of the listener (object the this keyword will point to). You can also pass several space-separated types (e.g. 'click dblclick').

Parameters
ParameterType
type"popupopen" | "popupclose"
fnPopupEventHandlerFn
context?any
Returns

this

Inherited from
L.GridLayer.on

Call Signature

on(
type,
fn,
context?): this;

Adds a listener function (fn) to a particular event type of the object. You can optionally specify the context of the listener (object the this keyword will point to). You can also pass several space-separated types (e.g. 'click dblclick').

Parameters
ParameterType
type"tooltipopen" | "tooltipclose"
fnTooltipEventHandlerFn
context?any
Returns

this

Inherited from
L.GridLayer.on

Call Signature

on(
type,
fn,
context?): this;

Adds a listener function (fn) to a particular event type of the object. You can optionally specify the context of the listener (object the this keyword will point to). You can also pass several space-separated types (e.g. 'click dblclick').

Parameters
ParameterType
type"locationerror"
fnErrorEventHandlerFn
context?any
Returns

this

Inherited from
L.GridLayer.on

Call Signature

on(
type,
fn,
context?): this;

Adds a listener function (fn) to a particular event type of the object. You can optionally specify the context of the listener (object the this keyword will point to). You can also pass several space-separated types (e.g. 'click dblclick').

Parameters
ParameterType
type"locationfound"
fnLocationEventHandlerFn
context?any
Returns

this

Inherited from
L.GridLayer.on

Call Signature

on(
type,
fn,
context?): this;

Adds a listener function (fn) to a particular event type of the object. You can optionally specify the context of the listener (object the this keyword will point to). You can also pass several space-separated types (e.g. 'click dblclick').

Parameters
ParameterType
type| "click" | "dblclick" | "mousedown" | "mouseup" | "mouseover" | "mouseout" | "mousemove" | "contextmenu" | "preclick"
fnLeafletMouseEventHandlerFn
context?any
Returns

this

Inherited from
L.GridLayer.on

Call Signature

on(
type,
fn,
context?): this;

Adds a listener function (fn) to a particular event type of the object. You can optionally specify the context of the listener (object the this keyword will point to). You can also pass several space-separated types (e.g. 'click dblclick').

Parameters
ParameterType
type"keypress" | "keydown" | "keyup"
fnLeafletKeyboardEventHandlerFn
context?any
Returns

this

Inherited from
L.GridLayer.on

Call Signature

on(
type,
fn,
context?): this;

Adds a listener function (fn) to a particular event type of the object. You can optionally specify the context of the listener (object the this keyword will point to). You can also pass several space-separated types (e.g. 'click dblclick').

Parameters
ParameterType
type"zoomanim"
fnZoomAnimEventHandlerFn
context?any
Returns

this

Inherited from
L.GridLayer.on

Call Signature

on(
type,
fn,
context?): this;

Adds a listener function (fn) to a particular event type of the object. You can optionally specify the context of the listener (object the this keyword will point to). You can also pass several space-separated types (e.g. 'click dblclick').

Parameters
ParameterType
type"dragend"
fnDragEndEventHandlerFn
context?any
Returns

this

Inherited from
L.GridLayer.on

Call Signature

on(
type,
fn,
context?): this;

Adds a listener function (fn) to a particular event type of the object. You can optionally specify the context of the listener (object the this keyword will point to). You can also pass several space-separated types (e.g. 'click dblclick').

Parameters
ParameterType
type"tileloadstart" | "tileunload" | "tileload" | "tileabort"
fnTileEventHandlerFn
context?any
Returns

this

Inherited from
L.GridLayer.on

Call Signature

on(
type,
fn,
context?): this;

Adds a listener function (fn) to a particular event type of the object. You can optionally specify the context of the listener (object the this keyword will point to). You can also pass several space-separated types (e.g. 'click dblclick').

Parameters
ParameterType
type"tileerror"
fnTileErrorEventHandlerFn
context?any
Returns

this

Inherited from
L.GridLayer.on

Call Signature

on(
type,
fn,
context?): this;

Adds a listener function (fn) to a particular event type of the object. You can optionally specify the context of the listener (object the this keyword will point to). You can also pass several space-separated types (e.g. 'click dblclick').

Parameters
ParameterType
typestring
fnLeafletEventHandlerFn
context?any
Returns

this

Inherited from
L.GridLayer.on

Call Signature

on(eventMap): this;

Adds a set of type/listener pairs, e.g. {click: onClick, mousemove: onMouseMove}

Parameters
ParameterType
eventMapLeafletEventHandlerFnMap
Returns

this

Inherited from
L.GridLayer.on

onAdd()

onAdd(map): ZarrLayer;

Parameters

ParameterType
mapMap

Returns

ZarrLayer

Overrides

L.GridLayer.onAdd

once()

Call Signature

once(
type,
fn,
context?): this;

Behaves as on(...), except the listener will only get fired once and then removed.

Parameters
ParameterType
type"baselayerchange" | "overlayadd" | "overlayremove"
fnLayersControlEventHandlerFn
context?any
Returns

this

Inherited from
L.GridLayer.once

Call Signature

once(
type,
fn,
context?): this;

Behaves as on(...), except the listener will only get fired once and then removed.

Parameters
ParameterType
type"layeradd" | "layerremove"
fnLayerEventHandlerFn
context?any
Returns

this

Inherited from
L.GridLayer.once

Call Signature

once(
type,
fn,
context?): this;

Behaves as on(...), except the listener will only get fired once and then removed.

Parameters
ParameterType
type| "error" | "zoomlevelschange" | "unload" | "viewreset" | "load" | "zoomstart" | "movestart" | "zoom" | "move" | "zoomend" | "moveend" | "autopanstart" | "dragstart" | "drag" | "add" | "remove" | "loading" | "update" | "down" | "predrag"
fnLeafletEventHandlerFn
context?any
Returns

this

Inherited from
L.GridLayer.once

Call Signature

once(
type,
fn,
context?): this;

Behaves as on(...), except the listener will only get fired once and then removed.

Parameters
ParameterType
type"resize"
fnResizeEventHandlerFn
context?any
Returns

this

Inherited from
L.GridLayer.once

Call Signature

once(
type,
fn,
context?): this;

Behaves as on(...), except the listener will only get fired once and then removed.

Parameters
ParameterType
type"popupopen" | "popupclose"
fnPopupEventHandlerFn
context?any
Returns

this

Inherited from
L.GridLayer.once

Call Signature

once(
type,
fn,
context?): this;

Behaves as on(...), except the listener will only get fired once and then removed.

Parameters
ParameterType
type"tooltipopen" | "tooltipclose"
fnTooltipEventHandlerFn
context?any
Returns

this

Inherited from
L.GridLayer.once

Call Signature

once(
type,
fn,
context?): this;

Behaves as on(...), except the listener will only get fired once and then removed.

Parameters
ParameterType
type"locationerror"
fnErrorEventHandlerFn
context?any
Returns

this

Inherited from
L.GridLayer.once

Call Signature

once(
type,
fn,
context?): this;

Behaves as on(...), except the listener will only get fired once and then removed.

Parameters
ParameterType
type"locationfound"
fnLocationEventHandlerFn
context?any
Returns

this

Inherited from
L.GridLayer.once

Call Signature

once(
type,
fn,
context?): this;

Behaves as on(...), except the listener will only get fired once and then removed.

Parameters
ParameterType
type| "click" | "dblclick" | "mousedown" | "mouseup" | "mouseover" | "mouseout" | "mousemove" | "contextmenu" | "preclick"
fnLeafletMouseEventHandlerFn
context?any
Returns

this

Inherited from
L.GridLayer.once

Call Signature

once(
type,
fn,
context?): this;

Behaves as on(...), except the listener will only get fired once and then removed.

Parameters
ParameterType
type"keypress" | "keydown" | "keyup"
fnLeafletKeyboardEventHandlerFn
context?any
Returns

this

Inherited from
L.GridLayer.once

Call Signature

once(
type,
fn,
context?): this;

Behaves as on(...), except the listener will only get fired once and then removed.

Parameters
ParameterType
type"zoomanim"
fnZoomAnimEventHandlerFn
context?any
Returns

this

Inherited from
L.GridLayer.once

Call Signature

once(
type,
fn,
context?): this;

Behaves as on(...), except the listener will only get fired once and then removed.

Parameters
ParameterType
type"dragend"
fnDragEndEventHandlerFn
context?any
Returns

this

Inherited from
L.GridLayer.once

Call Signature

once(
type,
fn,
context?): this;

Behaves as on(...), except the listener will only get fired once and then removed.

Parameters
ParameterType
type"tileloadstart" | "tileunload" | "tileload" | "tileabort"
fnTileEventHandlerFn
context?any
Returns

this

Inherited from
L.GridLayer.once

Call Signature

once(
type,
fn,
context?): this;

Behaves as on(...), except the listener will only get fired once and then removed.

Parameters
ParameterType
type"tileerror"
fnTileEventHandlerFn
context?any
Returns

this

Inherited from
L.GridLayer.once

Call Signature

once(
type,
fn,
context?): this;

Behaves as on(...), except the listener will only get fired once and then removed.

Parameters
ParameterType
typestring
fnLeafletEventHandlerFn
context?any
Returns

this

Inherited from
L.GridLayer.once

Call Signature

once(eventMap): this;

Behaves as on(...), except the listener will only get fired once and then removed.

Parameters
ParameterType
eventMapLeafletEventHandlerFnMap
Returns

this

Inherited from
L.GridLayer.once

onRemove()

onRemove(map): ZarrLayer;

Parameters

ParameterType
mapMap

Returns

ZarrLayer

Overrides

L.GridLayer.onRemove

openPopup()

openPopup(latlng?): this;

Parameters

ParameterType
latlng?LatLngExpression

Returns

this

Inherited from

L.GridLayer.openPopup

openTooltip()

openTooltip(latlng?): this;

Parameters

ParameterType
latlng?LatLngExpression

Returns

this

Inherited from

L.GridLayer.openTooltip

redraw()

redraw(): this;

Returns

this

Inherited from

L.GridLayer.redraw

remove()

remove(): this;

Returns

this

Inherited from

L.GridLayer.remove

removeEventListener()

Call Signature

removeEventListener(
type,
fn?,
context?): this;

Alias for off(...)

Removes a previously added listener function. If no function is specified, it will remove all the listeners of that particular event from the object. Note that if you passed a custom context to on, you must pass the same context to off in order to remove the listener.

Parameters
ParameterType
type"baselayerchange" | "overlayadd" | "overlayremove"
fn?LayersControlEventHandlerFn
context?any
Returns

this

Inherited from
L.GridLayer.removeEventListener

Call Signature

removeEventListener(
type,
fn?,
context?): this;

Alias for off(...)

Removes a previously added listener function. If no function is specified, it will remove all the listeners of that particular event from the object. Note that if you passed a custom context to on, you must pass the same context to off in order to remove the listener.

Parameters
ParameterType
type"layeradd" | "layerremove"
fn?LayerEventHandlerFn
context?any
Returns

this

Inherited from
L.GridLayer.removeEventListener

Call Signature

removeEventListener(
type,
fn?,
context?): this;

Alias for off(...)

Removes a previously added listener function. If no function is specified, it will remove all the listeners of that particular event from the object. Note that if you passed a custom context to on, you must pass the same context to off in order to remove the listener.

Parameters
ParameterType
type| "error" | "zoomlevelschange" | "unload" | "viewreset" | "load" | "zoomstart" | "movestart" | "zoom" | "move" | "zoomend" | "moveend" | "autopanstart" | "dragstart" | "drag" | "add" | "remove" | "loading" | "update" | "down" | "predrag"
fn?LeafletEventHandlerFn
context?any
Returns

this

Inherited from
L.GridLayer.removeEventListener

Call Signature

removeEventListener(
type,
fn?,
context?): this;

Alias for off(...)

Removes a previously added listener function. If no function is specified, it will remove all the listeners of that particular event from the object. Note that if you passed a custom context to on, you must pass the same context to off in order to remove the listener.

Parameters
ParameterType
type"resize"
fn?ResizeEventHandlerFn
context?any
Returns

this

Inherited from
L.GridLayer.removeEventListener

Call Signature

removeEventListener(
type,
fn?,
context?): this;

Alias for off(...)

Removes a previously added listener function. If no function is specified, it will remove all the listeners of that particular event from the object. Note that if you passed a custom context to on, you must pass the same context to off in order to remove the listener.

Parameters
ParameterType
type"popupopen" | "popupclose"
fn?PopupEventHandlerFn
context?any
Returns

this

Inherited from
L.GridLayer.removeEventListener

Call Signature

removeEventListener(
type,
fn?,
context?): this;

Alias for off(...)

Removes a previously added listener function. If no function is specified, it will remove all the listeners of that particular event from the object. Note that if you passed a custom context to on, you must pass the same context to off in order to remove the listener.

Parameters
ParameterType
type"tooltipopen" | "tooltipclose"
fn?TooltipEventHandlerFn
context?any
Returns

this

Inherited from
L.GridLayer.removeEventListener

Call Signature

removeEventListener(
type,
fn?,
context?): this;

Alias for off(...)

Removes a previously added listener function. If no function is specified, it will remove all the listeners of that particular event from the object. Note that if you passed a custom context to on, you must pass the same context to off in order to remove the listener.

Parameters
ParameterType
type"locationerror"
fn?ErrorEventHandlerFn
context?any
Returns

this

Inherited from
L.GridLayer.removeEventListener

Call Signature

removeEventListener(
type,
fn?,
context?): this;

Alias for off(...)

Removes a previously added listener function. If no function is specified, it will remove all the listeners of that particular event from the object. Note that if you passed a custom context to on, you must pass the same context to off in order to remove the listener.

Parameters
ParameterType
type"locationfound"
fn?LocationEventHandlerFn
context?any
Returns

this

Inherited from
L.GridLayer.removeEventListener

Call Signature

removeEventListener(
type,
fn?,
context?): this;

Alias for off(...)

Removes a previously added listener function. If no function is specified, it will remove all the listeners of that particular event from the object. Note that if you passed a custom context to on, you must pass the same context to off in order to remove the listener.

Parameters
ParameterType
type| "click" | "dblclick" | "mousedown" | "mouseup" | "mouseover" | "mouseout" | "mousemove" | "contextmenu" | "preclick"
fn?LeafletMouseEventHandlerFn
context?any
Returns

this

Inherited from
L.GridLayer.removeEventListener

Call Signature

removeEventListener(
type,
fn?,
context?): this;

Alias for off(...)

Removes a previously added listener function. If no function is specified, it will remove all the listeners of that particular event from the object. Note that if you passed a custom context to on, you must pass the same context to off in order to remove the listener.

Parameters
ParameterType
type"keypress" | "keydown" | "keyup"
fn?LeafletKeyboardEventHandlerFn
context?any
Returns

this

Inherited from
L.GridLayer.removeEventListener

Call Signature

removeEventListener(
type,
fn?,
context?): this;

Alias for off(...)

Removes a previously added listener function. If no function is specified, it will remove all the listeners of that particular event from the object. Note that if you passed a custom context to on, you must pass the same context to off in order to remove the listener.

Parameters
ParameterType
type"zoomanim"
fn?ZoomAnimEventHandlerFn
context?any
Returns

this

Inherited from
L.GridLayer.removeEventListener

Call Signature

removeEventListener(
type,
fn?,
context?): this;

Alias for off(...)

Removes a previously added listener function. If no function is specified, it will remove all the listeners of that particular event from the object. Note that if you passed a custom context to on, you must pass the same context to off in order to remove the listener.

Parameters
ParameterType
type"dragend"
fn?DragEndEventHandlerFn
context?any
Returns

this

Inherited from
L.GridLayer.removeEventListener

Call Signature

removeEventListener(
type,
fn?,
context?): this;

Alias for off(...)

Removes a previously added listener function. If no function is specified, it will remove all the listeners of that particular event from the object. Note that if you passed a custom context to on, you must pass the same context to off in order to remove the listener.

Parameters
ParameterType
type"tileloadstart" | "tileunload" | "tileload" | "tileabort"
fn?TileEventHandlerFn
context?any
Returns

this

Inherited from
L.GridLayer.removeEventListener

Call Signature

removeEventListener(
type,
fn?,
context?): this;

Alias for off(...)

Removes a previously added listener function. If no function is specified, it will remove all the listeners of that particular event from the object. Note that if you passed a custom context to on, you must pass the same context to off in order to remove the listener.

Parameters
ParameterType
type"tileerror"
fn?TileErrorEventHandlerFn
context?any
Returns

this

Inherited from
L.GridLayer.removeEventListener

Call Signature

removeEventListener(
type,
fn?,
context?): this;

Alias for off(...)

Removes a previously added listener function. If no function is specified, it will remove all the listeners of that particular event from the object. Note that if you passed a custom context to on, you must pass the same context to off in order to remove the listener.

Parameters
ParameterType
typestring
fn?LeafletEventHandlerFn
context?any
Returns

this

Inherited from
L.GridLayer.removeEventListener

Call Signature

removeEventListener(eventMap): this;

Alias for off(...)

Removes a set of type/listener pairs.

Parameters
ParameterType
eventMapLeafletEventHandlerFnMap
Returns

this

Inherited from
L.GridLayer.removeEventListener

removeEventParent()

removeEventParent(obj): this;

Removes an event parent, so it will stop receiving propagated events

Parameters

ParameterType
objEvented

Returns

this

Inherited from

L.GridLayer.removeEventParent

removeFrom()

removeFrom(map): this;

Parameters

ParameterType
mapMap

Returns

this

Inherited from

L.GridLayer.removeFrom

removeInteractiveTarget()

removeInteractiveTarget(targetEl): this;

Parameters

ParameterType
targetElHTMLElement

Returns

this

Inherited from

L.GridLayer.removeInteractiveTarget

setOpacity()

setOpacity(opacity): this;

Parameters

ParameterType
opacitynumber

Returns

this

Inherited from

L.GridLayer.setOpacity

setPopupContent()

setPopupContent(content): this;

Parameters

ParameterType
contentContent | Popup

Returns

this

Inherited from

L.GridLayer.setPopupContent

setTooltipContent()

setTooltipContent(content): this;

Parameters

ParameterType
contentContent | Tooltip

Returns

this

Inherited from

L.GridLayer.setTooltipContent

setZIndex()

setZIndex(zIndex): this;

Parameters

ParameterType
zIndexnumber

Returns

this

Inherited from

L.GridLayer.setZIndex

togglePopup()

togglePopup(): this;

Returns

this

Inherited from

L.GridLayer.togglePopup

toggleTooltip()

toggleTooltip(): this;

Returns

this

Inherited from

L.GridLayer.toggleTooltip

unbindPopup()

unbindPopup(): this;

Returns

this

Inherited from

L.GridLayer.unbindPopup

unbindTooltip()

unbindTooltip(): this;

Returns

this

Inherited from

L.GridLayer.unbindTooltip

updateSelectors()

updateSelectors(selectors): void;

Update the selectors used for slicing the Zarr dataset.

Parameters

ParameterTypeDescription
selectorsZarrSelectorsNew selectors to apply.

Returns

void


updateStyle()

updateStyle(opts): void;

Update the visual style of the layer.

Parameters

ParameterTypeDescription
opts&#123; colormap?: string; opacity?: number; scale?: [number, number]; &#125;Style options to update.
opts.colormap?stringColormap name.
opts.opacity?numberLayer opacity.
opts.scale?[number, number][min, max] range for data scaling.

Returns

void


addInitHook()

Call Signature

static addInitHook(initHookFn): any;
Parameters
ParameterType
initHookFn() => void
Returns

any

Inherited from
L.GridLayer.addInitHook

Call Signature

static addInitHook(methodName, ...args): any;
Parameters
ParameterType
methodNamestring
...argsany[]
Returns

any

Inherited from
L.GridLayer.addInitHook

callInitHooks()

static callInitHooks(): void;

Returns

void

Inherited from

L.GridLayer.callInitHooks

extend()

static extend(props): (...args) => any & typeof Class;

Parameters

ParameterType
propsany

Returns

(...args) => any & typeof Class

Inherited from

L.GridLayer.extend

include()

static include(props): any;

Parameters

ParameterType
propsany

Returns

any

Inherited from

L.GridLayer.include

mergeOptions()

static mergeOptions(props): any;

Parameters

ParameterType
propsany

Returns

any

Inherited from

L.GridLayer.mergeOptions

Properties

_map

protected _map: Map;

Inherited from

L.GridLayer._map

_tiles

protected _tiles: InternalTiles;

Inherited from

L.GridLayer._tiles

_tileZoom?

protected optional _tileZoom: number;

Inherited from

L.GridLayer._tileZoom

options

options: LayerOptions;

Inherited from

L.GridLayer.options

provider

provider: ZarrLayerProvider;