Main Content

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

expand all in page

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

expand all

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

Attributes:

GetAccess
public
SetAccess
private
GetObservable
true
SetObservable
true

Name of the event, specified as a character vector.

Attributes:

GetAccess
public
SetAccess
private
GetObservable
true
SetObservable
true

Data Types: char

Annotation whose label has been edited, specified as a Point or Line object. Each Point object specifies a 3-D point annotation, and each Line object specifies a 3-D line annotation.

Attributes:

GetAccess
public
SetAccess
private
GetObservable
true
SetObservable
true

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

Attributes:

GetAccess
public
SetAccess
private
GetObservable
true
SetObservable
true

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

Attributes:

GetAccess
public
SetAccess
private
GetObservable
true
SetObservable
true

Examples

collapse all

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

expand all

See Also

| | |

Topics