ZarrLayer

OpenLayers Zarr tile layer using the shared ZarrLayerProvider.

Remarks

This class extends TileLayer<XYZ> 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 OLLayerOptions.

Extends

• TileLayer<XYZ>

Constructors

Constructor

new ZarrLayer(options): ZarrLayer;

Parameters

Parameter	Type
options	OLLayerOptions

Returns

ZarrLayer

Overrides

TileLayer<XYZ>.constructor

Methods

addChangeListener()

addChangeListener(key, listener): void;

Parameters

Parameter	Type	Description
key	string	Key name.
listener	Listener	Listener.

Returns

void

Inherited from

TileLayer.addChangeListener

---

addEventListener()

addEventListener(type, listener): void;

Parameters

Parameter	Type	Description
type	string	Type.
listener	Listener	Listener.

Returns

void

Inherited from

TileLayer.addEventListener

---

applyProperties()

protected applyProperties(source): void;

Apply any properties from another object without triggering events.

Parameters

Parameter	Type	Description
source	BaseObject	The source object.

Returns

void

Inherited from

TileLayer.applyProperties

---

changed()

changed(): void;

Increases the revision counter and dispatches a 'change' event.

Returns

void

Api

Inherited from

TileLayer.changed

---

clearRenderer()

clearRenderer(): void;

This will clear the renderer so that a new one can be created next time it is needed

Returns

void

Inherited from

TileLayer.clearRenderer

---

createRenderer()

createRenderer(): CanvasTileLayerRenderer<ZarrLayer>;

Returns

CanvasTileLayerRenderer<ZarrLayer>

Inherited from

TileLayer.createRenderer

---

dispatchEvent()

dispatchEvent(event): boolean | undefined;

Dispatches an event and calls all listeners listening for events of this type. The event parameter can either be a string or an Object with a type property.

Parameters

Parameter	Type	Description
event	string | BaseEvent	Event object.

Returns

boolean | undefined

false if anyone called preventDefault on the event object or if any of the listeners returned false.

Api

Inherited from

TileLayer.dispatchEvent

---

dispose()

dispose(): void;

Clean up.

Returns

void

Inherited from

TileLayer.dispose

---

disposeInternal()

protected disposeInternal(): void;

Extension point for disposable objects.

Returns

void

Overrides

TileLayer.disposeInternal

---

get()

get(key): any;

Gets a value.

Parameters

Parameter	Type	Description
key	string	Key name.

Returns

any

Value.

Api

Inherited from

TileLayer.get

---

getAttributions()

getAttributions(view?): string[];

Get the attributions of the source of this layer for the given view.

Parameters

Parameter	Type	Description
view?	View | ViewStateLayerStateExtent	View or import("../Map.js").FrameState. Only required when the layer is not added to a map.

Returns

string[]

Attributions for this layer at the given view.

Api

Inherited from

TileLayer.getAttributions

---

getBackground()

getBackground(): false | BackgroundColor;

Get the background for this layer.

Returns

false | BackgroundColor

Layer background.

Inherited from

TileLayer.getBackground

---

getCacheSize()

protected getCacheSize(): number | undefined;

Returns

number | undefined

The suggested cache size

Inherited from

TileLayer.getCacheSize

---

getClassName()

getClassName(): string;

Returns

string

CSS class name.

Inherited from

TileLayer.getClassName

---

getData()

getData(pixel): 
  | Uint8Array<ArrayBufferLike>
  | Float32Array<ArrayBufferLike>
  | Uint8ClampedArray<ArrayBufferLike>
  | DataView<ArrayBufferLike>
  | null;

Parameters

Parameter	Type	Description
pixel	Pixel	Pixel.

Returns

| Uint8Array<ArrayBufferLike> | Float32Array<ArrayBufferLike> | Uint8ClampedArray<ArrayBufferLike> | DataView<ArrayBufferLike> | null

Pixel data.

Inherited from

TileLayer.getData

---

getDeclutter()

getDeclutter(): string;

Returns

string

Declutter

Inherited from

TileLayer.getDeclutter

---

getExtent()

getExtent(): Extent | undefined;

Return the module:ol/extent~Extent extent of the layer or undefined if it will be visible regardless of extent.

Returns

Extent | undefined

The layer extent.

Observable

Api

Inherited from

TileLayer.getExtent

---

getFeatures()

getFeatures(pixel): Promise<FeatureLike[]>;

Parameters

Parameter	Type	Description
pixel	Pixel	Pixel.

Returns

Promise<FeatureLike[]>

Promise that resolves with an array of features.

Inherited from

TileLayer.getFeatures

---

getKeys()

getKeys(): string[];

Get a list of object property names.

Returns

string[]

List of property names.

Api

Inherited from

TileLayer.getKeys

---

getLayersArray()

abstract getLayersArray(array?): Layer<Source, LayerRenderer<any>>[];

Parameters

Parameter	Type	Description
array?	Layer<Source, LayerRenderer<any>>[]	Array of layers (to be modified in place).

Returns

Layer<Source, LayerRenderer<any>>[]

Array of layers.

Inherited from

TileLayer.getLayersArray

---

getLayerState()

getLayerState(managed?): State;

This method is not meant to be called by layers or layer renderers because the state is incorrect if the layer is included in a layer group.

Parameters

Parameter	Type	Description
managed?	boolean	Layer is managed.

Returns

State

Layer state.

Inherited from

TileLayer.getLayerState

---

getLayerStatesArray()

abstract getLayerStatesArray(states?): State[];

Parameters

Parameter	Type	Description
states?	State[]	Optional list of layer states (to be modified in place).

Returns

State[]

List of layer states.

Inherited from

TileLayer.getLayerStatesArray

---

getListeners()

getListeners(type): Listener[] | undefined;

Get the listeners for a specified event type. Listeners are returned in the order that they will be called in.

Parameters

Parameter	Type	Description
type	string	Type.

Returns

Listener[] | undefined

Listeners.

Inherited from

TileLayer.getListeners

---

getMapInternal()

getMapInternal(): Map | null;

For use inside the library only.

Returns

Map | null

Map.

Inherited from

TileLayer.getMapInternal

---

getMaxResolution()

getMaxResolution(): number;

Return the maximum resolution of the layer. Returns Infinity if the layer has no maximum resolution set.

Returns

number

The maximum resolution of the layer.

Observable

Api

Inherited from

TileLayer.getMaxResolution

---

getMaxZoom()

getMaxZoom(): number;

Return the maximum zoom level of the layer. Returns Infinity if the layer has no maximum zoom set.

Returns

number

The maximum zoom level of the layer.

Observable

Api

Inherited from

TileLayer.getMaxZoom

---

getMinResolution()

getMinResolution(): number;

Return the minimum resolution of the layer. Returns 0 if the layer has no minimum resolution set.

Returns

number

The minimum resolution of the layer.

Observable

Api

Inherited from

TileLayer.getMinResolution

---

getMinZoom()

getMinZoom(): number;

Return the minimum zoom level of the layer. Returns -Infinity if the layer has no minimum zoom set.

Returns

number

The minimum zoom level of the layer.

Observable

Api

Inherited from

TileLayer.getMinZoom

---

getOpacity()

getOpacity(): number;

Return the opacity of the layer (between 0 and 1).

Returns

number

The opacity of the layer.

Observable

Api

Inherited from

TileLayer.getOpacity

---

getPreload()

getPreload(): number;

Return the level as number to which we will preload tiles up to.

Returns

number

The level to preload tiles up to.

Observable

Api

Inherited from

TileLayer.getPreload

---

getProperties()

getProperties(): object;

Get an object of all property names and values.

Returns

object

Object.

Api

Inherited from

TileLayer.getProperties

---

getPropertiesInternal()

getPropertiesInternal(): 
  | {
[x: string]: any;
}
  | null;

Get an object of all property names and values.

Returns

| &#123; [x: string]: any; &#125; | null

Object.

Inherited from

TileLayer.getPropertiesInternal

---

getRenderer()

getRenderer(): 
  | CanvasTileLayerRenderer<
  | TileLayer<TileSource<Tile>>
  | VectorTileLayer<VectorTile<any>, any>>
  | null;

Get the renderer for this layer.

Returns

| CanvasTileLayerRenderer< | TileLayer<TileSource<Tile>> | VectorTileLayer<VectorTile<any>, any>> | null

The layer renderer.

Inherited from

TileLayer.getRenderer

---

getRenderSource()

getRenderSource(): XYZ | null;

Returns

XYZ | null

The source being rendered.

Inherited from

TileLayer.getRenderSource

---

getRevision()

getRevision(): number;

Get the version number for this object. Each time the object is modified, its version number will be incremented.

Returns

number

Revision.

Api

Inherited from

TileLayer.getRevision

---

getSource()

getSource(): XYZ | null;

Get the layer source.

Returns

XYZ | null

The layer source (or null if not yet set).

Observable

Api

Inherited from

TileLayer.getSource

---

getSourceState()

abstract getSourceState(): State;

Returns

State

Source state.

Inherited from

TileLayer.getSourceState

---

getUseInterimTilesOnError()

getUseInterimTilesOnError(): boolean;

Deprecated. Whether we use interim tiles on error.

Returns

boolean

Use interim tiles on error.

Observable

Api

Inherited from

TileLayer.getUseInterimTilesOnError

---

getVisible()

getVisible(): boolean;

Return the value of this layer's visible property. To find out whether the layer is visible on a map, use isVisible() instead.

Returns

boolean

The value of the visible property of the layer.

Observable

Api

Inherited from

TileLayer.getVisible

---

getZIndex()

getZIndex(): number | undefined;

Return the Z-index of the layer, which is used to order layers before rendering. Returns undefined if the layer is unmanaged.

Returns

number | undefined

The Z-index of the layer.

Observable

Api

Inherited from

TileLayer.getZIndex

---

hasListener()

hasListener(type?): boolean;

Parameters

Parameter	Type	Description
type?	string	Type. If not provided, true will be returned if this event target has any listeners.

Returns

boolean

Has listeners.

Inherited from

TileLayer.hasListener

---

hasProperties()

hasProperties(): boolean;

Returns

boolean

The object has properties.

Inherited from

TileLayer.hasProperties

---

hasRenderer()

hasRenderer(): boolean;

Returns

boolean

The layer has a renderer.

Inherited from

TileLayer.hasRenderer

---

isVisible()

isVisible(view?): boolean;

The layer is visible on the map view, i.e. within its min/max resolution or zoom and extent, not set to visible: false, and not inside a layer group that is set to visible: false.

Parameters

Parameter	Type	Description
view?	View | ViewStateLayerStateExtent	View or import("../Map.js").FrameState. Only required when the layer is not added to a map.

Returns

boolean

The layer is visible in the map view.

Api

Inherited from

TileLayer.isVisible

---

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.

---

notify()

notify(key, oldValue): void;

Parameters

Parameter	Type	Description
key	string	Key name.
oldValue	any	Old value.

Returns

void

Inherited from

TileLayer.notify

---

onceInternal()

protected onceInternal(type, listener): EventsKey | EventsKey[];

Parameters

Parameter	Type	Description
type	string | string[]	Type.
listener	(arg0) => unknown	Listener.

Returns

EventsKey | EventsKey[]

Event key.

Inherited from

TileLayer.onceInternal

---

onInternal()

protected onInternal(type, listener): EventsKey | EventsKey[];

Parameters

Parameter	Type	Description
type	string | string[]	Type.
listener	(arg0) => unknown	Listener.

Returns

EventsKey | EventsKey[]

Event key.

Inherited from

TileLayer.onInternal

---

removeChangeListener()

removeChangeListener(key, listener): void;

Parameters

Parameter	Type	Description
key	string	Key name.
listener	Listener	Listener.

Returns

void

Inherited from

TileLayer.removeChangeListener

---

removeEventListener()

removeEventListener(type, listener): void;

Parameters

Parameter	Type	Description
type	string	Type.
listener	Listener	Listener.

Returns

void

Inherited from

TileLayer.removeEventListener

---

render()

render(frameState, target): HTMLElement | null;

In charge to manage the rendering of the layer. One layer type is bounded with one layer renderer.

Parameters

Parameter	Type	Description
frameState	FrameState | null	Frame state.
target	HTMLElement	Target which the renderer may (but need not) use for rendering its content.

Returns

HTMLElement | null

The rendered element.

Inherited from

TileLayer.render

---

renderDeclutter()

renderDeclutter(frameState, layerState): void;

Parameters

Parameter	Type	Description
frameState	FrameState	Frame state.
layerState	State	Layer state.

Returns

void

Inherited from

TileLayer.renderDeclutter

---

renderDeferred()

renderDeferred(frameState): void;

When the renderer follows a layout -> render approach, do the final rendering here.

Parameters

Parameter	Type	Description
frameState	FrameState	Frame state

Returns

void

Inherited from

TileLayer.renderDeferred

---

set()

set(
   key, 
   value, 
   silent?): void;

Sets a value.

Parameters

Parameter	Type	Description
key	string	Key name.
value	any	Value.
silent?	boolean	Update without triggering an event.

Returns

void

Api

Inherited from

TileLayer.set

---

setBackground()

setBackground(background?): void;

Sets the background color.

Parameters

Parameter	Type	Description
background?	BackgroundColor	Background color.

Returns

void

Inherited from

TileLayer.setBackground

---

setExtent()

setExtent(extent): void;

Set the extent at which the layer is visible. If undefined, the layer will be visible at all extents.

Parameters

Parameter	Type	Description
extent	Extent | undefined	The extent of the layer.

Returns

void

Observable

Api

Inherited from

TileLayer.setExtent

---

setMap()

setMap(map): void;

Sets the layer to be rendered on top of other layers on a map. The map will not manage this layer in its layers collection. This is useful for temporary layers. To remove an unmanaged layer from the map, use #setMap(null).

To add the layer to a map and have it managed by the map, use module:ol/Map~Map#addLayer instead.

Parameters

Parameter	Type	Description
map	Map | null	Map.

Returns

void

Api

Inherited from

TileLayer.setMap

---

setMapInternal()

setMapInternal(map): void;

For use inside the library only.

Parameters

Parameter	Type	Description
map	Map | null	Map.

Returns

void

Inherited from

TileLayer.setMapInternal

---

setMaxResolution()

setMaxResolution(maxResolution): void;

Set the maximum resolution at which the layer is visible.

Parameters

Parameter	Type	Description
maxResolution	number	The maximum resolution of the layer.

Returns

void

Observable

Api

Inherited from

TileLayer.setMaxResolution

---

setMaxZoom()

setMaxZoom(maxZoom): void;

Set the maximum zoom (exclusive) at which the layer is visible. Note that the zoom levels for layer visibility are based on the view zoom level, which may be different from a tile source zoom level.

Parameters

Parameter	Type	Description
maxZoom	number	The maximum zoom of the layer.

Returns

void

Observable

Api

Inherited from

TileLayer.setMaxZoom

---

setMinResolution()

setMinResolution(minResolution): void;

Set the minimum resolution at which the layer is visible.

Parameters

Parameter	Type	Description
minResolution	number	The minimum resolution of the layer.

Returns

void

Observable

Api

Inherited from

TileLayer.setMinResolution

---

setMinZoom()

setMinZoom(minZoom): void;

Set the minimum zoom (inclusive) at which the layer is visible. Note that the zoom levels for layer visibility are based on the view zoom level, which may be different from a tile source zoom level.

Parameters

Parameter	Type	Description
minZoom	number	The minimum zoom of the layer.

Returns

void

Observable

Api

Inherited from

TileLayer.setMinZoom

---

setOpacity()

setOpacity(opacity): void;

Set the opacity of the layer, allowed values range from 0 to 1.

Parameters

Parameter	Type	Description
opacity	number	The opacity of the layer.

Returns

void

Observable

Api

Inherited from

TileLayer.setOpacity

---

setPreload()

setPreload(preload): void;

Set the level as number to which we will preload tiles up to.

Parameters

Parameter	Type	Description
preload	number	The level to preload tiles up to.

Returns

void

Observable

Api

Inherited from

TileLayer.setPreload

---

setProperties()

setProperties(values, silent?): void;

Sets a collection of key-value pairs. Note that this changes any existing properties and adds new ones (it does not remove any existing properties).

Parameters

Parameter	Type	Description
values	{ [x: string]: any; }	Values.
silent?	boolean	Update without triggering an event.

Returns

void

Api

Inherited from

TileLayer.setProperties

---

setSource()

setSource(source): void;

Set the layer source.

Parameters

Parameter	Type	Description
source	XYZ | null	The layer source.

Returns

void

Observable

Api

Inherited from

TileLayer.setSource

---

setUseInterimTilesOnError()

setUseInterimTilesOnError(useInterimTilesOnError): void;

Deprecated. Set whether we use interim tiles on error.

Parameters

Parameter	Type	Description
useInterimTilesOnError	boolean	Use interim tiles on error.

Returns

void

Observable

Api

Inherited from

TileLayer.setUseInterimTilesOnError

---

setVisible()

setVisible(visible): void;

Set the visibility of the layer (true or false).

Parameters

Parameter	Type	Description
visible	boolean	The visibility of the layer.

Returns

void

Observable

Api

Inherited from

TileLayer.setVisible

---

setZIndex()

setZIndex(zindex): void;

Set Z-index of the layer, which is used to order layers before rendering. The default Z-index is 0.

Parameters

Parameter	Type	Description
zindex	number	The z-index of the layer.

Returns

void

Observable

Api

Inherited from

TileLayer.setZIndex

---

unInternal()

protected unInternal(type, listener): void;

Unlisten for a certain type of event.

Parameters

Parameter	Type	Description
type	string | string[]	Type.
listener	(arg0) => unknown	Listener.

Returns

void

Inherited from

TileLayer.unInternal

---

unrender()

unrender(): void;

Called when a layer is not visible during a map render.

Returns

void

Inherited from

TileLayer.unrender

---

unset()

unset(key, silent?): void;

Unsets a property.

Parameters

Parameter	Type	Description
key	string	Key name.
silent?	boolean	Unset without triggering an event.

Returns

void

Api

Inherited from

TileLayer.unset

---

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

Properties

disposed

protected disposed: boolean;

The object has already been disposed.

Inherited from

TileLayer.disposed

---

on

on: BaseTileLayerOnSignature<EventsKey>;

Inherited from

TileLayer.on

---

once

once: BaseTileLayerOnSignature<EventsKey>;

Inherited from

TileLayer.once

---

provider

provider: ZarrLayerProvider;

---

rendered

protected rendered: boolean;

Inherited from

TileLayer.rendered

---

un

un: BaseTileLayerOnSignature<void>;

Inherited from

TileLayer.un