Resource

new Cesium.Resource (options)

包含位置和我们需要检索它或创建派生资源的任何其他参数的资源。它还提供重试请求的能力。
Name Type Description
options String | Resource.ConstructorOptions 描述初始化选项的 url 或对象
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;
      })
      .catch(function() {
        return false;
      });
  }

  return false;
}

const 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

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

headers : Object

将随请求一起发送的附加 HTTP 标头。

isBlobUri : Boolean

如果 Resource 引用了 blob URI,则为真。

isCrossOriginUrl : Boolean

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

isDataUri : Boolean

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

readonly queryParameters : Object

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

retryAttempts : Number

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

retryCallback : function

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

readonly templateValues : Object

用于替换 url 中模板参数的键/值对。
替换模板值的资源 url,如果设置了查询字符串,则由代理附加和编码。

Methods

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

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

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

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

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

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

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

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

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

创建一个 Resource 并在其上调用 fetchImage()。
Name Type Description
options String | Object 具有以下属性的 url 或对象
姓名 类型 默认 描述
url 细绳 资源的网址。
queryParameters 目的 可选 包含在检索资源时将发送的查询参数的对象。
templateValues 目的 用于替换模板值的 可选 键/值对(例如 {x})。
headers 目的 {} 可选 将发送的附加 HTTP 标头。
proxy 代理人 可选 加载资源时使用的代理。
flipY 布尔值 false 可选 在获取和解码期间是否垂直翻转图像。仅在请求图像且浏览器支持 createImageBitmap 时适用。
retryCallback Resource.RetryCallback 可选 当对该资源的请求失败时调用的函数。如果返回 true,则请求将被重试。
retryAttempts 数字 0 可选 在放弃之前应该调用 retryCallback 的次数。
request 要求 可选 将使用的请求对象。仅供内部使用。
preferBlob 布尔值 false 可选 如果为 true,我们将通过 blob 加载图像。
preferImageBitmap 布尔值 false 可选 如果为真,图像将在获取期间被解码并返回一个 ImageBitmap
skipColorSpaceConversion 布尔值 false 可选 如果为真,图像中的任何自定义伽马或颜色配置文件都将被忽略。仅在请求图像且浏览器支持 createImageBitmap 时适用。
Returns:
加载时将解析为请求的数据的承诺。如果 request.throttle 为 true 并且请求没有足够高的优先级,则返回 undefined。

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

从 URL 创建资源并在其上调用 post()。
Name Type Description
options Object 具有以下属性的 url 或对象
姓名 类型 默认 描述
url 细绳 资源的网址。
data 目的 随资源发布的数据。
queryParameters 目的 可选 包含在检索资源时将发送的查询参数的对象。
templateValues 目的 用于替换模板值的 可选 键/值对(例如 {x})。
headers 目的 {} 可选 将发送的附加 HTTP 标头。
proxy 代理人 可选 加载资源时使用的代理。
retryCallback Resource.RetryCallback 可选 当对该资源的请求失败时调用的函数。如果返回 true,则请求将被重试。
retryAttempts 数字 0 可选 在放弃之前应该调用 retryCallback 的次数。
request 要求 可选 将使用的请求对象。仅供内部使用。
responseType 细绳 可选 响应的类型。这控制返回的项目的类型。
overrideMimeType 细绳 可选 覆盖服务器返回的 MIME 类型。
Returns:
加载时将解析为请求的数据的承诺。如果 request.throttle 为 true 并且请求没有足够高的优先级,则返回 undefined。

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

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

appendForwardSlash ()

将正斜杠附加到 URL。

appendQueryParameters (params)

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

delete ( options ) Promise.<*>|undefined

异步删除给定的资源。返回一个承诺,一旦加载就会解析为结果,或者如果资源加载失败则拒绝。数据是使用 XMLHttpRequest 加载的,这意味着为了向另一个源发出请求,服务器必须启用跨源资源共享 (CORS) 标头。
Name Type Description
options Object 具有以下属性的 可选 对象:
姓名 类型 描述
responseType 细绳 可选 响应的类型。这控制返回的项目的类型。
headers 目的 可选 与请求一起发送的附加 HTTP 标头(如果有)。
overrideMimeType 细绳 可选 覆盖服务器返回的 MIME 类型。
Returns:
加载时将解析为请求的数据的承诺。如果 request.throttle 为 true 并且请求没有足够高的优先级,则返回 undefined。
Example:
resource.delete()
  .then(function(body) {
      // use the data
  }).catch(function(error) {
      // an error occurred
  });
See:

fetch ( options ) Promise.<*>|undefined

异步加载给定的资源。返回一个承诺,一旦加载就会解析为结果,或者如果资源加载失败则拒绝。数据是使用 XMLHttpRequest 加载的,这意味着为了向另一个源发出请求,服务器必须启用跨源资源共享 (CORS) 标头。建议您使用更具体的功能,例如。 fetchJson、fetchBlob 等
Name Type Description
options Object 具有以下属性的 可选 对象:
姓名 类型 描述
responseType 细绳 可选 响应的类型。这控制返回的项目的类型。
headers 目的 可选 与请求一起发送的附加 HTTP 标头(如果有)。
overrideMimeType 细绳 可选 覆盖服务器返回的 MIME 类型。
Returns:
加载时将解析为请求的数据的承诺。如果 request.throttle 为 true 并且请求没有足够高的优先级,则返回 undefined。
Example:
resource.fetch()
  .then(function(body) {
      // use the data
  }).catch(function(error) {
      // an error occurred
  });
See:

fetchArrayBuffer () Promise.<ArrayBuffer>|undefined

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

fetchBlob () Promise.<Blob>|undefined

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

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

异步加载给定的图像资源。如果 preferImageBitmap 为 true 并且浏览器支持 createImageBitmap 或其他 图像 一旦加载,则返回将解析为 ImageBitmap 的承诺,或者如果图像加载失败则拒绝。
Name Type Description
options Object 可选 具有以下属性的对象。
姓名 类型 默认 描述
preferBlob 布尔值 false 可选 如果为 true,我们将通过 blob 加载图像。
preferImageBitmap 布尔值 false 可选 如果为真,图像将在获取期间被解码并返回一个 ImageBitmap
flipY 布尔值 false 可选 如果为真,图像将在解码过程中垂直翻转。仅在浏览器支持 createImageBitmap 时适用。
skipColorSpaceConversion 布尔值 false 可选 如果为真,图像中的任何自定义伽马或颜色配置文件都将被忽略。仅在浏览器支持 createImageBitmap 时适用。
Returns:
加载时将解析为请求的数据的承诺。如果 request.throttle 为 true 并且请求没有足够高的优先级,则返回 undefined。
Example:
// load a single image asynchronously
resource.fetchImage().then(function(image) {
    // use the loaded image
}).catch(function(error) {
    // an error occurred
});

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

fetchJson () Promise.<*>|undefined

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

fetchJsonp ( callbackParameterName ) Promise.<*>|undefined

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

fetchText () Promise.<String>|undefined

将给定资源作为文本异步加载。返回一个承诺,一旦加载将解析为字符串,或者如果资源加载失败则拒绝。数据是使用 XMLHttpRequest 加载的,这意味着为了向另一个源发出请求,服务器必须启用跨源资源共享 (CORS) 标头。
Returns:
加载时将解析为请求的数据的承诺。如果 request.throttle 为 true 并且请求没有足够高的优先级,则返回 undefined。
Example:
// load text from a URL, setting a custom header
const 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
}).catch(function(error) {
    // an error occurred
});
See:

fetchXML () Promise.<XMLDocument>|undefined

将给定资源作为 XML 异步加载。返回一个加载后将解析为 XML 文档的承诺,或者如果资源加载失败则拒绝。数据是使用 XMLHttpRequest 加载的,这意味着为了向另一个源发出请求,服务器必须启用跨源资源共享 (CORS) 标头。
Returns:
加载时将解析为请求的数据的承诺。如果 request.throttle 为 true 并且请求没有足够高的优先级,则返回 undefined。
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
}).catch(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})。这些将与当前实例的合并。
headers 目的 {} 可选 将发送的附加 HTTP 标头。
proxy 代理人 可选 加载资源时使用的代理。
retryCallback Resource.RetryCallback 可选 加载资源失败时调用的函数。
retryAttempts 数字 可选 在放弃之前应该调用 retryCallback 的次数。
request 要求 可选 将使用的请求对象。仅供内部使用。
preserveQueryParameters 布尔值 false 可选 如果为真,这将保留当前资源和派生资源中的所有查询参数。如果为 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 细绳 可选 响应的类型。这控制返回的项目的类型。
headers 目的 可选 与请求一起发送的附加 HTTP 标头(如果有)。
overrideMimeType 细绳 可选 覆盖服务器返回的 MIME 类型。
Returns:
加载时将解析为请求的数据的承诺。如果 request.throttle 为 true 并且请求没有足够高的优先级,则返回 undefined。
Example:
resource.head()
  .then(function(headers) {
      // use the data
  }).catch(function(error) {
      // an error occurred
  });
See:

options ( options ) Promise.<*>|undefined

异步获取给定资源的选项。返回一个承诺,一旦加载就会解析为结果,或者如果资源加载失败则拒绝。数据是使用 XMLHttpRequest 加载的,这意味着为了向另一个源发出请求,服务器必须启用跨源资源共享 (CORS) 标头。
Name Type Description
options Object 具有以下属性的 可选 对象:
姓名 类型 描述
responseType 细绳 可选 响应的类型。这控制返回的项目的类型。
headers 目的 可选 与请求一起发送的附加 HTTP 标头(如果有)。
overrideMimeType 细绳 可选 覆盖服务器返回的 MIME 类型。
Returns:
加载时将解析为请求的数据的承诺。如果 request.throttle 为 true 并且请求没有足够高的优先级,则返回 undefined。
Example:
resource.options()
  .then(function(headers) {
      // use the data
  }).catch(function(error) {
      // an error occurred
  });
See:

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

将数据异步修补到给定资源。返回一个承诺,一旦加载就会解析为结果,或者如果资源加载失败则拒绝。数据是使用 XMLHttpRequest 加载的,这意味着为了向另一个源发出请求,服务器必须启用跨源资源共享 (CORS) 标头。
Name Type Description
data Object 随资源发布的数据。
options Object 具有以下属性的 可选 对象:
姓名 类型 描述
responseType 细绳 可选 响应的类型。这控制返回的项目的类型。
headers 目的 可选 与请求一起发送的附加 HTTP 标头(如果有)。
overrideMimeType 细绳 可选 覆盖服务器返回的 MIME 类型。
Returns:
加载时将解析为请求的数据的承诺。如果 request.throttle 为 true 并且请求没有足够高的优先级,则返回 undefined。
Example:
resource.patch(data)
  .then(function(result) {
      // use the result
  }).catch(function(error) {
      // an error occurred
  });
See:

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

将数据异步发布到给定资源。返回一个承诺,一旦加载就会解析为结果,或者如果资源加载失败则拒绝。数据是使用 XMLHttpRequest 加载的,这意味着为了向另一个源发出请求,服务器必须启用跨源资源共享 (CORS) 标头。
Name Type Description
data Object 随资源发布的数据。
options Object 具有以下属性的 可选 对象:
姓名 类型 描述
data 目的 与资源一起发布的 可选 数据。
responseType 细绳 可选 响应的类型。这控制返回的项目的类型。
headers 目的 可选 与请求一起发送的附加 HTTP 标头(如果有)。
overrideMimeType 细绳 可选 覆盖服务器返回的 MIME 类型。
Returns:
加载时将解析为请求的数据的承诺。如果 request.throttle 为 true 并且请求没有足够高的优先级,则返回 undefined。
Example:
resource.post(data)
  .then(function(result) {
      // use the result
  }).catch(function(error) {
      // an error occurred
  });
See:

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

异步将数据放入给定的资源。返回一个承诺,一旦加载就会解析为结果,或者如果资源加载失败则拒绝。数据是使用 XMLHttpRequest 加载的,这意味着为了向另一个源发出请求,服务器必须启用跨源资源共享 (CORS) 标头。
Name Type Description
data Object 随资源发布的数据。
options Object 具有以下属性的 可选 对象:
姓名 类型 描述
responseType 细绳 可选 响应的类型。这控制返回的项目的类型。
headers 目的 可选 与请求一起发送的附加 HTTP 标头(如果有)。
overrideMimeType 细绳 可选 覆盖服务器返回的 MIME 类型。
Returns:
加载时将解析为请求的数据的承诺。如果 request.throttle 为 true 并且请求没有足够高的优先级,则返回 undefined。
Example:
resource.put(data)
  .then(function(result) {
      // use the result
  }).catch(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,则这些值将用作默认值,因此只有在未定义时才会设置它们。

toString () String

覆盖 Object#toString 以便隐式字符串转换提供此资源表示的完整 URL。
Returns:
此资源表示的 URL

Type Definitions

Cesium.Resource.ConstructorOptions

Resource 构造函数的初始化选项
Properties:
Name Type Attributes Default Description
url String 资源的网址。
queryParameters Object <optional>
包含在检索资源时将发送的查询参数的对象。
templateValues Object <optional>
用于替换模板值的键/值对(例如 {x})。
headers Object <optional>
{} 将发送的其他 HTTP 标头。
proxy Proxy <optional>
加载资源时要使用的代理。
retryCallback Resource.RetryCallback <optional>
对该资源的请求失败时调用的函数。如果返回 true,则请求将被重试。
retryAttempts Number <optional>
0 在放弃之前应该调用 retryCallback 的次数。
request Request <optional>
将使用的 Request 对象。仅供内部使用。

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

返回属性值的函数。
Name Type Description
resource Resource 可选 加载失败的资源。
error Error 可选 加载资源期间发生的错误。
Returns:
如果为真或一个承诺为真,资源将被重试。否则将返回失败。