useOlVectorLayer

useOlVectorLayer(): VectorLayer<VectorSource<FeatureLike>, FeatureLike>

Defined in: src/ol-vector-layer.tsx:149

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

Returns

VectorLayer<VectorSource<FeatureLike>, FeatureLike>

The OpenLayers VectorLayer instance

Throws

If called outside of an OlVectorLayer component

Example

function VectorControl() {
  const layer = useOlVectorLayer()
  // Use layer instance
  return null
}