Cesium API - IonResource 中文文档

Name	Type	Default	Description
`accessToken`	String	`Ion.defaultAccessToken`	optional 要使用的访问令牌。
`server`	String \| Resource	`Ion.defaultServer`	optional Cesium ion API服务器的资源。

返回值：

对代表Cesium ion 资产的实例的约定（Promise）。

示例：

// 加载资产ID为124624234的Cesium3DTileset
viewer.scene.primitives.add(new Cesium.Cesium3DTileset({ url: Cesium.IonResource.fromAssetId(124624234) }));

// 加载资产ID为10890的CZML文件
Cesium.IonResource.fromAssetId(10890)
  .then(function (resource) {
    viewer.dataSources.add(Cesium.CzmlDataSource.load(resource));
  });

appendForwardSlash()

Core/Resource.js 764

向URL追加正斜杠（forward slash）。

Inherited From:

Resource#appendForwardSlash

appendQueryParameters(params)

Core/Resource.js 623

组合指定的对象和现有的查询参数。这允许您一次添加多个参数，而不是一次向queryParameters属性添加一个参数。

Name	Type	Description
`params`	Object	查询参数。

Inherited From:

Resource#appendQueryParameters

clone(result) → Resource

Core/Resource.js 730

复制资源实例。

Name	Type	Description
`result`	Resource	optional 存储结果的对象。

返回值：

已修改的结果参数或新资源实例（如果未提供）。

Inherited From:

Resource#clone

delete(options) → Promise.<Object>|undefined

Core/Resource.js 1502

异步 deletes 给定的资源。返回一个约定，该约定将在加载后解析为结果，或者在资源加载失败时拒绝。使用XMLHttpRequest加载数据，这意味着为了向另一个源发出请求，服务器必须启用跨源资源共享（CORS）标头。

Name Type Description

options

Object

optional 对象，具有以下属性：

Name	Type	Description
`responseType`	String	optional 响应的类型。它控制返回的项的类型。
`headers`	Object	optional 将发送的其他HTTP头信息（如果有的话）。
`overrideMimeType`	String	optional 重写服务器返回的MIME类型。

返回值：

将在加载完成时解析到请求数据的约定。如果request.throttle为true并且请求的优先级不够高，返回undefined。

Inherited From:

Resource#delete

示例：

resource.delete()
  .then(function(body) {
      // use the data
  }).otherwise(function(error) {
      // an error occurred
  });

参考：

fetch(options) → Promise.<Object>|undefined

Core/Resource.js 1447

异步 loads 给定的资源。返回一个约定，该约定将在加载后解析为结果，或者在资源加载失败时拒绝。使用XMLHttpRequest加载数据，这意味着为了向另一个源发出请求，服务器必须启用跨源资源共享（CORS）标头。建议您使用更具体的函数，如：fetchJson，fetchBlob等等。

Name Type Description

options

Object

optional 对象，具有以下属性：

Name	Type	Description
`responseType`	String	optional 响应的类型。它控制返回的项的类型。
`headers`	Object	optional 将发送的其他HTTP头信息（如果有的话）。
`overrideMimeType`	String	optional 重写服务器返回的MIME类型。

返回值：

将在加载完成时解析到请求数据的约定。如果request.throttle为true并且请求的优先级不够高，返回undefined。

Inherited From:

Resource#fetch

示例：

resource.fetch()
  .then(function(body) {
      // use the data
  }).otherwise(function(error) {
      // an error occurred
  });

参考：

fetchArrayBuffer() → Promise.<ArrayBuffer>|undefined

Core/Resource.js 786

以原始二进制数据的形式异步地加载给定的资源。返回一个约定，该约定将在加载后解析为结果，或者在资源加载失败时拒绝。使用XMLHttpRequest加载数据，这意味着为了向另一个源发出请求，服务器必须启用跨源资源共享（CORS）标头。

返回值：

将在加载完成时解析到请求数据的约定。如果request.throttle为true并且请求的优先级不够高，返回undefined。

Inherited From:

Resource#fetchArrayBuffer

示例：

// 异步加载单个URL
resource.fetchArrayBuffer().then(function(arrayBuffer) {
    // use the data
}).otherwise(function(error) {
    // an error occurred
});

参考：

fetchBlob() → Promise.<Blob>|undefined

Core/Resource.js 830

以blob的形式异步地加载给定的资源。返回一个约定，该约定将在加载后解析为结果，或者在资源加载失败时拒绝。使用XMLHttpRequest加载数据，这意味着为了向另一个源发出请求，服务器必须启用跨源资源共享（CORS）标头。

返回值：

将在加载完成时解析到请求数据的约定。如果request.throttle为true并且请求的优先级不够高，返回undefined。

Inherited From:

Resource#fetchBlob

示例：

// 异步加载单个URL
resource.fetchBlob().then(function(blob) {
    // use the data
}).otherwise(function(error) {
    // an error occurred
});

参考：

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

Core/Resource.js 884

异步加载给定的图像资源。返回一个约定，该约定将解析为ImageBitmap，如果preferImageBitmap为true，并且浏览器支持createImageBitmap或其他加载后的Image；如果图像加载失败则拒绝。

Name Type Description

options

Object

optional 对象，具有下列属性：

Name	Type	Default	Description
`preferBlob`	Boolean	`false`	optional 如果为true，则通过blob加载图像。
`preferImageBitmap`	Boolean	`false`	optional 如果为true，图像将在获取过程中被解码，并返回`ImageBitmap` 。
`flipY`	Boolean	`false`	optional 如果为true，图像将在解码过程中垂直翻转。只适用于浏览器支持`createImageBitmap`。

返回值：

将在加载完成时解析到请求数据的约定。如果request.throttle为true并且请求的优先级不够高，返回undefined。

Inherited From:

Resource#fetchImage

示例：

// 异步加载单个图像
resource.fetchImage().then(function(image) {
    // use the loaded image
}).otherwise(function(error) {
    // an error occurred
});
// 并行加载多个图像
when.all([resource1.fetchImage(), resource2.fetchImage()]).then(function(images) {
    // images is an array containing all the loaded images
});

参考：

fetchJson() → Promise.<Object>|undefined

Core/Resource.js 1131

以JSON的形式异步地加载给定的资源。返回一个约定，该约定将在加载后解析为结果，或者在资源加载失败时拒绝。使用XMLHttpRequest加载数据，这意味着为了向另一个源发出请求，服务器必须启用跨源资源共享（CORS）标头。如果尚未指定，此函数将向请求头添加'Accept: application/json,*/*;q=0.01'。

返回值：

将在加载完成时解析到请求数据的约定。如果request.throttle为true并且请求的优先级不够高，返回undefined。

Inherited From:

Resource#fetchJson

示例：

resource.fetchJson().then(function(jsonData) {
    // Do something with the JSON object
}).otherwise(function(error) {
    // an error occurred
});

参考：

fetchJsonp(callbackParameterName) → Promise.<Object>|undefined

Core/Resource.js 1234

使用JSONP请求资源。

Name	Type	Default	Description
`callbackParameterName`	String	`'callback'`	optional 服务器期望的回调参数名。

返回值：

将在加载完成时解析到请求数据的约定。如果request.throttle为true并且请求的优先级不够高，返回undefined。

Inherited From:

Resource#fetchJsonp

示例：

// 异步加载数据
resource.fetchJsonp().then(function(data) {
    // use the loaded data
}).otherwise(function(error) {
    // an error occurred
});

参考：

CommonJS Promises/A

fetchText() → Promise.<Object>|undefined

Core/Resource.js 1087

以文本的形式异步地加载给定的资源。返回一个约定，该约定将在加载后解析为结果，或者在资源加载失败时拒绝。使用XMLHttpRequest加载数据，这意味着为了向另一个源发出请求，服务器必须启用跨源资源共享（CORS）标头。

返回值：

将在加载完成时解析到请求数据的约定。如果request.throttle为true并且请求的优先级不够高，返回undefined。

Inherited From:

Resource#fetchText

示例：

// 从URL加载文本，设置自定义标头
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
});

参考：

fetchXML() → Promise.<Object>|undefined

Core/Resource.js 1192

以XML的形式异步加载给定的资源。返回一个约定，该约定将在加载后解析为结果，或者在资源加载失败时拒绝。使用XMLHttpRequest加载数据，这意味着为了向另一个源发出请求，服务器必须启用跨源资源共享（CORS）标头。

返回值：

将在加载完成时解析到请求数据的约定。如果request.throttle为true并且请求的优先级不够高，返回undefined。

Inherited From:

Resource#fetchXML

示例：

// 从URL加载XML，设置自定义标头
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
});

参考：

getBaseUri(includeQuery) → String

Core/Resource.js 757

返回资源的基本路径。

Name	Type	Default	Description
`includeQuery`	Boolean	`false`	optional 是否包含查询字符串和uri片段

返回值：

资源的基本URI

Inherited From:

Resource#getBaseUri

getDerivedResource(options) → Resource

Core/Resource.js 658

返回相对于当前实例的资源。除非在options中被覆盖，否则所有属性都保持与当前实例相同。

Name Type Description

options

Object

对象，具有下列属性：

Name	Type	Default	Description
`url`	String		optional 将相对于当前实例的url解析的url。
`queryParameters`	Object		optional 包含将与当前实例的查询参数组合的查询参数的对象。
`templateValues`	Object		optional 用于替换模板值（例如：{x}）的键/值对。这些将与当前实例的那些相结合。
`headers`	Object	`{}`	optional 将发送的其他HTTP头信息。
`proxy`	DefaultProxy		optional 加载资源时使用的代理。
`retryCallback`	Resource~RetryCallback		optional 当请求此资源失败时要调用的函数。
`retryAttempts`	Number		optional 在放弃之前应该调用retryCallback的次数。
`request`	Request		optional 将使用的Request对象。仅供内部使用。
`preserveQueryParameters`	Boolean	`false`	optional 如果为true，则将保留来自当前资源和派生资源的所有查询参数。如果为false，派生的参数将替换当前资源的参数。

返回值：

从当前资源派生的资源。

Inherited From:

Resource#getDerivedResource

getUrlComponent(query, proxy) → String

Core/Resource.js 572

返回url，查询字符串可选，由代理处理。

Name	Type	Default	Description
`query`	Boolean	`false`	optional 如果为true，则包含查询字符串。
`proxy`	Boolean	`false`	optional 如果为true，则定义代理对象处理url。

返回值：

包含所有请求分量的url。

Inherited From:

Resource#getUrlComponent

head(options) → Promise.<Object>|undefined

Core/Resource.js 1558

异步获取给定资源的headers。返回一个约定，该约定将在加载后解析为结果，或者在资源加载失败时拒绝。使用XMLHttpRequest加载数据，这意味着为了向另一个源发出请求，服务器必须启用跨源资源共享（CORS）标头。

Name Type Description

options

Object

optional 对象，具有以下属性：

Name	Type	Description
`responseType`	String	optional 响应的类型。它控制返回的项的类型。
`headers`	Object	optional 将发送的其他HTTP头信息（如果有的话）。
`overrideMimeType`	String	optional 重写服务器返回的MIME类型。

返回值：

将在加载完成时解析到请求数据的约定。如果request.throttle为true并且请求的优先级不够高，返回undefined。

Inherited From:

Resource#head

示例：

resource.head()
  .then(function(headers) {
      // use the data
  }).otherwise(function(error) {
      // an error occurred
  });

参考：

options(options) → Promise.<Object>|undefined

Core/Resource.js 1612

异步获取给定资源的options。返回一个约定，该约定将在加载后解析为结果，或者在资源加载失败时拒绝。使用XMLHttpRequest加载数据，这意味着为了向另一个源发出请求，服务器必须启用跨源资源共享（CORS）标头。

Name Type Description

options

Object

optional 对象，具有以下属性：

Name	Type	Description
`responseType`	String	optional 响应的类型。它控制返回的项的类型。
`headers`	Object	optional 将发送的其他HTTP头信息（如果有的话）。
`overrideMimeType`	String	optional 重写服务器返回的MIME类型。

返回值：

将在加载完成时解析到请求数据的约定。如果request.throttle为true并且请求的优先级不够高，返回undefined。

Inherited From:

Resource#options

示例：

resource.options()
  .then(function(headers) {
      // use the data
  }).otherwise(function(error) {
      // an error occurred
  });

参考：

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

Core/Resource.js 1788

将数据异步地 patches 到给定的资源。返回一个约定，该约定将在加载后解析为结果，或者在资源加载失败时拒绝。使用XMLHttpRequest加载数据，这意味着为了向另一个源发出请求，服务器必须启用跨源资源共享（CORS）标头。

Name Type Description

data Object 与资源一起发布的数据。

options

Object

optional 对象，具有以下属性：

Name	Type	Description
`responseType`	String	optional 响应的类型。它控制返回的项的类型。
`headers`	Object	optional 与请求一起发送的附加HTTP头（如果有的话）。
`overrideMimeType`	String	optional 重写服务器返回的MIME类型。

返回值：

将在加载完成时解析到请求数据的约定。如果request.throttle为true并且请求的优先级不够高，返回undefined。

Inherited From:

Resource#patch

示例：

resource.patch(data)
  .then(function(result) {
      // use the result
  }).otherwise(function(error) {
      // an error occurred
  });

参考：

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

Core/Resource.js 1668

异步地将数据 posts 到给定的资源。返回一个约定，该约定将在加载后解析为结果，或者在资源加载失败时拒绝。使用XMLHttpRequest加载数据，这意味着为了向另一个源发出请求，服务器必须启用跨源资源共享（CORS）标头。

Name Type Description

data Object 与资源一起发布的数据。

options

Object

optional 对象，具有以下属性：

Name	Type	Description
`data`	Object	optional 与资源一起发布的数据。
`responseType`	String	optional 响应的类型。它控制返回的项的类型。
`headers`	Object	optional 将发送的其他HTTP头信息（如果有的话）。
`overrideMimeType`	String	optional 重写服务器返回的MIME类型。

返回值：

将在加载完成时解析到请求数据的约定。如果request.throttle为true并且请求的优先级不够高，返回undefined。

Inherited From:

Resource#post

示例：

resource.post(data)
  .then(function(result) {
      // use the result
  }).otherwise(function(error) {
      // an error occurred
  });

参考：

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

Core/Resource.js 1728

异步地将数据 put 到给定的资源。返回一个约定，该约定将在加载后解析为结果，或者在资源加载失败时拒绝。使用XMLHttpRequest加载数据，这意味着为了向另一个源发出请求，服务器必须启用跨源资源共享（CORS）标头。

Name Type Description

data Object 与资源一起发布的数据。

options

Object

optional 对象，具有以下属性：

Name	Type	Description
`responseType`	String	optional 响应的类型。它控制返回的项的类型。
`headers`	Object	optional 将发送的其他HTTP头信息（如果有的话）。
`overrideMimeType`	String	optional 重写服务器返回的MIME类型。

返回值：

将在加载完成时解析到请求数据的约定。如果request.throttle为true并且请求的优先级不够高，返回undefined。

Inherited From:

Resource#put

示例：

resource.put(data)
  .then(function(result) {
      // use the result
  }).otherwise(function(error) {
      // an error occurred
  });

参考：

setQueryParameters(params, useAsDefault)

Core/Resource.js 610

组合指定的对象和现有的查询参数。这允许您一次添加多个参数，而不是一次向queryParameters属性添加一个参数。如果已经设置了值，则将用新值替换它。

Name	Type	Default	Description
`params`	Object		查询参数。
`useAsDefault`	Boolean	`false`	optional 如果为true，则参数将用作默认值，因此只有在参数未定义时才会设置它们。