The Entry Point for the IPCC Module. Contains classes and methods relevant to ViewerControl.
Classes
- Event
- LoadMarkupLayersRequest
- Mark
- MarkupLayer
- MarkupLayerCollection
- MouseTool
- Promise
- SearchRequest
- SearchResult
- SearchTask
- SearchTaskResult
- ViewerControl
Namespaces
Members
(static, readonly) EventType :string
The `EventType` enumeration defines event types known to IPCC.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 `IPCC.Event` object for this event: - None |
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 `IPCC.Event` object for this event: - `pageCount` {number} The actual page count of the document. |
EstimatedPageCountReady |
string | Event is triggered when the viewer has an estimated page count from the server. Augmented properties of the `IPCC.Event` object for this event: - `pageCount` {number} The estimated page count of the document. |
PageChanged |
string | Event is triggered when the viewer changed the current page. Augmented properties of the `IPCC.Event` object for this event: - none |
PageLoadFailed |
string | Event is triggered when the viewer changed the current page. Augmented properties of the `IPCC.Event` object for this event: - `pageNumber` {number} Indicates the page number of the page that failed to load. - `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 | 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 `IPCC.Event` object for this event: - `pageNumber` {number} The page number of the displayed page. |
PageRotated |
string | Event is triggered when the viewer has displayed a page, not necessarily the content of a page. Augmented properties of the IPCC.ViewerControl.Event object for this event: - `pageNumber` {number} The page number of the page that was rotated. |
DocumentRotated |
string | Event is triggered when the rotation of all pages in the document changes. Augmented properties of the `IPCC.Event` object for this event: - `degreesClockwise` {number} The amount in degrees clockwise the pages were rotated. |
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 `IPCC.Event` object for this event: - `scaleType` {string} Gives an indication of whether the content was `scaledUp` (got bigger) or `scaledDown` (got smaller). - `scaleFactor` {number} Indicates the new scale factor of the viewer. A value of 1 indicates 100% zoom. See also IPCC.ViewerControl#getScaleFactor. - `trigger` {string} Indicates how the scale change was triggered. Possible values are: - "Zoom" - Indicates a direct zoom, such as using the IPCC.ViewerControl#zoomIn, IPCC.ViewerControl#zoomOut, or IPCC.ViewerControl#setScaleFactor methods. - "Fit" - Indicates a change due to a fit type being applied through the IPCC.ViewerControl#fitContent method. - `fitType` {string} Indicates the fit type that was applied, if applicable. This property will only be defined if the `trigger` was Fit, and will be `undefined` otherwise. |
TextSelected |
string | Event is triggered when text is selected. Augmented properties of the IPCC.Event object for this event: - `selectedText` {string} Deprecated since v9.2 (use the `textSelection.text` argument instead). - `pageNumbers` {Array.<number>} Deprecated since v9.2 (use the `textSelection.pageNumber` argument instead). - `textSelection` {IPCC.ViewerControl.TextSelection} An object that provides information regarding the text selection. - `clientX` {number} An optional value indicating the absolute window position in the x-axis of the cursor at the end of the selection. A value for this property is available only when using the `SelectText` mouse tool. - `clientY` {number} An optional value indicating the absolute window position in the y-axis of the cursor at the end of the selection. A value for this property is available only when using the `SelectText` mouse tool. - `handleClientX` {number} An optional value indicating the absolute window position in the x-axis of the handle at the sliding end of the selection. A value for this property is available when the text is initially selected or when the selection is edited. (In either case, one end of the selection is stationary throughout the drag, and the other end is sliding.) - `handleClientY` {number} An optional value indicating the absolute window position in the y-axis of the handle at the sliding end of the selection. A value for this property is available when the text is initially selected or when the selection is edited. (In either case, one end of the selection is stationary throughout the drag, and the other end is sliding.) |
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 `IPCC.Event` object for this event: - `mouseToolName` {string} Indicates the name of the new mouse tool. |
SearchPerformed |
string | Triggered when a search is performed with a call to IPCC.ViewerControl#search. Augmented properties of the IPCC.Event object for this event: - `searchRequest` {IPCC.SearchRequest} The search request returned from the call to IPCC.ViewerControl#search. |
PartialSearchResultsAvailable |
string | Event is triggered when partial search results are available Augmented properties of the IPCC.Event object for this event: - `partialSearchResults` {Array.<IPCC.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 | 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 IPCC.Event object for this event: - `completedSearchResults` {Array.<IPCC.SearchResult>} The set of search results. |
SearchFailed |
string | Event is triggered when search failed to due to an exception. Augmented properties of the IPCC.Event object for this event: - errorMessage {string} A human readable error message indicating why the search failed. |
SearchCancelled |
string | Event is triggered when search is cancelled by the user. Augmented properties of the IPCC.Event object for this event: - none |
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 IPCC.Event object for this event: - `completedSearchResults` {Array.<IPCC.SearchResult>} The set of search results. |
SearchCleared |
string | Event is triggered when the current search is cleared. After this event, calls to IPCC.ViewerControl#setSelectedSearchResult, IPCC.ViewerControl#getSelectedSearchResult, and IPCC.ViewerControl#getSearchRequest will no longer be valid. Augmented properties of the IPCC.Event object for this event: - none |
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 IPCC.Event object for this event: - none |
MarkupLoaded |
string | Event is triggered when annotations are loaded from a file. Triggered when annotations are loaded from a file. Augmented properties of the `IPCC.Event` object for this event: - `name` {string} The name of the markup data that was loaded. - `loadedMarks` {Array.<IPCC.Mark>} The marks that were loaded. |
MarkupSaved |
string | Event is triggered when annotations save to the server. Augmented properties of the `IPCC.Event` object for this event: - `name` {string} The name of the markup data that was saved. |
MarkChanged |
string | Event is triggered when one or more attributes changes on an annotation. Augmented properties of the `IPCC.Event` object for this event: - `mark` {IPCC.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 | Event is triggered when a new annotation is created. Augmented properties of the `IPCC.Event` object for this event: - `mark` {IPCC.Mark} The annotation object. - `pageNumber` {number} The page number of the annotation. - `clientX` {number} An optional value indicating the absolute window position in the x-axis of the cursor at the end of the selection. A value for this property is available only when using a mouse tool to create the mark. Values will be `undefined` for marks added using the API. - `clientY` {number} An optional value indicating the absolute window position in the y-axis of the cursor at the end of the selection. A value for this property is available only when using a mouse tool to create the mark. Values will be `undefined` for marks added using the API. |
MarkRemoved |
string | Event is triggered when a annotation is removed from a page. Augmented properties of the `IPCC.Event` object for this event: - `mark` {IPCC.Mark} The annotation object. - `pageNumber` {number} The page number of the annotation. |
MarkReordered |
string | Event is triggered when the annotation's stacking order has changed. Augmented properties of the `IPCC.Event` object for this event: - `mark` {IPCC.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 | Triggered when the set of selected annotations has changed. Augmented properties of the `IPCC.Event` object for this event: - `pageNumber` {number} The page number containing the mark that was selected or deselected. |
MarkMouseEnter |
string | Event is triggered when the mouse enters the annotation bounding box. Augmented properties of the `IPCC.Event` object for this event: - `mark` {IPCC.Mark} The annotation object. - `clientX` {number} A value indicating the absolute window position in the x-axis of the cursor. - `clientY` {number} A value indicating the absolute window position in the y-axis of the cursor. |
MarkMouseOver |
string | Event is triggered when the mouse moves over the annotation bounding box. Augmented properties of the `IPCC.Event` object for this event: - `mark` {IPCC.Mark} The annotation object. - `clientX` {number} A value indicating the absolute window position in the x-axis of the cursor. - `clientY` {number} A value indicating the absolute window position in the y-axis of the cursor. |
MarkMouseLeave |
string | Event is triggered when the mouse leaves the annotation bounding box. Augmented properties of the `IPCC.Event` object for this event: - `mark` {IPCC.Mark} The annotation object. - `clientX` {number} A value indicating the absolute window position in the x-axis of the cursor. - `clientY` {number} A value indicating the absolute window position in the y-axis of the cursor. |
PageTextReady |
string | Triggered when the text of a page has been loaded in the viewer. Augmented properties of the `IPCC.Event` object for this event: - `pageNumber` {number} The page number of the page that text is ready for. |
Click |
string | Triggered when a user clicks a page or comment pane in the viewer. Augmented properties of the `IPCC.Event` object for this event: - `pageNumber` {number} The page number of the page that was clicked, or null if none. - `targetType` {string} A description of the clicked object: "mark", "page", "comments" or null (if the user clicked in an area outside of a page and outside of the comments panel). - `mark` {object} - The mark object that was clicked, or null if none. - `originalEvent` {object} - A copy of the browser event. - `clientX` {number} - The x window coordinate of the position where the user clicked. - `clientY` {number} - The y window coordinate of the position where the user clicked. |
PageOpening |
string | Triggered when the width and height page attributes are retrieved. Note that this event will fire whenever a page opens, so if a page opens, it will fire, and if the page is scrolled out of view, disposed, and then scrolled back into view, the event will fire again. Augmented properties of the `IPCC.Event` object for this event: - `width` {number} The width in pixels of the page that is opening - `height` {number} The height in pixels of the page that is opening - `pageNumber` {number} The 1-based number of the page that is opening |
(static, readonly) FitType :string
The FitType enumeration defines fit types known by IPCC.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(IPCC.FitType.FullWidth);
// or just use the string value
myViewerControl.fitContent("FullWidth");(static, readonly) MarkHandleMode :string
The MarkHandleMode enumeration defines mark handle modes known by IPCC.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(IPCC.MarkHandleMode.HideCornerHandlesWhenClose);
// or just use the string value
myViewerControl.setMarkHandleMode("HideCornerHandlesWhenClose");(static, readonly) PageLayout :string
The PageLayout enumeration defines page layouts known by IPCC.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:
-
- IPCC.ViewerControl#pageLayout
Example
// use the enumeration
myViewerControl.setPageLayout(IPCC.PageLayout.Horizontal);
// or just use the string value
myViewerControl.setPageLayout("Horizontal");(static, readonly) ScaleTrigger :string
The `ScaleTrigger` enumeration defines actions known to IPCC.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 === IPCC.ScaleTrigger.Pinch
// or just use the string value
ev.trigger === "Pinch"(static, readonly) ViewMode :string
The ViewMode enumeration defines view modes known by IPCC.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 `"EqualFitPages"` enumeration value instead). |
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(IPCC.ViewMode.EqualFitPages);
// or just use the string value
myViewerControl.setViewMode("EqualFitPages");