elementUrlMode Property

Summary

The method to use for loading the image with an ImageLoader.

Syntax

JavaScript Syntax

Object.defineProperty(DocumentImages.prototype, 'elementUrlMode', 
	get: function(), 
	set: function(value) 
)

TypeScript Syntax

static elementUrlMode: ImageLoaderUrlMode;

The image loading technique. Default value is ImageLoaderUrlMode.ImageUrl.

Remarks

As discussed in Image Loading using the Documents Library, some methods (like GetImageElement) can make requests for HTML or SVG Elements that represent a DocumentPage for a loaded Document. The images are loaded internally with an ImageLoader, and callbacks to resolve the Promise object are attached to that loader.

Since the ImageLoader is not exposed from the method in this case, ElementAjaxMethod and ElementUrlMode are used for default values for the AJAX method type and ImageLoaderUrlMode. However, each of these methods also takes an optional ImageLoader parameter for complete control (like GetImageElement. If this parameter is provided, the values of ElementAjaxMethod and ElementUrlMode are ignored since they can be set with UrlMode and Method, respectively.

Requirements

Help Version 19.0.2017.10.27