Some test text!
iOS / Guides
Creates a NativeViewer and embeds it on the HTML page.
Options passed to the NativeViewer, available options are:
initialDoc
: string, optional - the URL path to a document to load on startupl
: string, optional - the Apryse license keydisabledElements
: array of string, optional - hides multiple elements in the viewer, see disableElements
for list of available optionsboundingRect
: object, optional - the bounding box for where NativeViewer should be embedded. If no boundingRect
is provided, the viewer will be presented full screen.topLeftButtonTitle
: string, optional - the menu item for top left navigation button, shown as icon on Android and text on iOS, available options are: menu
, close
, back
showTopLeftButton
: boolean, optional - whether to show the top left navigation buttonType | Required | Default |
---|---|---|
object | true | N/A |
An html element. If an element is provided, the viewer will be added at the location specified by boundingRect
. (If no boundingRect
is provided, on iOS the viewer will be presented directly over the element itself, and on Android the viewer will be presented full screen.) If no element is provided, the API showDocumentViewer()
must be used to show the viewer.
Type | Required | Default |
---|---|---|
string | false | N/A |
var viewerElement = document.getElementById('viewer');
var rect = viewerElement.getBoundingClientRect();
var viewer = new Apryse.NativeViewer({
l: '<your-key-here>',
initialDoc: 'https://pdftron.s3.amazonaws.com/downloads/pl/PDFTRON_mobile_about.pdf',
boundingRect: { left: rect.left, top: rect.top, width: rect.width, height: rect.height },
disabledElements: [
// hide elements as you wish
]
}, viewerElement);
Hides multiple elements in the viewer, available options are:
Array of element keys.
Type | Required | Default |
---|---|---|
array of string | true | N/A |
// remove search button and line create tool
this.viewer.disableElements([ 'searchButton', 'lineToolButton' ]);
Disable multiple tools.
Array of name of the tools, available options are:
Type | Required | Default |
---|---|---|
array of string | false | all tools |
// enable sticky annotation tool and free text tool
this.viewer.disableTools([ 'AnnotationCreateSticky', 'AnnotationCreateFreeText' ]);
Enable multiple tools that were previously disabled.
Array of name of the tools, available options are:
Type | Required | Default |
---|---|---|
array of string | false | all tools |
// enable sticky annotation tool and free text tool
this.viewer.disableElements([ 'AnnotationCreateSticky', 'AnnotationCreateFreeText' ]);
Sets tool mode.
Name of the tool, available options are:
Type | Required | Default |
---|---|---|
string | true | N/A |
// sets the current tool mode to freehand inking
this.viewer.setToolMode('AnnotationCreateFreeHand');
Load a document inside NativeViewer UI.
Path to the document.
Type | Required | Default |
---|---|---|
string | true | N/A |
this.viewer.loadDocument('https://pdftron.s3.amazonaws.com/downloads/pl/PDFTRON_mobile_about.pdf');
Shows a previously constructed NativeViewer.
If a boundingRect
is defined, the viewer will be displayed on top of the web content within the specified rect. If no boundingRect
is defined, the viewer will be presented full screen.
this.viewer.showDocumentViewer();
Get the answers you need: Chat with us