Class EpubCFI

Parsing and creation of EpubCFIs: http://www.idpf.org/epub/linking/cfi/epub-cfi.html

Implements:

Character Offset: epubcfi(/6/4[chap01ref]!/4[body01]/10[para05]/2/1:3)
Simple Ranges : epubcfi(/6/4[chap01ref]!/4[body01]/10[para05],/2/1:1,/3:4)

Does Not Implement:

Temporal Offset (~)
Spatial Offset (@)
Temporal-Spatial Offset (~ + @)
Text Location Assertion ([)

Param: cfiFrom

Param: base

Param: ignoreClass

class to ignore when parsing DOM

Constructors

constructor

new EpubCFI(
    cfiFrom?: string | Node | Range | EpubCFI,
    base?: string | EpubCFIComponent,
    ignoreClass?: string,
): EpubCFI
Parameters
- OptionalcfiFrom: string | Node | Range | EpubCFI
- Optionalbase: string | EpubCFIComponent
- OptionalignoreClass: string
Returns EpubCFI
- Defined in epubcfi.ts:36

Properties

base

base: EpubCFIComponent

end

end: EpubCFIComponent | null

id

id: string | null

path

path: EpubCFIComponent

range

range: boolean

spinePos

spinePos: number

start

start: EpubCFIComponent | null

str

str: string

Methods

collapse

collapse(toStart?: boolean): void
Collapse a CFI Range to a single CFI Position
Parameters
- OptionaltoStart: boolean
Returns void
- Defined in epubcfi.ts:1050

compare

compare(cfiOne: string | EpubCFI, cfiTwo: string | EpubCFI): number
Compare which of two CFIs is earlier in the text
Parameters
- cfiOne: string | EpubCFI
- cfiTwo: string | EpubCFI
Returns number
First is earlier = -1, Second is earlier = 1, They are equal = 0
- Defined in epubcfi.ts:345

equalStep

equalStep(stepA: EpubCFIStep, stepB: EpubCFIStep): boolean
Parameters
- stepA: EpubCFIStep
- stepB: EpubCFIStep
Returns boolean
- Defined in epubcfi.ts:499

filter

filter(anchor: Node, ignoreClass: string): false | Node
Parameters
- anchor: Node
- ignoreClass: string
Returns false | Node
- Defined in epubcfi.ts:637

filteredPosition

filteredPosition(anchor: Node, ignoreClass: string): number
Parameters
- anchor: Node
- ignoreClass: string
Returns number
- Defined in epubcfi.ts:764

filteredStep

filteredStep(node: Node, ignoreClass: string): EpubCFIStep | undefined
Parameters
- node: Node
- ignoreClass: string
Returns EpubCFIStep | undefined
- Defined in epubcfi.ts:432

findNode

findNode(
    steps: EpubCFIStep[],
    _doc?: Document,
    ignoreClass?: string,
): Node | undefined
Parameters
- steps: EpubCFIStep[]
- Optional_doc: Document
- OptionalignoreClass: string
Returns Node | undefined
- Defined in epubcfi.ts:889

fixMiss

fixMiss(
    steps: EpubCFIStep[],
    offset: number,
    _doc?: Document,
    ignoreClass?: string,
): { container: Node; offset: number }
Parameters
- steps: EpubCFIStep[]
- offset: number
- Optional_doc: Document
- OptionalignoreClass: string
Returns { container: Node; offset: number }
- Defined in epubcfi.ts:906

fromNode

fromNode(
    anchor: Node,
    base: string | EpubCFIComponent,
    ignoreClass?: string,
): Partial<
    Pick<EpubCFI, "spinePos" | "range" | "base" | "path" | "start" | "end">,
>
Create a CFI object from a Node
Parameters
- anchor: Node
- base: string | EpubCFIComponent
- OptionalignoreClass: string
Returns Partial<Pick<EpubCFI, "spinePos" | "range" | "base" | "path" | "start" | "end">>
cfi
- Defined in epubcfi.ts:615

fromRange

fromRange(
    range: Range,
    base: string | EpubCFIComponent,
    ignoreClass?: string,
): Partial<
    Pick<EpubCFI, "spinePos" | "range" | "base" | "path" | "start" | "end">,
>
Create a CFI object from a Range
Parameters
- range: Range
- base: string | EpubCFIComponent
- OptionalignoreClass: string
Returns Partial<Pick<EpubCFI, "spinePos" | "range" | "base" | "path" | "start" | "end">>
cfi
- Defined in epubcfi.ts:520

generateChapterComponent

generateChapterComponent(
    _spineNodeIndex: number,
    _pos: string | number,
    id?: string,
): string
Parameters
- _spineNodeIndex: number
- _pos: string | number
- Optionalid: string
Returns string
- Defined in epubcfi.ts:1032

getChapterComponent

getChapterComponent(cfiStr: string): string
Parameters
- cfiStr: string
Returns string
- Defined in epubcfi.ts:233

getCharecterOffsetComponent

getCharecterOffsetComponent(cfiStr: string): string
Parameters
- cfiStr: string
Returns string
- Defined in epubcfi.ts:265

getPathComponent

getPathComponent(cfiStr: string): string | undefined
Parameters
- cfiStr: string
Returns string | undefined
- Defined in epubcfi.ts:240

getRange

getRange(cfiStr: string): false | [string, string]
Parameters
- cfiStr: string
Returns false | [string, string]
- Defined in epubcfi.ts:251

isCfiString

isCfiString(str: unknown): boolean
Check if a string is wrapped with "epubcfi()"
Parameters
- str: unknown
Returns boolean
- Defined in epubcfi.ts:1022

joinSteps

joinSteps(steps: EpubCFIStep[]): string
Parameters
- steps: EpubCFIStep[]
Returns string
- Defined in epubcfi.ts:270

normalizedMap

normalizedMap(
    children: NodeListOf<ChildNode>,
    nodeType: number,
    ignoreClass: string,
): Record<number, number>
Parameters
- children: NodeListOf<ChildNode>
- nodeType: number
- ignoreClass: string
Returns Record<number, number>
- Defined in epubcfi.ts:713

parse

parse(
cfiStr: string,
): Partial<
Pick<EpubCFI, "spinePos" | "range" | "base" | "path" | "start" | "end">,
>
Parse a cfi string to a CFI object representation
Parameters
- cfiStr: string
Returns Partial<Pick<EpubCFI, "spinePos" | "range" | "base" | "path" | "start" | "end">>
cfi
- Defined in epubcfi.ts:104

parseComponent

parseComponent(componentStr: string): EpubCFIComponent
Parameters
- componentStr: string
Returns EpubCFIComponent
- Defined in epubcfi.ts:151

parseStep

parseStep(stepStr: string): EpubCFIStep | undefined
Parameters
- stepStr: string
Returns EpubCFIStep | undefined
- Defined in epubcfi.ts:179

parseTerminal

parseTerminal(
termialStr: string,
): { assertion: string | null; offset: number | null }
Parameters
- termialStr: string
Returns { assertion: string | null; offset: number | null }
- Defined in epubcfi.ts:210

patchOffset

patchOffset(anchor: Node, offset: number, ignoreClass: string): number
Parameters
- anchor: Node
- offset: number
- ignoreClass: string
Returns number
- Defined in epubcfi.ts:680

pathTo

pathTo(
    node: Node,
    offset: number | null,
    ignoreClass?: string,
): EpubCFIComponent
Parameters
- node: Node
- offset: number | null
- OptionalignoreClass: string
Returns EpubCFIComponent
- Defined in epubcfi.ts:451

position

position(anchor: Node): number
Parameters
- anchor: Node
Returns number
- Defined in epubcfi.ts:748

segmentString

segmentString(segment: EpubCFIComponent): string
Parameters
- segment: EpubCFIComponent
Returns string
- Defined in epubcfi.ts:296

step

step(node: Node): EpubCFIStep
Parameters
- node: Node
Returns EpubCFIStep
- Defined in epubcfi.ts:421

stepsToQuerySelector

stepsToQuerySelector(steps: EpubCFIStep[]): string
Parameters
- steps: EpubCFIStep[]
Returns string
- Defined in epubcfi.ts:821

stepsToXpath

stepsToXpath(steps: EpubCFIStep[]): string
Parameters
- steps: EpubCFIStep[]
Returns string
- Defined in epubcfi.ts:787

textNodes

textNodes(container: Node, ignoreClass?: string): Node[]
Parameters
- container: Node
- OptionalignoreClass: string
Returns Node[]
- Defined in epubcfi.ts:841

toRange

toRange(_doc?: Document, ignoreClass?: string): Range | null
Creates a DOM range representing a CFI
Parameters
- Optional_doc: Document
  document referenced in the base
- OptionalignoreClass: string
Returns Range | null
- Defined in epubcfi.ts:949

toString

toString(): string
Convert CFI to a epubcfi(...) string

Returns string
epubcfi
- Defined in epubcfi.ts:316

walkToNode

walkToNode(
    steps: EpubCFIStep[],
    _doc?: Document,
    ignoreClass?: string,
): Node | undefined
Parameters
- steps: EpubCFIStep[]
- Optional_doc: Document
- OptionalignoreClass: string
Returns Node | undefined
- Defined in epubcfi.ts:853