ColorSizeStop | References | ArcGIS Maps SDK for JavaScript

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

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

Inheritance: ColorSizeStop→Accessor

Since: ArcGIS Maps SDK for JavaScript 4.12

Defines how to data values should be represented in the ColorSizeSlider with an associated color and size.

See also

ColorSizeSlider.stops

Constructors

Constructor

Parameters

Parameter	Type	Description	Required
properties	ColorSizeStopProperties

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
label	string \| null \| undefined
size	number
value	number

color

autocast Property

Type: Color

The Color used to render features with the given value.

declaredClass

readonlyinherited Property

Type: string

Inherited from: Accessor

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

label

Property

Type: string | null | undefined

A string value used to label the stop in the Legend.

size

autocast Property

Type: number

The size value in points used to render features with the given value. This value may also be autocast from a string in points or pixels.

value

Property

Type: number

Specifies the data value to map to the given size and color.

Methods

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

Creates a deep clone of the ColorSizeStop.

Returns: ColorSizeStop
A deep clone of the size stop that invoked this method.

Example

// Creates a deep clone of the visual variable
const stops = renderer.visualVariables[0].stops.map(function(stop){
  return stop.clone();
});

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.