Interface: DecorationDto

Properties

optional data?: unknown

Opaque data passed through to the click handler.

optional groupId?: string

Optional ID for grouping related decorations. Pass the same groupId to ui.updateVerseDecorations to replace the whole group atomically.

optional hoverContent?: HoverContentDto

Optional hover content shown when the user mouses over the decorated text.

optional onClickCommand?: string

Command to execute when the user clicks the decoration. The command receives { range, data } as args.

optional order?: number

Render order. See "order hint" section of the spec.

range: VerseRange | VerseRange[]

A single range or several ranges to apply the same style.

style: DecorationStyle