ColorRamp
esri/tasks/support/ColorRamp
A ColorRamp object is used to specify a range of colors that are applied to a group of symbols or pixels.
There are two types of color ramps available:
Algorithmic color ramp
A AlgorithmicColorRamp is defined by two colors and the algorithm used to traverse the intervening color space between them.
Multipart color ramp
A MultipartColorRamp is defined by a list of constituent color ramps.
Property Overview
Name | Type | Summary | Class | |
---|---|---|---|---|
String | The name of the class. more details | more details | Accessor | |
String | A string value representing the color ramp type. more details | more details | ColorRamp |
Property Details
- Since: ArcGIS API for JavaScript 4.7
The name of the class. The declared class name is formatted as
esri.folder.className
.
- type Stringreadonly
A string value representing the color ramp type.
Possible Values:"algorithmic"|"multipart"
Method Overview
Name | Return Type | Summary | Class | |
---|---|---|---|---|
* | 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 | ColorRamp | |
Object | Converts an instance of this class to its ArcGIS portal JSON representation. more details | more details | ColorRamp |
Method Details
- 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() guide topic for more information.
Returns:Type Description Object The ArcGIS portal JSON representation of an instance of this class.