Home > @magiclane/maps-sdk > TextMark

TextMark class

Represents a textual annotation at a specific moment in a recording.

A TextMark stores an offset timestamp, geographic Coordinates, and a textual report describing the moment. Text marks are useful for bookmarks, notes, or labeling events during a recording session.

Text marks are added by calling the Recorder.addTextMark method while recording.

Signature:

export declare class TextMark implements LogMark 

Implements: LogMark

Constructors

Constructor

Modifiers

Description

(constructor)(offset, coordinates, report)

Creates a TextMark with the specified offset, coordinates, and report.

API users typically do not create TextMark instances directly.

Properties

Property

Modifiers

Type

Description

coordinates

Coordinates

The geographical coordinates where the text mark was recorded.

offset

number

The timestamp (in milliseconds) of the text mark within the log.

report

string

A textual note or annotation associated with the mark.