# EpubCFI Parsing and creation of EpubCFIs: https://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 `([)` **Kind**: global class * [EpubCFI](#EpubCFI) * [new EpubCFI([cfiFrom], [base], [ignoreClass])](#new_EpubCFI_new) * _instance_ * [.collapse([toStart])](#EpubCFI+collapse) * [.compare(cfiOne, cfiTwo)](#EpubCFI+compare) ⇒ number * [.generateChapterComponent(spineNodeIndex, position, [id])](#EpubCFI+generateChapterComponent) ⇒ string * [.fromNode(node, base, [ignoreClass])](#EpubCFI+fromNode) ⇒ [EpubCFI](#EpubCFI) * [.fromRange(range, base, [ignoreClass])](#EpubCFI+fromRange) ⇒ [EpubCFI](#EpubCFI) * [.isCfiString(str)](#EpubCFI+isCfiString) ⇒ boolean * [.parse(cfiStr)](#EpubCFI+parse) ⇒ [EpubCFI](#EpubCFI) * [.toRange([doc], [ignoreClass])](#EpubCFI+toRange) ⇒ Range * [.toString()](#EpubCFI+toString) ⇒ string * _static_ * [.base](#EpubCFI.base) : object * [.spinePos](#EpubCFI.spinePos) : number * [.path](#EpubCFI.path) : object * [.range](#EpubCFI.range) : boolean * [.start](#EpubCFI.start) : object * [.end](#EpubCFI.end) : object * [.str](#EpubCFI.str) : string ## new EpubCFI([cfiFrom], [base], [ignoreClass]) Constructor | Param | Type | Description | | --- | --- | --- | | [cfiFrom] | string \| Range \| Node | | | [base] | string \| object | | | [ignoreClass] | string | class to ignore when parsing DOM | ## epubCFI.collapse([toStart]) Collapse a CFI Range to a single CFI Position **Kind**: instance method of [EpubCFI](#EpubCFI) | Param | Type | | --- | --- | | [toStart] | boolean | ## epubCFI.compare(cfiOne, cfiTwo) ⇒ number Compare which of two CFIs is earlier in the text **Kind**: instance method of [EpubCFI](#EpubCFI) **Returns**: number - First is earlier = -1, Second is earlier = 1, They are equal = 0 | Param | Type | | --- | --- | | cfiOne | string \| [EpubCFI](#EpubCFI) | | cfiTwo | string \| [EpubCFI](#EpubCFI) | ## epubCFI.generateChapterComponent(spineNodeIndex, position, [id]) ⇒ string Generate chapter component **Kind**: instance method of [EpubCFI](#EpubCFI) **Returns**: string - EpubCFI string format | Param | Type | | --- | --- | | spineNodeIndex | number | | position | number | | [id] | string | ## epubCFI.fromNode(node, base, [ignoreClass]) ⇒ [EpubCFI](#EpubCFI) Create a EpubCFI object from a Node **Kind**: instance method of [EpubCFI](#EpubCFI) | Param | Type | | --- | --- | | node | Node | | base | string \| object | | [ignoreClass] | string | ## epubCFI.fromRange(range, base, [ignoreClass]) ⇒ [EpubCFI](#EpubCFI) Create a CFI object from a Range **Kind**: instance method of [EpubCFI](#EpubCFI) | Param | Type | | --- | --- | | range | Range | | base | string \| object | | [ignoreClass] | string | ## epubCFI.isCfiString(str) ⇒ boolean Check if a string is wrapped with "epubcfi()" **Kind**: instance method of [EpubCFI](#EpubCFI) **Returns**: boolean - `true` if the string is valid, `false` otherwise | Param | Type | Description | | --- | --- | --- | | str | string | EpubCFI string format | ## epubCFI.parse(cfiStr) ⇒ [EpubCFI](#EpubCFI) Parse a cfi string to a EpubCFI object representation **Kind**: instance method of [EpubCFI](#EpubCFI) **Returns**: [EpubCFI](#EpubCFI) - EpubCFI object | Param | Type | Description | | --- | --- | --- | | cfiStr | string | EpubCFI string format | ## epubCFI.toRange([doc], [ignoreClass]) ⇒ Range Creates a DOM range representing a CFI **Kind**: instance method of [EpubCFI](#EpubCFI) | Param | Type | Description | | --- | --- | --- | | [doc] | Document | document referenced in the base | | [ignoreClass] | string | | ## epubCFI.toString() ⇒ string Convert CFI to a epubcfi(...) string **Kind**: instance method of [EpubCFI](#EpubCFI) **Returns**: string - EpubCFI string format ## EpubCFI.base : object **Kind**: static property of [EpubCFI](#EpubCFI) **Read only**: true ## EpubCFI.spinePos : number spine position **Kind**: static property of [EpubCFI](#EpubCFI) **Read only**: true ## EpubCFI.path : object **Kind**: static property of [EpubCFI](#EpubCFI) **Read only**: true ## EpubCFI.range : boolean **Kind**: static property of [EpubCFI](#EpubCFI) **Read only**: true ## EpubCFI.start : object **Kind**: static property of [EpubCFI](#EpubCFI) **Read only**: true ## EpubCFI.end : object **Kind**: static property of [EpubCFI](#EpubCFI) **Read only**: true ## EpubCFI.str : string EpubCFI string format **Kind**: static property of [EpubCFI](#EpubCFI) **Read only**: true