Utility object for working with the Cesium ion API.
Experimental
This class is part of Cesium ion beta functionality and may change without our normal deprecation policy.
See:
Members
-
The default Cesium ion access token to use.
-
The default Cesium ion server to use.
-
Default Value:
https://api.cesium.com
Methods
-
staticCesium.CesiumIon.create3DTileset(assetId, options) → Promise.<Cesium3DTileset>
-
Asynchronously creates a
Cesium3DTileset
representing a Cesium ion 3D Tiles asset and waits for it to become ready.Name Type Description assetId
Number The Cesium ion asset id. options
Object optional An object with the following properties: Name Type Default Description accessToken
String CesiumIon.defaultAccessToken
optional The access token to use. serverUrl
String CesiumIon.defaultServerUrl
optional The url to the Cesium ion API server. tilesetOptions
String optional Additional options to be passed to the Cesium3DTileset
constructor.Returns:
A promise to the ready tileset representing the requested Cesium ion Asset.Example:
//Load a tileset with asset ID of 2347923 Cesium.CesiumIon.create3DTileset(2347923) .then(function (tileset) { viewer.scene.primitives.add(tileset); }); //Load a tileset with asset ID of 2347923 for 3D Tile classification Cesium.CesiumIon.create3DTileset(2347923, { tilesetOptions: { classificationType: Cesium.ClassificationType.CESIUM_3D_TILE } }) .then(function (tileset) { viewer.scene.primitives.add(tileset); });
-
staticCesium.CesiumIon.createImageryProvider(assetId, options) → Promise.<ImageryProvider>
-
Asynchronously creates an
ImageryProvider
representing a Cesium ion imagery asset and waits for it to become ready. UnlikeCesiumIon.createResource
, this function supports external asset functionality.Name Type Description assetId
Number The Cesium ion asset id. options
Object optional An object with the following properties: Name Type Default Description accessToken
String CesiumIon.defaultAccessToken
optional The access token to use. serverUrl
String CesiumIon.defaultServerUrl
optional The url to the Cesium ion API server. Returns:
A promise to a ready imagery provider representing the requested Cesium ion Asset.Example:
//Load an ImageryProvider with asset ID of 2347923 Cesium.CesiumIon.createImageryProvider(2347923) .then(function (imageryProvider) { viewer.imageryLayers.addProvider(imageryProvider); });
-
staticCesium.CesiumIon.createResource(assetId, options) → Promise.<Resource>
-
Asynchronously creates a
Resource
representing a Cesium ion asset.Name Type Description assetId
Number The Cesium ion asset id. options
Object optional An object with the following properties: Name Type Default Description accessToken
String CesiumIon.defaultAccessToken
optional The access token to use. serverUrl
String CesiumIon.defaultServerUrl
optional The url to the Cesium ion API server. Returns:
A Promise to a Resource representing the Cesium ion Asset.Examples:
//Load a Cesium3DTileset with asset ID of 124624234 Cesium.CesiumIon.createResource(124624234) .then(function (resource) { viewer.scene.primitives.add(new Cesium.Cesium3DTileset({ url: resource })); });
//Load a CZML file with asset ID of 10890 Cesium.CesiumIon.createResource(10890) .then(function (resource) { viewer.dataSources.add(Cesium.CzmlDataSource.load(resource)); });
//Load an ImageryProvider with asset ID of 2347923 Cesium.CesiumIon.createResource(2347923) .then(function (resource) { viewer.imageryLayers.addProvider(Cesium.createTileMapServiceImageryProvider({url : resource })); });