isSvgSupported Property (original) (raw)

Summary

Gets a value that indicate whether this document supports getting a page as SVG.

Syntax

Object.defineProperty(DocumentImages.prototype, 'isSvgSupported', get: function() )

readonly isSvgSupported: boolean; 

Property Value

true if this document supports getting a page as SVG; otherwise, false.

Remarks

Use IsSvgSupported to determine whether an SVG (Scalable Vector Graphics) representation of a page can be obtained throughGetSvgBackImageUrl, GetSvgBackImageElement, GetSvgUrl, or GetSvgElement. If IsSvgSupported is true, then these methods can return an SVG document (or the URL to it). If IsSvgSupportedis false, then GetSvgBackImageUrl and GetSvgUrlwill return URLs that cannot be loaded, while GetSvgBackImageElement and GetSvgElement will fail.

The GetText method is used to parse the text from a page within the document. If IsSvgSupported is true, the Document Service will parse the text from the SVG document directly, without OCR. If IsSvgSupported is false, the text is parsed using the OCR engine instance set in the service. You can override this behavior using the TextExtractionMode property.

Currently, SVG support is provided for these types of documents:

• All document formats supported by LEADTOOLS. This includes the likes of Microsoft Office formats (DOC/DOCX, XLSX/XLS, PPT/PPTX), HTML, Text, RTF, IOCA/MODCA, ePub and many more. The value of IsSvgViewingPreferred will be true as well.
• Vector file formats such DXF, DWG, DWF. The value of IsSvgViewingPreferred will be true as well.
• SVG files, naturally. The value of IsSvgViewingPreferred will be true as well.
• Acrobat PDF documents. LEADTOOLS will check the PDF file structure and IsSvgSupported will be based on whether the document has any text data that can be parsed. The value of IsSvgViewingPreferred will also be calculated from the document elements. If the value of IsSvgSupported is false, then IsSvgViewingPreferred is false as well. If IsSvgSupported is true, then IsSvgViewingPreferred will be true unless the document is PDF with an raster image overlay (PDF with image over text feature).

Note that when the value of IsSvgSupported is false, then the value of IsSvgViewingPreferred will always be false too.