Colibrio Reader Framework API - Cloud license
    Preparing search index...

    Interface IReaderPublicationNavigationItem

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

    interface IReaderPublicationNavigationItem {
        getChildren(): readonly IReaderPublicationNavigationItem[];
        getHref(): string;
        getId(): number;
        getLocator(): Locator;
        getParent(): IReaderPublicationNavigationItem;
        getTextContent(): string;
        isTargetingReaderDocumentInSpine(): boolean;
        toJSON(): IReaderPublicationNavigationItemData;
    }

    Hierarchy (View Summary)

    Methods

    • 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 method always returns null if isTargetingReaderDocumentInSpine() returns true.

      Returns string

    • An identifier for this item, unique within the publication.

      Returns number

    • The locator this navigation item points to.

      Returns Locator

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

    • The contents of this item as text.

      Returns string

    • If the locator is targeting content within the publication.

      Returns boolean

    Methods