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

    Interface ISelectionChangedEngineEventData

    EngineEvent type used for "selectionChanged" events.

    interface ISelectionChangedEngineEventData {
        cancelable: boolean;
        defaultPrevented: boolean;
        immediatePropagationStopped: boolean;
        isRange: boolean;
        isTrusted: boolean;
        locator: ISimpleLocatorData;
        objectType: EngineEventDataObjectType;
        propagationStopped: boolean;
        readerDocumentIndexInSpine: number;
        readerViewName: string;
        selectionText: string;
        type: keyof IEngineEventTypeMap;
    }

    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.

    isRange: boolean

    If the selection is a range or a position.

    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: ISimpleLocatorData

    A locator describing the selection A value of null means that nothing is currently selected.

    objectType: EngineEventDataObjectType

    The type of engine event object this JSON structure represents.

    SELECTION_CHANGED_ENGINE_EVENT
    propagationStopped: boolean

    True if stopPropagation() was called on this event.

    readerDocumentIndexInSpine: number

    The index of the reader document that was the target of the event if any.

    readerViewName: string

    The name of the ReaderView this event is related to.

    selectionText: string

    The text contents of the selection range.

    type: keyof IEngineEventTypeMap

    The type of event.

    Properties