PrizmDoc® v14.3 Release - Updated January 14, 2025
PrizmDoc / API Reference / Viewer Control / Namespace: PCCViewer / Class: Viewer
Class: Viewer

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.

Example

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

See:

Fires:

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

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

Example

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

$('#mydiv').pccViewer(options);

Type:


Documentation generated by JSDoc 3.6.10 on Thu Oct 31 2024 15:02:24 GMT+0000 (Coordinated Universal Time)