Skip to main content

Interface: NewHighlightDto

Defined in: Extensions/ExtensionApiDtos.ts:593

Properties​

comment?​

optional comment?: string

Defined in: Extensions/ExtensionApiDtos.ts:601

Optional comment text.

data?​

optional data?: unknown

Defined in: Extensions/ExtensionApiDtos.ts:599

Optional opaque metadata, returned with the highlight.

range​

range: VerseRange | VerseRange[]

Defined in: Extensions/ExtensionApiDtos.ts:595

Whole-verse, multi-verse, or sub-verse range.

styleId​

styleId: string

Defined in: Extensions/ExtensionApiDtos.ts:597

ID of a registered style (built-in or extension-contributed).