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

    Interface IPublicationStorageChangedEngineEvent

    Event used if a publication storage, localStorage or sessionStorage, was changed.

    interface IPublicationStorageChangedEngineEvent {
        cancelable: boolean;
        defaultPrevented: boolean;
        immediatePropagationStopped: boolean;
        isTrusted: boolean;
        key: string;
        newValue: string;
        oldValue: string;
        propagationStopped: boolean;
        readerDocumentIndexInSpine: number;
        readerPublication: IReaderPublication;
        readerView: IReaderView;
        storageAreaType: ReaderPublicationStorageAreaType;
        type: keyof IEngineEventTypeMap;
        preventDefault(): void;
        stopImmediatePropagation(): void;
        stopPropagation(): void;
        toJSON(): IPublicationStorageChangedEngineEventData;
    }

    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.

    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".

    key: string

    A string with the key for the storage item that was changed. The key attribute is null when the change is caused by the storage clear() method.

    newValue: string

    A string with the new value of the storage item that was changed. This value is null when the change has been invoked by storage clear() method, or the storage item has been removed from the storage.

    oldValue: string

    A string with the original value of the storage item that was changed. This value is null when the storage item has been newly added and therefore doesn't have any previous value.

    propagationStopped: boolean

    True if stopPropagation() was called on this event.

    readerDocumentIndexInSpine: number

    Represents the index of the ReaderDocument in the publication's spine where the storage change originated. If this property is null, the storage change was initiated by the application via the IReaderPublicationStorageArea API.

    readerPublication: IReaderPublication

    The ReaderPublication instance associated with the storage change.

    readerView: IReaderView

    The ReaderView instance this event is related to, if any.

    storageAreaType: ReaderPublicationStorageAreaType

    The type of the affected storage area.

    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