1.0.5 • Published 8 years ago

prizmdoc-reader v1.0.5

Weekly downloads
6
License
MIT
Repository
github
Last release
8 years ago

Accusoft PrizmDoc HTML5 Document Reader

If you're building an application that requires an easy-to-implement document viewer, then using Accusoft Services to display documents is perfect for you. With just a few lines of code, you can embed a document viewer into any web application or site. Start with our configurator here or read the FAQs.

You can view dozens of file types within a browser without the need to download additional applications. Easily add document viewing and search to your web applications using only HTML5 standard technologies. Create a trial PrizmDoc Reader account, which gives you up to 100 free transactions per month. Sign up for a free account now to get started.

PrizmDoc supports more than 300 file types, including :

  • Doc
  • PDF
  • PPT
  • XLS
  • CAD

Install

npm install prizmdoc-reader

Initializing the viewer

Note: jQuery version 1.6 or higher is required to run PrizmDoc Reader.

<script src="https://ajax.googleapis.com/ajax/libs/jquery/1.12.2/jquery.min.js"></script>
<script src="prizmdoc-reader.js" type="text/javascript"></script>
<script>
  getViewer(prizmDocKeyValue, documentUrl, viewerElementId, {optionalParameter : OptionalValue});
</script>

Request Type

GET

Request Headers

NameDiscriptionDetails
acs-api-keyYour api key {{api-key-value}}Required

Parameters

NameDiscriptionDetails
keyYour api key {{api-key-value}}Required
documentThe direct url to the document you wish to displayRequired
viewerElementIdViewer Iframe will be loaded within this HTML Element IDRequired
regionPrizmDoc Reader will be running on US Servers or EU Servers based on your API key (USA Default)Optional
logoimageChanges the logo image that displays before the viewer is loaded (url)Optional
viewertypeChoosing between either the html5 viewer or the slideshow version (html5 or slideshow)Optional
viewerwidthViewer width in pixelsOptional
viewerheightviewer height in pixelsOptional
lowerToolbarColorChanges the color of the toolbar using hex color codes without the # (i.e. FFFFFF)Optional
upperToolbarColorChanges the color of the toolbar using hex color codes without the # (i.e. FFFFFF)Optional
bottomToolbarColorChanges the color of the toolbar using hex color codes without the # (i.e. FFFFFF)Optional
backgroundColorChanges the color of the background using hex color codes without the # (i.e. FFFFFF)Optional
fontColorChanges the color of the toolbar font using hex color codes without the # (i.e. FFFFFF)Optional
animdurationSets the amount of time between slide changes in ms (int)Optional
animspeedSets the amount of time between slide changes in ms (int)Optional
hideAllfalseOptional
automaticShould the slideshow start and rotate automatically (yes / no)Optional
showcontrolsShould the controls display on hover? (yes / no)Optional
centercontrolsShould the controls be centered or at the top of the slideshow (yes / no)Optional
keyboardnavAllow for keyboard navigation (yes / no)Optional
hoverpauseShould the slideshow pause on hover? (yes / no)Optional

Request Body

Empty.

Response Header

NameValue
Content-Encodinggzip
Content-Typetext/html

Response Body

Returns the document within the viewer itself with all the parameters you defined when initializing the viewer.

For More Info

PrizmDoc Reader

Version

1.0.0

License

MIT

©2016. Accusoft Corporation. All Rights Reserved.