Background

require(["esri/webscene/background/Background"], function(Background) { /* code goes here */ });
Class: esri/webscene/background/Background
Inheritance: Background Accessor
Subclasses: ColorBackground
Since: ArcGIS API for JavaScript 4.8

The background of a SceneView that lies behind the sky, atmosphere and stars.

Background is a base class. Use ColorBackground subclass for setting a color as the background of a SceneView.

See also:

Constructors

new Background(properties)
Parameter:
properties Object
optional

See the properties for a list of all the properties that may be passed into the constructor.

Property Overview

Any properties can be set, retrieved or listened to. See the Working with Properties topic.
Show inherited properties Hide inherited properties
Name Type Summary Class
String

The name of the class.

more details
more detailsAccessor

Property Details

declaredClass Stringreadonly inherited

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

Method Overview

Name Return Type Summary Class
Background

Creates a deep clone of the Background.

more details
more detailsBackground
*

Creates a new instance of this class and initializes it with values from a JSON object generated from an ArcGIS product.

more details
more detailsBackground
Object

Converts an instance of this class to its ArcGIS portal JSON representation.

more details
more detailsBackground

Method Details

clone(){Background}

Creates a deep clone of the Background.

Returns:
Type Description
Background A deep clone of the object that invoked this method.
fromJSON(json){*}static

Creates a new instance of this class and initializes it with values from a JSON object generated from an ArcGIS product. 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. 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 ArcGIS REST API documentation for examples of the structure of various input JSON objects.

Returns:
Type Description
* Returns a new instance of this class.
toJSON(){Object}

Converts an instance of this class to its ArcGIS portal JSON representation. See the Using fromJSON() guide topic for more information.

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