ColorStop

AMD: require(["esri/renderers/visualVariables/support/ColorStop"], (ColorStop) => { /* code goes here */ });
ESM: import ColorStop from "@arcgis/core/renderers/visualVariables/support/ColorStop";
Class: esri/renderers/visualVariables/support/ColorStop
Inheritance: ColorStop Accessor
Since: ArcGIS API for JavaScript 4.10

Defines a color stop used for creating a continuous color visualization in a color visual variable.

See also:

Constructors

new ColorStop(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 used to render features with the given value.

more detailsColorStop
Stringmore details

The name of the class.

more detailsAccessor
Stringmore details

A string value used to label the stop along the color ramp in the Legend.

more detailsColorStop
Numbermore details

Specifies the data value to map to the given color.

more detailsColorStop

Property Details

Autocasts from Number[]|String|Object

The Color used to render features with the given value.

declaredClass Stringreadonly inherited

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

label String

A string value used to label the stop along the color ramp in the Legend.

value Number

Specifies the data value to map to the given color.

Method Overview

Name Return Type Summary Class
ColorStopmore details

Creates a deep clone of the ColorStop.

more detailsColorStop
*more details

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

more detailsColorStop
Objectmore details

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

more detailsColorStop

Method Details

clone(){ColorStop}

Creates a deep clone of the ColorStop.

Returns:
Type Description
ColorStop A deep clone of the color stop that invoked this method.
Example:
// Creates a deep clone of the visual variable
const stops = renderer.visualVariables[0].stops.map(function(stop){
  return stop.clone();
});
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.