useOlTileLayer

useOlTileLayer(): TileLayer<TileSource<Tile>>

Defined in: src/ol-tile-layer.tsx:90

Hook to access the OpenLayers TileLayer instance from the nearest parent OlTileLayer component. Must be used within a descendant of OlTileLayer.

Returns

TileLayer<TileSource<Tile>>

The OpenLayers TileLayer instance

Throws

If called outside of an OlTileLayer component

Example

function TileControl() {
  const layer = useOlTileLayer()
  // Use layer instance
  return null
}