Skip To ContentArcGIS for DevelopersSign In Dashboard

ColorBackground

require(["esri/webscene/background/ColorBackground"], function(WebsceneColorBackground) { /* code goes here */ });
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.
NameTypeSummaryClass
Color

The color of the background.

more details
more detailsColorBackground
String

The name of the class.

more details
more detailsAccessor

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

NameReturn TypeSummaryClass
ColorBackground

Creates a deep clone of the object.

more details
more detailsColorBackground
*

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

more details
more detailsColorBackground
Object

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

more details
more detailsColorBackground

Method Details

Creates a deep clone of the object.

Returns:
TypeDescription
ColorBackgroundA 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 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. 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:
TypeDescription
*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() topic in the Guide for more information.

Returns:
TypeDescription
ObjectThe ArcGIS portal JSON representation of an instance of this class.

API Reference search results

NameTypeModule
Loading...