ColorStop
require(["esri/renderers/visualVariables/support/ColorStop"], function(ColorStop) { /* code goes here */ });
esri/renderers/visualVariables/support/ColorStop
Defines a color stop used for creating a continuous color visualization in a color visual variable.
- See also:
Constructors
- new ColorStop(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 used to render features with the given value. more details | more details | ColorStop | |
String | The name of the class. more details | more details | Accessor | |
String | A string value used to label the stop along the color ramp in the Legend. more details | more details | ColorStop | |
Number | Specifies the data value to map to the given color. more details | more details | ColorStop |
Property Details
The name of the class. The declared class name is formatted as
esri.folder.className
.
Method Overview
Name | Return Type | Summary | Class | |
---|---|---|---|---|
ColorStop | Creates a deep clone of the ColorStop. more details | more details | ColorStop | |
* | 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 | ColorStop | |
Object | Converts an instance of this class to its ArcGIS portal JSON representation. more details | more details | ColorStop |
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 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 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.