Options
All
  • Public
  • Public/Protected
  • All
Menu

Describes a reference to an item in the publication navigation.

Hierarchy

  • IReaderPublicationNavigationItemReferenceData

Index

Properties

collectionIndex

collectionIndex: number

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

int

collectionType

collectionType: NavigationCollectionType

The type of navigation collection.

navigationItemId

navigationItemId: number

The id of the ReaderPublicationNavigationItem referenced.

int

readerDocumentIndexInSpine

readerDocumentIndexInSpine: number

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

int

readerPublicationDefaultLocatorUrl

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.

Generated using TypeDoc