MultipartColorRamp | References | ArcGIS Maps SDK for JavaScript

import MultipartColorRamp from "@arcgis/core/rest/support/MultipartColorRamp.js";

const MultipartColorRamp = await $arcgis.import("@arcgis/core/rest/support/MultipartColorRamp.js");

Inheritance: MultipartColorRamp→ColorRamp→Accessor

Since: ArcGIS Maps SDK for JavaScript 4.0

Creates a multipart color ramp to combine multiple continuous color ramps for use in raster renderers. The MultipartColorRamp will try to use an equal number of colors from each member ramp to create its colors.

See also

Sample - ImageryTileLayer - shaded relief renderer

Constructors

Constructor

Parameters

Parameter	Type	Description	Required
properties	MultipartColorRampProperties

See the properties table for a list of all the properties that may be passed into the constructor.

Properties

Any properties can be set, retrieved or listened to. See the Watch for changes topic.

Property	Type	Class
colorRamps	AlgorithmicColorRamp[] \| null \| undefined
declaredClass readonly inherited	string	Accessor
type readonly	"multipart"
weights	number[] \| null \| undefined

colorRamps

autocast Property

Type: AlgorithmicColorRamp[] | null | undefined

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

declaredClass

readonlyinherited Property

Type: string

Inherited from: Accessor

Since: ArcGIS Maps SDK for JavaScript 4.7

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

type

readonly Property

Type: "multipart"

A string value representing the color ramp type.

Default value: "multipart"

weights

Property

Type: number[] | null | undefined

Since: ArcGIS Maps SDK for JavaScript 4.34

Sets the proportional weight of each colorRamp within the multipart color ramp. This controls how much of the overall gradient each ramp occupies, allowing for precise transitions between ramps based on the specified weights. If not specified, all ramps are assigned equal weight.

Methods

Method	Signature	Class
fromJSON inherited static	fromJSON(json: any): any	JSONSupportMixin
clone	clone(): MultipartColorRamp
toJSON inherited	toJSON(): any	JSONSupportMixin

fromJSON

inheritedstatic Method

Signature: fromJSON (json: any): any

Inherited from: JSONSupportMixin

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.

Parameters

Parameter	Type	Description	Required
json	any	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: any
Returns a new instance of this class.

clone

Method

Signature: clone (): MultipartColorRamp

Creates a deep clone of this object.

Returns: MultipartColorRamp
A deep clone of the MultipartColorRamp instance that invoked this method.

toJSON

inherited Method

Signature: toJSON (): any

Inherited from: JSONSupportMixin

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

Returns: any
The ArcGIS portal JSON representation of an instance of this class.