useOlModify

useOlModify(): Modify

Defined in: src/ol-modify.tsx:83

Hook to access the OpenLayers Modify interaction instance from the nearest parent OlModify component. Must be used within a descendant of OlModify.

Returns

Modify

The OpenLayers Modify interaction instance

Throws

If called outside of an OlModify component

Example

function ModifyControl() {
  const modify = useOlModify()
  // Use modify instance
  return null
}