Skip to main content

Interface: VerseRange

Defined in: Extensions/ExtensionApiDtos.ts:74

Targets a verse, a multi-verse range, or a sub-verse word range. The host supports word-range targeting only on modules that ship token data; for other modules, character offsets are used instead. Extensions can use either.

Properties​

endOffset?​

optional endOffset?: number

Defined in: Extensions/ExtensionApiDtos.ts:82

endTokenIndex?​

optional endTokenIndex?: number

Defined in: Extensions/ExtensionApiDtos.ts:89

endVerseId?​

optional endVerseId?: number

Defined in: Extensions/ExtensionApiDtos.ts:91

For multi-verse ranges, the inclusive end verse.

startOffset?​

optional startOffset?: number

Defined in: Extensions/ExtensionApiDtos.ts:81

Optional UTF-16 character offset into the verse plaintext (after stripping formatting). Inclusive start, exclusive end. Omit both for whole-verse targeting.

startTokenIndex?​

optional startTokenIndex?: number

Defined in: Extensions/ExtensionApiDtos.ts:88

Optional token indexes when the module has tokenized data. Preferred over character offsets for languages with complex morphology. The host resolves token indexes to render coordinates.

verseId​

verseId: number

Defined in: Extensions/ExtensionApiDtos.ts:75