Colibrio Reader Framework API - Cloud license
    Preparing search index...

    Interface INavigationIntentEngineEvent

    EngineEvent used with the "navigationIntent" event type. Fired when a "navigation intent" occurs that was NOT initiated by a call to ReaderView.next(), ReaderView.previous(), ReaderView.goToStart() or ReaderView.goTo().

    Some examples are:

    • User clicks a link in the publication.
    • A scripted content document has triggered navigation.

    The default action by the reading system is to navigate to the intended locator, but only if the locator points to a ReaderDocument assigned to the ReaderView. Otherwise, nothing is done.

    To prevent the default behaviour, call preventDefault().

    interface INavigationIntentEngineEvent {
        cancelable: boolean;
        defaultPrevented: boolean;
        immediatePropagationStopped: boolean;
        internalNavigation: boolean;
        isTrusted: boolean;
        locator: ILocator;
        propagationStopped: boolean;
        readerDocument: IReaderDocument;
        readerView: IReaderView;
        relatedEvent: IMouseEngineEvent;
        sourceReaderDocument: IReaderDocument;
        type: keyof IEngineEventTypeMap;
        preventDefault(): void;
        stopImmediatePropagation(): void;
        stopPropagation(): void;
        toJSON(): INavigationIntentEngineEventData;
    }

    Hierarchy (View Summary)

    Properties

    cancelable: boolean

    If this event's default action is cancelable. See respective engine event for its definition of default action.

    defaultPrevented: boolean

    If this event's default action has been canceled/prevented by a call to preventDefault()

    immediatePropagationStopped: boolean

    True if stopImmediatePropagation() was called on this event.

    internalNavigation: boolean

    If the locator points to a ReaderDocument in the ReaderView.

    isTrusted: boolean

    If this event runs in a "trusted" context, i.e. the event callback is executed during a user-generated event such as "click" or "pointerdown".

    locator: ILocator

    The locator for the navigation.

    propagationStopped: boolean

    True if stopPropagation() was called on this event.

    readerDocument: IReaderDocument

    The target ReaderDocument to navigate to. This field is only set if the locator points to a ReaderDocument within a ReaderPublication loaded in the ReadingSystemEngine.

    readerView: IReaderView

    The ReaderView instance this event is related to.

    relatedEvent: IMouseEngineEvent

    The MouseEngineEvent that triggered this navigation intent if available.

    sourceReaderDocument: IReaderDocument

    The source ReaderDocument where the event was triggered. This field is only set if the locator points to a ReaderDocument within a ReaderPublication loaded in the ReadingSystemEngine.

    type: keyof IEngineEventTypeMap

    The type of event.

    Methods

    • Prevent the event's default action. See the respective engine event for its definition of default action.

      Returns void

    • Stops this event from propagating to listeners on the ReadingSystemEngine instance, if called from a listener added to a ReaderView instance. If the event has already propagated to the ReadingSystemEngine instance, calling this method has no effect.

      Returns void

    Properties
    Methods