AlgorithmicColorRamp

require(["esri/tasks/support/AlgorithmicColorRamp"], function(AlgorithmicColorRamp) { /* code goes here */ });
Class: esri/tasks/support/AlgorithmicColorRamp
Inheritance: AlgorithmicColorRamp ColorRamp Accessor
Since: ArcGIS API for JavaScript 4.0

Create an algorithmic color ramp to define the range of colors used in the renderer generated by the GenerateRendererTask. The algorithmic color ramp is defined by specifying two colors and the algorithm used to traverse the intervening color spaces.

There are three algorithms that can be used to define the color values between the from and to colors: 'cie-lab', 'hsv', and 'lab-lch'. There is very little difference between these algorithms when the from and the to colors are of the same or very similar hues. However, when the hues for the from and to colors are different (Hue is different by 40 or more on a 0-360 scale), the algorithms produce different results. The 'hsv' algorithm traverses the hue difference in a purely linear fashion, resulting in a bright ramp where all intermediate colors are represented. For instance, a ramp from red to green would include orange, yellow, and yellow-green. The 'cie-lab' and 'lab-lch' produce a more blended result. Thus, a ramp from dark green to orange would not contain a bright yellow, but instead a more brown and green-gold or green-brown intermediate color. The advantage of the 'cie-lab' algorithm is that the colors of the ramp are visually equidistant, which can produce a better ramp.

Constructors

new AlgorithmicColorRamp(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.
NameTypeSummaryClass
String

The algorithm used to generate the colors between the fromColor and toColor.

more details
more detailsAlgorithmicColorRamp
String

The name of the class.

more details
more detailsAccessor
Color

The first color in the color ramp.

more details
more detailsAlgorithmicColorRamp
Color

The last color in the color ramp.

more details
more detailsAlgorithmicColorRamp
String

A string value representing the color ramp type.

more details
more detailsAlgorithmicColorRamp

Property Details

algorithm String

The algorithm used to generate the colors between the fromColor and toColor. Each algorithm uses different methods for generating the intervening colors.

Possible ValueDescription
cie-labBlends the from and to colors without traversing the intervening hue space.
lab-lchThe hue, saturation, value (hsv) algorithm is a linear traverse of colors between pairs: Color 1 H to Color 2 H, Color 1 S to Color 2 S, and Color 1 V to Color 2 V.
hsvThe lab-lch algorithm is very similar to the cie-lab but does not seek the shortest path between colors.
declaredClass Stringreadonly inherited
Since: ArcGIS API for JavaScript 4.7

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

fromColor Color

The first color in the color ramp.

toColor Color

The last color in the color ramp.

type Stringreadonly

A string value representing the color ramp type. This value is always algorithmic.

Default Value:algorithmic

Method Overview

NameReturn TypeSummaryClass
AlgorithmicColorRamp

Creates a deep clone of this object.

more details
more detailsAlgorithmicColorRamp
*

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 detailsColorRamp
Object

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

more details
more detailsColorRamp

Method Details

Creates a deep clone of this object.

Returns:
TypeDescription
AlgorithmicColorRampA deep clone of the AlgorithmicColorRamp instance 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 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 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:
TypeDescription
*Returns a new instance of this class.
toJSON(){Object}inherited

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

Returns:
TypeDescription
ObjectThe ArcGIS portal JSON representation of an instance of this class.

API Reference search results

NameTypeModule
Loading...