getSvgBackImage Method

Summary

Gets a raster image that represents contains only the image elements of the SVG document for this page.

Syntax

JavaScript Syntax

DocumentPage.prototype.getSvgBackImage = function(backColor)

TypeScript Syntax

getSvgBackImage(backColor: string): string;

Parameters

backColor

Color to use to fill the background of the image.

Return Value

Raster image that represents contains only the image elements of the SVG document for this page if this page supports SVG and the SVG data contains image elements; otherwise, null.

Remarks

This method will be deprecated. Use GetSvgBackImageUrl instead.

GetSvgBackImageUrl is used to get a raster image that represents contains only the image elements of the SVG document for this page. Not all document types support this method, this depends on the value of DocumentImages.IsSvgSupported.

This method works as follows (the "item" is the raster image passed by the user):

If this document does not support SVG (the value of DocumentImages.IsSvgSupported is false), then an exception will be thrown.
If an item was found in the cache, it is returned right away. This is available if the document was created using the cache system. Serialization is used to create the image object from the data found in the cache.
The SVG data for this page is loaded with everything dropped except the image elements. If the result document is empty (the page does not contain any image elements in its SVG), then null is returned.
Otherwise, a new image is created and filled with backColor (if its not a transparent color) then the SVG data containing only the image elements is rendered on the surface of this image. The size of the result raster image is the same size as this page.
The image object is saved to the cache before it is returned. Next time this method is called, the image will be returned from the cache directly without loading it from the file or creating a new instance.