Interface IReaderPublicationNavigationCollection

Represents a collection of IReaderPublicationNavigationItems in a tree structure. Note that some NavigationCollectionTypes such as PAGE_LIST are flat lists of IReaderPublicationNavigationItems.

interface IReaderPublicationNavigationCollection {
    getChildren(): readonly IReaderPublicationNavigationItem[];
    getIndex(): number;
    getTitle(): string;
    getType(): NavigationCollectionType;
    toJSON(): IReaderPublicationNavigationCollectionData;
}

Methods

getChildren

getChildren(): readonly IReaderPublicationNavigationItem[]
The children of this collection.

Returns readonly IReaderPublicationNavigationItem[]

getIndex

getIndex(): number
The index of this collection within the parent array returned by ReaderPublicationNavigation.getNavigationCollections().

Returns number

getTitle

getTitle(): string
The display title of this collection if any exists.

Returns string

getType

getType(): NavigationCollectionType
The type of navigation collection.

Returns NavigationCollectionType

toJSON

toJSON(): IReaderPublicationNavigationCollectionData
Get this instance as a plain JSON object.

Returns IReaderPublicationNavigationCollectionData