Skip to main content

Interface: DisplayModeDescriptor

Defined in: Extensions/ExtensionApiDtos.ts:836

Properties

applicableLanguages?

optional applicableLanguages?: string[]

Defined in: Extensions/ExtensionApiDtos.ts:844

Languages this mode applies to. Empty = all.


id

id: string

Defined in: Extensions/ExtensionApiDtos.ts:837


kind

kind: "overlay" | "replace"

Defined in: Extensions/ExtensionApiDtos.ts:840

'overlay' adds decorations on top of the standard rendering; 'replace' substitutes an iframe.


label

label: LocalizedString

Defined in: Extensions/ExtensionApiDtos.ts:838


renderEndpoint

renderEndpoint: string

Defined in: Extensions/ExtensionApiDtos.ts:842

Reverse-RPC: (verseId[]) -> DecorationDto[] for overlay; (verseId) -> uiEntry path for replace.