I3SDataProvider

new Cesium.I3SDataProvider(options)
engine/Source/Scene/I3SDataProvider.js 120

An I3SDataProvider is the main public class for I3S support. The url option should return a scene object. Currently supported I3S versions are 1.6 and 1.7/1.8 (OGC I3S 1.2). I3SFeature and I3SNode classes implement the Object Model for I3S entities, with public interfaces.
This object is normally not instantiated directly, use I3SDataProvider.fromUrl.
Name Type Description
options I3SDataProvider.ConstructorOptions An object describing initialization options
Examples:
try {
  const i3sData = await I3SDataProvider.fromUrl(
    "https://tiles.arcgis.com/tiles/z2tnIkrLQ2BRzr6P/arcgis/rest/services/Frankfurt2017_vi3s_18/SceneServer/layers/0"
  );
  viewer.scene.primitives.add(i3sData);
} catch (error) {
  console.log(`There was an error creating the I3S Data Provider: ${error}`);
}
try {
  const geoidService = await Cesium.ArcGISTiledElevationTerrainProvider.fromUrl(
    "https://tiles.arcgis.com/tiles/z2tnIkrLQ2BRzr6P/arcgis/rest/services/EGM2008/ImageServer"
  );
  const i3sData = await I3SDataProvider.fromUrl(
    "https://tiles.arcgis.com/tiles/z2tnIkrLQ2BRzr6P/arcgis/rest/services/Frankfurt2017_vi3s_18/SceneServer/layers/0", {
      geoidTiledTerrainProvider: geoidService
  });
  viewer.scene.primitives.add(i3sData);
} catch (error) {
  console.log(`There was an error creating the I3S Data Provider: ${error}`);
}
See:

Members

readonly data : object
engine/Source/Scene/I3SDataProvider.js 240

Gets the I3S data for this object.

readonly extent : Rectangle
engine/Source/Scene/I3SDataProvider.js 252

Gets the extent covered by this I3S.

readonly geoidTiledTerrainProvider : ArcGISTiledElevationTerrainProvider
engine/Source/Scene/I3SDataProvider.js 216

The terrain provider referencing the GEOID service to be used for orthometric to ellipsoidal conversion.

readonly layers : Array.<I3SLayer>
engine/Source/Scene/I3SDataProvider.js 228

Gets the collection of layers.

readonly name : string
engine/Source/Scene/I3SDataProvider.js 163

Gets a human-readable name for this dataset.

readonly deprecated ready : boolean
engine/Source/Scene/I3SDataProvider.js 283

When true, the I3S scene is loaded. This is set to true right before I3SDataProvider#readyPromise is resolved.

Deprecated: true

readonly deprecated readyPromise : Promise.<I3SDataProvider>
engine/Source/Scene/I3SDataProvider.js 265

Gets the promise that will be resolved when the I3S scene is loaded.

Deprecated: true

readonly resource : Resource
engine/Source/Scene/I3SDataProvider.js 299

The resource used to fetch the I3S dataset.

show : boolean
engine/Source/Scene/I3SDataProvider.js 174

Determines if the dataset will be shown.

traceFetches : boolean
engine/Source/Scene/I3SDataProvider.js 197

Gets or sets debugging and tracing of I3S fetches.

Methods

static Cesium.I3SDataProvider.fromUrl(url, options) → Promise.<I3SDataProvider>
engine/Source/Scene/I3SDataProvider.js 420

Creates an I3SDataProvider. Currently supported I3S versions are 1.6 and 1.7/1.8 (OGC I3S 1.2).
Name Type Description
url string | Resource The url of the I3S dataset, which should return an I3S scene object
options I3SDataProvider.ConstructorOptions An object describing initialization options
Returns:
Examples:
try {
  const i3sData = await I3SDataProvider.fromUrl(
    "https://tiles.arcgis.com/tiles/z2tnIkrLQ2BRzr6P/arcgis/rest/services/Frankfurt2017_vi3s_18/SceneServer/layers/0"
  );
  viewer.scene.primitives.add(i3sData);
} catch (error) {
  console.log(`There was an error creating the I3S Data Provider: ${error}`);
}
try {
  const geoidService = await Cesium.ArcGISTiledElevationTerrainProvider.fromUrl(
    "https://tiles.arcgis.com/tiles/z2tnIkrLQ2BRzr6P/arcgis/rest/services/EGM2008/ImageServer"
  );
  const i3sData = await I3SDataProvider.fromUrl(
    "https://tiles.arcgis.com/tiles/z2tnIkrLQ2BRzr6P/arcgis/rest/services/Frankfurt2017_vi3s_18/SceneServer/layers/0", {
      geoidTiledTerrainProvider: geoidService
  });
  viewer.scene.primitives.add(i3sData);
} catch (error) {
  console.log(`There was an error creating the I3S Data Provider: ${error}`);
}

destroy()
engine/Source/Scene/I3SDataProvider.js 319

Destroys the WebGL resources held by this object. Destroying an object allows for deterministic release of WebGL resources, instead of relying on the garbage collector to destroy this object.

Once an object is destroyed, it should not be used; calling any function other than isDestroyed will result in a DeveloperError exception. Therefore, assign the return value (undefined) to the object as done in the example.

Throws:
  • DeveloperError : This object was destroyed, i.e., destroy() was called.
See:

isDestroyed() → boolean
engine/Source/Scene/I3SDataProvider.js 340

Returns true if this object was destroyed; otherwise, false.

If this object was destroyed, it should not be used; calling any function other than isDestroyed will result in a DeveloperError exception.

Returns:
true if this object was destroyed; otherwise, false.
See:

Type Definitions

Cesium.I3SDataProvider.ConstructorOptions
engine/Source/Scene/I3SDataProvider.js 65

Initialization options for the I3SDataProvider constructor
Properties:
Name Type Attributes Default Description
url Resource | string <optional>
 The url of the I3S dataset. Deprecated.
name string <optional>
 The name of the I3S dataset.
show boolean <optional>
 true Determines if the dataset will be shown.
geoidTiledTerrainProvider ArcGISTiledElevationTerrainProvider | Promise.<ArcGISTiledElevationTerrainProvider> <optional>
 Tiled elevation provider describing an Earth Gravitational Model. If defined, geometry will be shifted based on the offsets given by this provider. Required to position I3S data sets with gravity-related height at the correct location.
traceFetches boolean <optional>
 false Debug option. When true, log a message whenever an I3S tile is fetched.
cesium3dTilesetOptions Cesium3DTileset.ConstructorOptions <optional>
 Object containing options to pass to an internally created Cesium3DTileset. See Cesium3DTileset for list of valid properties. All options can be used with the exception of url and show which are overridden by values from I3SDataProvider.
Need help? The fastest way to get answers is from the community and team on the Cesium Forum.
packages/engine
packages/widgets