getSvgBackImageUrl Method

Summary

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

Syntax

JavaScript Syntax

DocumentPage.prototype.getSvgBackImageUrl = function(backColor)

TypeScript Syntax

getSvgBackImageUrl(backColor: string): string;

Parameters

backColor

Color to use to fill the background of the image.

Return Value

A URL to a raster image that will contain only the image elements of the SVG document for this page. If IsSvgSupported is false, a request to this URL will fail. If the SVG for this page contains no background images, a request to this URL will return a 1x1 transparent GIF image.

Remarks

For more information on this method or to load the image through the Documents Library, see GetSvgBackImageElement.

This method will always return a URL to attempt loading from, even if IsSvgSupported is false.

Refer to Image Loading Using LEADTOOLS Documents Library and Document Loading Using LEADTOOLS Documents Library for more information.

Requirements

Target Platforms