MultipartColorRamp

AMD: require(["esri/tasks/support/MultipartColorRamp"], (MultipartColorRamp) => { /* code goes here */ });
ESM: import MultipartColorRamp from "@arcgis/core/tasks/support/MultipartColorRamp";
Class: esri/tasks/support/MultipartColorRamp
Inheritance: MultipartColorRamp ColorRamp Accessor
Since: ArcGIS API for JavaScript 4.0
Deprecated since version 4.20. Use MultipartColorRamp instead.

Create 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 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.
Show inherited properties Hide inherited properties
Name Type Summary Class
AlgorithmicColorRamp[]more details

Define an array of algorithmic color ramps used to generate the multi part ramp.

more detailsMultipartColorRamp
Stringmore details

The name of the class.

more detailsAccessor
Stringmore details

A string value representing the color ramp type.

more detailsMultipartColorRamp

Property Details

Define an array of algorithmic color ramps used to generate the multi part ramp.

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.

For MultipartColorRamp the type is always "multipart".

Default Value:multipart

Method Overview

Show inherited methods Hide inherited methods
Name Return Type Summary Class
MultipartColorRampmore details

Creates a deep clone of this object.

more detailsMultipartColorRamp
*more details

Creates a new instance of this class and initializes it with values from a JSON object generated from an ArcGIS product.

more detailsColorRamp
Objectmore details

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

more detailsColorRamp

Method Details

clone(){MultipartColorRamp}static

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 an ArcGIS product. 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:
Type Description
* 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() guide topic for more information.

Returns:
Type Description
Object The ArcGIS portal JSON representation of an instance of this class.

Your browser is no longer supported. Please upgrade your browser for the best experience. See our browser deprecation post for more details.