MultipartColorRamp
require(["esri/tasks/support/MultipartColorRamp"], function(MultipartColorRamp) { /* code goes here */ });esri/tasks/support/MultipartColorRampCreate a multipart color ramp to concatenate multiple color ramps for use in the renderer generated by the GenerateRendererTask. After creating a new MultipartColorRamp object you can add algorithmic color ramps using the addRamp method. The MultipartColorRamp will try to use an equal number of colors from each member ramp to create its colors.
Constructors
- new MultipartColorRamp(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 | |
|---|---|---|---|---|
| AlgorithmicColorRamp[] | Define an array of algorithmic color ramps used to generate the multi part ramp. more details | more details | MultipartColorRamp | |
| String | The name of the class. more details | more details | Accessor | |
| String | A string value representing the color ramp type. more details | more details | MultipartColorRamp |
Property Details
- colorRamps AlgorithmicColorRamp[]
Define an array of algorithmic color ramps used to generate the multi part ramp.
- 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.
For MultipartColorRamp the type is always "multipart".
- Default Value:multipart
Method Overview
| Name | Return Type | Summary | Class | |
|---|---|---|---|---|
| MultipartColorRamp | Creates a deep clone of this object. more details | more details | MultipartColorRamp | |
| * | 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
- clone(){MultipartColorRamp}
Creates a deep clone of this object.
Returns:Type Description MultipartColorRamp A deep clone of the MultipartColorRamp 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
jsonparameter 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.
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.