ColorBackground

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

Represents the background color of the WebMap when displayed in a MapView.

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
Colormore details

The color of the background.

more detailsColorBackground
Stringmore details

The name of the class.

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

Name Return Type Summary Class
ColorBackgroundmore details

Creates a deep clone of the object.

more detailsColorBackground
*more details

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

more detailsColorBackground
Objectmore details

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

more detailsColorBackground

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 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.

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