useOlImageLayer

useOlImageLayer(): GeolImageLayer

Defined in: src/ol-layer-geo-image.tsx:109

Hook to access the OpenLayers GeoImage layer instance from the nearest parent OlImageLayer component. Must be used within a descendant of OlImageLayer.

Returns

GeolImageLayer

The OpenLayers LayerGeoImage instance

Throws

If called outside of an OlImageLayer component

Example

function ImageControl() {
  const layer = useOlImageLayer()
  // Use layer instance
  return null
}