Identified annotation
An annotation that names the id of the annotation to replace.
Referenced In
Fields
| Field | Type | Description | Default |
|---|---|---|---|
| outline | one of: - string - object(Target by element (detailed)) - object(Target by position) | Optional. Draw a box around the target. | — |
| arrow | one of: - string - object(Target by element (detailed)) - object(Target by position) | Optional. Point an arrow at the target. | — |
| badge | one of: - string - object(Target by element (detailed)) - object(Target by position) | Optional. Mark the target with a small numbered or lettered marker. Set the marker’s characters with label. | — |
| callout | one of: - string - object(Target by element (detailed)) - object(Target by position) | Optional. Label the target with a text box and a leader line. Set the text with label. | — |
| blur | one of: - string - object(Target by element (detailed)) - object(Target by position) | Optional. Obscure the target to redact sensitive information. Pair with all to redact every match rather than the first. | — |
| text | one of: - string - object(Target by element (detailed)) - object(Target by position) | Optional. Place a standalone text box. Set the text with label. | — |
| label | string | Optional. Text to display. Required by badge, callout, and text; ignored by the other types. | — |
| id | string | Optional. Handle for this annotation, so a later annotate step can update or clear it. Only meaningful for annotations added by an annotate step; ignored on screenshot annotations, which live only for the capture.Pattern: ^[A-Za-z0-9_-]+$ | — |
| style | object(Annotation style) | Optional. Visual overrides for this annotation. Anything unset falls back to the resolved annotationDefaults theme (test, then spec, then config), then to the built-in theme. | — |
| position | one of: - string - object(Annotation point) - object(Annotation offset) | Optional. Where to place the annotation relative to its target. Accepts a named region, an absolute point, or an offset that nudges the default placement. | — |
| track | boolean | Optional. If true, the annotation follows its element as the page scrolls or reflows. Applies to recordings; inert in still screenshots, which capture a single moment. | — |
| transition | object(Annotation transition) | Optional. How the annotation enters and leaves. Applies to recordings; inert in still screenshots, which render the settled state. | — |
| duration | number | Optional. Milliseconds to display the annotation before it clears itself. Omit to display it until an annotate step clears it. Applies to recordings; inert in still screenshots.Minimum: 0 | — |
| all | boolean | Optional. If true, annotates every element matching the target instead of only the first. Most useful with blur, where redacting only the first match can leave sensitive content visible. | — |
Examples
{"outline": "example","arrow": "example","badge": "example","callout": "example","blur": "example","text": "example","label": "example","id": "example","position": "top","track": true,"duration": 42,"all": true}