Class: CrossReferenceGroup

Defined in: Data/Models/CrossReference/CrossReferenceGroup.ts:12

A group of cross-references for a source passage. Phrase-level: one group per clause/phrase within the passage (phrase IS NOT NULL). Verse-level: one group for the whole passage (phrase IS NULL).

The anchor is the canonical inclusive range of ModuleFormat §5. verseId is the range start and keeps its original name because existing consumers read it as "the source verse"; verseIdEnd exposes the end of the range.

Constructors

Constructor

new CrossReferenceGroup(data): CrossReferenceGroup

Defined in: Data/Models/CrossReference/CrossReferenceGroup.ts:22

Parameters

data

groupId?

number

metadata?

Metadata

phrase?

string

sortOrder?

number

verseId

number

verseIdEnd?

number

Returns

CrossReferenceGroup

Properties

groupId?

optional groupId?: number

Defined in: Data/Models/CrossReference/CrossReferenceGroup.ts:13

---

metadata?

optional metadata?: Metadata

Defined in: Data/Models/CrossReference/CrossReferenceGroup.ts:20

---

phrase?

optional phrase?: string

Defined in: Data/Models/CrossReference/CrossReferenceGroup.ts:18

---

sortOrder?

optional sortOrder?: number

Defined in: Data/Models/CrossReference/CrossReferenceGroup.ts:19

---

verseId

verseId: number

Defined in: Data/Models/CrossReference/CrossReferenceGroup.ts:15

First verse of the source passage (inclusive).

---

verseIdEnd

verseIdEnd: number

Defined in: Data/Models/CrossReference/CrossReferenceGroup.ts:17

Last verse of the source passage (inclusive). Equals verseId for a single verse.

Methods

isPhraseLevel()

isPhraseLevel(): boolean

Defined in: Data/Models/CrossReference/CrossReferenceGroup.ts:43

Check if this is a phrase-level group (vs verse-level)

Returns

boolean

---

isRange()

isRange(): boolean

Defined in: Data/Models/CrossReference/CrossReferenceGroup.ts:50

Check if the source anchor spans more than one verse

Returns

boolean