Resource

new Cesium.Resource (options)

包含位置和我们需要检索它或创建派生资源的任何其他参数的资源。它还提供了重试请求的功能。
Name Type Description
options String | Object 具有以下属性的网址或对象
名称 类型 默认 说明
url 字符串 资源的网址。
queryParameters 对象 可选 包含查询参数的对象,该参数将在检索资源时发送。
templateValues 对象 可选 用于替换模板值(例如{x})的键/值对。
标题 对象 {} 可选 将发送的其他HTTP标头。
proxy DefaultProxy 可选 加载资源时要使用的代理。
retryCallback 资源〜RetryCallback 可选 当对此资源的请求失败时要调用的函数。如果返回true,则将重试该请求。
retryAttempts 数字 0 可选 放弃之前应调用retryCallback的次数。
request 请求 可选 将使用的Request对象。仅供内部使用。
Example:
function refreshTokenRetryCallback(resource, error) {
  if (error.statusCode === 403) {
    // 403 status code means a new token should be generated
    return getNewAccessToken()
      .then(function(token) {
        resource.queryParameters.access_token = token;
        return true;
      })
      .otherwise(function() {
        return false;
      });
  }

  return false;
}

var resource = new Resource({
   url: 'http://server.com/path/to/resource.json',
   proxy: new DefaultProxy('/proxy/'),
   headers: {
     'X-My-Header': 'valueOfHeader'
   },
   queryParameters: {
     'access_token': '123-435-456-000'
   },
   retryCallback: refreshTokenRetryCallback,
   retryAttempts: 1
});

Members

static constant Cesium.Resource.DEFAULT : Resource

资源实例已初始化为当前浏览器位置

static readonly Cesium.Resource.isBlobSupported : Boolean

如果支持blob,则返回true。

readonly extension : String

资源的文件扩展名。

hasHeaders : Boolean

如果资源具有请求标头,则为True。这等效于检查headers属性是否具有任何键。

headers : Object

与请求一起发送的其他HTTP标头。

isBlobUri : Boolean

如果资源引用Blob URI,则为true。

isCrossOriginUrl : Boolean

如果资源引用跨源URL,则为True。

isDataUri : Boolean

如果资源引用数据URI,则为True。
加载资源时要使用的代理。

readonly queryParameters : Object

查询参数附加到URL。
将使用的Request对象。仅用于内部使用。

retryAttempts : Number

放弃之前应调用retryCallback的次数。

retryCallback : function

当对此资源的请求失败时调用的函数。如果返回true或将Promise解析为true,则将重试该请求。

readonly templateValues : Object

键/值对,用于替换url中的模板参数。
资源的url(已设置模板)替换为模板值,附加查询字符串并由代理编码。

Methods

static Cesium.Resource.delete (options) Promise.<Object>|undefined

从URL创建资源,并在其上调用delete()。
Name Type Description
options String | Object 具有以下属性的网址或对象
名称 类型 默认 说明
url 字符串 资源的网址。
数据 对象 可选 与资源一起发布的数据。
queryParameters 对象 可选 包含查询参数的对象,该参数将在检索资源时发送。
templateValues 对象 可选 用于替换模板值(例如{x})的键/值对。
标题 对象 {} 可选 将发送的其他HTTP标头。
proxy DefaultProxy 可选 加载资源时要使用的代理。
retryCallback 资源〜RetryCallback 可选 当对此资源的请求失败时要调用的函数。如果返回true,则将重试该请求。
retryAttempts 数字 0 可选 放弃之前应调用retryCallback的次数。
request 请求 可选 将使用的Request对象。仅供内部使用。
responseType 字符串 可选 响应类型。这样可以控制返回的商品类型。
overrideMimeType 字符串 可选 覆盖服务器返回的MIME类型。
Returns:
一个承诺,将在加载时解析为请求的数据。如果未返回,则返回undefined request.throttle 为true,并且请求的优先级不够高。

static Cesium.Resource.fetch (options) Promise.<Object>|undefined

从URL创建资源并在其上调用fetch()。
Name Type Description
options String | Object 具有以下属性的网址或对象
名称 类型 默认 说明
url 字符串 资源的网址。
queryParameters 对象 可选 包含查询参数的对象,该参数将在检索资源时发送。
templateValues 对象 可选 用于替换模板值(例如{x})的键/值对。
标题 对象 {} 可选 将发送的其他HTTP标头。
proxy DefaultProxy 可选 加载资源时要使用的代理。
retryCallback 资源〜RetryCallback 可选 当对此资源的请求失败时要调用的函数。如果返回true,则将重试该请求。
retryAttempts 数字 0 可选 放弃之前应调用retryCallback的次数。
request 请求 可选 将使用的Request对象。仅供内部使用。
responseType 字符串 可选 响应类型。这样可以控制返回的商品类型。
overrideMimeType 字符串 可选 覆盖服务器返回的MIME类型。
Returns:
一个承诺,将在加载时解析为请求的数据。如果未返回,则返回undefined request.throttle 为true,并且请求的优先级不够高。

static Cesium.Resource.fetchArrayBuffer (options) Promise.<ArrayBuffer>|undefined

创建一个资源,并在其上调用fetchArrayBuffer()。
Name Type Description
options String | Object 具有以下属性的网址或对象
名称 类型 默认 说明
url 字符串 资源的网址。
queryParameters 对象 可选 包含查询参数的对象,该参数将在检索资源时发送。
templateValues 对象 可选 用于替换模板值(例如{x})的键/值对。
标题 对象 {} 可选 将发送的其他HTTP标头。
proxy DefaultProxy 可选 加载资源时要使用的代理。
retryCallback 资源〜RetryCallback 可选 当对此资源的请求失败时要调用的函数。如果返回true,则将重试该请求。
retryAttempts 数字 0 可选 放弃之前应调用retryCallback的次数。
request 请求 可选 将使用的Request对象。仅供内部使用。
Returns:
一个承诺,将在加载时解析为请求的数据。如果未返回,则返回undefined request.throttle 为true,并且请求的优先级不够高。

static Cesium.Resource.fetchBlob (options) Promise.<Blob>|undefined

创建一个资源,并在其上调用fetchBlob()。
Name Type Description
options String | Object 具有以下属性的网址或对象
名称 类型 默认 说明
url 字符串 资源的网址。
queryParameters 对象 可选 包含查询参数的对象,该参数将在检索资源时发送。
templateValues 对象 可选 用于替换模板值(例如{x})的键/值对。
标题 对象 {} 可选 将发送的其他HTTP标头。
proxy DefaultProxy 可选 加载资源时要使用的代理。
retryCallback 资源〜RetryCallback 可选 当对此资源的请求失败时要调用的函数。如果返回true,则将重试该请求。
retryAttempts 数字 0 可选 放弃之前应调用retryCallback的次数。
request 请求 可选 将使用的Request对象。仅供内部使用。
Returns:
一个承诺,将在加载时解析为请求的数据。如果未返回,则返回undefined request.throttle 为true,并且请求的优先级不够高。

static Cesium.Resource.fetchImage (options) Promise.<ImageBitmap>|Promise.<Image>|undefined

创建一个资源,并在其上调用fetchImage()。
Name Type Description
options String | Object 具有以下属性的网址或对象
名称 类型 默认 说明
url 字符串 资源的网址。
queryParameters 对象 可选 包含查询参数的对象,该参数将在检索资源时发送。
templateValues 对象 可选 用于替换模板值(例如{x})的键/值对。
标题 对象 {} 可选 将发送的其他HTTP标头。
proxy DefaultProxy 可选 加载资源时要使用的代理。
flipY 布尔值 错误 可选 在获取和解码期间是否垂直翻转图像。仅在请求图像且浏览器支持 createImageBitmap 时适用。
retryCallback 资源〜RetryCallback 可选 当对此资源的请求失败时要调用的函数。如果返回true,则将重试该请求。
retryAttempts 数字 0 可选 放弃之前应调用retryCallback的次数。
request 请求 可选 将使用的Request对象。仅供内部使用。
preferBlob 布尔值 错误 可选 如果为true,我们将通过Blob加载图像。
preferImageBitmap 布尔值 错误 可选 如果为true,则将在获取过程中对图像进行解码,并返回 ImageBitmap
Returns:
一个承诺,将在加载时解析为请求的数据。如果未返回,则返回undefined request.throttle 为true,并且请求的优先级不够高。

static Cesium.Resource.fetchJson (options) Promise.<Object>|undefined

创建一个资源,并在其上调用fetchJson()。
Name Type Description
options String | Object 具有以下属性的网址或对象
名称 类型 默认 说明
url 字符串 资源的网址。
queryParameters 对象 可选 包含查询参数的对象,该参数将在检索资源时发送。
templateValues 对象 可选 用于替换模板值(例如{x})的键/值对。
标题 对象 {} 可选 将发送的其他HTTP标头。
proxy DefaultProxy 可选 加载资源时要使用的代理。
retryCallback 资源〜RetryCallback 可选 当对此资源的请求失败时要调用的函数。如果返回true,则将重试该请求。
retryAttempts 数字 0 可选 放弃之前应调用retryCallback的次数。
request 请求 可选 将使用的Request对象。仅供内部使用。
Returns:
一个承诺,将在加载时解析为请求的数据。如果未返回,则返回undefined request.throttle 为true,并且请求的优先级不够高。

static Cesium.Resource.fetchJsonp (options) Promise.<Object>|undefined

从URL创建资源,并在其上调用fetchJsonp()。
Name Type Description
options String | Object 具有以下属性的网址或对象
名称 类型 默认 说明
url 字符串 资源的网址。
queryParameters 对象 可选 包含查询参数的对象,该参数将在检索资源时发送。
templateValues 对象 可选 用于替换模板值(例如{x})的键/值对。
标题 对象 {} 可选 将发送的其他HTTP标头。
proxy DefaultProxy 可选 加载资源时要使用的代理。
retryCallback 资源〜RetryCallback 可选 当对此资源的请求失败时要调用的函数。如果返回true,则将重试该请求。
retryAttempts 数字 0 可选 放弃之前应调用retryCallback的次数。
request 请求 可选 将使用的Request对象。仅供内部使用。
callbackParameterName 字符串 '回调' 可选 服务器期望的回调参数名称。
Returns:
一个承诺,将在加载时解析为请求的数据。如果未返回,则返回undefined request.throttle 为true,并且请求的优先级不够高。

static Cesium.Resource.fetchText (options) Promise.<String>|undefined

创建一个资源,并在其上调用fetchText()。
Name Type Description
options String | Object 具有以下属性的网址或对象
名称 类型 默认 说明
url 字符串 资源的网址。
queryParameters 对象 可选 包含查询参数的对象,该参数将在检索资源时发送。
templateValues 对象 可选 用于替换模板值(例如{x})的键/值对。
标题 对象 {} 可选 将发送的其他HTTP标头。
proxy DefaultProxy 可选 加载资源时要使用的代理。
retryCallback 资源〜RetryCallback 可选 当对此资源的请求失败时要调用的函数。如果返回true,则将重试该请求。
retryAttempts 数字 0 可选 放弃之前应调用retryCallback的次数。
request 请求 可选 将使用的Request对象。仅供内部使用。
Returns:
一个承诺,将在加载时解析为请求的数据。如果未返回,则返回undefined request.throttle 为true,并且请求的优先级不够高。

static Cesium.Resource.fetchXML (options) Promise.<XMLDocument>|undefined

创建一个资源,并在其上调用fetchXML()。
Name Type Description
options String | Object 具有以下属性的网址或对象
名称 类型 默认 说明
url 字符串 资源的网址。
queryParameters 对象 可选 包含查询参数的对象,该参数将在检索资源时发送。
templateValues 对象 可选 用于替换模板值(例如{x})的键/值对。
标题 对象 {} 可选 将发送的其他HTTP标头。
proxy DefaultProxy 可选 加载资源时要使用的代理。
retryCallback 资源〜RetryCallback 可选 当对此资源的请求失败时要调用的函数。如果返回true,则将重试该请求。
retryAttempts 数字 0 可选 放弃之前应调用retryCallback的次数。
request 请求 可选 将使用的Request对象。仅供内部使用。
Returns:
一个承诺,将在加载时解析为请求的数据。如果未返回,则返回undefined request.throttle 为true,并且请求的优先级不够高。

static Cesium.Resource.head (options) Promise.<Object>|undefined

从URL创建资源并在其上调用head()。
Name Type Description
options String | Object 具有以下属性的网址或对象
名称 类型 默认 说明
url 字符串 资源的网址。
queryParameters 对象 可选 包含查询参数的对象,该参数将在检索资源时发送。
templateValues 对象 可选 用于替换模板值(例如{x})的键/值对。
标题 对象 {} 可选 将发送的其他HTTP标头。
proxy DefaultProxy 可选 加载资源时要使用的代理。
retryCallback 资源〜RetryCallback 可选 当对此资源的请求失败时要调用的函数。如果返回true,则将重试该请求。
retryAttempts 数字 0 可选 放弃之前应调用retryCallback的次数。
request 请求 可选 将使用的Request对象。仅供内部使用。
responseType 字符串 可选 响应类型。这样可以控制返回的商品类型。
overrideMimeType 字符串 可选 覆盖服务器返回的MIME类型。
Returns:
一个承诺,将在加载时解析为请求的数据。如果未返回,则返回undefined request.throttle 为true,并且请求的优先级不够高。

static Cesium.Resource.options (options) Promise.<Object>|undefined

从URL创建资源并在其上调用options()。
Name Type Description
options String | Object 具有以下属性的网址或对象
名称 类型 默认 说明
url 字符串 资源的网址。
queryParameters 对象 可选 包含查询参数的对象,该参数将在检索资源时发送。
templateValues 对象 可选 用于替换模板值(例如{x})的键/值对。
标题 对象 {} 可选 将发送的其他HTTP标头。
proxy DefaultProxy 可选 加载资源时要使用的代理。
retryCallback 资源〜RetryCallback 可选 当对此资源的请求失败时要调用的函数。如果返回true,则将重试该请求。
retryAttempts 数字 0 可选 放弃之前应调用retryCallback的次数。
request 请求 可选 将使用的Request对象。仅供内部使用。
responseType 字符串 可选 响应类型。这样可以控制返回的商品类型。
overrideMimeType 字符串 可选 覆盖服务器返回的MIME类型。
Returns:
一个承诺,将在加载时解析为请求的数据。如果未返回,则返回undefined request.throttle 为true,并且请求的优先级不够高。

static Cesium.Resource.patch (options) Promise.<Object>|undefined

从URL创建资源并在其上调用patch()。
Name Type Description
options Object 具有以下属性的网址或对象
名称 类型 默认 说明
url 字符串 资源的网址。
数据 对象 与资源一起发布的数据。
queryParameters 对象 可选 包含查询参数的对象,该参数将在检索资源时发送。
templateValues 对象 可选 用于替换模板值(例如{x})的键/值对。
标题 对象 {} 可选 将发送的其他HTTP标头。
proxy DefaultProxy 可选 加载资源时要使用的代理。
retryCallback 资源〜RetryCallback 可选 当对此资源的请求失败时要调用的函数。如果返回true,则将重试该请求。
retryAttempts 数字 0 可选 放弃之前应调用retryCallback的次数。
request 请求 可选 将使用的Request对象。仅供内部使用。
responseType 字符串 可选 响应类型。这样可以控制返回的商品类型。
overrideMimeType 字符串 可选 覆盖服务器返回的MIME类型。
Returns:
一个承诺,将在加载时解析为请求的数据。如果未返回,则返回undefined request.throttle 为true,并且请求的优先级不够高。

static Cesium.Resource.post (options) Promise.<Object>|undefined

从URL创建资源并在其上调用post()。
Name Type Description
options Object 具有以下属性的网址或对象
名称 类型 默认 说明
url 字符串 资源的网址。
数据 对象 与资源一起发布的数据。
queryParameters 对象 可选 包含查询参数的对象,该参数将在检索资源时发送。
templateValues 对象 可选 用于替换模板值(例如{x})的键/值对。
标题 对象 {} 可选 将发送的其他HTTP标头。
proxy DefaultProxy 可选 加载资源时要使用的代理。
retryCallback 资源〜RetryCallback 可选 当对此资源的请求失败时要调用的函数。如果返回true,则将重试该请求。
retryAttempts 数字 0 可选 放弃之前应调用retryCallback的次数。
request 请求 可选 将使用的Request对象。仅供内部使用。
responseType 字符串 可选 响应类型。这样可以控制返回的商品类型。
overrideMimeType 字符串 可选 覆盖服务器返回的MIME类型。
Returns:
一个承诺,将在加载时解析为请求的数据。如果未返回,则返回undefined request.throttle 为true,并且请求的优先级不够高。

static Cesium.Resource.put (options) Promise.<Object>|undefined

从URL创建资源并在其上调用put()。
Name Type Description
options Object 具有以下属性的网址或对象
名称 类型 默认 说明
url 字符串 资源的网址。
数据 对象 与资源一起发布的数据。
queryParameters 对象 可选 包含查询参数的对象,该参数将在检索资源时发送。
templateValues 对象 可选 用于替换模板值(例如{x})的键/值对。
标题 对象 {} 可选 将发送的其他HTTP标头。
proxy DefaultProxy 可选 加载资源时要使用的代理。
retryCallback 资源〜RetryCallback 可选 当对此资源的请求失败时要调用的函数。如果返回true,则将重试该请求。
retryAttempts 数字 0 可选 放弃之前应调用retryCallback的次数。
request 请求 可选 将使用的Request对象。仅供内部使用。
responseType 字符串 可选 响应类型。这样可以控制返回的商品类型。
overrideMimeType 字符串 可选 覆盖服务器返回的MIME类型。
Returns:
一个承诺,将在加载时解析为请求的数据。如果未返回,则返回undefined request.throttle 为true,并且请求的优先级不够高。

appendForwardSlash ()

在URL后面加上斜杠。

appendQueryParameters (params)

组合指定的对象和现有的查询参数。这样,您可以一次添加许多参数, 而不是一次将它们一次添加到queryParameters属性。
Name Type Description
params Object 查询参数
复制资源实例。
Name Type Description
result Resource 可选 将结果存储到的对象。
Returns:
修改后的结果参数或一个新的Resource实例(如果未提供)。

delete ( options ) Promise.<Object>|undefined

异步删除给定资源。返回一个承诺,将解决加载后返回结果,如果资源加载失败,则拒绝。数据已加载使用XMLHttpRequest,这意味着为了向另一个来源发出请求,服务器必须启用跨域资源共享(CORS)标头。
Name Type Description
options Object 可选 具有以下属性的对象:
名称 类型 说明
responseType 字符串 可选 响应类型。这样可以控制返回的商品类型。
标题 对象 可选 与请求一起发送的其他HTTP标头(如果有)。
overrideMimeType 字符串 可选 覆盖服务器返回的MIME类型。
Returns:
一个承诺,将在加载时解析为请求的数据。如果未返回,则返回undefined request.throttle 为true,并且请求的优先级不够高。
Example:
resource.delete()
  .then(function(body) {
      // use the data
  }).otherwise(function(error) {
      // an error occurred
  });
See:

fetch ( options ) Promise.<Object>|undefined

异步加载给定资源。返回一个承诺,将解决加载后返回结果,如果资源加载失败,则拒绝。数据已加载使用XMLHttpRequest,这意味着为了向另一个来源发出请求,服务器必须启用跨域资源共享(CORS)标头。建议您使用更具体的功能,例如fetchJson,fetchBlob等。
Name Type Description
options Object 可选 具有以下属性的对象:
名称 类型 说明
responseType 字符串 可选 响应类型。这样可以控制返回的商品类型。
标题 对象 可选 与请求一起发送的其他HTTP标头(如果有)。
overrideMimeType 字符串 可选 覆盖服务器返回的MIME类型。
Returns:
一个承诺,将在加载时解析为请求的数据。如果未返回,则返回undefined request.throttle 为true,并且请求的优先级不够高。
Example:
resource.fetch()
  .then(function(body) {
      // use the data
  }).otherwise(function(error) {
      // an error occurred
  });
See:

fetchArrayBuffer () Promise.<ArrayBuffer>|undefined

异步将资源作为原始二进制数据加载。返回一个承诺,将解决ArrayBuffer加载后,如果资源加载失败,则拒绝。数据已加载使用XMLHttpRequest,这意味着为了向另一个来源发出请求,服务器必须启用跨域资源共享(CORS)标头。
Returns:
一个承诺,将在加载时解析为请求的数据。如果未返回,则返回undefined request.throttle 为true,并且请求的优先级不够高。
Example:
// load a single URL asynchronously
resource.fetchArrayBuffer().then(function(arrayBuffer) {
    // use the data
}).otherwise(function(error) {
    // an error occurred
});
See:

fetchBlob () Promise.<Blob>|undefined

异步将给定资源加载为Blob。返回一个承诺,将解决Blob一旦加载,或者如果资源加载失败,则拒绝。数据已加载使用XMLHttpRequest,这意味着为了向另一个来源发出请求,服务器必须启用跨域资源共享(CORS)标头。
Returns:
一个承诺,将在加载时解析为请求的数据。如果未返回,则返回undefined request.throttle 为true,并且请求的优先级不够高。
Example:
// load a single URL asynchronously
resource.fetchBlob().then(function(blob) {
    // use the data
}).otherwise(function(error) {
    // an error occurred
});
See:

fetchImage ( options ) Promise.<ImageBitmap>|Promise.<Image>|undefined

异步加载给定的图像资源。返回一个承诺,将解决如果 preferImageBitmap 为true并且浏览器支持 ImageBitmap code> createImageBitmap 或其他 图像 一旦加载,或者如果图像加载失败则拒绝。
Name Type Description
options Object 可选 具有以下属性的对象。
名称 类型 默认 说明
preferBlob 布尔值 错误 可选 如果为true,我们将通过Blob加载图像。
preferImageBitmap 布尔值 错误 可选 如果为true,则将在获取过程中对图像进行解码,并返回 ImageBitmap
flipY 布尔值 错误 可选 如果为true,则在解码期间图像将垂直翻转。仅在浏览器支持 createImageBitmap 时适用。
Returns:
一个承诺,将在加载时解析为请求的数据。如果未返回,则返回undefined request.throttle 为true,并且请求的优先级不够高。
Example:
// load a single image asynchronously
resource.fetchImage().then(function(image) {
    // use the loaded image
}).otherwise(function(error) {
    // an error occurred
});

// load several images in parallel
when.all([resource1.fetchImage(), resource2.fetchImage()]).then(function(images) {
    // images is an array containing all the loaded images
});
See:

fetchJson () Promise.<Object>|undefined

异步将给定资源加载为JSON。返回一个承诺,将解决一次加载JSON对象,如果资源加载失败,则拒绝。数据已加载使用XMLHttpRequest,这意味着为了向另一个来源发出请求,服务器必须启用跨域资源共享(CORS)标头。此功能如果没有,将' Accept:application/json,*/*; q = 0.01'添加到请求标头中已经指定。
Returns:
一个承诺,将在加载时解析为请求的数据。如果未返回,则返回undefined request.throttle 为true,并且请求的优先级不够高。
Example:
resource.fetchJson().then(function(jsonData) {
    // Do something with the JSON object
}).otherwise(function(error) {
    // an error occurred
});
See:

fetchJsonp ( callbackParameterName ) Promise.<Object>|undefined

使用JSONP请求资源。
Name Type Default Description
callbackParameterName String 'callback' 可选 服务器期望的回调参数名称。
Returns:
一个承诺,将在加载时解析为请求的数据。如果未返回,则返回undefined request.throttle 为true,并且请求的优先级不够高。
Example:
// load a data asynchronously
resource.fetchJsonp().then(function(data) {
    // use the loaded data
}).otherwise(function(error) {
    // an error occurred
});
See:

fetchText () Promise.<String>|undefined

异步加载给定资源为文本。返回一个承诺,将解决一次加载String,如果资源加载失败,则拒绝。数据已加载使用XMLHttpRequest,这意味着为了向另一个来源发出请求,服务器必须启用跨域资源共享(CORS)标头。
Returns:
一个承诺,将在加载时解析为请求的数据。如果未返回,则返回undefined request.throttle 为true,并且请求的优先级不够高。
Example:
// load text from a URL, setting a custom header
var resource = new Resource({
  url: 'http://someUrl.com/someJson.txt',
  headers: {
    'X-Custom-Header' : 'some value'
  }
});
resource.fetchText().then(function(text) {
    // Do something with the text
}).otherwise(function(error) {
    // an error occurred
});
See:

fetchXML () Promise.<XMLDocument>|undefined

异步将给定资源加载为XML。返回一个承诺,将解决XML文档一旦加载,或者如果资源加载失败,则拒绝。数据已加载使用XMLHttpRequest,这意味着为了向另一个来源发出请求,服务器必须启用跨域资源共享(CORS)标头。
Returns:
一个承诺,将在加载时解析为请求的数据。如果未返回,则返回undefined request.throttle 为true,并且请求的优先级不够高。
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:

getBaseUri ( includeQuery ) String

返回资源的基本路径。
Name Type Default Description
includeQuery Boolean false 可选 是否在uri中包含查询字符串和片段
Returns:
资源的基本URI

getDerivedResource (options) Resource

返回相对于当前实例的资源。除非在选项中覆盖,否则所有属性均与当前实例相同。
Name Type Description
options Object 具有以下属性的对象
名称 类型 默认 说明
url 字符串 可选 将相对于当前实例的URL解析的URL。
queryParameters 对象 可选 一个对象,其中包含将与当前实例的查询参数组合的查询参数。
templateValues 对象 可选 用于替换模板值的键/值对(例如{x})。这些将与当前实例的对象合并。
标题 对象 {} 可选 将发送的其他HTTP标头。
proxy DefaultProxy 可选 加载资源时要使用的代理。
retryCallback 资源〜RetryCallback 可选 加载资源时调用的函数失败。
retryAttempts 数字 可选 放弃之前应调用retryCallback的次数。
request 请求 可选 将使用的Request对象。仅供内部使用。
preserveQueryParameters 布尔值 错误 可选 如果为true,则将保留当前资源和派生资源中的所有查询参数。如果为false,则派生参数将替换当前资源的参数。
Returns:
从当前资源派生的资源。

getUrlComponent ( query , proxy ) String

返回url(可选)和查询字符串,并由代理处理。
Name Type Default Description
query Boolean false 可选 如果为true,则包含查询字符串。
proxy Boolean false 可选 如果为true,则对URL进行处理(如果已定义)。
Returns:
具有所有要求的组件的URL。
异步获取标头给定的资源。返回一个承诺,将解决加载后返回结果,如果资源加载失败,则拒绝。数据已加载使用XMLHttpRequest,这意味着为了向另一个来源发出请求,服务器必须启用跨域资源共享(CORS)标头。
Name Type Description
options Object 可选 具有以下属性的对象:
名称 类型 说明
responseType 字符串 可选 响应类型。这样可以控制返回的商品类型。
标题 对象 可选 与请求一起发送的其他HTTP标头(如果有)。
overrideMimeType 字符串 可选 覆盖服务器返回的MIME类型。
Returns:
一个承诺,将在加载时解析为请求的数据。如果未返回,则返回undefined request.throttle 为true,并且请求的优先级不够高。
Example:
resource.head()
  .then(function(headers) {
      // use the data
  }).otherwise(function(error) {
      // an error occurred
  });
See:

options ( options ) Promise.<Object>|undefined

异步获取给定资源的选项。返回一个承诺,将解决加载后返回结果,如果资源加载失败,则拒绝。数据已加载使用XMLHttpRequest,这意味着为了向另一个来源发出请求,服务器必须启用跨域资源共享(CORS)标头。
Name Type Description
options Object 可选 具有以下属性的对象:
名称 类型 说明
responseType 字符串 可选 响应类型。这样可以控制返回的商品类型。
标题 对象 可选 与请求一起发送的其他HTTP标头(如果有)。
overrideMimeType 字符串 可选 覆盖服务器返回的MIME类型。
Returns:
一个承诺,将在加载时解析为请求的数据。如果未返回,则返回undefined request.throttle 为true,并且请求的优先级不够高。
Example:
resource.options()
  .then(function(headers) {
      // use the data
  }).otherwise(function(error) {
      // an error occurred
  });
See:

patch (data, options ) Promise.<Object>|undefined

异步将数据修补到给定资源。返回一个承诺,将解决加载后返回结果,如果资源加载失败,则拒绝。数据已加载使用XMLHttpRequest,这意味着为了向另一个来源发出请求,服务器必须启用跨域资源共享(CORS)标头。
Name Type Description
data Object 与资源一起发布的数据。
options Object 可选 具有以下属性的对象:
名称 类型 说明
responseType 字符串 可选 响应类型。这样可以控制返回的商品类型。
标题 对象 可选 与请求一起发送的其他HTTP标头(如果有)。
overrideMimeType 字符串 可选 覆盖服务器返回的MIME类型。
Returns:
一个承诺,将在加载时解析为请求的数据。如果未返回,则返回undefined request.throttle 为true,并且请求的优先级不够高。
Example:
resource.patch(data)
  .then(function(result) {
      // use the result
  }).otherwise(function(error) {
      // an error occurred
  });
See:

post (data, options ) Promise.<Object>|undefined

异步将数据发布到给定资源。返回一个承诺,将解决加载后返回结果,如果资源加载失败,则拒绝。数据已加载使用XMLHttpRequest,这意味着为了向另一个来源发出请求,服务器必须启用跨域资源共享(CORS)标头。
Name Type Description
data Object 与资源一起发布的数据。
options Object 可选 具有以下属性的对象:
名称 类型 说明
数据 对象 可选 与资源一起发布的数据。
responseType 字符串 可选 响应类型。这样可以控制返回的商品类型。
标题 对象 可选 与请求一起发送的其他HTTP标头(如果有)。
overrideMimeType 字符串 可选 覆盖服务器返回的MIME类型。
Returns:
一个承诺,将在加载时解析为请求的数据。如果未返回,则返回undefined request.throttle 为true,并且请求的优先级不够高。
Example:
resource.post(data)
  .then(function(result) {
      // use the result
  }).otherwise(function(error) {
      // an error occurred
  });
See:

put (data, options ) Promise.<Object>|undefined

异步将数据放入给定资源。返回一个承诺,将解决加载后返回结果,如果资源加载失败,则拒绝。数据已加载使用XMLHttpRequest,这意味着为了向另一个来源发出请求,服务器必须启用跨域资源共享(CORS)标头。
Name Type Description
data Object 与资源一起发布的数据。
options Object 可选 具有以下属性的对象:
名称 类型 说明
responseType 字符串 可选 响应类型。这样可以控制返回的商品类型。
标题 对象 可选 与请求一起发送的其他HTTP标头(如果有)。
overrideMimeType 字符串 可选 覆盖服务器返回的MIME类型。
Returns:
一个承诺,将在加载时解析为请求的数据。如果未返回,则返回undefined request.throttle 为true,并且请求的优先级不够高。
Example:
resource.put(data)
  .then(function(result) {
      // use the result
  }).otherwise(function(error) {
      // an error occurred
  });
See:

setQueryParameters (params, useAsDefault )

组合指定的对象和现有的查询参数。这样,您可以一次添加许多参数, 而不是一次将它们一次添加到queryParameters属性。如果已经设置了一个值,它将被新值替换。
Name Type Default Description
params Object 查询参数
useAsDefault Boolean false 可选 如果为true,则将使用参数作为默认值,因此只有在未定义参数的情况下才会设置这些参数。

setTemplateValues (template, useAsDefault )

组合指定的对象和现有的模板值。这使您可以一次添加许多值, 而不是一次将它们一次添加到templateValues属性。如果已经设置了一个值,它将成为一个数组并附加新值。
Name Type Default Description
template Object 模板值
useAsDefault Boolean false 可选 如果为true,则将这些值用作默认值,因此只有在未定义它们时才设置它们。

Type Definitions

RetryCallback ( resource , error ) Boolean|Promise.<Boolean>

一个返回属性值的函数。
Name Type Description
resource Resource 可选 无法加载的资源。
error Error 可选 资源加载过程中发生的错误。
Returns:
如果为true或将promise解析为true,则将重试该资源。否则,将返回故障。