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.
Constructors
-
new MultipartColorRamp(properties)
-
Parameterproperties 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 | MultipartColorRamp | |
| String | The name of the class. more details | Accessor | |
| String | A string value representing the color ramp type. more details | MultipartColorRamp |
Property Details
-
colorRamps AlgorithmicColorRamp[]
-
Define an array of algorithmic color ramps used to generate the multi part ramp.
-
Since: ArcGIS Maps SDK 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 |
|---|---|---|---|
Adds one or more handles which are to be tied to the lifecycle of the object. more details | Accessor | ||
| MultipartColorRamp | Creates a deep clone of this object. more details | MultipartColorRamp | |
| * | Creates a new instance of this class and initializes it with values from a JSON object generated from an ArcGIS product. more details | ColorRamp | |
| Boolean | Returns true if a named group of handles exist. more details | Accessor | |
Removes a group of handles owned by the object. more details | Accessor | ||
| Object | Converts an instance of this class to its ArcGIS portal JSON representation. more details | ColorRamp |
Method Details
-
addHandles(handleOrHandles, groupKey)inheritedSince: ArcGIS Maps SDK for JavaScript 4.25
-
Adds one or more handles which are to be tied to the lifecycle of the object. The handles will be removed when the object is destroyed.
// Manually manage handles const handle = reactiveUtils.when( () => !view.updating, () => { wkidSelect.disabled = false; }, { once: true } ); this.addHandles(handle); // Destroy the object this.destroy();ParametershandleOrHandles WatchHandle|WatchHandle[]Handles marked for removal once the object is destroyed.
groupKey *optionalKey identifying the group to which the handles should be added. All the handles in the group can later be removed with Accessor.removeHandles(). If no key is provided the handles are added to a default group.
-
clone(){MultipartColorRamp}
-
Creates a deep clone of this object.
ReturnsType 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
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.Parameterjson 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.
ReturnsType Description * Returns a new instance of this class.
-
Since: ArcGIS Maps SDK for JavaScript 4.25
-
Returns true if a named group of handles exist.
ParametergroupKey *optionalA group key.
ReturnsType Description Boolean Returns trueif a named group of handles exist.Example// Remove a named group of handles if they exist. if (obj.hasHandles("watch-view-updates")) { obj.removeHandles("watch-view-updates"); }
-
removeHandles(groupKey)inheritedSince: ArcGIS Maps SDK for JavaScript 4.25
-
Removes a group of handles owned by the object.
ParametergroupKey *optionalA group key or an array or collection of group keys to remove.
Exampleobj.removeHandles(); // removes handles from default group obj.removeHandles("handle-group"); obj.removeHandles("other-handle-group");
-
Converts an instance of this class to its ArcGIS portal JSON representation. See the Using fromJSON() guide topic for more information.
ReturnsType Description Object The ArcGIS portal JSON representation of an instance of this class.