In This Topic ▼

isSvgViewingPreferred Property

Summary

Indicates whether SVG viewing is preferred with this page.

Syntax

TypeScript

JavaScript

Object.defineProperty(DocumentPage.prototype, 'isSvgViewingPreferred', 
   get: function() 
)

readonly isSvgViewingPreferred: boolean;

Property Value

true if SVG viewing is preferred with this page; otherwise; false.

Remarks

This property is used by the DocumentViewer when this document is being viewed.

For most types of documents, the value of isSvgViewingPreferred is the same as DocumentImages.isSvgViewingPreferred. In other words, if the document supports SVG, then the SVG engine should be used to render the document for viewing.

For certain types of documents, this may not be true depending on the type of the page. For instance, if the document is PDF with a mix of raster and text pages, then the raster pages should be viewed using the raster engine. The value of isSvgViewingPreferred is false for all the raster pages and true for all the text pages. Text pages that have an overlay image (saved with the image over text feature) should also be viewed using the raster engine with the value of isSvgViewingPreferred set to false.

Requirements

Target Platforms