Skip to main content

ImageAnnotations

Array of annotations for a 2D image

Panel support

ImageAnnotations is used in the Image panel.

Schema

fieldtypedescription
circlesCircleAnnotation[]Circle annotations
pointsPointsAnnotation[]Points annotations
textsTextAnnotation[]Text annotations
metadata (optional)KeyValuePair[]Additional user-provided metadata associated with the image annotations. Keys must be unique.
timestamp (optional)TimestampTimestamp of the image annotations. When set, individual annotation timestamps will be ignored.

Reference implementations

Foxglove schemas are framework-agnostic, and can be implemented using any supported message encoding:

encodingschema
ROS 1foxglove_msgs/ImageAnnotations
ROS 2foxglove_msgs/msg/ImageAnnotations
JSONfoxglove.ImageAnnotations
Protobuffoxglove.ImageAnnotations
FlatBuffersfoxglove.ImageAnnotations
OMG IDLfoxglove::ImageAnnotations

You must use the schema names specified above for Foxglove to recognize the schema.