TypeScript
JavaScript
References ▼
The XMLHttpRequest object used in the image data request.
null by default. Can be set to a custom XMLHttpRequest object to use for the image request. Otherwise, a new XMLHttpRequest object will be created as needed.
This property is only useful with the ImageLoaderUrlMode.ajaxDataUrl or ImageLoaderUrlMode.ajaxXml modes, which use an XMLHttpRequest to get the image data.
Users can pass their own XMLHttpRequest objects with custom settings. When run is called and the urlMode is ImageLoaderUrlMode.ajaxDataUrl or ImageLoaderUrlMode.ajaxXml, xhr will be set to a new XMLHttpRequest if it is currently null.
When using the ImageLoaderUrlMode.ajaxDataUrl mode specifically, the processAjaxData callback can be used to access the actual binary data from the response. This is helpful for decryption.
By setting xhr before calling run, a user can set additional properties on the request that are otherwise not available through other properties of ImageLoader.
The object in xhr will have its withCredentials property set based on the value of ajaxWithCredentials.