Events

annotations.willChange

Detailed viewer event reference for annotations.willChange.

Summary

  • Category: Annotations
  • Event: annotations.willChange
  • Trigger: Fires before annotation collections change.

Payload

[AnnotationWillChangeEventPayload];

Payload fields

Payload is not an object literal. Use the declaration above and runtime guards when handling this event.

Subscription example

function onEvent(payload) {
  console.log('annotations.willChange', payload);
}

instance.addEventListener('annotations.willChange', onEvent);
instance.removeEventListener('annotations.willChange', onEvent);