Skip to main content

Class: UserHighlight

Defined in: Data/Models/User/UserHighlight.ts:7

User highlight entity from the user database Represents highlighted text in a Bible module

Constructors​

Constructor​

new UserHighlight(data): UserHighlight

Defined in: Data/Models/User/UserHighlight.ts:19

Parameters​

data​
color​

HighlightColor

createdDate?​

string

highlightId?​

number

metadata?​

Metadata

moduleId​

number

noteId?​

number

textEnd?​

number

textStart?​

number

verseIdEnd?​

number

verseIdStart​

number

Returns​

UserHighlight

Properties​

color​

color: HighlightColor

Defined in: Data/Models/User/UserHighlight.ts:14

createdDate?​

optional createdDate?: string

Defined in: Data/Models/User/UserHighlight.ts:16

highlightId?​

optional highlightId?: number

Defined in: Data/Models/User/UserHighlight.ts:8

metadata?​

optional metadata?: Metadata

Defined in: Data/Models/User/UserHighlight.ts:17

moduleId​

moduleId: number

Defined in: Data/Models/User/UserHighlight.ts:9

noteId?​

optional noteId?: number

Defined in: Data/Models/User/UserHighlight.ts:15

textEnd?​

optional textEnd?: number

Defined in: Data/Models/User/UserHighlight.ts:13

textStart?​

optional textStart?: number

Defined in: Data/Models/User/UserHighlight.ts:12

verseIdEnd?​

optional verseIdEnd?: number

Defined in: Data/Models/User/UserHighlight.ts:11

verseIdStart​

verseIdStart: number

Defined in: Data/Models/User/UserHighlight.ts:10

Methods​

getVerseRange()​

getVerseRange(): object

Defined in: Data/Models/User/UserHighlight.ts:67

Get the verse range

Returns​

object

end?​

optional end?: number

start​

start: number

hasNote()​

hasNote(): boolean

Defined in: Data/Models/User/UserHighlight.ts:60

Check if this highlight has an associated note

Returns​

boolean

isPartialText()​

isPartialText(): boolean

Defined in: Data/Models/User/UserHighlight.ts:53

Check if this is a partial text highlight (within a verse)

Returns​

boolean

isSingleVerse()​

isSingleVerse(): boolean

Defined in: Data/Models/User/UserHighlight.ts:46

Check if this is a single verse highlight

Returns​

boolean