// Create a slide from a view and apply it at a later time
Slide.createFrom(view).then(function(slide) {
  // Add slide to the scene presentation
  scene.presentation.slides.add(slide);
});

// At a later time
var firstSlide = scene.presentation.slides.getItemAt(0);

firstSlide.applyTo(view).then(function() {
  // Slide has been successfully applied to the view
});

Property Overview

Property Details

basemapBasemapautocast

Autocasts from String|Object

The basemap of the scene. Only the base and reference layers of the basemap are stored in a slide.

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

declaredClassStringreadonly inherited

Since: ArcGIS API for JavaScript 4.7

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

descriptionAccessorautocast

The description of the slide.

Property:

text String optional Autocasts from String|Object The description.

environmentEnvironmentautocast

Represents settings that affect the environment in which the WebScene is displayed (such as lighting).

groundAccessorautocast

Ground properties for this slide.

Property:

opacity Number optional Ground opacity

idString

The unique id of a slide within the slides property of a Presentation.

thumbnailAccessorautocast

A data URI encoded thumbnail.

Property:

url String optional Autocasts from String|Object The URI pointing to the thumbnail image representing the slide.

titleAccessorautocast

The title of the slide.

Property:

text String optional Autocasts from String|Object The title.

viewpointViewpointautocast

The viewpoint of the slide. This acts like a bookmark, saving a predefined location or point of view from which to view the scene.

visibleLayersCollection<Accessor>autocast

The visible layers of the scene. This is a collection of objects that stores references (by ID) to the scene layers and ground layers that are set as visible when a slide is applied to a SceneView.

When assigning visible layers, the following types of values will be automatically casted:

• Array (or Collection) of Layer instances: [layerInstance, layerInstance]
• Array (or Collection) of Layer IDs: ["layer-1", "layer-2"]

The specification for each object in the collection is outlined in the table below.

Property:

id String Autocasts from Object[] The ID of a layer in the WebScene or Ground that is made visible in the SceneView when the slide is applied to the view.

Example:

// Update the visible layers to the second layer in the scene, and the
// first elevation layer in the ground.
slide.visibleLayers = [
  { id: scene.layers.getItemAt(1).id }
  { id: scene.ground.layers.getItemAt(0).id }
];

// Equivalent using convenience autocasting
slide.visibleLayers = [scene.layers.getItemAt(0), scene.ground.layers.getItemAt(0)];

Method Overview

Method Details

applyTo(view, options){Promise<Slide>}

Applies a slide's settings to a SceneView.

Parameters:

view SceneView The SceneView the slide should be applied to.

options Object optional Animation options. See properties below for object specifications. Specification: animate Boolean optional Default Value: true Indicates whether to animate the slide transition. speedFactor Number optional Default Value: 1 Increases or decreases the animation speed by the specified factor. A speedFactor of 2 will make the animation twice as fast, while a speedFactor of 0.5 will make the animation half as fast. Setting the speed factor will automatically adapt the default maxDuration accordingly. duration Number optional Set the exact duration (in milliseconds) of the animation. Note that by default, animation duration is calculated based on the time required to reach the target at a constant speed. Setting duration overrides the speedFactor option. Note that the resulting duration is still limited to the maxDuration. maxDuration Number optional Default Value: 8000 The maximum allowed duration (in milliseconds) of the animation. The default maxDuration value takes the specified speedFactor into account. easing String|EasingFunction optional The easing function to use for the animation. This may either be a preset (named) function, or a user specified function. Supported named presets are: linear, in-cubic, out-cubic, in-out-cubic, in-expo, out-expo, in-out-expo By default, animations that are less than 1000 ms use an out easing function; longer animations use an in-out function.

Returns:

Type	Description
Promise<Slide>	When resolved, returns the updated slide.

Examples:

// Applies the slide's settings to the view, but does
// not use animation when updating the viewpoint
slide.applyTo(view, {
  animate: false
});

// Applies the slide's settings to the view, animates with a maximum
// duration of 2 seconds.
slide.applyTo(view, {
  maxDuration: 2000
});

slide.applyTo(view, {
  maxDuration: 2000
}).then(function(){
 //do something after applying the slide's settings to the view
});

clone(){Slide}

Creates a deep clone of this object. Note that the basemap instance is cloned, but the layers within the basemap are copied.

Returns:

Type	Description
Slide	A new Slide instance.

createFrom(view, options){Promise<Slide>}static

Creates a slide from a SceneView, which may be added to the slides in the WebScene's presentation. Updating the slide is asynchronous and a snapshot of the view is only complete once the returned promise has resolved.

Parameters:

view SceneView The SceneView from which the slide should be created.

options Object optional Creation options. See properties below for object specifications. Parameters: screenshot Object optional Screenshot options to use. See properties below for object specifications. Specification: format String optional Default Value: jpeg The image format. quality Number optional Default Value: 80 The image quality (due to compression). width Number optional Default Value: 120 The image width. height Number optional Default Value: 75 The image height.

Returns:

Type	Description
Promise<Slide>	When resolved, returns the created slide.

Examples:

// Creates a slide from the view and
// adds it to the webscene
Slide.createFrom(view).then(function(slide){
  webscene.presentation.slides.add(slide);
});

// Create multiple slides from multiple viewpoints.
view.goTo({ heading: 0 }, { animate: false })
  .then(function() {
    // Create first slide at heading 0 (looking north)
    return Slide.createFrom(view);
  })
  .then(function(slide){
    // Slide has been captured, add to presentation
    webscene.presentation.slides.add(slide);

    // Change viewpoint to look east
    return view.goTo({ heading: 90 }, { animate: false });
  })
  .then(function() {
    // Capture second slide
    return Slide.createFrom(view);
  })
  .then(function(slide) {
    // Add second slide to presentation
    webscene.presentation.slides.add(slide);
  });

updateFrom(view, options){Promise<Slide>}

Updates a slide from a WebScene's slides. Updating the slide is asynchronous and a snapshot of the view is only complete once the returned promise has resolved.

Parameters:

view SceneView The SceneView from which the slide should update.

options Object optional Update options. See properties below for object specifications. Parameters: screenshot Object Screenshot options to use. See properties below for object specifications. Specification: format String optional Default Value: jpeg The image format. quality Number optional Default Value: 80 The image quality (due to compression). width Number optional Default Value: 120 The image width. height Number optional Default Value: 75 The image height.

Returns:

Type	Description
Promise<Slide>	When resolved, returns the updated slide.