Interface IEpubCfiResolvedPath
ast: IEpubCfiPathNode;
characterOffsetOutOfBounds: boolean;
container: Node;
documentUrl: URL;
elementCharacterOffset: number;
indirectionsResolved: boolean;
intendedTargetType: EpubCfiIntendedTargetType;
localPaths: IEpubCfiResolvedLocalPath[];
offset: number;
sideBias: EpubCfiSideBias;
spatialOffset: IEpubCfiSpatialOffset;
stepsResolved: boolean;
temporalOffset: IEpubCfiTemporalOffset;
virtualTarget: EpubCfiVirtualTarget;
addResolvedLocalPath(localPath: IEpubCfiResolvedLocalPath): void;
getDocument(): Document;
getResolverErrors(): IEpubCfiResolverError[];
getTargetElement(): Element;
getTargetNode(): Node;
getTerminalLocalPath(): IEpubCfiResolvedLocalPath;
isMissingXmlIdAssertions(): boolean;
isRepairedWithXmlIdAssertions(): boolean;
isTargetingOpfDocument(): boolean;
}
Properties
ast
character
container
The container node for the "target", where "target" can be a node in the DOM tree or a character offset. The container can be a Element, Text, Document or DocumentFragment node.
document
The file path to the document
element
Set if intended target type is 'element' and there was a character offset defined.
Used for referencing the "alt" text in elements.
indirections
If all indirections were resolved successfully.
intended
If the epubcfi intended to target a characters or an element. This depends if the terminal step in this path was odd or even.
local
All local paths that were resolved in this path.
offset
The childNode offset into container
side
Will be set if the terminal step of the path contained the assertion parameter 's' with a valid value.
See http://www.idpf.org/epub/linking/cfi/epub-cfi.html#sec-path-side-bias
spatial
The spatial offset if any.
steps
If steps were resolved, i.e. the steps pointed to existing or virtual nodes, or were recovered using assertions. Will be false if any indirection failed to resolve.
temporal
The temporal offset if any,
virtual
If this path uses a virtual target, targeting 'firstChild' or the 'lastChild'. This will be set if the epubcfi ends with a step of 0 or N+2 where N is the last valid element step. If a step was larger than N+2, virtualTarget will be set to 'lastChild' and stepsResolved to false.
Methods
add
Parameters
- localPath: IEpubCfiResolvedLocalPath
Returns void
get
Returns Document
get
Returns IEpubCfiResolverError[]
get
Get the target Element, if the intended target was en element and it is not the virtual first or virtual last element.
Returns Element
get
Get the target node for this local path, unless the target is a virtual Target in which case the container is returned instead.
Returns Node
get
Returns IEpubCfiResolvedLocalPath
is
Returns boolean
is
Returns boolean
is
Returns boolean
The AST used to resolve this path.