PrizmDoc Viewer v13.20 Release - Updated
API Reference / Viewer Control / Namespace: PCCViewer / Class: Viewer
In This Topic
    Class: Viewer
    In This Topic

    PCCViewer. Viewer

    This class gives programmatic access to the HTML 5 viewer.

    Constructor

    new Viewer()

    Use the jQuery plugin external:jQuery.fn#pccViewer to create the viewer.

    See:

    Fires:

    Example

    // Create an instance of the class using the jQuery plugin
    $("#mydiv").pccViewer(options); // returns PCCViewer.Viewer instance
    

    Members

    viewerControl :PCCViewer.ViewerControl

    Gets the PCCViewer.ViewerControl object used by the viewer instance. Through the PCCViewer.ViewerControl object, the caller has API access to control the viewer behavior.

    Type:

    Methods

    destroy()

    Cleans up the viewer DOM elements and leaves the elements as they were. This method also destroys the PCCViewer.ViewerControl object by calling PCCViewer.ViewerControl#destroy on the ViewerControl that is associated with this viewer.

    Example

    var viewerPlugin = $('#mydiv').pccViewer(options);
    var viewerControl = viewerPlugin.viewerControl;
    
    viewerPlugin.destroy();
    

    Events

    ViewerReady

    Fired when the viewer has initialized and is ready to be manipulated.

    Type:

    Example

    $('#mydiv').on('ViewerReady', function(pccViewer) {
        var marks = pccViewer.viewerControl.getAllMarks();
    });
    
    $('#mydiv').pccViewer(options);
    

    Documentation generated by JSDoc 3.3.3 on Tue Apr 19 2022 13:54:15 GMT-0400 (Eastern Daylight Time)