SizeStop | References | ArcGIS Maps SDK for JavaScript

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

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

Inheritance: SizeStop→Accessor

Since: ArcGIS Maps SDK for JavaScript 4.10

Defines a size stop used for creating a continuous size visualization in a size visual variable.

See also

SizeVariable

Constructors

Constructor

Parameters

Parameter	Type	Description	Required
properties	SizeStopProperties

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

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 (between 0 and 90) used to render features with the given value. This value may also be autocast from a string in points or pixels.

Examples

// size defined in points
const sizeVisVar = {
  type: "size",
  field: "POPULATION",
  stops: [
    { value: 5000, size: 4 },
    { value: 1000000, size: 80 }
  ]
};
renderer.visualVariables = [ sizeVisVar ];

// size defined with pixels
const sizeVisVar = {
  type: "size",
  field: "POPULATION",
  stops: [
    { value: 5000, size: "6px" },
    { value: 1000000, size: "120px" }
  ]
};
renderer.visualVariables = [ sizeVisVar ];

value

Property

Type: number

Specifies the data value to map to the given size.

Methods

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

Creates a deep clone of the SizeStop.

Returns: SizeStop
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.