MultipartColorRamp

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

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.
NameTypeSummaryClass
AlgorithmicColorRamp[]

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

more details
more detailsMultipartColorRamp
String

The name of the class.

more details
more detailsAccessor
String

A string value representing the color ramp type.

more details
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. This value is always multipart.

Default Value:multipart

Method Overview

NameReturn TypeSummaryClass
MultipartColorRamp

Creates a deep clone of this object.

more details
more detailsMultipartColorRamp
*

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