Prizm Content Connect
Namespace: PCCViewer
Working with the Viewer > Developer Reference > API > Namespace: PCCViewer

Namespace: PCCViewer

PCCViewer

PCCViewer is the global namespace used for members of this API.

Classes

Event
Mark
MouseTool
PrintRequest
Promise
SearchRequest
SearchResult
Viewer
ViewerControl

Namespaces

MouseTools

Members

<static, readonly> EventType :string

The EventType enumeration defines event types known to PCCViewer.ViewerControl.

Note: This enumeration is for convenience for API developers. Instead of using this enumeration, you can pass string values of the eventType (enumeration values)

Type:
  • string
Properties:
Name Type Default Description
PageCountReady string PageCountReady

Event is triggered when the viewer has an actual page count from the server and the consumer can begin to interact with the viewer interfaces.

Augmented properties of the PCCViewer.Event object for this event:

  • pageCount {number} The actual page count of the document.
EstimatedPageCountReady string EstimatedPageCountReady

Event is triggered when the viewer has an estimated page count from the server.

Augmented properties of the PCCViewer.Event object for this event:

  • pageCount {number} The estimated page count of the document.
PageChanged string PageChanged

Event is triggered when the viewer changed the current page.

Augmented properties of the PCCViewer.Event object for this event:

  • none
PageLoadFailed string PageLoadFailed

Event is triggered when the viewer changed the current page.

Augmented properties of the PCCViewer.Event object for this event:

  • statusCode {number} Indicates the HTTP page load failure error code returned by the image service
  • accusoftErrorNumber {number} The error codes in this category currently are:
    • 4001 Document requires a password (HTTP statusCode will be 480)
    • 5001 Unable to generate Page (HTTP statusCode will be 580)
    • 5002 Download of the file to the Image service failed (HTTP statusCode will be 580)
  • accusoftErrorMessage {string} Description of the error provided by the Image service
PageDisplayed string PageDisplayed

Event is triggered when the viewer has displayed a page. If the content of a page is large, for example an engineering drawing with several hundred nodes, then the browser may be busy still rendering/preparing the content when this event gets fired.

Augmented Properties of the PCCViewer.Event object for this event:

  • pageNumber {number} The page number of the displayed page.
PageRotated string PageRotated

Event is triggered when the viewer has displayed a page, not necessarily the content of a page.

Augmented properties of the PCCViewer.ViewerControl.Event object for this event:

  • pageNumber {number} The page number of the page that was rotated.
ScaleChanged string ScaleChanged

Event is triggered when the scaling of page(s) in the viewer changed. After the user actions, zoom buttons pressed, zoom api called, fit type changed, viewer mode changed and that resulted in a scale change.

Augmented properties of the PCCViewer.Event object for this event:

  • scaleType {string} Gives an indication of whether the content was scaledUp (got bigger) or scaledDown (got smaller)
DocumentPrinted string DocumentPrinted

Event is triggered when the .windowMode property of the viewer changed.

Augmented properties of the PCCViewer.Event object for this event:

  • pageNumbers {Array.<number>} An array containing the page number of each page that was printed. NOTE: In the PageView viewer, the array contains the current page only.
  • orientation {string} "portrait" or "landscape"
  • includeMarks {boolean} Indicats whether the marks were included in the printed pages.
TextSelected string TextSelected

Event is triggered when the print button was clicked in the viewer's print dialog. We have no way to know if the page printed in the system print dialog

Augmented properties of the PCCViewer.Event object for this event:

  • selectedText {string} Indicates the value of the selected text. This is plain text without any formatting.
MouseToolChanged string MouseToolChanged

Event is triggered when the mouse tool changed. This change could be initiated through the viewer's toolbar, viewer's context menu, or viewer's API.

Augmented properties of the PCCViewer.Event object for this event:

  • mouseToolName {string} Indicates the name of the new mouse tool.
PartialSearchResultsAvailable string PartialSearchResultsAvailable

Event is triggered when partial search results are available

Augmented properties of the PCCViewer.Event object for this event:

  • partialSearchResults {Array.<PCCViewer.SearchResult>} The new search results found since the last "PartialSearchResultsAvailable" event.
  • pagesWithoutText {Array.<number>} The set of pages that could not be searched because searchable text was not available for the page. This includes only the pages on which searching was attempted since the last "PartialSearchResultsAvailable" event.
SearchCompleted string SearchCompleted

Event is triggered when search is completed successfully, user cancelled, or an exception. This event will also return the searchResult object to the consumer

Augmented properties of the PCCViewer.Event object for this event:
SearchFailed string SearchFailed

Event is triggered when search failed to due to an exception.

Augmented properties of the PCCViewer.Event object for this event:

  • none
SearchCancelled string SearchCancelled

Event is triggered when search is cancelled by the user.

Augmented properties of the PCCViewer.Event object for this event:

  • errorMessage {string} A human readable error message indicating why the search failed.
SearchResultsAvailable string SearchResultsAvailable

Event is triggered when search is completed and the results are available. This event will return the full results object to the consumer if available.

Augmented properties of the PCCViewer.Event object for this event:
SearchCleared string SearchCleared

Event is triggered when the current search is cleared. After this event, calls to PCCViewer#setSelectedSearchResult, {@link PCCViewer#getSelectedSearchResult}, and PCCViewer#getSearchRequest will no longer be valid.

Augmented properties of the PCCViewer.Event object for this event:

  • none
SearchResultSelectionChanged string SearchResultSelectionChanged

Event is triggered when the selected search result changes, including when the first result is selected, the selection is cleared, or the selection changes from one result to another.

Augmented properties of the PCCViewer.Event object for this event:

  • none
PrintRequested string PrintRequested

Event is triggered when a document print is requested through PCCViewer.ViewerControl#print.

Augmented properties of the PCCViewer.Event object for this event:
MarkupLoaded string MarkupLoaded

Event is triggered when annotations are loaded from a file. Triggered when annotations are loaded from a file.

Augmented properties of the PCCViewer.Event object for this event:

  • name {string} The name of the markup data that was loaded.
MarkupSaved string MarkupSaved

Event is triggered when annotations save to the server.

Augmented properties of the PCCViewer.Event object for this event:

  • name {string} The name of the markup data that was saved.
MarkChanged string MarkChanged

Event is triggered when one or more attributes changes on an annotation.

Augmented properties of the PCCViewer.Event object for this event:

  • mark {PCCViewer.Mark} The changed annotation object
  • pageNumber {number} The page number of the annotation.
  • propertyNames {Array.<string>} The names of properties that have changed.
MarkCreated string MarkCreated

Event is triggered when a new annotation is created.

Augmented properties of the PCCViewer.Event object for this event:

  • mark {PCCViewer.Mark} The annotation object.
  • pageNumber {number} The page number of the annotation.
MarkRemoved string MarkRemoved

Event is triggered when a annotation is removed from a page.

Augmented properties of the PCCViewer.Event object for this event:

  • mark {PCCViewer.Mark} The annotation object.
  • pageNumber {number} The page number of the annotation.
MarkReordered string MarkReordered

Event is triggered when the annotation's stacking order has changed.

Augmented properties of the PCCViewer.Event object for this event:

  • mark {PCCViewer.Mark} The annotation object.
  • pageNumber {number} The page number of the annotation.
  • index {number} The new stacking order index of the annotation.
  • oldIndex {number} The old stacking order index of the annotation.
MarkSelectionChanged string MarkSelectionChanged

Triggered when the set of selected annotations has changed.

Augmented properties of the PCCViewer.Event object for this event:

  • pageNumber {number} The page number containing the mark that was selected or deselected.
ViewerReady string ViewerReady

Triggered when the Viewer is ready.

Augmented properties of the PCCViewer.Event object for this event:

  • None
SearchPerformed string SearchPerformed

Triggered when a search is performed with a call to PCCViewer.ViewerControl#search.

Augmented properties of the PCCViewer.Event object for this event:
See:

<static, readonly> FitType :string

The FitType enumeration defines fit types known by PCCViewer.ViewerControl. The ViewerControl uses a specified fit type to set or update the scaling of the pages displayed in the viewer.

Note: This enumeration is a convenience for API developers. Instead of using it, you can pass in the string values of the fit type (enumeration values) directly to the API.

Type:
  • string
Properties:
Name Type Default Description
FullWidth string FullWidth

The viewer scales the content to fill the width of the viewer.
ShrinkToWidth string ShrinkToWidth

The viewer will scale down the content until it fits fully width-wise into view. The page will not be scaled up if it already fits.
See:
Example
// us the enumeration
myViewerControl.fitContent(PCCViewer.FitType.FullWidth);

// or just use the string value
myViewerControl.fitContent("FullWidth");

<static, readonly> ViewMode :string

The ViewMode enumeration defines view modes known by PCCViewer.ViewerControl. The ViewerControl uses a specified view mode to set or update how documents that contain different sized pages are displayed in the viewer.

Note: This enumeration is a convenience for API developers. Instead of using it, you can pass in the string values of the view mode (enumeration values) directly to the API.

Type:
  • string
Properties:
Name Type Default Description
Document string Document

The viewer maintains the relative size of each page when displaying a document. For example, if page 2 is smaller than page 1, it will appear smaller.
EqualWidthPages string EqualWidthPages

The viewer scales each page so that their width is the same. For example, if page 2 is smaller than page 1, it will be scaled larger so that its width is equal to the width of page 1.
See:
Example
// use the enumeration
myViewerControl.setViewMode(PCCViewer.ViewMode.EqualWidthPages);

// or just use the string value
myViewerControl.setViewMode("EqualWidthPages");

 

 

©2014. Accusoft Corporation. All Rights Reserved.

Send Feedback