ColorBackground
require(["esri/webscene/background/ColorBackground"], function(ColorBackground) { /* code goes here */ });esri/webscene/background/ColorBackgroundThis 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:
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
}
});
Constructors
- new ColorBackground(properties)
- Parameter:properties Objectoptional
See the properties for a list of all the properties that may be passed into the constructor.
Property Overview
| Name | Type | Summary | Class | |
|---|---|---|---|---|
| Color | The color of the background. more details | more details | ColorBackground | |
| String | The name of the class. more details | more details | Accessor |
Property Details
The color of the background. This can be autocast with a named string, hex string, array of rgb or rgba values, an object with
r,g,b, andaproperties, or a Color object.- Default Value:black
The name of the class. The declared class name is formatted as
esri.folder.className.
Method Overview
| Name | Return Type | Summary | Class | |
|---|---|---|---|---|
| ColorBackground | Creates a deep clone of the object. more details | more details | ColorBackground | |
| * | 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 details | ColorBackground | |
| Object | Converts an instance of this class to its ArcGIS portal JSON representation. more details | more details | ColorBackground |
Method Details
- 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 a product in the ArcGIS platform. The object passed into the input
jsonparameter 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 ObjectA 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() topic in the Guide for more information.
Returns:Type Description Object The ArcGIS portal JSON representation of an instance of this class.