Interface Facade

Allows for the management of navigation modes.

interface Facade {
    addEventListener<K extends "onNavigationControllerChanged">(
        event: K,
        listener: (eventData: NavigationAPI.Events[K]) => void,
    ): { remove: () => void };
    getAvailableNavigationModes(): NavigationMode[];
    getNavigationMode(): NavigationMode;
    setNavigationMode(mode: NavigationMode): void;
}

Hierarchy (View Summary)

EventEmitterInterface<NavigationAPI.Events>
- Facade

Implemented by

AssetNavigationSdkFacade

Index

Methods

addEventListener getAvailableNavigationModes getNavigationMode setNavigationMode

Methods

addEventListener

addEventListener<K extends "onNavigationControllerChanged">(
event: K,
listener: (eventData: NavigationAPI.Events[K]) => void,
): { remove: () => void }
Type Parameters
- K extends "onNavigationControllerChanged"
Parameters
- event: K
- listener: (eventData: NavigationAPI.Events[K]) => void
Returns { remove: () => void }
Inherited from EventEmitterInterface.addEventListener
- Defined in core/src/lib/Event/EventEmitter.ts:7

getAvailableNavigationModes

getAvailableNavigationModes(): NavigationMode[]
Returns NavigationMode[]
AssetNavigationMode[] - An array of available navigation modes.
- Defined in embedded/engine/src/lib/sdk/AssetNavigationFacade.ts:40

getNavigationMode

getNavigationMode(): NavigationMode
Returns NavigationMode
AssetNavigationMode - The current navigation mode.
- Defined in embedded/engine/src/lib/sdk/AssetNavigationFacade.ts:35

setNavigationMode

setNavigationMode(mode: NavigationMode): void
Parameters
- mode: NavigationMode
  The desired navigation mode to set.
Returns void
- Defined in embedded/engine/src/lib/sdk/AssetNavigationFacade.ts:45