getErrorMessage: function()

The error message returned by the processing service.

Parameters

none

Returns

string

Example

var error = document.getErrorMessage();

getFileName: function()

The file name.

Parameters

none

Returns

integer

Example

var size = document.getFileName();

getFileSize: function()

The file size in bytes.

Parameters

none

Returns

integer

Example

var size = document.getFileSize();

getFileType: function()

The file type as a string (‘doc’, ‘pdf’, ‘xls’).

Parameters

none

Returns

string

Example

var type = document.getFileType();

getHeight: function( idZoom )

The page height in pixels at the passed in zoom level.

Parameters

Returns

integer

Example

var height = document.getHeight(2);

getHeightThumb: function()

The height of the thumbnail in pixels.

Parameters

none

Returns

integer

Example

var height = document.getHeightThumb();

getId: function()

The document ID.

Parameters

none

Returns

string

Example

var id = document.getId();

getImageType: function()

The image type extension returned as a string (‘jpg’, ‘png’, etc).

Parameters

none

Returns

string

Example

var type = document.getImageType();

getModifiedAt: function()

The last date the document was modified.

Parameters

none

Returns

string

Example

var date = document.getModifiedAt();

getPageCount: function()

The length of the document in number of pages.

Parameters

none

Returns

integer

Example

var page_count = document.getPageCount();

getSubject: function()

The document subject metadata.

Parameters

none

Returns

string

Example

var subject = document.getSubject();

getSubmittedAt: function()

The last date the document was modified.

Parameters

none

Returns

string

Example

var date = document.getSubmittedAt();

getTitle: function()

The title of the document.

Parameters

none

Returns

string

Example

var title = document.getTitle();

getUrl: function()

The URL of the document.

Parameters

none

Returns

string

Example

var url = document.getUrl();

getUrlImage: function( idPage, idZoom )

The URL of the image at the specified page and zoom level.

Parameters

Returns

string

Example

var url = viewer.getDocument().getUrlImage(0, 1);

getUrlImageThumb: function( idPage )

The URL of the thumbnail image at the specified zoom level.

Parameters

Returns

string

Example

var url = viewer.getDocument().getUrlImageThumb(0);

getWidth: function( idZoom )

The page width in pixels at the passed in zoom level.

Parameters

Returns

integer

Example

var width = document.getWidth(2);

getWidthThumb: function()

The width of the thumbnail in pixels.

Parameters

none

Returns

integer

Example

var width = document.getWidthThumb();

getZoomCount: function()

The number of zoom levels available.

Parameters

none

Returns

integer

Example

var num_zooms = document.getZoomCount();

isDownloadable: function()

True if the document is downloadable.

Parameters

none

Returns

boolean

Example

var downloadable = document.isDownloadable();

isProcessingComplete: function()

True if the document is done processing.  A document is processed once and only once, the first time it is viewed.  After calling this function, you might want to check Document::isProcessingSuccess() to make sure the conversion was successful.

Parameters

none

Returns

boolean

Example

var complete = document.isProcessingComplete();

isPrintPdf: function()

True if the printpdf is enabled.

Parameters

none

Returns

boolean

Example

var printpdf = document.isPrintPdf();

isProcessingSuccess: function()

True if the document was processed successfully, and ready to be displayed.  A document is processed once and only once, the first time it is viewed.

Parameters

none

Returns

boolean

Example

var success = document.isProcessingSuccess();