Interface IReaderPublicationNavigationItem

Represents an item within a ReaderPublicationNavigationCollection. The type of ReaderPublicationNavigationCollection dictates the type of content in the item.

Hierarchy

ITreeNode<IReaderPublicationNavigationItem>
- IReaderPublicationNavigationItem

Index

Methods

Methods

getChildren

getChildren(): readonly IReaderPublicationNavigationItem[]

Overrides ITreeNode.getChildren

The nested children of this item if any.

Returns readonly IReaderPublicationNavigationItem[]

getHref

getHref(): string

Returns the "href" for this publication navigation item if it does not target any location within the publication.

The href can for example refer to an external website (https://) , or an email address (mailto:)

This method always returns null if isTargetingReaderDocumentInSpine() returns true.

Returns string

getId

getId(): number

An identifier for this item, unique within the publication.

Returns number

getLocator

getLocator(): Locator

The locator this navigation item points to.

deprecated
in 4.0.0. Please use the item directly with methods that accepts locators instead. For example: IReaderView.goTo(navigationItem)

Returns Locator

getParent

getParent(): IReaderPublicationNavigationItem

The parent navigation item. Null if this is a top-level item.

Returns IReaderPublicationNavigationItem

getTextContent

getTextContent(): string

The contents of this item as text.

Returns string

isTargetingReaderDocumentInSpine

isTargetingReaderDocumentInSpine(): boolean

If the locator is targeting content within the publication.

Returns boolean

toJSON

toJSON(): IReaderPublicationNavigationItemData

Get this instance as a plain JSON object.

Returns IReaderPublicationNavigationItemData

Generated using TypeDoc