Annotation

entity

Sticky-note canvas annotation. Constructed via Annotation(...) and chained with the field setters. Annotations sit on the flow's Metadata.Annotations[] array.

Factories

`Annotation`

Annotation() -> Annotation

Construct a fresh annotation with an auto-generated id.

`Annotation`

Annotation(id: String) -> Annotation

Construct an annotation pinned to a specific id.

Parameter	Type	Required	Description
`id`	`String`	yes	Operator-supplied annotation identifier (typically a UUID).

Methods

`kind`

kind(value: String) -> Annotation

Set the annotation kind.

Parameter	Type	Required	Description
`value`	`String`	yes	Annotation kind. Connect emits `"default"` today.

`content`

content(value: String) -> Annotation

Set the annotation's text.

Parameter	Type	Required	Description
`value`	`String`	yes	Annotation body text.

`action_id`

action_id(target: Handle | String) -> Annotation

Tie the annotation to a specific block. Pass "" for a free-floating annotation.

Parameter	Type	Required	Description
`target`	`Handle \| String`	yes	Block handle (preferred) or wire identifier this annotation documents.

`position`

position(x: Number, y: Number) -> Annotation

Set the annotation's canvas position.

Parameter	Type	Required	Description
`x`	`Number`	yes	Canvas X. Floats accepted; integers preferred where possible.
`y`	`Number`	yes	Canvas Y.

`size`

size(height: i64, width: i64) -> Annotation

Set the annotation box's dimensions.

Parameter	Type	Required	Description
`height`	`i64`	yes	Annotation box height in pixels.
`width`	`i64`	yes	Annotation box width in pixels.

`folded`

folded(value: bool) -> Annotation

Toggle the folded UI state.

Parameter	Type	Required	Description
`value`	`bool`	yes	True when the operator has collapsed the annotation in the console.