Skip to main content

Interface: HighlightStyleDescriptor

Defined in: Extensions/ExtensionApiDtos.ts:604

Properties​

id​

id: string

Defined in: Extensions/ExtensionApiDtos.ts:606

Namespaced under the extension's ID, e.g. 'ext.greekTools.verbHighlight'.

label​

label: LocalizedString

Defined in: Extensions/ExtensionApiDtos.ts:607

rangeMode?​

optional rangeMode?: "verse" | "range" | "word"

Defined in: Extensions/ExtensionApiDtos.ts:613

True if this style applies to ranges/words instead of whole verses.

style​

style: DecorationStyle

Defined in: Extensions/ExtensionApiDtos.ts:609

The visual style applied. Same shape as decorations.

swatch?​

optional swatch?: string

Defined in: Extensions/ExtensionApiDtos.ts:611

Optional preview swatch (a small icon ID or hex color).