var scene = new WebScene({
  // autocasts as esri/portal/PortalItem
  portalItem: {
    id: "affa021c51944b5694132b2d61fe1057"  // ID of the WebScene on arcgis.com
  }
});

esriConfig.portalUrl = "https://myHostName.esri.com/arcgis";

var scene = new WebScene({
  // autocasts as esri/portal/PortalItem
  portalItem: {
    id: "0614ea1f9dd043e9ba157b9c20d3c538"  // ID of the WebScene on the on-premise portal
  }
});

var view = new SceneView({
  map: scene,  // The WebScene instance created above
  container: "viewDiv"
});

scene.when(function() {
  // All layers and the basemap have been created
});
view.when(function() {
  // All layer and basemap resources have been loaded and are ready to be displayed
});

var portal = new Portal({
  url: "http://myportal.arcgis.com/", // the url of the portal
  authMode: "immediate" // user authenticates by signing in when the Portal is loaded
});
// once the portal is loaded save the web scene to the portal as a new web scene
portal.load().then(function() {
  webscene.saveAs({
    title: "My Scene",
    portal: portal
  })
  .then(function() {
    console.log("Scene was saved");
  })
  .catch(function(err) {
    console.log(err);
  });
})

Property Overview

Property Details

allLayersCollection<Layer>readonly inherited

A flat collection of all the layers in the map. This collection contains basemap layers, operational layers and ground layers. Group Layers and their children layers are also part of this collection. Reference layers in the basemap will always be included at the end of the collection.

Layers should not be added directly to this collection. They must only be added via the layers, basemap or ground properties.

Example:

// Find a layer with title "US Counties"
var foundLayer = map.allLayers.find(function(layer) {
 return layer.title === "US Counties";
});

// Create a filtered collection of the non-group layers
var nonGroupLayers = map.allLayers.filter(function(layer) {
 return !foundLayer.layers;
});

// Listen for any layer being added or removed in the Map
map.allLayers.on("change", function(event) {
 console.log("Layer added: ", event.added);
 console.log("Layer removed: ", event.removed);
 console.log("Layer moved: ", event.moved);
});

applicationPropertiesApplicationProperties

Since: ArcGIS API for JavaScript 4.7

Configuration of application and UI elements.

basemapBasemapautocast inherited

Autocasts from String|Object

Specifies a basemap for the map. The basemap is a set of tile layers that give geographic context to the MapView or SceneView and the other operational layers in the map.

This value can be an instance of Basemap or one of the strings listed in the table below.

Value	Description
streets
satellite
hybrid
topo
gray
dark-gray
oceans
national-geographic
terrain
osm
dark-gray-vector
gray-vector
streets-vector
topo-vector
streets-night-vector
streets-relief-vector
streets-navigation-vector

Example:

// Set the basemap in the constructor
var map = new Map({
  basemap: "streets"
});

// Set the basemap after the map instance is created
map.basemap = "topo";

clippingAreaExtentautocast

This property only applies to local scenes. Represents an optional clipping area used to define the bounds or Extent of a local scene. If defined, only data (including the basemap) within the area will be displayed.

Set the clippingEnabled property to true to apply the specified clippingArea to the view.

See also:

• clippingEnabled

clippingEnabledBoolean

This property only applies to local scenes. Determines whether clipping using the clippingArea is enabled.

Default Value:false

See also:

• clippingArea

declaredClassStringreadonly inherited

Since: ArcGIS API for JavaScript 4.7

The name of the class. The declared class name is formatted as esri.folder.className.

groundGroundautocast inherited

Autocasts from String|Object

Specifies the surface properties for the map. This property is only relevant when adding the map to a 3D SceneView. It renders the terrain or topographical variations in the real world on the map's surface with a collection of ElevationLayer.

This value can be an instance of Ground, or one of the following strings:

• world-elevation for a default instance of ground using the Terrain3D Service.
• world-topobathymetry for an instance of ground that combines surface elevation and bathymetry using the TopoBathy3D Service.

The ground may not be set to null or undefined, it is guaranteed to always contain an instance of type Ground. The elevation can be removed from the ground by setting the ground property to a new empty Ground instance or by removing all the ground layers.

See also:

• ElevationLayer
• Ground

Examples:

// Use the world elevation service
var map = new Map({
  basemap: "topo",
  ground: "world-elevation"
});

// Create a map with the world elevation layer overlaid by a custom elevation layer
var worldElevation = ElevationLayer({
  url: "//elevation3d.arcgis.com/arcgis/rest/services/WorldElevation3D/Terrain3D/ImageServer"
});
var customElevation = ElevationLayer({
  url: "https://my.server.com/arcgis/rest/service/MyElevationService/ImageServer"
});
var map = new Map({
  basemap: "topo",
  ground: new Ground({
   layers: [ worldElevation, customElevation ]
  })
});

heightModelInfoHeightModelInfoautocast

Since: ArcGIS API for JavaScript 4.5

The height model info of the WebScene. This object defines the characteristics of the vertical coordinate system used by the scene. In a SceneView, the height model info is used to avoid combining layers that have incompatible vertical coordinate systems.

initialViewPropertiesInitialViewPropertiesautocast

The initial view of the WebScene. This object contains properties such as viewpoint, spatialReference, viewingMode, and environment that should be applied to the SceneView when the scene loads.

layersCollection<Layer>autocast inherited

Autocasts from Layer[]

A collection of operational layers. This property only contains interactive operational layers, such as FeatureLayers, WebTileLayers and GraphicsLayers that may be queried, assigned different renderers, analyzed, etc. It does not include basemaps.

A layer is a collection of one or more features, or graphics, that represent real-world phenomena. Each feature contains a symbol and geographic data that allows it to be rendered on the map as a graphic with spatial context. Features within the layer may also contain data attributes that provide additional information that may be viewed in popup windows and used for rendering the layer.

Layers may be added in the constructor, with the add() or addMany() methods, or directly to the layers collection using add() or addMany().

A layer may only be added to one parent. Adding the same layer to multiple Maps or GroupLayers is not possible. If you attempt to do so, the layer will automatically be removed from its current parent and placed in the new parent.

var layer = new GraphicsLayer();
// The layer belongs to map1
map1.layers.add(layer);
// The layer now belongs to map2
// and implicitly does: map1.layers.remove(layer)
map2.layers.add(layer);

Example:

// Add layers in the constructor of Map using an array
var fl = new FeatureLayer(url);
var gl = new GraphicsLayer();
var map = new Map({
  layers: [fl, gl]
});

// Add layers using add()
map.addMany([fl, gl]);

// Add layers using layers collection
map.layers.addMany([fl, gl]);

loadedBooleanreadonly

Indicates whether the instance has loaded. When true, the properties of the object can be accessed. A WebScene is considered loaded when its layers and basemap are fully created, but not yet loaded.

Default Value:false

loadErrorErrorreadonly

The Error object returned if an error occurred while loading.

Default Value:null

loadStatusStringreadonly

Represents the status of a load operation.

Value	Description
not-loaded	The object's resources have not loaded.
loading	The object's resources are currently loading.
loaded	The object's resources have loaded without errors.
failed	The object's resources failed to load. See loadError for more details.

Default Value:not-loaded

portalItemPortalItemautocast

The portal item from which the WebScene is loaded.

presentationPresentationautocast

Provides a Collection of slides that act as bookmarks for saving predefined viewpoints and visible layers.

See also:

• Slide

• Sample - WebScene slides

sourceVersionObjectreadonly

Since: ArcGIS API for JavaScript 4.1

The version of the source document from which the WebScene was read. The WebScene must be version 1.x to load into an app.

Properties:

major Number The major version of the WebScene.

minor Number The minor version of the WebScene.

thumbnailUrlString

Since: ArcGIS API for JavaScript 4.9

The URL to the thumbnail used for the web scene. The thumbnail will by default be the thumbnail URL from the portal item associated to the web scene. The thumbnail of the web scene may be updated by changing the thumbnail URL and saving the web scene. Use #updateFrom to update the thumbnail automatically from a specified view.

Example:

scene.updateFrom(view)
  .then(function() {
    return scene.save();
  })
  .then(function(portalItem) {
    console.log("Saved to portal", portalItem.id);
  })
  .catch(function(error) {
    console.error("Error saving to portal", error);
  });

Method Overview

Method Details

add(layer, index)inherited

Adds a layer to the layers collection.

Parameters:

layer Layer|Promise<Layer> Layer or a Promise<Layer> to be added to the layers collection.

index Number optional A layer can be added at a specified index in the layers collection. If no index is specified or the index specified is greater than the current number of layers, the layer is automatically appended to the list of layers in the layers collection and the index is normalized.

addMany(layers, index)inherited

Adds a layer or an array of layers to the layers collection.

Parameters:

layers Layer[] Layer(s) to be added to the layers collection.

index Number optional A layer can be added at a specified index in the layers collection. If no index is specified or the index specified is greater than the current number of layers, the layer is automatically appended to the list of layers in the layers collection and the index is normalized.

findLayerById(layerId){Layer}inherited

Returns a layer based on the given layer id.

Parameter:

layerId String The ID assigned to the layer.

Returns:

Type	Description
Layer	Returns the requested layer object.

fromJSON(json){*}static

Creates a new instance of this class and initializes it with values from a JSON object generated from a product in the ArcGIS platform. The object passed into the input json parameter often comes from a response to a query operation in the REST API or a toJSON() method from another ArcGIS product. If the WebScene is used outside of a view, you must call load() explicitly to interact with its resources. See the Using fromJSON() topic in the Guide for details and examples of when and how to use this function.

Parameter:

json Object A JSON representation of the instance in the ArcGIS format. See the web scene specification for more detailed information on serializing web scenes to JSON.

Returns:

Type	Description
*	Returns a new instance of this class.

Example:

// Retrieve a WebScene JSON by url and deserialize it into a WebScene API instance
require(["esri/request", "esri/WebScene"], function(esriRequest, WebScene) {
  esriRequest("http://domain/url/to/webscene.json").then(function(json) {
    var scene = WebScene.fromJSON(json);

    var view = new SceneView({
      map: scene,
      container: "viewDiv"
    });
  });
});

isFulfilled(){Boolean}

isFulfilled() may be used to verify if creating an instance of the class is fulfilled (either resolved or rejected). If it is fulfilled, true will be returned.

Returns:

Type	Description
Boolean	Indicates whether creating an instance of the class has been fulfilled (either resolved or rejected).

isRejected(){Boolean}

isRejected() may be used to verify if creating an instance of the class is rejected. If it is rejected, true will be returned.

Returns:

Type	Description
Boolean	Indicates whether creating an instance of the class has been rejected.

isResolved(){Boolean}

isResolved() may be used to verify if creating an instance of the class is resolved. If it is resolved, true will be returned.

Returns:

Type	Description
Boolean	Indicates whether creating an instance of the class has been resolved.

load(){Promise}

Triggers the loading of the WebScene instance.

A WebScene is considered loaded when its operational layers, basemap and ground are fully created. When created with a portalItem, load() will first fetch its data to create the content, otherwise it resolves immediately.

The SceneView automatically calls the load() method when a WebScene instance is added to its map property so it can display in the view and load each individual layer. If the WebScene is used outside of a view, for example to preload it, you must call load() explicitly to interact with its resources.

Returns:

Type	Description
Promise	Resolves when the WebScene is loaded.

See also:

• portalItem

Example:

// programmatically load all the layers
require([
  "esri/WebScene",

  "dojo/promise/all"
], function(
  WebScene,
  all
) {

  var scene = new WebScene({
    portalItem: {
      id: "affa021c51944b5694132b2d61fe1057"
    }
  });

  scene.load()
    .then(function() {
      // load the basemap to get its layers created
      return scene.basemap.load();
    })
    .then(function() {
      // grab all the layers and load them
      var allLayers = scene.allLayers;
      var promises = allLayers.map(function(layer) {
        return layer.load();
      });
      return all(promises.toArray());
    })
    .then(function(layers) {
      // each layer load promise resolves with the layer
      console.log("all " + layers.length + " layers loaded");
    })
    .catch(function(error) {
      console.error(error);
    });
});

loadAll(){Promise<WebScene>}

Since: ArcGIS API for JavaScript 4.9

Loads all the externally loadable resources associated with the webscene. For the webscene this will load the ground, basemap, layers and slide basemaps.

Returns:

Type	Description
Promise<WebScene>	Resolves when all the loadable resources have been loaded.

See also:

• load

remove(layer){Layer}inherited

Removes the specified layer from the layers collection.

Parameter:

layer Layer Layer to remove from the layers collection.

Returns:

Type	Description
Layer	Returns the layer removed from the layers collection.

removeAll(){Layer[]}inherited

Removes all layers.

Returns:

Type	Description
Layer[]	Returns the layers removed from the layers collection.

removeMany(layers){Layer[]}inherited

Removes the specified layers.

Parameter:

layers Layer[] Array of layers to remove from the layers collection.

Returns:

Type	Description
Layer[]	Returns the layers removed from the layers collection.

reorder(layer, index){Layer}inherited

Changes the layer order. The first layer added is always the base layer, even if its order is changed.

Parameters:

layer Layer The layer to be moved.

index Number The index location for placing the layer. The bottom-most layer has an index of 0.

Returns:

Type	Description
Layer	Returns the layer that was moved.

save(options){Promise<PortalItem>}

Since: ArcGIS API for JavaScript 4.1

Saves the webscene to its associated portal item. The portal item to save to must already exist and be valid. This is a convenience method that will use PortalItem to store the webscene in the item. The web scene is saved according to web scene specification standards.

Use updateFrom to store the current view properties in the webscene before saving it.

Note that this saves the webscene to its existing item. Depending on how the scene is shared, users that do not own the scene may modify it. To save an existing scene as a new item owned by the user signed into the portal instance, use saveAs().

The webscene will be automatically loaded if it is not already before saving.

Parameters:

options Object optional Additional options. Specification: ignoreUnsupported Boolean optional When true, the scene will save even if it contains unsupported content (layers, renderers, symbols). Any content that is not supported will not be saved and the scene may appear different when reloaded from its portal item.

Returns:

Type	Description
Promise<PortalItem>	A promise that resolves with the PortalItem instance when the item has successfully been saved, or rejects otherwise.

See also:

• updateFrom

• Sample - Save a WebScene

saveAs(portalItem, options){Promise<PortalItem>}

Since: ArcGIS API for JavaScript 4.1

Saves the webscene to a new portal item. If saving has completed successfully, then the saved portal item will be set in the portalItem property of the WebScene. This is a convenience method that will create a new PortalItem and use PortalUser.addItem() to store the webscene in a Portal.

Use updateFrom to store the current view properties in the webscene before saving it.

Note that this always saves the webscene as a new portal item owned by the user performing the edits and executing the saveAs() method. If you want to modify the existing item without changing its ownership use save().

The webscene will be automatically loaded if it is not already before saving.

Parameters:

portalItem PortalItem autocast Autocasts from Object The new portal item to which the scene will be saved. Portal item properties such as the title or description need to be explicitly set on the item and will not be automatically copied from the current associated scene portal item (if any).

options Object optional additional save options. Specification: folder PortalFolder optional the folder in which to save the item. ignoreUnsupported Boolean optional allow the scene to be saved even in the case it contains unsupported content (layers, renderers, symbols). Any content that is not supported will not be saved and the scene may appear different when reloaded from its portal item.

Returns:

Type	Description
Promise<PortalItem>	a promise that resolves with the PortalItem instance when the item has successfully been saved, or rejects otherwise.

See also:

• updateFrom

• Sample - Save a WebScene

Example:

var scene = new Webscene();
scene.saveAs({
  // autocasts as new PortalItem()
  title: "New WebScene"
});

toJSON(){Object}

Converts an instance of this class to its ArcGIS portal JSON representation. See the Using fromJSON() topic in the Guide and the web scene specification for more information.

Returns:

Type	Description
Object	The ArcGIS portal JSON representation of an instance of this class.

updateFrom(view, options){Promise}

Update properties of the WebScene related to the view. This should usually be called just before saving a scene. The following properties are updated from the view:

1. initialViewProperties.spatialReference
2. initialViewProperties.viewingMode
3. clippingArea
4. heightModelInfo

Depending on the provided options, the following properties are also updated:

1. initialViewProperties.environment
2. initialViewProperties.viewpoint
3. thumbnail

Parameters:

view SceneView the view to update from.

options Object optional update options. Parameters: environmentExcluded Boolean optional do not update the initial environment from the view, defaults to false. viewpointExcluded Boolean optional do not update the initial viewpoint from the view, defaults to false. thumbnailExcluded Boolean optional do not update the thumbnail from the view, defaults to viewpointExcluded. thumbnailSize Object optional the size of the thumbnail. Defaults to 600x400 (ratio 1.5:1). Note that the thumbnail size may currently not be larger than the size of the view. Specification: width Number the width of the thumbnail. height Number the height of the thumbnail.

Returns:

Type	Description
Promise	Resolves when the update has completed.

See also:

• save

• saveAs

when(callback, errback){Promise}

Since: ArcGIS API for JavaScript 4.6

when() may be leveraged once an instance of the class is created. This method takes two input parameters: a callback function and an errback function. The callback executes when the instance of the class loads. The errback executes if the instance of the class fails to load.

Parameters:

callback Function optional The function to call when the promise resolves.

errback Function optional The function to execute when the promise fails.

Returns:

Type	Description
Promise	Returns a new promise for the result of callback that may be used to chain additional functions.

Example:

// Although this example uses MapView, any class instance that is a promise may use then() in the same way
var view = new MapView();
view.when(function(){
  // This function will execute once the promise is resolved
}, function(error){
  // This function will execute if the promise is rejected due to an error
});