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
| Parameter | Type |
|---|---|
options | LeafletLayerOptions & GridLayerOptions |
Returns
ZarrLayer
Overrides
L.GridLayer.constructor
Methods
_removeTile()
_removeTile(key): any;
Parameters
| Parameter | Type |
|---|---|
key | string |
Returns
any
_tileCoordsToKey()
protected _tileCoordsToKey(coords): string;
Parameters
| Parameter | Type |
|---|---|
coords | Coords |
Returns
string
Inherited from
L.GridLayer._tileCoordsToKey
_wrapCoords()
protected _wrapCoords(parameter): Coords;
Parameters
| Parameter | Type |
|---|---|
parameter | Coords |
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
| Parameter | Type |
|---|---|
type | "baselayerchange" | "overlayadd" | "overlayremove" |
fn | LayersControlEventHandlerFn |
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
| Parameter | Type |
|---|---|
type | "layeradd" | "layerremove" |
fn | LayerEventHandlerFn |
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
| Parameter | Type |
|---|---|
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.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
| Parameter | Type |
|---|---|
type | "resize" |
fn | ResizeEventHandlerFn |
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
| Parameter | Type |
|---|---|
type | "popupopen" | "popupclose" |
fn | PopupEventHandlerFn |
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
| Parameter | Type |
|---|---|
type | "tooltipopen" | "tooltipclose" |
fn | TooltipEventHandlerFn |
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
| Parameter | Type |
|---|---|
type | "locationerror" |
fn | ErrorEventHandlerFn |
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
| Parameter | Type |
|---|---|
type | "locationfound" |
fn | LocationEventHandlerFn |
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
| Parameter | Type |
|---|---|
type | | "click" | "dblclick" | "mousedown" | "mouseup" | "mouseover" | "mouseout" | "mousemove" | "contextmenu" | "preclick" |
fn | LeafletMouseEventHandlerFn |
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
| Parameter | Type |
|---|---|
type | "keypress" | "keydown" | "keyup" |
fn | LeafletKeyboardEventHandlerFn |
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
| Parameter | Type |
|---|---|
type | "zoomanim" |
fn | ZoomAnimEventHandlerFn |
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
| Parameter | Type |
|---|---|
type | "dragend" |
fn | DragEndEventHandlerFn |
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
| Parameter | Type |
|---|---|
type | "tileloadstart" | "tileunload" | "tileload" | "tileabort" |
fn | TileEventHandlerFn |
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
| Parameter | Type |
|---|---|
type | "tileerror" |
fn | TileErrorEventHandlerFn |
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
| Parameter | Type |
|---|---|
type | string |
fn | LeafletEventHandlerFn |
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
| Parameter | Type |
|---|---|
eventMap | LeafletEventHandlerFnMap |
Returns
this
Inherited from
L.GridLayer.addEventListener
addEventParent()
addEventParent(obj): this;
Adds an event parent - an Evented that will receive propagated events
Parameters
| Parameter | Type |
|---|---|
obj | Evented |
Returns
this
Inherited from
L.GridLayer.addEventParent
addInteractiveTarget()
addInteractiveTarget(targetEl): this;
Parameters
| Parameter | Type |
|---|---|
targetEl | HTMLElement |
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
| Parameter | Type |
|---|---|
type | "baselayerchange" | "overlayadd" | "overlayremove" |
fn | LayersControlEventHandlerFn |
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
| Parameter | Type |
|---|---|
type | "layeradd" | "layerremove" |
fn | LayerEventHandlerFn |
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
| Parameter | Type |
|---|---|
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.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
| Parameter | Type |
|---|---|
type | "resize" |
fn | ResizeEventHandlerFn |
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
| Parameter | Type |
|---|---|
type | "popupopen" | "popupclose" |
fn | PopupEventHandlerFn |
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
| Parameter | Type |
|---|---|
type | "tooltipopen" | "tooltipclose" |
fn | TooltipEventHandlerFn |
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
| Parameter | Type |
|---|---|
type | "locationerror" |
fn | ErrorEventHandlerFn |
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
| Parameter | Type |
|---|---|
type | "locationfound" |
fn | LocationEventHandlerFn |
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
| Parameter | Type |
|---|---|
type | | "click" | "dblclick" | "mousedown" | "mouseup" | "mouseover" | "mouseout" | "mousemove" | "contextmenu" | "preclick" |
fn | LeafletMouseEventHandlerFn |
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
| Parameter | Type |
|---|---|
type | "keypress" | "keydown" | "keyup" |
fn | LeafletKeyboardEventHandlerFn |
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
| Parameter | Type |
|---|---|
type | "zoomanim" |
fn | ZoomAnimEventHandlerFn |
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
| Parameter | Type |
|---|---|
type | "dragend" |
fn | DragEndEventHandlerFn |
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
| Parameter | Type |
|---|---|
type | "tileloadstart" | "tileunload" | "tileload" | "tileabort" |
fn | TileEventHandlerFn |
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
| Parameter | Type |
|---|---|
type | "tileerror" |
fn | TileErrorEventHandlerFn |
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
| Parameter | Type |
|---|---|
type | string |
fn | LeafletEventHandlerFn |
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
| Parameter | Type |
|---|---|
eventMap | LeafletEventHandlerFnMap |
Returns
this
Inherited from
L.GridLayer.addOneTimeEventListener
addTo()
addTo(map): this;
Parameters
| Parameter | Type |
|---|---|
map | Map | LayerGroup<any> |
Returns
this
Inherited from
L.GridLayer.addTo
beforeAdd()?
optional beforeAdd(map): this;
Parameters
| Parameter | Type |
|---|---|
map | Map |
Returns
this
Inherited from
L.GridLayer.beforeAdd
bindPopup()
bindPopup(content, options?): this;
Parameters
| Parameter | Type |
|---|---|
content | (layer) => Content | Content | Popup |
options? | PopupOptions |
Returns
this
Inherited from
L.GridLayer.bindPopup
bindTooltip()
bindTooltip(content, options?): this;
Parameters
| Parameter | Type |
|---|---|
content | Content | (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
| Parameter | Type |
|---|---|
coords | Coords |
done | DoneCallback |
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
| Parameter | Type |
|---|---|
type | string |
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
| Parameter | Type |
|---|---|
type | string |
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
| Parameter | Type |
|---|---|
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
| Parameter | Type |
|---|---|
type | string |
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
| Parameter | Type |
|---|---|
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
| Parameter | Type |
|---|---|
type | "baselayerchange" | "overlayadd" | "overlayremove" |
fn | LayersControlEventHandlerFn |
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
| Parameter | Type |
|---|---|
type | "layeradd" | "layerremove" |
fn | LayerEventHandlerFn |
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
| Parameter | Type |
|---|---|
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 |
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
| Parameter | Type |
|---|---|
type | "resize" |
fn | ResizeEventHandlerFn |
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
| Parameter | Type |
|---|---|
type | "popupopen" | "popupclose" |
fn | PopupEventHandlerFn |
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
| Parameter | Type |
|---|---|
type | "tooltipopen" | "tooltipclose" |
fn | TooltipEventHandlerFn |
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
| Parameter | Type |
|---|---|
type | "locationerror" |
fn | ErrorEventHandlerFn |
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
| Parameter | Type |
|---|---|
type | "locationfound" |
fn | LocationEventHandlerFn |
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
| Parameter | Type |
|---|---|
type | | "click" | "dblclick" | "mousedown" | "mouseup" | "mouseover" | "mouseout" | "mousemove" | "contextmenu" | "preclick" |
fn | LeafletMouseEventHandlerFn |
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
| Parameter | Type |
|---|---|
type | "keypress" | "keydown" | "keyup" |
fn | LeafletKeyboardEventHandlerFn |
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
| Parameter | Type |
|---|---|
type | "zoomanim" |
fn | ZoomAnimEventHandlerFn |
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
| Parameter | Type |
|---|---|
type | "dragend" |
fn | DragEndEventHandlerFn |
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
| Parameter | Type |
|---|---|
type | "tileloadstart" | "tileunload" | "tileload" | "tileabort" |
fn | TileEventHandlerFn |
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
| Parameter | Type |
|---|---|
type | "tileerror" |
fn | TileEventHandlerFn |
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
| Parameter | Type |
|---|---|
type | string |
fn | LeafletEventHandlerFn |
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
| Parameter | Type |
|---|---|
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
| Parameter | Type |
|---|---|
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
| Parameter | Type |
|---|---|
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
| Parameter | Type |
|---|---|
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
| Parameter | Type |
|---|---|
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
| Parameter | Type |
|---|---|
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
| Parameter | Type |
|---|---|
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
| Parameter | Type |
|---|---|
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
| Parameter | Type |
|---|---|
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
| Parameter | Type |
|---|---|
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
| Parameter | Type |
|---|---|
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
| Parameter | Type |
|---|---|
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
| Parameter | Type |
|---|---|
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
| Parameter | Type |
|---|---|
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
| Parameter | Type |
|---|---|
type | string |
fn? | LeafletEventHandlerFn |
context? | any |
Returns
this
Inherited from
L.GridLayer.off
Call Signature
off(eventMap): this;
Removes a set of type/listener pairs.
Parameters
| Parameter | Type |
|---|---|
eventMap | LeafletEventHandlerFnMap |
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
| Parameter | Type |
|---|---|
type | "baselayerchange" | "overlayadd" | "overlayremove" |
fn | LayersControlEventHandlerFn |
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
| Parameter | Type |
|---|---|
type | "layeradd" | "layerremove" |
fn | LayerEventHandlerFn |
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
| Parameter | Type |
|---|---|
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.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
| Parameter | Type |
|---|---|
type | "resize" |
fn | ResizeEventHandlerFn |
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
| Parameter | Type |
|---|---|
type | "popupopen" | "popupclose" |
fn | PopupEventHandlerFn |
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
| Parameter | Type |
|---|---|
type | "tooltipopen" | "tooltipclose" |
fn | TooltipEventHandlerFn |
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
| Parameter | Type |
|---|---|
type | "locationerror" |
fn | ErrorEventHandlerFn |
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
| Parameter | Type |
|---|---|
type | "locationfound" |
fn | LocationEventHandlerFn |
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
| Parameter | Type |
|---|---|
type | | "click" | "dblclick" | "mousedown" | "mouseup" | "mouseover" | "mouseout" | "mousemove" | "contextmenu" | "preclick" |
fn | LeafletMouseEventHandlerFn |
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
| Parameter | Type |
|---|---|
type | "keypress" | "keydown" | "keyup" |
fn | LeafletKeyboardEventHandlerFn |
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
| Parameter | Type |
|---|---|
type | "zoomanim" |
fn | ZoomAnimEventHandlerFn |
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
| Parameter | Type |
|---|---|
type | "dragend" |
fn | DragEndEventHandlerFn |
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
| Parameter | Type |
|---|---|
type | "tileloadstart" | "tileunload" | "tileload" | "tileabort" |
fn | TileEventHandlerFn |
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
| Parameter | Type |
|---|---|
type | "tileerror" |
fn | TileErrorEventHandlerFn |
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
| Parameter | Type |
|---|---|
type | string |
fn | LeafletEventHandlerFn |
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
| Parameter | Type |
|---|---|
eventMap | LeafletEventHandlerFnMap |
Returns
this
Inherited from
L.GridLayer.on
onAdd()
onAdd(map): ZarrLayer;
Parameters
| Parameter | Type |
|---|---|
map | Map |
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
| Parameter | Type |
|---|---|
type | "baselayerchange" | "overlayadd" | "overlayremove" |
fn | LayersControlEventHandlerFn |
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
| Parameter | Type |
|---|---|
type | "layeradd" | "layerremove" |
fn | LayerEventHandlerFn |
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
| Parameter | Type |
|---|---|
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.once
Call Signature
once(
type,
fn,
context?): this;
Behaves as on(...), except the listener will only get fired once and then removed.
Parameters
| Parameter | Type |
|---|---|
type | "resize" |
fn | ResizeEventHandlerFn |
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
| Parameter | Type |
|---|---|
type | "popupopen" | "popupclose" |
fn | PopupEventHandlerFn |
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
| Parameter | Type |
|---|---|
type | "tooltipopen" | "tooltipclose" |
fn | TooltipEventHandlerFn |
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
| Parameter | Type |
|---|---|
type | "locationerror" |
fn | ErrorEventHandlerFn |
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
| Parameter | Type |
|---|---|
type | "locationfound" |
fn | LocationEventHandlerFn |
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
| Parameter | Type |
|---|---|
type | | "click" | "dblclick" | "mousedown" | "mouseup" | "mouseover" | "mouseout" | "mousemove" | "contextmenu" | "preclick" |
fn | LeafletMouseEventHandlerFn |
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
| Parameter | Type |
|---|---|
type | "keypress" | "keydown" | "keyup" |
fn | LeafletKeyboardEventHandlerFn |
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
| Parameter | Type |
|---|---|
type | "zoomanim" |
fn | ZoomAnimEventHandlerFn |
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
| Parameter | Type |
|---|---|
type | "dragend" |
fn | DragEndEventHandlerFn |
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
| Parameter | Type |
|---|---|
type | "tileloadstart" | "tileunload" | "tileload" | "tileabort" |
fn | TileEventHandlerFn |
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
| Parameter | Type |
|---|---|
type | "tileerror" |
fn | TileEventHandlerFn |
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
| Parameter | Type |
|---|---|
type | string |
fn | LeafletEventHandlerFn |
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
| Parameter | Type |
|---|---|
eventMap | LeafletEventHandlerFnMap |
Returns
this
Inherited from
L.GridLayer.once
onRemove()
onRemove(map): ZarrLayer;
Parameters
| Parameter | Type |
|---|---|
map | Map |
Returns
ZarrLayer
Overrides
L.GridLayer.onRemove
openPopup()
openPopup(latlng?): this;
Parameters
| Parameter | Type |
|---|---|
latlng? | LatLngExpression |
Returns
this
Inherited from
L.GridLayer.openPopup
openTooltip()
openTooltip(latlng?): this;
Parameters
| Parameter | Type |
|---|---|
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
| Parameter | Type |
|---|---|
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
| Parameter | Type |
|---|---|
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
| Parameter | Type |
|---|---|
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
| Parameter | Type |
|---|---|
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
| Parameter | Type |
|---|---|
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
| Parameter | Type |
|---|---|
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
| Parameter | Type |
|---|---|
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
| Parameter | Type |
|---|---|
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
| Parameter | Type |
|---|---|
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
| Parameter | Type |
|---|---|
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
| Parameter | Type |
|---|---|
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
| Parameter | Type |
|---|---|
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
| Parameter | Type |
|---|---|
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
| Parameter | Type |
|---|---|
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
| Parameter | Type |
|---|---|
type | string |
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
| Parameter | Type |
|---|---|
eventMap | LeafletEventHandlerFnMap |
Returns
this
Inherited from
L.GridLayer.removeEventListener
removeEventParent()
removeEventParent(obj): this;
Removes an event parent, so it will stop receiving propagated events
Parameters
| Parameter | Type |
|---|---|
obj | Evented |
Returns
this
Inherited from
L.GridLayer.removeEventParent
removeFrom()
removeFrom(map): this;
Parameters
| Parameter | Type |
|---|---|
map | Map |
Returns
this
Inherited from
L.GridLayer.removeFrom
removeInteractiveTarget()
removeInteractiveTarget(targetEl): this;
Parameters
| Parameter | Type |
|---|---|
targetEl | HTMLElement |
Returns
this
Inherited from
L.GridLayer.removeInteractiveTarget
setOpacity()
setOpacity(opacity): this;
Parameters
| Parameter | Type |
|---|---|
opacity | number |
Returns
this
Inherited from
L.GridLayer.setOpacity
setPopupContent()
setPopupContent(content): this;
Parameters
| Parameter | Type |
|---|---|
content | Content | Popup |
Returns
this
Inherited from
L.GridLayer.setPopupContent
setTooltipContent()
setTooltipContent(content): this;
Parameters
| Parameter | Type |
|---|---|
content | Content | Tooltip |
Returns
this
Inherited from
L.GridLayer.setTooltipContent
setZIndex()
setZIndex(zIndex): this;
Parameters
| Parameter | Type |
|---|---|
zIndex | number |
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
| Parameter | Type | Description |
|---|---|---|
selectors | ZarrSelectors | New selectors to apply. |
Returns
void
updateStyle()
updateStyle(opts): void;
Update the visual style of the layer.
Parameters
| Parameter | Type | Description |
|---|---|---|
opts | { colormap?: string; opacity?: number; scale?: [number, number]; } | Style options to update. |
opts.colormap? | string | Colormap name. |
opts.opacity? | number | Layer opacity. |
opts.scale? | [number, number] | [min, max] range for data scaling. |
Returns
void
addInitHook()
Call Signature
static addInitHook(initHookFn): any;
Parameters
| Parameter | Type |
|---|---|
initHookFn | () => void |
Returns
any
Inherited from
L.GridLayer.addInitHook
Call Signature
static addInitHook(methodName, ...args): any;
Parameters
| Parameter | Type |
|---|---|
methodName | string |
...args | any[] |
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
| Parameter | Type |
|---|---|
props | any |
Returns
(...args) => any & typeof Class
Inherited from
L.GridLayer.extend
include()
static include(props): any;
Parameters
| Parameter | Type |
|---|---|
props | any |
Returns
any
Inherited from
L.GridLayer.include
mergeOptions()
static mergeOptions(props): any;
Parameters
| Parameter | Type |
|---|---|
props | any |
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;