ColorBackground

AMD: require(["esri/webscene/background/ColorBackground"], (WebsceneColorBackground) => { /* code goes here */ });
ESM: import WebsceneColorBackground from "@arcgis/core/webscene/background/ColorBackground";
Class: esri/webscene/background/ColorBackground
Inheritance: ColorBackground Background Accessor
Since: ArcGIS API for JavaScript 4.8

This type of Background allows to set a Color as the background of a SceneView. The view environment stars and atmosphere will show on top of the background when enabled. To have a clear background color only, make sure to set both the view.environment.starsEnabled and view.environment.atmosphereEnabled properties to false.

The default for ColorBackground is a fully opaque, black color. The example below shows how to change this:

background-color

const view = new SceneView({
  container: "view",
  map: map,
  environment: {
    background: {
      type: "color",
      color: [255, 252, 244, 1]
    },
    starsEnabled: false,
    atmosphereEnabled: false
  }
});

Set alphaCompositingEnabled to true when you want to make the SceneView background partially or fully transparent and blend with the rest of the webpage.

const view = new SceneView({
  container: "view",
  map: map,
  alphaCompositingEnabled: true,
  environment: {
    background: {
      type: "color",
      color: [255, 252, 244, 0.4]
    },
    starsEnabled: false,
    atmosphereEnabled: false
  }
});
See also

Constructors

new ColorBackground(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
Color

The color of the background.

more details
ColorBackground
String

The name of the class.

more details
Accessor

Property Details

Autocasts from Object|Number[]|String

The color of the background. This can be autocast with an array of rgb(a) values, named string, hex string or an hsl(a) string, an object with r, g, b, and a properties, or a Color object.

Default Value:black
declaredClass Stringreadonly inherited

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

Method Overview

Show inherited methods Hide inherited methods
Name Return Type Summary Class

Adds one or more handles which are to be tied to the lifecycle of the object.

more details
Accessor
ColorBackground

Creates a deep clone of the object.

more details
ColorBackground
*

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

more details
ColorBackground
Boolean

Returns true if a named group of handles exist.

more details
Accessor

Removes a group of handles owned by the object.

more details
Accessor
Object

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

more details
ColorBackground

Method Details

addHandles(handleOrHandles, groupKey)inherited
Since: ArcGIS API for JavaScript 4.25

Adds one or more handles which are to be tied to the lifecycle of the object. The handles will be removed when the object is destroyed.

// Manually manage handles
const handle = reactiveUtils.when(
  () => !view.updating,
  () => {
    wkidSelect.disabled = false;
  },
  { once: true }
);

// Handle gets removed when the object is destroyed.
this.addHandles(handle);
Parameters
handleOrHandles WatchHandle|WatchHandle[]

Handles marked for removal once the object is destroyed.

groupKey *
optional

Key identifying the group to which the handles should be added. All the handles in the group can later be removed with Accessor.removeHandles(). If no key is provided the handles are added to a default group.

clone(){ColorBackground}

Creates a deep clone of the object.

Returns
Type Description
ColorBackground 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.
hasHandles(groupKey){Boolean}inherited
Since: ArcGIS API for JavaScript 4.25

Returns true if a named group of handles exist.

Parameter
groupKey *
optional

A group key.

Returns
Type Description
Boolean Returns true if a named group of handles exist.
Example
// Remove a named group of handles if they exist.
if (obj.hasHandles("watch-view-updates")) {
  obj.removeHandles("watch-view-updates");
}
removeHandles(groupKey)inherited
Since: ArcGIS API for JavaScript 4.25

Removes a group of handles owned by the object.

Parameter
groupKey *
optional

A group key or an array or collection of group keys to remove.

Example
obj.removeHandles(); // removes handles from default group

obj.removeHandles("handle-group");
obj.removeHandles("other-handle-group");
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.

Your browser is no longer supported. Please upgrade your browser for the best experience. See our browser deprecation post for more details.