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

    Interface IEngineEventTargetData

    Contains information about the publication content targeted by an EngineEvent.

    objectType

    interface IEngineEventTargetData {
        frameworkComponent: EngineEventTargetFrameworkComponent;
        locator: ISimpleLocatorData;
        mediaType: string;
        nodeData: IEngineEventTargetXmlElementNodeData;
        objectType: EngineEventTargetObjectType;
        readerDocumentIndexInSpine: number;
    }

    Hierarchy (View Summary)

    Properties

    frameworkComponent: EngineEventTargetFrameworkComponent

    Describes the framework component that was the target of the event.

    locator: ISimpleLocatorData

    A locator that points to the publication content related with the event.

    mediaType: string

    Describes the media type of the document related with the event, and thereby what data types to expect in nodeData

    This can be for example:

    • MediaType.APPLICATION_SMIL ("application/smil+xml") if node is a par node within a SMIL document.
    • MediaType.APPLICATION_XHTML ("application/xhtml+xml") if node is a XHTML node.
    • MediaType.APPLICATION_SVG ("image/svg") if node is a SVG node.

    Some events will not generate any nodeData. In those cases, mediaType will be the empty string ''

    nodeData: IEngineEventTargetXmlElementNodeData

    A JSON compatible data structure representing the underlying node that was the target of the event, like for example a HTML node in a HTML content-document.

    objectType: EngineEventTargetObjectType

    The type of EngineEventTarget object this JSON structure represents.

    ENGINE_EVENT_TARGET
    readerDocumentIndexInSpine: number

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

    Properties