Interface IReaderPublicationNavigationItemReferenceData

Describes a reference to an item in the publication navigation.

interface IReaderPublicationNavigationItemReferenceData {
    collectionIndex: number;
    collectionType: NavigationCollectionType;
    navigationItemId: number;
    readerDocumentIndexInSpine: number;
    readerPublicationDefaultLocatorUrl: string;
}

Properties

collectionIndex: number

The index of the collection within the publication navigation collections list.

The type of navigation collection.

navigationItemId: number

The id of the ReaderPublicationNavigationItem referenced.

readerDocumentIndexInSpine: number

The index in the related ReaderPublication's spine of the document that the navigation item references.

readerPublicationDefaultLocatorUrl: string

The base URL used when creating Locators pointing to content in the related publication.

As this is a constant property of the ReaderPublication you can use this as an identifier or reference to the underlying publication.