images.ui.graphics.events.AnnotationEditedEventData Class

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

Event data is passed when annotation label is edited

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

Description

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

The images.ui.graphics.events.AnnotationEditedEventData 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 AnnotationEditedEventData 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 whose label has been edited

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

Annotation whose label has been edited, specified as one of these 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

Label — Current label

string scalar

Current label of the annotation, specified as a string scalar.

Attributes:

GetAccess	public
SetAccess	private
GetObservable	true
SetObservable	true

PreviousLabel — Previous label

string scalar

Previous label of the annotation, specified as a string scalar.

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.AnnotationEditedEventData object passed to it when the event is triggered.

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

Version History

Introduced in R2024a

R2026a: New annotation shapes

The class now supports new ROI object types, including the Rectange, Circle, Polygon, Polyline, Angle, Freehand, and Ellipse objects.

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

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