Interface IReaderPublicationNavigationItemData

interface IReaderPublicationNavigationItemData {
    children: IReaderPublicationNavigationItemData[];
    href: string;
    id: number;
    isTargetingReaderDocumentInSpine: boolean;
    locator: ISimpleLocatorData;
    parentId: number;
    textContent: string;
}

Properties

The nested children of this item if any.

href: 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://<some_website>) , or an email address (mailto:<some_email>)

This property is always null if isTargetingReaderDocumentInSpine is true.

id: number

An identifier for this item, unique within the publication.

isTargetingReaderDocumentInSpine: boolean

If the locator is targeting content within the publication.

The locator for this navigation item

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

parentId: number

The id of the parent navigation item if any. Null if this is a top-level item.

textContent: string

The contents of this item as text.