IonResource

new Cesium.IonResource(endpoint, endpointResource)
engine/Source/Core/IonResource.js 27

一个 Resource 实例，封装了对 Cesium ion 资产的访问。 此对象通常不直接实例化，使用 IonResource.fromAssetId。
Name Type Description
endpoint object Cesium ion 资产端点服务的结果。
endpointResource Resource 用于检索端点的资源。
See:

Extends

Members

readonly credits : Array.<Credit>
engine/Source/Core/IonResource.js 127

获取资产归属所需的信用信息。

readonly extension : string
engine/Source/Core/Resource.js 330

资源的文件扩展名。
Inherited From:

hasHeaders : boolean
engine/Source/Core/Resource.js 378

如果资源具有请求头，则返回真。等效于检查 headers 属性是否有任何键。
Inherited From:

headers : object
engine/Source/Core/Resource.js 115

将随请求发送的额外 HTTP 头。
Inherited From:

isBlobUri : boolean
engine/Source/Core/Resource.js 354

如果资源引用的是 blob URI，则为真。
Inherited From:

isCrossOriginUrl : boolean
engine/Source/Core/Resource.js 366

如果资源引用的是跨域 URL，则为真。
Inherited From:

isDataUri : boolean
engine/Source/Core/Resource.js 342

如果资源引用的是数据 URI，则为真。
Inherited From:

proxy : Proxy
engine/Source/Core/Resource.js 129

加载资源时使用的代理。
Inherited From:

readonly queryParameters : object
engine/Source/Core/Resource.js 287

附加到 URL 的查询参数。
Inherited From:

request : Request
engine/Source/Core/Resource.js 122

将被使用的 Request 对象。仅供内部使用。
Inherited From:

retryAttempts : number
engine/Source/Core/Resource.js 144

在放弃之前应调用 retryCallback 的次数。
Inherited From:

retryCallback : function
engine/Source/Core/Resource.js 136

请求该资源失败时要调用的函数。如果返回 true 或返回一个解析为 true 的 Promise，则请求将被重试。
Inherited From:

readonly templateValues : object
engine/Source/Core/Resource.js 301

用于替换 URL 中模板参数的键/值对。
Inherited From:

url : string
engine/Source/Core/Resource.js 313

URL，替换了模板值，附加了查询字符串，并在设置代理时进行了编码。
Inherited From:

Methods

static Cesium.IonResource.fromAssetId(assetId, options) → Promise.<IonResource>
engine/Source/Core/IonResource.js 107

异步创建一个实例。
Name Type Description
assetId number Cesium ion 资产 ID。
options object optional 具有以下属性的对象：
Name Type Default Description
accessToken string Ion.defaultAccessToken optional 要使用的访问令牌。
server string | Resource Ion.defaultServer optional 指向 Cesium ion API 服务器的资源。
Returns:
一个 Promise，表示代表 Cesium ion 资产的实例。
Examples:
// Load a Cesium3DTileset with asset ID of 124624234
try {
  const resource = await Cesium.IonResource.fromAssetId(124624234);
  const tileset = await Cesium.Cesium3DTileset.fromUrl(resource);
  scene.primitives.add(tileset);
} catch (error) {
  console.error(`Error creating tileset: ${error}`);
}
//Load a CZML file with asset ID of 10890
Cesium.IonResource.fromAssetId(10890)
  .then(function (resource) {
    viewer.dataSources.add(Cesium.CzmlDataSource.load(resource));
  });

appendForwardSlash()
engine/Source/Core/Resource.js 798

在 URL 末尾附加一个正斜杠。
Inherited From:

appendQueryParameters(params)
engine/Source/Core/Resource.js 637

结合指定对象和现有查询参数。这允许一次添加多个参数， 反之则需要逐个添加到 queryParameters 属性。
Name Type Description
params object 查询参数
Inherited From:

clone(result) → Resource
engine/Source/Core/Resource.js 753

复制一个 Resource 实例。
Name Type Description
result Resource optional 存储结果的对象。
Returns:
修改后的结果参数，或者如果未提供则返回一个新 Resource 实例。
Inherited From:

delete(options) → Promise.<any>|undefined
engine/Source/Core/Resource.js 1596

异步删除给定资源。返回一个承诺，一旦加载完成将解析为 结果，或者在资源加载失败时拒绝。数据是使用 XMLHttpRequest 加载的， 这意味着为了向其他来源发出请求，服务器必须启用跨源资源共享 (CORS) 头。
Name Type Description
options object optional 具有以下属性的对象：
Name Type Description
responseType string optional 响应的类型。控制返回的项目类型。
headers object optional 附加的 HTTP 头，将随请求发送（如果有）。
overrideMimeType string optional 覆盖服务器返回的 MIME 类型。
Returns:
一个承诺，当数据加载完成时将解析为请求的数据。如果 request.throttle 为真且请求的优先级不够高，则返回 undefined。
Inherited From:
Example:
resource.delete()
  .then(function(body) {
      // use the data
  }).catch(function(error) {
      // an error occurred
  });
See:

fetch(options) → Promise.<any>|undefined
engine/Source/Core/Resource.js 1540

异步加载给定资源。返回一个承诺，一旦加载完成将解析为 结果，或者在资源加载失败时拒绝。数据是使用 XMLHttpRequest 加载的， 这意味着为了向其他来源发出请求，服务器必须启用跨源资源共享 (CORS) 头。建议使用 更具体的函数，例如 fetchJson、fetchBlob 等。
Name Type Description
options object optional 具有以下属性的对象：
Name Type Description
responseType string optional 响应的类型。控制返回的项目类型。
headers object optional 附加的 HTTP 头，将随请求发送（如果有）。
overrideMimeType string optional 覆盖服务器返回的 MIME 类型。
Returns:
一个承诺，当数据加载完成时将解析为请求的数据。如果 request.throttle 为真且请求的优先级不够高，则返回 undefined。
Inherited From:
Example:
resource.fetch()
  .then(function(body) {
      // use the data
  }).catch(function(error) {
      // an error occurred
  });
See:

fetchArrayBuffer() → Promise.<ArrayBuffer>|undefined
engine/Source/Core/Resource.js 820

异步加载资源作为原始二进制数据。返回一个承诺，一旦加载完成将解析为 ArrayBuffer，或者在资源加载失败时拒绝。数据是使用 XMLHttpRequest 加载的， 这意味着为了向其他来源发出请求，服务器必须启用跨源资源共享 (CORS) 头。
Returns:
一个承诺，当数据加载完成时将解析为请求的数据。如果 request.throttle 为 true 且请求的优先级不够高，则返回 undefined。
Inherited From:
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
engine/Source/Core/Resource.js 864

异步加载给定资源作为 blob。返回一个承诺，一旦加载完成将解析为 Blob，或者在资源加载失败时拒绝。数据是使用 XMLHttpRequest 加载的， 这意味着为了向其他来源发出请求，服务器必须启用跨源资源共享 (CORS) 头。
Returns:
一个承诺，当数据加载完成时将解析为请求的数据。如果 request.throttle 为 true 且请求的优先级不够高，则返回 undefined。
Inherited From:
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
engine/Source/Core/Resource.js 918

异步加载给定的图像资源。返回一个承诺，如果 preferImageBitmap 为真且浏览器支持 createImageBitmap，将解析为一个 ImageBitmap， 否则将解析为一个 Image，一旦加载完成；如果图像加载失败，则拒绝。
Name Type Description
options object optional 具有以下属性的对象。
Name Type Default Description
preferBlob boolean false optional 如果为真，我们将通过 blob 加载图像。
preferImageBitmap boolean false optional 如果为真，图像将在获取期间解码并返回 ImageBitmap。
flipY boolean false optional 如果为真，图像将在解码时垂直翻转。仅在浏览器支持 createImageBitmap 时适用。
skipColorSpaceConversion boolean false optional 如果为真，图像中的任何自定义伽马或色彩配置文件将被忽略。仅在浏览器支持 createImageBitmap 时适用。
Returns:
一个承诺，当数据加载完成时将解析为请求的数据。如果 request.throttle 为真且请求的优先级不够高，则返回 undefined。
Inherited From:
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.<any>|undefined
engine/Source/Core/Resource.js 1186

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

fetchJsonp(callbackParameterName) → Promise.<any>|undefined
engine/Source/Core/Resource.js 1290

使用 JSONP 请求资源。
Name Type Default Description
callbackParameterName string 'callback' optional 服务器期望的回调参数名称。
Returns:
一个承诺，当数据加载完成时将解析为请求的数据。如果 request.throttle 为真且请求的优先级不够高，则返回 undefined。
Inherited From:
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
engine/Source/Core/Resource.js 1141

异步加载给定资源作为文本。返回一个承诺，一旦加载完成将解析为 字符串，或者在资源加载失败时拒绝。数据是使用 XMLHttpRequest 加载的， 这意味着为了向其他来源发出请求，服务器必须启用跨源资源共享 (CORS) 头。
Returns:
一个承诺，当数据加载完成时将解析为请求的数据。如果 request.throttle 为真且请求的优先级不够高，则返回 undefined。
Inherited From:
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
engine/Source/Core/Resource.js 1247

异步加载给定资源作为 XML。返回一个承诺，一旦加载完成将解析为 XML 文档，或者在资源加载失败时拒绝。数据是使用 XMLHttpRequest 加载的， 这意味着为了向其他来源发出请求，服务器必须启用跨源资源共享 (CORS) 头。
Returns:
一个承诺，当数据加载完成时将解析为请求的数据。如果 request.throttle 为真且请求的优先级不够高，则返回 undefined。
Inherited From:
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
engine/Source/Core/Resource.js 790

返回资源的基本路径。
Name Type Default Description
includeQuery boolean false optional 是否包含查询字符串和 URI 的片段。
Returns:
资源的基本 URI。
Inherited From:

getDerivedResource(options) → Resource
engine/Source/Core/Resource.js 678

返回相对于当前实例的资源。除非在选项中被覆盖，否则所有属性将与当前实例保持相同。
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 Proxy optional 加载资源时使用的代理。
retryCallback Resource.RetryCallback optional 当加载资源失败时调用的函数。
retryAttempts number optional 在放弃之前应调用 retryCallback 的次数。
request Request optional 将被使用的 Request 对象。仅供内部使用。
preserveQueryParameters boolean false optional 如果为真，则保留当前资源和派生资源的所有查询参数。如果为假，派生参数将替换当前资源的参数。
Returns:
从当前资源派生的资源。
Inherited From:

getUrlComponent(query, proxy) → string
engine/Source/Core/Resource.js 550

返回 URL，可选包含查询字符串，并由代理处理。
Name Type Default Description
query boolean false optional 如果为真，查询字符串将被包含。
proxy boolean false optional 如果为真，则 URL 将由代理对象处理（如果已定义）。
Returns:
包含所有请求组件的 URL。
Inherited From:
异步获取给定资源的头信息。返回一个承诺，一旦加载完成将解析为 结果，或者在资源加载失败时拒绝。数据是使用 XMLHttpRequest 加载的， 这意味着为了向其他来源发出请求，服务器必须启用跨源资源共享 (CORS) 头。
Name Type Description
options object optional 具有以下属性的对象：
Name Type Description
responseType string optional 响应的类型。控制返回的项目类型。
headers object optional 附加的 HTTP 头，将随请求发送（如果有）。
overrideMimeType string optional 覆盖服务器返回的 MIME 类型。
Returns:
一个承诺，当数据加载完成时将解析为请求的数据。如果 request.throttle 为真且请求的优先级不够高，则返回 undefined。
Inherited From:
Example:
resource.head()
  .then(function(headers) {
      // use the data
  }).catch(function(error) {
      // an error occurred
  });
See:

options(options) → Promise.<any>|undefined
engine/Source/Core/Resource.js 1706

异步获取给定资源的选项。返回一个承诺，一旦加载完成将解析为 结果，或者在资源加载失败时拒绝。数据是使用 XMLHttpRequest 加载的， 这意味着为了向其他来源发出请求，服务器必须启用跨源资源共享 (CORS) 头。
Name Type Description
options object optional 具有以下属性的对象：
Name Type Description
responseType string optional 响应的类型。控制返回的项目类型。
headers object optional 附加的 HTTP 头，将随请求发送（如果有）。
overrideMimeType string optional 覆盖服务器返回的 MIME 类型。
Returns:
一个承诺，当数据加载完成时将解析为请求的数据。如果 request.throttle 为真且请求的优先级不够高，则返回 undefined。
Inherited From:
Example:
resource.options()
  .then(function(headers) {
      // use the data
  }).catch(function(error) {
      // an error occurred
  });
See:

patch(data, options) → Promise.<any>|undefined
engine/Source/Core/Resource.js 1886

异步将数据修补到给定资源。返回一个承诺，一旦加载完成将解析为 结果，或者在资源加载失败时拒绝。数据是使用 XMLHttpRequest 加载的， 这意味着为了向其他来源发出请求，服务器必须启用跨源资源共享 (CORS) 头。
Name Type Description
data object 与资源一起发送的数据。
options object optional 具有以下属性的对象：
Name Type Description
responseType string optional 响应的类型。控制返回的项目类型。
headers object optional 附加的 HTTP 头，将随请求发送（如果有）。
overrideMimeType string optional 覆盖服务器返回的 MIME 类型。
Returns:
一个承诺，当数据加载完成时将解析为请求的数据。如果 request.throttle 为真且请求的优先级不够高，则返回 undefined。
Inherited From:
Example:
resource.patch(data)
  .then(function(result) {
      // use the result
  }).catch(function(error) {
      // an error occurred
  });
See:

post(data, options) → Promise.<any>|undefined
engine/Source/Core/Resource.js 1764

异步向给定资源发送数据。返回一个承诺，一旦加载完成将解析为 结果，或者在资源加载失败时拒绝。数据是使用 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 类型。
Returns:
一个承诺，当数据加载完成时将解析为请求的数据。如果 request.throttle 为真且请求的优先级不够高，则返回 undefined。
Inherited From:
Example:
resource.post(data)
  .then(function(result) {
      // use the result
  }).catch(function(error) {
      // an error occurred
  });
See:

put(data, options) → Promise.<any>|undefined
engine/Source/Core/Resource.js 1825

异步向给定资源发送数据。返回一个承诺，一旦加载完成将解析为 结果，或者在资源加载失败时拒绝。数据是使用 XMLHttpRequest 加载的， 这意味着为了向其他来源发出请求，服务器必须启用跨源资源共享 (CORS) 头。
Name Type Description
data object 与资源一起发送的数据。
options object optional 具有以下属性的对象：
Name Type Description
responseType string optional 响应的类型。控制返回的项目类型。
headers object optional 附加的 HTTP 头，将随请求发送（如果有）。
overrideMimeType string optional 覆盖服务器返回的 MIME 类型。
Returns:
一个承诺，当数据加载完成时将解析为请求的数据。如果 request.throttle 为真且请求的优先级不够高，则返回 undefined。
Inherited From:
Example:
resource.put(data)
  .then(function(result) {
      // use the result
  }).catch(function(error) {
      // an error occurred
  });
See:

setQueryParameters(params, useAsDefault)
engine/Source/Core/Resource.js 614

结合指定对象和现有查询参数。这允许一次添加多个参数， 反之则需要逐个添加到 queryParameters 属性。如果一个值已经设置，则会被新值替换。
Name Type Default Description
params object 查询参数
useAsDefault boolean false optional 如果为真，params 将作为默认值使用，因此只有在未定义时才会设置它们。
Inherited From:

setTemplateValues(template, useAsDefault)
engine/Source/Core/Resource.js 653

结合指定对象和现有模板值。这允许一次添加多个值， 反之则需要逐个添加到 templateValues 属性。如果一个值已经设置，它将变为一个数组，并将新值附加到其中。
Name Type Default Description
template object 模板值
useAsDefault boolean false optional 如果为真，这些值将作为默认值使用，因此只有在未定义时才会设置它们。
Inherited From:

toString() → string
engine/Source/Core/Resource.js 403

重写 Object#toString，以便隐式字符串转换返回 此资源所表示的完整 URL。
Returns:
此资源所表示的 URL
Inherited From:
需要帮助？获得答案的最快方法是来自社区和团队 Cesium Forum.
packages/engine
packages/widgets