Skip to main content

<Marker>

component@pond-ts/chartssource

A vertical line at an x position (a time, a distance, a lap boundary).

Props

atnumberrequired

x position in axis units — epoch ms on a time axis, the value on a value axis. (The generalisation of the mockup's "time line": a mark at an x, time or value.)

editingboolean

When true, this mark is in single-annotation edit (the double-click target): handles stay out, it's draggable, and it reads as level 1 — while other marks stay static. Independent of the container's global editAnnotations. Pair with onEditAnnotation (the consumer holds an editingId and sets editing={editingId === id}).

hoveredboolean

Controlled hover (OR'd with pointer hover) — lets a legend row light the mark remotely. Pair with the container's onHoverAnnotation to sync both ways.

idstring

Stable consumer id — a click reports it via the container's onSelectAnnotation, so the consumer can track which mark is selected.

indicatorboolean

Also pin this marker's time to the x-axis as an on-axis pill (drawn by <XAxis> at at, in the annotation colour) — the axis-edge counterpart of the near-line chip. Default false. The pill always shows the formatted at (the axis coordinate), never the custom label (which stays the near-line chip) — an indicator reads like a tick. A connector links the marker line to its pill.

labelstring | false

Chip label. Omit to auto-label with the shared x formatter (the axis's); pass false (or '') to render no label chip — for an inert background mark you don't want labelled (where the auto-label would just show a raw axis value).

onChange(at: number) => void

Make the marker editable (in edit mode): dragging its line reports the new at (controlled — wire it back to at). The whole line moves.

selectableboolean

Whether the mark responds to hover + selection (default true). When false it's inert background context — drawn at the back (level 3) always, no hover, no select, no edit.

selectedboolean

Controlled selection — brightens to the front (level 1). Handles are an edit-mode hover affordance, not a selection cue. Ignored if not selectable.