HeatmapColorStop | References | ArcGIS Maps SDK for JavaScript

import HeatmapColorStop from "@arcgis/core/renderers/support/HeatmapColorStop.js";

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

Inheritance: HeatmapColorStop→Accessor

Since: ArcGIS Maps SDK for JavaScript 4.8

This class is used to define an array of objects describing the HeatmapRenderer's color ramp and associated density value ratios. See HeatmapRenderer for examples of how this is used.

See also

HeatmapRenderer

Constructors

Constructor

Parameters

Parameter	Type	Description	Required
properties	HeatmapColorStopProperties

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
color	Color
declaredClass readonly inherited	string	Accessor
ratio	number

color

autocast Property

Type: Color

The color to shade a given pixel based on its calculated density ratio.

declaredClass

readonlyinherited Property

Type: string

Inherited from: Accessor

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

ratio

Property

Type: number

The ratio of a pixel's density value to the HeatmapRenderer.maxDensity of the renderer. The ratio of each pixel is matched to the corresponding color.

Methods

Method	Signature	Class
fromJSON inherited static	fromJSON(json: any): any	JSONSupportMixin
clone	clone(): HeatmapColorStop
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 (): HeatmapColorStop

Creates a deep clone of the color stop.

Returns: HeatmapColorStop
A deep clone of the object 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.