// Create a basic SceneView instance with a basemap and world elevation
var view = new SceneView({
  // An instance of Map or WebScene
  map: new Map({
    basemap: "hybrid"
  }),

  // The id of a DOM element (may also be an actual DOM element)
  container: "viewDiv"
});

// create a SceneView instance (for 3D viewing)
var view = new SceneView({
  map: new Map({
    basemap: "topo"
  }),

  container: "viewDiv"
});


view
   .then(function() {
      // SceneView is now ready for display and can be used. Here we will
      // use goTo to view a particular location at a given zoom level, camera
      // heading and tilt.
      view.goTo({
        center: [-112, 38],
        zoom: 13,
        heading: 30,
        tilt: 60
      })
    })
    .otherwise(function(err) {
      // A rejected view indicates a fatal error making it unable to display,
      // this usually means that WebGL is not available, or too old.
      console.error("SceneView rejected:", err);
    });

// Compatibility with 2D viewing properties, such as center and zoom, allows
// convenient transitioning from the familiar use of the 2D MapView to the
// use of the SceneView for 3D viewing.
var view = new SceneView({
  map: new Map({
    basemap: "satellite"
  }),

  container: "viewDiv",

  // Sets the center point of the view at a specified lon/lat
  center: [-112, 38],

  // Sets the zoom LOD to 13
  zoom: 13
});

// go to a location specified in geographic coordinates,
// from a 45 degree angle.
view.goTo({
  center: [-112, 38],
  heading: 45
});

// go to view all the graphics in view.graphics, while northing the
// the camera and tilting it to 60 degrees
view.goTo({
  target: view.graphics,
  heading: 0,
  tilt: 60
});

// Set the view to show an extent at a -20 degree heading, disabling the
// animated transition
view.goTo({
  target: new Extent(694942, 5596444, 1284090, 6163926, SpatialReference.WebMercator),
  heading: -20
}, {
  animate: false
});

var view = new SceneView({
  map: new Map({
    basemap: "satellite",

    // A ground preset containing a single elevation layer, sourced from
    // https://elevation3d.arcgis.com/arcgis/rest/services/WorldElevation3D/Terrain3D/ImageServer
    ground: "world-elevation"
  },

  container: "viewDiv"
});

// Typical usage
var view = new SceneView({
  // ID of DOM element containing the view
  container: "viewDiv",
  // Map/WebScene object
  map: new Map()
});

Property Overview

Property Details

allLayerViewsCollection

Collection containing a flat list of all the created LayerViews related to the basemap, operational layers, and group layers in this view.

See also:

• LayerView

animationViewAnimation autocast

Represents an ongoing view animation initialized by goTo(). You may watch this property to be notified of animation state changes.

See also:

• goTo()

Example:

view.watch("animation.state", function(state) {
  switch (state) {
    case "running":
      console.log("Animation is running");
      break;
    case "finished":
      console.log("Animation has finished");
      break;
    case "stopped":
      console.log("Animation was stopped by the user");
      break;
  }
});

breakpointsObject

A convenience property used for defining the breakpoints on the height and width of the view. The sizes specified here determine the values of the widthBreakpoint and heightBreakpoint properties depending on the view's size.

Note that if the view's height or width is larger than the value you set in the large property, then the value of widthBreakpoint or heightBreakpoint will be xlarge.

Properties:

xsmall Number Sets the xsmall breakpoint in pixels used by widthBreakpoint and heightBreakpoint. If the view's height or width is smaller than this value, then the value of widthBreakpoint or heightBreakpoint will be xsmall. Default Value: 544

small Number Sets the small breakpoint in pixels used by widthBreakpoint and heightBreakpoint. If the view's height or width is between this value and the value of the xsmall property, then the value of widthBreakpoint or heightBreakpoint will be small. Default Value: 768

medium Number Sets the medium breakpoint in pixels used by widthBreakpoint and heightBreakpoint. If the view's height or width is between this value and the value of the small property, then the value of widthBreakpoint or heightBreakpoint will be medium. Default Value: 992

large Number Sets the large breakpoint in pixels used by widthBreakpoint and heightBreakpoint. If the view's height or width is between this value and the value of the medium property, then the value of widthBreakpoint or heightBreakpoint will be large. Default Value: 1200

cameraCamera autocast

The observation point from which the visible portion (or perspective) of the SceneView is determined. Contains properties including the elevation, tilt, and heading (in degrees) of the current view. Setting the camera immediately changes the current view. For animating the view, see goTo().

When set in the constructor, this property overrides the viewpoint, extent, center, scale, and zoom properties.

The camera property contains an internal reference which may be modified in the future. To persist or modify the camera, create a clone using camera.clone().

Z-values defined in a geographic or metric coordinate system are expressed in meters. However, in local scenes that use a projected coordinate system, vertical units are assumed to be the same as the horizontal units specified by the service.

See also:

• goTo()

Examples:

// Initializes the view at the given (x, y, z) position with a heading of 95 degrees.
// The position of the camera is a Point wich will autocast in the sample
// below. Note that the default Point spatial reference is WGS84 which
// will only work if the SceneView has a Web Mercator or WGS84 spatial
// reference. For other spatial references, create a new position Point
// with an explicit spatial reference.
var view = new SceneView({
  camera: {
    position: [
       -122, // lon
         38, // lat
      50000  // elevation in meters
    ],

    heading: 95
  }
});

// Initializes the view at the given position with a tilt of 65 degrees
var view = new SceneView({
  camera: {
    position: {
      x: -100, // lon
      y: 45,   // lat
      z: 10654 // elevation in meters
    },

    tilt: 65
  }
});

// Clone the camera to modify its properties
var camera = view.camera.clone();

// Set new values for heading and tilt
camera.heading = 180;
camera.tilt = 45;

// Set the new properties on the view's camera
view.camera = camera;

// Set the view's camera to a new position, heading and tilt with the goTo() method
view.goTo({
  target: [-122, 38, 50000],
  heading: 180,
  tilt: 45
});

centerPoint autocast

Represents the view's center point; when setting the center you may pass a Point instance or an array of numbers representing at longitude/latitude pair ([-100.4593, 36.9014]). Setting the center immediately changes the current view. For animating the view, see goTo().

If set in the constructor, this property will be ignored if the viewpoint, camera, or extent properties are also set in the constructor.

The center property contains an internal reference which may be modified in the future. To persist or modify the center, create a clone using center.clone().

Z-values defined in a geographic or metric coordinate system are expressed in meters. However, in local scenes that use a projected coordinate system, vertical units are assumed to be the same as the horizontal units specified by the service.

See also:

• goTo()

Examples:

// Sets the initial center point of the view to long/lat coordinates
var view = new SceneView({
  center: [-112, 38]
});

// Updates the view's center point to a pre-determined Point object
view.center = new Point({
  x: 12804.24,
  y: -1894032.09,
  z: 12000,

  spatialReference: 2027
});

// view.center needs to be set (not modified in place) to have an effect.
// To modify only the center.x, first clone the current center, modify
// the .x property and then set it on the view.
var center = view.center.clone();

// Offset the center 1km to the east
center.x += 1000;

view.center = center;

clippingAreaExtent autocast

Represents an optional clipping area used to define the visible extent of a local scene. If defined, only data (including the basemap) within the area will be displayed.

The clippingArea property only applies to local scenes.

The clippingArea property contains an internal reference which may be modified in the future. To persist or modify the clippingArea, create a clone using clippingArea.clone().

See also:

• viewingMode

• Sample - Create a local scene

Example:

var extent = view.extent.clone();

// Expand the extent in place, reducing it to 50% of its original size
// and set it as the clippingArea
view.clippingArea = extent.expand(0.5);

constraintsAccessor autocast

Specifies constraints for Camera tilt and altitude that may be applied to the SceneView. See the object specification table below for details.

Properties:

altitude Accessor optional Specifies a constraint on the minimum and maximum allowed camera altitude. Specification: min Number optional The minimum allowed camera altitude (in meters). Default: -∞ max Number optional The maximum allowed camera altitude (in meters). Default: EARTH_RADIUS * 4

clipDistance Accessor optional Specifies the near and far webgl clip distances. Specification: near Number optional The near clip distance. far Number optional The far clip distance. mode String optional Specifies the mode of the constraint which is either auto or manual. In auto mode, the near and far clip distance values are automatically determined. In manual mode, the near and far clip distance values are user defined, constant values. Note that the mode automatically changes to manual whenever the near or far property is set. Default: auto

collision Object optional When enabled, prevents the user from navigating below the surface in a local SceneView. Specification: enabled Boolean optional Set to false to permit the user to navigate below the surface in a local SceneView. Default: true

tilt Accessor optional Specifies a constraint on the amount of allowed tilting of the view. Specification: max Number optional Specifies the maximum amount of tilt (in degrees) allowed in the view and may range from 0.5 to 179.5 degrees. mode String optional Specifies the mode of the constraint. There are two possible values: auto or manual. In auto mode, the maximum tilt value is automatically determined based on the altitude of the view camera. In manual mode, the maximum tilt value is a user defined, constant value. Note: The mode automatically changes to manual whenever the max property is set. Default: auto

See also:

• Sample - local scene

containerHTMLDivElement|String

The id or node representing the DOM element containing the view. This is typically set in the view's constructor.

Examples:

// Sets container to the DOM id
var view = new MapView({
  container: "viewDiv"  // ID of the HTML element that holds the view
});

// Sets container to the node
var viewNode = document.getElementById("viewDiv");
var view = new SceneView({
  container: viewNode
});

declaredClassStringreadonly

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

environmentAccessor

Specifies various properties of the environment's visualization in the view. The SceneView will redraw automatically when any property of environment changes.

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

// Set the sun position to reflect the current time
view.environment.lighting.date = Date.now();

// Disable automatic lighting updates by camera tracking
view.environment.lighting.cameraTrackingEnabled = true;

Properties:

lighting Accessor optional Lighting conditions of the scene. Specification: date Date optional The current date and time of the simulated sun. Default Value: new Date("March 15, 2015 12:00:00") directShadowsEnabled Boolean optional Indicates whether to show shadows cast by the sun Default Value: false ambientOcclusionEnabled Boolean optional Indicates whether to show ambient occlusion shading. Default Value: false cameraTrackingEnabled Boolean optional Indicates whether the date and time of the simulated sun is automatically updated to maintain the current time of day while the camera changes. Default Value: true

atmosphereEnabled Boolean optional Indicates whether atmosphere visualization is enabled.

atmosphere Accessor optional Atmosphere conditions of the scene. Specification: quality String optional Indicates the quality of the atmosphere visualization. The quality of the atmosphere may have a significant impact on performance. This setting does not have any effect in local scenes. Known Value Example low high Default Value: low

starsEnabled Boolean optional Indicates whether stars visualization is enabled. Default Value: true

extentExtent autocast

The extent represents the visible portion of a map within the view as an instance of Extent. Setting the extent immediately changes the view without animation. To animate the view, see goTo().

Rather than using extent to change the visible portion of the map in a SceneView, you should use camera since it easily allows you to define the heading, elevation and tilt of the observation point from which the view's perspective is created.

When set in the constructor, this property overrides the center, scale, and zoom properties. This property will be ignored if the viewpoint or camera are also set in the constructor.

The extent property contains an internal reference which may be modified in the future. To persist or modify the extent, create a clone using extent.clone().

Z-values defined in a geographic or metric coordinate system are expressed in meters. However, in local scenes that use a projected coordinate system, vertical units are assumed to be the same as the horizontal units specified by the service.

Default Value: null

See also:

• camera
• goTo()

graphicsCollection

Allows for adding graphics directly to the default graphics in the View.

See also:

• Graphic
• GraphicsLayer

• Get started with graphics

Examples:

// Adds a graphic to the View
view.graphics.add(pointGraphic);

// Removes a graphic from the View
view.graphics.remove(pointGraphic);

heightNumberreadonly

The height of the view in pixels read from the view container element.

The view container needs to have a height greater than 0 to be displayed.

Default Value: 0

heightBreakpointString

A convenience property indicating the general size of the view's height. This value is determined based on where the view's height falls in the ranges defined in the breakpoints property. See the table below for a list of possible values.

Possible Value	Description
xsmall	The height of the view is smaller than the value set in the xsmall breakpoint.
small	The height of the view is between the values set in the xsmall and small breakpoints.
medium	The height of the view is between the values set in the small and medium breakpoints.
large	The height of the view is between the values set in the medium and large breakpoints.
xlarge	The height of the view is larger than the value set in the large breakpoint.

See also:

• Sample: Responsive widgets

Example:

view.watch("heightBreakpoint", function(newVal){
  if (newVal === "xsmall"){
    // clear the view's default UI components if
    // app is used on a mobile device
    view.ui.components = [];
  }
});

highlightOptionsObject

Since: ArcGIS API for JavaScript 4.4

Options for configuring the highlight. Use the highlight method on the appropriate LayerView to highlight a feature.

Properties:

color Color optional The color of the highlight. Default Value: [0, 255, 255]

haloOpacity Number optional The opacity of the highlight halo. This will be multiplied with the opacity specified in color. Default Value: 1

fillOpacity Number optional The opacity of the fill (area within the halo). This will be multiplied with the opacity specified in color. Default Value: 0.25

See also:

• highlight()

• Sample: Highlight SceneLayer

• Sample: Highlight point features

Example:

var view = new SceneView({
  map: map,
  highlightOptions: {
    color: [255, 255, 0, 1],
    haloOpacity: 0.9,
    fillOpacity: 0.2
  }
});

interactingBooleanreadonly

Indication whether the view is being interacted with (for example when panning).

Default Value: false

layerViewsCollection

A collection containing a hierarchical list of all the created LayerViews of the operational layers in the map.

See also:

• LayerView

mapMap

An instance of a Map or WebScene object to display in the view. A view may only consume one map at a time. On the other hand, one Map may be viewed by multiple MapViews and/or SceneViews simultaneously.

This property is typically set in the constructor of the MapView or SceneView. See the class description for examples demonstrating the relationship between the map and the view.

orientationStringreadonly

A convenience property indicating the view's orientation. See the table below for a list of possible values.

Possible Value	Description
landscape	The width of the view is greater than its height.
portrait	The width of the view is equal to or smaller than its height.

paddingObject

Use the padding property to make the center, and extent, etc. work off a subsection of the full view. This is particularly useful when layering UI elements or semi-transparent content on top of portions of the view. See the view padding sample for an example of how this works.

Properties:

left Number optional The left padding (in pixels).

top Number optional The top padding (in pixels).

right Number optional The right padding (in pixels).

bottom Number optional The bottom padding (in pixels).

Default Value: {left: 0, top: 0, right: 0, bottom: 0}

See also:

• Sample - View padding

popupPopup autocast

A Popup object that displays general content or attributes from layers in the map.

The view has a default instance of Popup with predefined styles and a template for defining content. The content in this default instance may be modified directly in the popup's content or in a layer's PopupTemplate.

You may create a new Popup instance and set it to this property to customize the style, positioning, and content of the popup in favor of using the default popup instance on the view.

qualityProfileString

SceneView can draw scenes in two different quality modes: high and low. Using the low quality profile significantly increases performance on slower browsers and devices by reducing the visual quality in the following aspects:

• Map resolution
• Scene layer detail level
• Anti-aliasing (edge smoothing)

The default value is based on the detected browser:

• low for Internet Explorer 11 and Safari
• high for any other browser

Overriding the default value is best done in the constructor (see example below). If the value is modified after construction, only a subset of the quality aspects are affected.

Example:

var view = new SceneView({
  qualityProfile: "high"
});

readyBooleanreadonly

When true, this property indicates whether the view successfully satisfied all dependencies, signaling that the following conditions are met.

• The view has a map. If map is a WebMap or a WebScene, then the map or scene must be loaded.
• The view has a container with a size greater than 0.
• The view has a spatialReference.

When a view becomes ready it will resolve itself and invoke the callback defined in then() where code can execute on a working view. Subsequent changes to a view's readiness would typically be handled by watching view.ready and providing logic for cases where the map or container change.

Default Value: false

See also:

• then()

resizingBooleanreadonly

Indicates if the view is being resized.

Default Value: false

scaleNumber

Represents an approximation of the map scale at the center of the view. Setting the scale immediately changes the current view. For animating the view, see goTo().

When set in the constructor, this property overrides the zoom property. This property will be ignored if the viewpoint, camera, or extent properties are also set in the constructor.

See also:

• goTo()

Example:

// Set the approximate map scale at the center the view to 1:24,000
view.scale = 24000;

sizeNumber[]readonly

An array containing the width and height of the view in pixels, e.g. [width, height].

spatialReferenceSpatialReference autocast

The spatial reference of the view. This indicates the Projected Coordinate System or the Geographic Coordinate System used to locate geographic features in the map. In a SceneView the following supported coordinate systems are available.

The spatial reference can either be set explicitly or automatically derived from the following:

• In the case of a SceneView, if the map is a WebScene instance, the WebScene.initialViewProperties.spatialReference is used.
• In all other cases, the spatial reference is derived from the first layer that loads in this order:
  • map.basemap.baseLayers
  • map.layers
  • map.ground.layers

When using an Esri basemap, the default spatial reference is Web Mercator Auxiliary Sphere.

Default Value: null

stationaryBooleanreadonly

Indication whether the view is animating, being interacted with or resizing.

Default Value: true

suspendedBooleanreadonly

Indicates if the view is visible on the page. Is true if the view has no container, a height or width equal to 0, or the CSS visibility is hidden.

Default Value: true

typeStringreadonly

The type of the view (for SceneView, this value is always 3d).

uiDefaultUI autocast

Exposes the default widgets available in the view and allows you to toggle them on and off. See DefaultUI for more details.

Examples:

var toggle = new BasemapToggle({
  view: view,
  nextBasemap: "hybrid"
});
// Adds an instance of BasemapToggle widget to the
// top right of the view.
view.ui.add(toggle, "top-right");

// Moves the zoom and BasemapToggle widgets to the
// bottom left of the view.
view.ui.move([ "zoom", toggle ], "bottom-left");

// Removes all the widgets from the bottom left of the view
view.ui.empty("bottom-left");

// Removes the compass widget from the view
view.ui.remove("compass");

updatingBooleanreadonly

Indicates whether the view is being updated by additional data requests to the network, or by processing received data.

Default Value: false

viewingModeString

The viewing mode (local or global). Global scenes render the earth as a sphere. Local scenes render the earth on a flat plane and allow for navigation and feature display in a localized or clipped area. Users may also navigate the camera of a local scene below the surface of a basemap.

Value	Example	Description
global		Global scenes allow the entire globe to render in the view, showing the curvature of the earth.
local		Local scenes render the earth on a flat surface. They can be constrained to only show a "local" area by setting the clippingArea property. Local scenes also allow for displaying and exploring data that would otherwise be hidden by the surface of the earth.

Depending on the viewing mode different supported coordinate systems are available.

Default Value: global if the spatial reference of the view is either Web Mercator or WGS84; or local for all other spatial references.

See also:

• clippingArea

• Sample - Create a local scene

viewpointViewpoint autocast

Represents the current view as a Viewpoint or point of observation on the view. In SceneViews, camera should be used in favor of viewpoint for watching or changing the point of view. Setting the viewpoint immediately changes the current view. For animating the view, see goTo().

When set in the constructor, this property overrides the extent, center, scale, and zoom properties. This property will be ignored if camera is also set in the constructor.

The viewpoint property contains an internal reference which may be modified in the future. To persist or modify the viewpoint, create a clone using viewpoint.clone().

See also:

• goTo()

widthNumberreadonly

The width of the view in pixels read from the view container element.

The view container needs to have a width greater than 0 to be displayed.

Default Value: 0

widthBreakpointString

A convenience property indicating the general size of the view's width. This value is determined based on where the view's width falls in the ranges defined in the breakpoints property. See the table below for a list of possible values.

Possible Value	Description
xsmall	The width of the view is smaller than the value set in the xsmall breakpoint.
small	The width of the view is between the values set in the xsmall and small breakpoints.
medium	The width of the view is between the values set in the small and medium breakpoints.
large	The width of the view is between the values set in the medium and large breakpoints.
xlarge	The width of the view is larger than the value set in the large breakpoint.

See also:

• Sample: Responsive widgets

Example:

view.watch("widthBreakpoint", function(newVal){
  if (newVal === "xsmall"){
    // clear the view's default UI components if
    // app is used on a mobile device
    view.ui.components = [];
  }
});

zoomNumber

Represents the level of detail (LOD) at the center of the view. Setting the zoom immediately changes the current view. For animating the view, see goTo().

Setting this property in conjunction with center is a convenient way to set the initial extent of the view.

If set in the constructor, this property will be ignored if the viewpoint, camera, extent, or scale properties are also set in the constructor.

See also:

• goTo()

Examples:

view.zoom = 3;  // Sets the LOD to 3 (small map scale)
view.zoom = 18; // Sets the LOD to 18 (large map scale)

// Set the zoom level and center in the constructor
var view = new SceneView({
  zoom: 10,
  center: [-120, 34],
  map: map
});

Method Overview

Method Details

always(callbackOrErrback){Promise}inherited

An instance of this class is a Promise. Therefore always() may be used to execute a function if the promise is rejected or resolved. The input function will always execute no matter the response. For more information about promises, see the Working with Promises guide page.

Parameter:

callbackOrErrback Function optional The function to execute when the promise is rejected or resolved.

Returns:

Type	Description
Promise	Returns a new promise for the result of callbackOrErrback.

Example:

// Although this example uses MapView, any class instance that is a promise may use always() in the same way
var view = new MapView();
view.always(function(){
  // This function will always execute whether or not the promise is resolved or rejected
});

goTo(target, options){Promise}

Sets the view to a given target. The target parameter can be one of the following:

• [longitude, latitude] pair of coordinates
• Geometry (or array of Geometry[])
• Graphic (or array of Graphic[])
• Viewpoint
• Camera
• Object with a combination of target, center, scale, position, heading and tilt properties (with target being any of the types listed above). The center property is provided as a convenience to animate the SceneView.center and is the equivalent of specifying the target with the center Point.

This function returns a promise which resolves as soon as the new view has been set to the target. If an animation is performed, then the returned promise is a ViewAnimation instance which is owned by the view and can be obtained using SceneView.animation.

If the given target is far away from the current camera position, then heading and tilt will be automatically set to their neutral values (facing north, looking top down). Tilt and heading can always be explicitly set to override this behavior.

Parameters:

target Number[] | Geometry | Geometry[] | Graphic | Graphic[] | Viewpoint | Camera | Object The target location/viewpoint to go to. When using an object for target, use the properties in the table below. Specification: target Number[] | Geometry | Geometry[] | Graphic | Graphic[] | Viewpoint | Camera optional The target of the animation. center Number[] optional The SceneView.center to go to. scale Number optional The SceneView.scale to go to. zoom Number optional The final zoom value to go to. heading Number optional The Camera.heading to go to. tilt Number optional The Camera.tilt to go to. position Number optional The Camera.position to go to.

options Object optional View transition options. Specification: animate Boolean optional Indicates if the transition to the new view should be animated. Default Value: true speedFactor Number optional 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. Default Value: 1 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 The maximum allowed duration (in milliseconds) of the animation. The default maxDuration value takes the specified speedFactor into account. Default Value: 8000 / speedFactor 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	A promise that resolves when the view is set to the target.

Examples:

view.goTo({
  center: [-126, 49],
  heading: 180, // set the heading to point South
  tilt: view.camera.tilt, // maintain tilt value
})

// go to a location defined by a Camera object
var cam = new Camera({
  position: new Point({
    x: -100.23, // lon
    y: 65,      // lat
    z: 10000,   // elevation in meters
  }),

  heading: 180, // facing due south
  tilt: 45      // bird's eye view
});

view.goTo(cam);

// go to a point using center, zoom, tilt, and heading
view.goTo({
  center: [-126, 49],
  zoom: 13,
  tilt: 75,
  heading: 105
});

// goTo returns a Promise which resolves when the animation has finished.
// This promise may be chained to create a sequence of animations.
view.goTo(graphic1)
    .then(function() {
      return view.goTo(graphic2);
    })
    .then(function() {
      return view.goTo(graphic3);
    });

// goTo returns a Promise which resolves when the animation has finished.
// This promise may be chained to create a sequence of animations.
view.goTo(graphic1)
    .then(function() {
      return view.goTo(graphic2);
    })
    .then(function() {
      return view.goTo(graphic3);
    });

hasEventListener(type){Boolean}inherited

Indicates whether there is an event listener on the instance that matches the provided event name.

Parameter:

type String The name of the event.

Returns:

Type	Description
Boolean	Returns true if the class supports the input event.

hitTest(screenPoint){Promise}

Searches for graphics that intersect the specified screen coordinates. Draped graphics (i.e. graphics in layers where the elevation mode is on-the-ground) are currently not returned from this method, even when they intersect the input screen point.

When the ground surface is hit, but no graphic is found, then the result of hitTest will be a single object with its mapPoint set to the point on the surface that was hit, but its graphic will be set to null.

Parameters:

screenPoint Object The screen coordinates of the click on the view. Specification: x Number The horizontal screen coordinate of the click on the view. y Number The vertical screen coordinate of the click on the view.

Returns:

Type	Description
Promise	When resolved, returns an object with two properties: screenPoint, which is the input ScreenPoint, and results, which is an array of objects with the specification below. Property Type Description mapPoint Point The location of the input screen point in map coordinates. graphic Graphic The graphic object (if any) that intersects the map point.

See also:

• Sample: Access features with click events

Example:

// Get the screen point from the view's click event
view.on("click", function(event) {
 var screenPoint = {
  x: event.x,
  y: event.y
 };
  // Search for graphics at the clicked location
  view.hitTest(screenPoint).then(function(response) {
    var result = response.results[0];

    if (result) {
      var lon = result.mapPoint.longitude;
      var lat = result.mapPoint.latitude;

      console.log("Hit surface at (" + lon + ", " + lat + "), graphic:", result.graphic || "none");
    }
  });
});

isFulfilled(){Boolean}inherited

An instance of this class is a Promise. Therefore isFulfilled() may be used to verify if the promise is fulfilled (either resolved or rejected). If it is fulfilled, true will be returned. See the Working with Promises guide page for more information about promises.

Returns:

Type	Description
Boolean	Indicates whether the promise has been fulfilled (either resolved or rejected).

isRejected(){Boolean}inherited

An instance of this class is a Promise. Therefore isRejected() may be used to verify if the promise is rejected. If it is rejected, true will be returned. See the Working with Promises guide page for more information about promises.

Returns:

Type	Description
Boolean	Indicates whether the promise has been rejected.

isResolved(){Boolean}inherited

An instance of this class is a Promise. Therefore isResolved() may be used to verify if the promise is resolved. If it is resolved, true will be returned. See the Working with Promises guide page for more information about promises.

Returns:

Type	Description
Boolean	Indicates whether the promise has been resolved.

on(type, modifiersOrHandler, handler?){Object}inherited

Registers an event handler on the instance. Call this method to hook an event with a listener. See the Events summary table for a list of listened events.

Parameters:

type String | String[] The name of the event or the events to listen for.

modifiersOrHandler String[] | Function Additional modifier keys to filter the events by. Alternatively, if no modifiers are required, the function to call when the event is fired.

handler? Function The function to call when the event is fired, if modifiers were specified.

Returns:

Type	Description
Object	Returns an event handler with a remove() method that can be called to stop listening for the event. Property Type Description remove Function When called, removes the listener from the event.

See also:

• dojo/on

Example:

view.on("click", function(event){
  // event is the event handle returned after the event fires.
  console.log(event.mapPoint);
});

// Fires `pointer-move` event when user clicks on "Shift"
// key and moves the pointer on the view.
view.on('pointer-move', ["Shift"], function(evt){
  var point = view2d.toMap({x: evt.x, y: evt.y});
  bufferPoint(point);
});

otherwise(errback){Promise}inherited

An instance of this class is a Promise. Use otherwise() to call a function once the promise is rejected.

Parameter:

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

Returns:

Type	Description
Promise	Returns a new promise for the result of errback.

Example:

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

then(callback, errback, progback){Promise}inherited

An instance of this class is a Promise. Therefore then() 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 promise resolves (when the instance of the class loads). The errback executes if the promise fails. See the Working with Promises guide page for additional details.

Parameters:

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

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

progback Function optional The function to invoke when the promise emits a progress update.

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.then(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
});

toMap(screenPoint, mapPoint){Point}

Converts the given screen point to a map point.

Parameters:

screenPoint Object The screen coordinates to convert. Specification: x Number The horizontal screen coordinate to convert. y Number The vertical screen coordinate to convert.

mapPoint Point optional The point object that will reference the result.

Returns:

Type	Description
Point	The map point corresponding to the given screen point.

toScreen(point, screenPoint){ScreenPoint}

Converts the given map point to a screen point.

Parameters:

point Point A point geometry.

screenPoint ScreenPoint optional ScreenPoint object that will reference the result.

Returns:

Type	Description
ScreenPoint	The screen point corresponding to the given map point.

whenLayerView(layer){Promise}inherited

Gets the LayerView created on the view for the given layer. The returned promise resolves when the layer view for the given layer has been created, or rejects with an error (for example if the layer is not part of the view, or if the layer type is not supported in this view).

Parameter:

layer Layer The layer for which to obtain its LayerView.

Returns:

Type	Description
Promise	Resolves to an instance of LayerView for the specified layer.

See also:

• Sample - StreamLayer

Example:

// Create a feature layer from a url pointing to a Feature Service
var layer = new FeatureLayer(url);

map.add(layer);

view.whenLayerView(layer)
    .then(function(layerView) {
      // The layerview for the layer
    })
    .otherwise(function(error) {
      // An error occurred during the layerview creation
    });

Type Definitions

EasingFunction(t, duration){Number}

User provided easing function. The function receives a normalized time between 0 and 1 as input and should provide a transformed normalized time between 0 and 1 as output.

Parameters:

t Number The input time (from 0 to 1)

duration Number The total duration (in milliseconds) of the animation. This may be used for heuristics on deciding what type of easing to perform.

Returns:

Type	Description
Number	a value between 0 and 1

Example:

// Simple quadratic ease in function
function easeIn(t) {
  return t * t;
}

Event Overview

{mapPoint: Point,x: Number,y: Number,button: Number,type: String,stopPropagation: Function,timestamp: Number,native: Object}

{mapPoint: Point,x: Number,y: Number,button: Number,type: String,stopPropagation: Function,timestamp: Number,native: Object}

{action: String,x: Number,y: Number,origin: Object,type: String,stopPropagation: Function,timestamp: Number,native: Object}

{mapPoint: Point,x: Number,y: Number,button: Number,type: String,stopPropagation: Function,timestamp: Number,native: Object}

{repeat: Boolean,key: String,type: String,stopPropagation: Function,timestamp: Number,native: Object}

{type: String,stopPropagation: Function,timestamp: Number,native: Object}

{layer: Layer,layerView: LayerView}

{layer: Layer,layerView: LayerView}

{x: Number,y: Number,deltaY: Number,type: String,stopPropagation: Function,timestamp: Number,native: Object}

{pointerId: Number,pointerType: String,x: Number,y: Number,type: String,stopPropagation: Function,timestamp: Number,native: Object}

{pointerId: Number,pointerType: String,x: Number,y: Number,type: String,stopPropagation: Function,timestamp: Number,native: Object}

{pointerId: Number,pointerType: String,x: Number,y: Number,type: String,stopPropagation: Function,timestamp: Number,native: Object}

{oldWidth: Number,oldHeight: Number,width: Number,height: Number}

Event Details

clickinherited

Fires after a user clicks on the view. This event emits slightly slower than a key-down event to make sure that a double-click event isn't triggered instead.

Properties:

mapPoint Point The point location of the click on the view in the spatial reference of the map.

x Number The horizontal screen coordinate of the click on the view.

y Number The vertical screen coordinate of the click on the view.

button Number Indicates which mouse button was clicked. Value Description 0 left click (or touch) 1 middle click 2 right click

type String For click the type is always click.

stopPropagation Function Prevents event propagation bubbling up the event chain. By default the click event will close the view's popup if the clicked location doesn't intersect a feature containing a PopupTemplate. If calling view.popup.open() to display custom content in the popup, you should call event.stopPropagation() on the click event object to disable this default behavior. This ensures the popup will remain open or open with new custom content when the user clicks other locations in the view.

timestamp Number Time stamp (in milliseconds) at which the event was emitted.

native Object A standard DOM PointerEvent.

See also:

• Sample: Access features with click events

Examples:

// Set up a click event handler and retrieve the screen point
view.on("click", function(event) {
 // the hitTest() checks to see if any graphics in the view
 // intersect the given screen x, y coordinates
 view.hitTest(event)
  .then(getGraphics);
});

view.on("click", function(event) {
 // you must overwrite default click-for-popup
 // behavior to display your own popup
 event.stopPropagation();

 // Get the coordinates of the click on the view
 var lat = Math.round(event.mapPoint.latitude * 1000) / 1000;
 var lon = Math.round(event.mapPoint.longitude * 1000) / 1000;

 view.popup.open({
   // Set the popup's title to the coordinates of the location
   title: "Reverse geocode: [" + lon + ", " + lat + "]",
   location: event.mapPoint // Set the location of the popup to the clicked location
   content: "This is a point of interest"  // content displayed in the popup
 });
});

double-clickinherited

Fires after double-clicking on the view.

Properties:

mapPoint Point The point location of the click on the view in the spatial reference of the map.

x Number The horizontal screen coordinate of the click on the view.

y Number The vertical screen coordinate of the click on the view.

button Number Indicates which mouse button was clicked. Value Description 0 left click (or touch) 1 middle click 2 right click

type String For double-click the type is always double-click.

stopPropagation Function Prevents event propagation bubbling up the event chain.

timestamp Number Time stamp (in milliseconds) at which the event was emitted.

native Object A standard DOM PointerEvent.

Example:

view.on("double-click", function(event) {
  // The event object contains the mapPoint and the screen coordinates of the location
  // that was clicked.
  console.log("screen point", event.x, event.y);
  console.log("map point", event.mapPoint);
});

draginherited

Fires during a pointer drag on the view.

Properties:

action String Indicates the state of the drag. Known Values: start | update | end

x Number The horizontal screen coordinate of the pointer on the view.

y Number The vertical screen coordinate of the pointer on the view.

origin Object Screen coordinates of the start of the drag. Specification: x Number The horizontal screen coordinate of the pointer on the view. y Number The vertical screen coordinate of the pointer on the view.

type String For drag the type is always drag.

stopPropagation Function Prevents event propagation bubbling up the event chain.

timestamp Number Time stamp (in milliseconds) at which the event was emitted.

native Object A standard DOM MouseEvent.

Example:

view.on("drag", function(evt){
 // Print out the current state of the
 // drag event.
 console.log("drag state", evt.action);
});

holdinherited

Fires after holding either a mouse button or a single finger on the view for a short amount of time.

Properties:

mapPoint Point The point location of the click on the view in the spatial reference of the map.

x Number The horizontal screen coordinate of the hold on the view.

y Number The vertical screen coordinate of the hold on the view.

button Number Indicates which mouse button was held down. Value Description 0 left mouse button (or touch) 1 middle mouse button 2 right mouse button

type String For hold the type is always hold.

stopPropagation Function Prevents event propagation bubbling up the event chain.

timestamp Number Time stamp (in milliseconds) at which the event was emitted.

native Object A standard DOM PointerEvent.

Example:

view.on("hold", function(event) {
  // The event object contains the mapPoint and the screen coordinates of the location
  // that was clicked.
  console.log("hold at screen point", event.x, event.y);
  console.log("hold at map point", event.mapPoint);
});

key-downinherited

Fires after a keyboard key is pressed.

Properties:

repeat Boolean Indicates whether this is the first event emitted due to the key press, or a repeat.

key String The key value that was pressed, according to the MDN full list of key values.

type String For key-down the type is always key-down.

stopPropagation Function Prevents event propagation bubbling up the event chain.

timestamp Number Time stamp (in milliseconds) at which the event was emitted.

native Object A standard DOM KeyboardEvent.

Example:

// Zoom in when user clicks on "a" button
// Zoom out when user clicks on "s" button
view.on("key-down", function(evt){
 console.log("key-down", evt);

 if (evt.key === "a"){
   var zm = view.zoom + 1;

   view.goTo({
     target: view.center,
     zoom: zm
   });
 }
 else if(evt.key == "s"){
   var zm = view.zoom - 1;

   view.goTo({
     target: view.center,
     zoom: zm
   });
 }
});

key-upinherited

Fires after a keyboard key is released.

Properties:

type String For key-up the type is always key-up.

stopPropagation Function Prevents event propagation bubbling up the event chain.

timestamp Number Time stamp (in milliseconds) at which the event was emitted.

native Object A standard DOM KeyboardEvent.

layerview-createinherited

Fires after each layer in the map has a corresponding LayerView created and rendered in the view.

Properties:

layer Layer The layer in the map for which the layerView was created.

layerView LayerView The LayerView rendered in the view representing the layer in layer.

See also:

• View.whenLayerView()

Example:

// This function fires each time a layer view is created for a layer in
// the map of the view.
view.on("layerview-create", function(event) {
  // The event contains the layer and its layer view that has just been
  // created. Here we check for the creation of a layer view for a layer with
  // a specific id, and log the layer view
  if (event.layer.id === "satellite") {
    // The LayerView for the desired layer
    console.log(event.layerView);
  }
});

layerview-destroyinherited

Fires after a LayerView is destroyed and is no longer rendered in the view. This happens for example when a layer is removed from the map of the view.

Properties:

layer Layer The layer in the map for which the layerView was destroyed.

layerView LayerView The LayerView that was destroyed in the view.

mouse-wheelinherited

Fires when a wheel button of a pointing device (typically a mouse) is scrolled on the view.

Properties:

x Number The horizontal screen coordinate of the click on the view.

y Number The vertical screen coordinate of the click on the view.

deltaY Number Number representing the vertical scroll amount.

type String For mouse-wheel the type is always mouse-wheel.

stopPropagation Function Prevents event propagation bubbling up the event chain.

timestamp Number Time stamp (in milliseconds) at which the event was emitted.

native Object A standard DOM WheelEvent.

Example:

view.on("mouse-wheel", function(evt){
 // deltaY value is postive when wheel is scrolled up
 // and it is negative when wheel is scrolled down.
 console.log(evt.deltaY);
});

pointer-downinherited

Fires after a mouse button is pressed, or a finger touches the display.

Properties:

pointerId Number Uniquely identifies a pointer between multiple down, move, and up events. Ids might get reused after a pointer-up event.

pointerType String Indicates the pointer type. Known Values: mouse | touch

x Number The horizontal screen coordinate of the pointer on the view.

y Number The vertical screen coordinate of the pointer on the view.

type String For pointer-down the type is always pointer-down.

stopPropagation Function Prevents event propagation bubbling up the event chain.

timestamp Number Time stamp (in milliseconds) at which the event was emitted.

native Object A standard DOM PointerEvent.

pointer-moveinherited

Fires after the mouse or a finger on the display moves.

Properties:

pointerId Number Uniquely identifies a pointer between multiple down, move, and up events. Ids might get reused after a pointer-up event.

pointerType String Indicates the pointer type. Known Values: mouse | touch

x Number The horizontal screen coordinate of the pointer on the view.

y Number The vertical screen coordinate of the pointer on the view.

type String Type of the event. It is always "pointer-move" for this event.

stopPropagation Function Prevents further propagation of the current event bubbling up the event chain.

timestamp Number Time stamp (in milliseconds) at which the event was created.

native Object A standard DOM PointerEvent.

Example:

// Fires `pointer-move` event when user clicks on "Shift"
// key and moves the pointer on the view.
view.on('pointer-move', ["Shift"], function(evt){
  var point = view2d.toMap({x: evt.x, y: evt.y});
  bufferPoint(point);
});

pointer-upinherited

Fires after a mouse button is released, or a display touch ends.

Properties:

pointerId Number Uniquely identifies a pointer between multiple down, move, and up events. Ids might get reused after a pointer-up event.

pointerType String Indicates the pointer type. Known Values: mouse | touch

x Number The horizontal screen coordinate of the pointer on the view.

y Number The vertical screen coordinate of the pointer on the view.

type String Type of the event. It is always "pointer-up" for this event.

stopPropagation Function Prevents further propagation of the current event bubbling up the event chain.

timestamp Number Time stamp (in milliseconds) at which the event was created.

native Object A standard DOM PointerEvent.

resizeinherited

Fires when the view's size changes.

Properties:

oldWidth Number The previous view width in pixels

oldHeight Number The previous view height in pixels

width Number The new measured view width in pixels

height Number The new measured view height in pixels

See also:

• size
• height
• width