ColorBackground | References | ArcGIS Maps SDK for JavaScript

import ColorBackground from "@arcgis/core/webscene/background/ColorBackground.js";

const ColorBackground = await $arcgis.import("@arcgis/core/webscene/background/ColorBackground.js");

Inheritance: ColorBackground→Background→Accessor

Since: ArcGIS Maps SDK 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 SceneView.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

Constructor

Parameters

Parameter	Type	Description	Required
properties	ColorBackgroundProperties

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

Properties

Any properties can be set, retrieved or listened to. See the Watch for changes topic.

Property	Type	Class
color	Color
declaredClass readonly inherited	string	Accessor

color

autocast Property

Type: Color

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

readonlyinherited Property

Type: string

Inherited from: Accessor

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

Methods

Method	Signature	Class
fromJSON inherited static	fromJSON(json: any): any	JSONSupportMixin
clone	clone(): ColorBackground
toJSON inherited	toJSON(): any	JSONSupportMixin

fromJSON

inheritedstatic Method

Signature: fromJSON (json: any): any

Inherited from: JSONSupportMixin

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.

Parameters

Parameter	Type	Description	Required
json	any	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: any
Returns a new instance of this class.

clone

Method

Signature: clone (): ColorBackground

Creates a deep clone of the object.

Returns: ColorBackground
A deep clone of the object that invoked this method.

toJSON

inherited Method

Signature: toJSON (): any

Inherited from: JSONSupportMixin

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

Returns: any
The ArcGIS portal JSON representation of an instance of this class.