ColorRamp

Class: esri/tasks/support/ColorRamp
Inheritance: ColorRamp Accessor
Since: ArcGIS API for JavaScript 4.0

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

Any properties can be set, retrieved or listened to. See the Working with Properties topic.
NameTypeSummaryClass
String

The name of the class.

more details
more detailsAccessor
String

A string value representing the color ramp type.

more details
more detailsColorRamp

Property Details

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.

type Stringreadonly

A string value representing the color ramp type.

Method Overview

NameReturn TypeSummaryClass
*

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

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}

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