images.ui.graphics.events.AnnotationRemovedEventData Class

Namespace: images.ui.graphics.events
Superclasses: event.EventData

Event data is passed when annotation is removed

Renamed from images.ui.graphics3d.events.AnnotationRemovedEventData in R2024b

Description

The images.ui.graphics.events.AnnotationRemovedEventData class is the class passed to listeners when you remove an annotation from a Viewer object. When the object triggers an event using the notify handle class method, MATLAB^® assigns values to the properties of an AnnotationRemovedEventData object and passes that object to the listener callback function (the event handler).

The images.ui.graphics.events.AnnotationRemovedEventData class is a handle class.

Class Attributes

ConstructOnLoad	true
HandleCompatible	true

For information on class attributes, see Class Attributes.

Creation

The notify handle class method creates an AnnotationRemovedEventData object when called to trigger an event.

Properties

Source — Event source

Viewer object

Event source, specified as a handle to the Viewer object that triggered the event.

Attributes:

GetAccess	public
SetAccess	private
GetObservable	true
SetObservable	true

EventName — Name of event

character vector

Name of the event, specified as a character vector.

Attributes:

GetAccess	public
SetAccess	private
GetObservable	true
SetObservable	true

Data Types: char

Annotation — Annotation removed from viewer

Point object | Line object | Polygon object | ...

Annotation removed from the viewer, specified as one of these ROI object types.

• Angle object

• Circle object

• Ellipse object

• Freehand object

• Line object

• Point object

• Polygon object

• Polyline object

• Rectangle object

Attributes:

GetAccess	public
SetAccess	private
GetObservable	true
SetObservable	true

Examples

Access Event Data

This code defines a callback function that gets the event properties from the images.ui.graphics.events.AnnotationRemovedEventData object passed to it when the event is triggered.

function myCallbk(s,evtData)
   eventSource = evtData.Source;
   eventName = evtData.EventName;
   eventAnnotation = evtData.Annotation;
   ...
end

Version History

Introduced in R2024a

R2026a: New annotation shapes

The class now supports new ROI object types, in addition to the previously supported Point and Line objects. The Annotation property can now be specified as a Rectange, Circle, Polygon, Polyline, Angle, Freehand, or Ellipse object.

R2024b: Renamed from images.ui.graphics3d.events.AnnotationRemovedEventData

To reflect new workflows, the images.ui.graphics3d.events.AnnotationRemovedEventData class is now called images.ui.graphics.events.AnnotationRemovedEventData. There are no plans to remove support for references to the old name.