List of indirection errors that occured
The parent path to the target. If rangeStartPath and rangeEndPath are null, this path is the full path to the intended target if no range components were defined for the epubcfi.
If the range components are non-null, this path is a common path for both rangeStartPath and rangeEndPath. Note that it may not be the "deepest" common path for the range.
If not null, it defines the end of a target range.
If not null, it defines the start of a target range.
Creates a DOM Range from this instance. The created Range will be collapsed if this instance does not have any range path components.
If this instance has a range that start and end in different Documents, the range will be collapsed to range start.
Get the element character offsets if any exists. The returned object will always have 'start' defined, indicating the start offset.
Get a list of all parser errors that were encountered.
Get a list of all resolver errors that were encountered.
Get the spatial range if any is defined.
Returns the target element, if this instance is targeting a single element. If this instance targets several elements in a range, null is returned. If this instance is targeting a virtual element, null is returned.
Get the temporal range if any is defined.
If this instance has spatial, temporal or element character offsets.
Returns true if any parse errors or resolver errors were encountered. To detect all parse errors, ensure to run EpubCfiValidator on the AST.
Resolver errors include:
If this instance has both rangeStart and rangeEnd defined.
Returns true if:
If this instance represents a DOM Range. If this method returns false, createDomRange() will returned a collapsed Range instance.
Returns true if all indirections were resolved
Returns true if the parser parsed all path steps and offsets.
Returns true if all steps and indirections were resolved.
Returns true if an element id was found in a path but the epubcfi was missing the correct XML id assertion.
Always true for non-range instances. Only true for ranges if both start target node and end target node has the same ownerDocument.
A path was repaired using an XML id assertion
If this instance is targeting a single element.
If this instance is targeting the OPF document instead of a content document. Will return true if no indirection took place at all (i.e. still inside the OPF document)
If this method returns true, methods such as getTargetElement() and createDomRange() will return null.
Generated using TypeDoc
The EpubCFI AST that was used to resolve this instance