-
Notifications
You must be signed in to change notification settings - Fork 3.5k
/
loadXML.js
59 lines (54 loc) · 2.2 KB
/
loadXML.js
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
define([
'./Check',
'./defined',
'./deprecationWarning',
'./Resource'
], function(
Check,
defined,
deprecationWarning,
Resource) {
'use strict';
/**
* Asynchronously loads the given URL as XML. Returns a promise that will resolve to
* an XML Document once loaded, or reject if the URL failed to load. The data is loaded
* using XMLHttpRequest, which means that in order to make requests to another origin,
* the server must have Cross-Origin Resource Sharing (CORS) headers enabled.
*
* @exports loadXML
*
* @param {Resource|String} urlOrResource The URL to request.
* @param {Object} [headers] HTTP headers to send with the requests.
* @param {Request} [request] The request object. Intended for internal use only.
* @returns {Promise.<XMLDocument>|undefined} a promise that will resolve to the requested data when loaded. Returns undefined if <code>request.throttle</code> is true and the request does not have high enough priority.
*
*
* @example
* // load XML from a URL, setting a custom header
* Cesium.loadXML('http://someUrl.com/someXML.xml', {
* 'X-Custom-Header' : 'some value'
* }).then(function(document) {
* // Do something with the document
* }).otherwise(function(error) {
* // an error occurred
* });
*
* @see {@link https://developer.mozilla.org/en-US/docs/Web/API/XMLHttpRequest|XMLHttpRequest}
* @see {@link http://www.w3.org/TR/cors/|Cross-Origin Resource Sharing}
* @see {@link http://wiki.commonjs.org/wiki/Promises/A|CommonJS Promises/A}
*
* @deprecated
*/
function loadXML(urlOrResource, headers, request) {
//>>includeStart('debug', pragmas.debug);
Check.defined('urlOrResource', urlOrResource);
//>>includeEnd('debug');
deprecationWarning('loadXML', 'loadXML is deprecated and will be removed in Cesium 1.44. Please use Resource.fetchXML instead.');
var resource = Resource.createIfNeeded(urlOrResource, {
headers: headers,
request: request
});
return resource.fetchXML();
}
return loadXML;
});