Options
All
  • Public
  • Public/Protected
  • All
Menu

Options for fetching navigation item references from a ContentLocation.

Hierarchy

  • IFetchNavigationItemReferencesOptions

Index

Properties

Optional collectionTypes

collectionTypes?: NavigationCollectionType[]

What navigation collection types to fetch references for. If not specified, all navigation collection types are assumed.

nodefault

Optional greedy

greedy?: boolean

If true, extra navigation item references before the locator may be included in the "itemsInRange" list in order to make sure that all content targeted by the locator are mapped to a corresponding navigation item.

For example: You would typically want to set this to true when fetching references to TOC or PAGE_LIST for example. You would typically want to set this to false when fetching references to LIST_OF_ILLUSTRATIONS.

default

false

Generated using TypeDoc