PCCViewer
is the global namespace used for members of this API.
Classes
- BurnRequest
- Comment
- Conversation
- ConversionRequest
- DocumentHyperlink
- Error
- Event
- ImageStamps
- LoadMarkupLayersRequest
- Mark
- MarkupLayer
- MarkupLayerCollection
- MouseTool
- ObservableCollection
- PrintRequest
- Promise
- SearchRequest
- SearchResult
- SearchTaskResult
- SignatureControl
- SignatureDisplay
- ThumbnailControl
- Viewer
- ViewerControl
Mixins
Namespaces
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 | Description |
---|---|---|
ViewerReady |
string |
Triggered when the Viewer is ready. Augmented properties of the PCCViewer.Event object for this event:
|
PageCountReady |
string |
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:
|
EstimatedPageCountReady |
string |
Event is triggered when the viewer has an estimated page count from the server. Augmented properties of the PCCViewer.Event object for this event:
|
PageChanged |
string |
Event is triggered when the viewer changed the current page. Augmented properties of the PCCViewer.Event object for this event:
|
PageLoadFailed |
string |
Event is triggered when the viewer changed the current page. Augmented properties of the PCCViewer.Event object for this event:
|
PageDisplayed |
string |
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. Note that if the maxOutOfViewDisplay viewer parameter is greater than 0, then out-of-view pages will be displayed (the page content will be loaded in the DOM, though the page will not be visible since it is out of view). In this scenario, the PageDisplayed event will fire for out-of-view pages. Augmented Properties of the PCCViewer.Event object for this event:
|
PageRotated |
string |
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:
|
DocumentRotated |
string |
Event is triggered when the rotation of all pages in the document changes. Augmented properties of the PCCViewer.Event object for this event:
|
ScaleChanged |
string |
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:
|
DocumentPrinted |
string |
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:
|
TextSelected |
string |
Event is triggered when text is selected. Augmented properties of the PCCViewer.Event object for this event:
|
MouseToolChanged |
string |
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:
|
SearchPerformed |
string |
Triggered when a search is performed with a call to PCCViewer.ViewerControl#search. Augmented properties of the PCCViewer.Event object for this event:
|
PartialSearchResultsAvailable |
string |
Event is triggered when partial search results are available Augmented properties of the PCCViewer.Event object for this event:
|
SearchCompleted |
string |
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 |
Event is triggered when search failed to due to an exception. Augmented properties of the PCCViewer.Event object for this event:
|
SearchCancelled |
string |
Event is triggered when search is cancelled by the user. Augmented properties of the PCCViewer.Event object for this event:
|
SearchResultsAvailable |
string |
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 |
Event is triggered when the current search is cleared. After this event, calls to PCCViewer#setSelectedSearchResult, PCCViewer#getSelectedSearchResult, and PCCViewer#getSearchRequest will no longer be valid. Augmented properties of the PCCViewer.Event object for this event:
|
SearchResultSelectionChanged |
string |
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:
|
PrintRequested |
string |
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 |
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:
|
MarkupSaved |
string |
Event is triggered when annotations save to the server. Augmented properties of the PCCViewer.Event object for this event:
|
MarkChanged |
string |
Event is triggered when one or more attributes changes on an annotation. Augmented properties of the PCCViewer.Event object for this event:
|
MarkCreated |
string |
Event is triggered when a new annotation is created. Augmented properties of the PCCViewer.Event object for this event:
|
MarkRemoved |
string |
Event is triggered when a annotation is removed from a page. Augmented properties of the PCCViewer.Event object for this event:
|
MarkReordered |
string |
Event is triggered when the annotation's stacking order has changed. Augmented properties of the PCCViewer.Event object for this event:
|
MarkSelectionChanged |
string |
Triggered when the set of selected annotations has changed. Augmented properties of the PCCViewer.Event object for this event:
|
CommentsPanelToggled |
string |
Triggered when the comments panel opens or closes. Augmented properties of the PCCViewer.Event object for this event:
|
CommentCreated |
string |
Triggered when a comment is added to a Conversation in the viewer. Augmented properties of the PCCViewer.Event object for this event:
|
CommentRemoved |
string |
Triggered when a comment is removed from a Conversation in the viewer. Augmented properties of the PCCViewer.Event object for this event:
|
CommentChanged |
string |
Triggered when the text of a comment in the viewer has changed. Augmented properties of the PCCViewer.Event object for this event:
|
PageTextReady |
string |
Triggered when the text of a page has been loaded in the viewer. Augmented properties of the PCCViewer.Event object for this event:
|
Click |
string |
Triggered when a user clicks a page or comment pane in the viewer. Augmented properties of the PCCViewer.Event object for this event:
|
(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 | Description |
---|---|---|
FullWidth |
string |
The viewer scales the content to fill the width of the viewer. |
ShrinkToWidth |
string |
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. |
ActualSize |
string |
The viewer shows the content actual size. The content is not scaled. |
FullHeight |
string |
The viewer scales the content to fill the height of the viewer, based on the largest known page height. |
FullPage |
string |
The viewer scales the content to best fit the largest known page in the viewer. |
Example
// us the enumeration
myViewerControl.fitContent(PCCViewer.FitType.FullWidth);
// or just use the string value
myViewerControl.fitContent("FullWidth");
(static, readonly) MarkHandleMode :string
The MarkHandleMode enumeration defines mark handle modes known by PCCViewer.ViewerControl. The ViewerControl
uses a specified mark handle mode to determine how the mark handles are shown.
Note: This enumeration is a convenience for API developers. Instead of using it, you can pass in the string values of the mode (enumeration values) directly to the API.
Type:
- string
Properties:
Name | Type | Description |
---|---|---|
HideSideHandlesWhenClose |
string | |
HideCornerHandlesWhenClose |
string |
Example
// use the enumeration
myViewerControl.setMarkHandleMode(PCCViewer.MarkHandleMode.HideCornerHandlesWhenClose);
// or just use the string value
myViewerControl.setMarkHandleMode("HideCornerHandlesWhenClose");
(static, readonly) PageLayout :string
The PageLayout enumeration defines page layouts known by PCCViewer.ViewerControl. The ViewerControl
uses a specified page layout to set or update the placement or arrangement of the pages 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 page layout (enumeration values) directly to the API.
Type:
- string
Properties:
Name | Type | Description |
---|---|---|
Horizontal |
string |
Pages are displayed as a single horizontal row and a horizontal scroll bar is displayed to bring into view the pages that are not in view. |
Vertical |
string |
Pages are displayed as a single vertical column and a vertical scroll bar is displayed to bring into view the pages that are not in view. |
- See:
-
- PCCViewer.ViewerControl#pageLayout
Example
// use the enumeration
myViewerControl.setPageLayout(PCCViewer.PageLayout.Horizontal);
// or just use the string value
myViewerControl.setPageLayout("Horizontal");
(static, readonly) RedactionViewMode :string
The RedactionViewMode enumeration defines redaction view modes known by PCCViewer.ViewerControl. The ViewerControl
uses a specified redaction view mode to set visibility of the text underneath the redaction rectangle marks that are opaque.
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 | Description |
---|---|---|
Draft |
string |
The viewer displays the document content underneath the redaction rectangles in the document. |
Normal |
string |
The viewer hides the document content underneath the redaction rectangles. |
Example
// use the enumeration
myViewerControl.setRedactionViewMode(PCCViewer.ViewMode.Draft);
// or just use the string value
myViewerControl.setRedactionViewMode("Draft");
(static, readonly) ScaleTrigger :string
The ScaleTrigger
enumeration defines actions known to PCCViewer.ViewerControl that alter page scaling.
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 | Description |
---|---|---|
Pinch |
string | |
Zoom |
string | |
Fit |
string | |
ViewMode |
string |
Example
// use the enumeration
ev.trigger === PCCViewer.ScaleTrigger.Pinch
// or just use the string value
ev.trigger === "Pinch"
(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 | Description |
---|---|---|
Document |
string |
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 |
Deprecated since v10.0 (use the |
SinglePage |
string |
The viewer displays a single page at a time. Each page is scaled to fit within a view box, which is the initial size of the viewer and increases in size when zooming in (and decreases in size when zooming out). After the viewer initializes, the view mode may not be changed to or from SinglePage view mode (an Error will be thrown in this case). |
EqualFitPages |
string |
The viewer scales each page so that their width is the same, when using vertical page layout. 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. If using horizontal page layout, the viewer scales each page so that their height is the same. |
Example
// use the enumeration
myViewerControl.setViewMode(PCCViewer.ViewMode.EqualFitPages);
// or just use the string value
myViewerControl.setViewMode("EqualFitPages");