SizeStop

AMD: require(["esri/renderers/visualVariables/support/SizeStop"], (SizeStop) => { /* code goes here */ });
ESM: import SizeStop from "@arcgis/core/renderers/visualVariables/support/SizeStop";
Class: esri/renderers/visualVariables/support/SizeStop
Inheritance: SizeStop Accessor
Since: ArcGIS API for JavaScript 4.10

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

See also:

Constructors

new SizeStop(properties)
Parameter:
properties Object
optional

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

Property Overview

Any properties can be set, retrieved or listened to. See the Working with Properties topic.
Show inherited properties Hide inherited properties
Name Type Summary Class
Stringmore details

The name of the class.

more detailsAccessor
Stringmore details

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

more detailsSizeStop
Numbermore details

The size value in points (between 0 and 90) used to render features with the given value.

more detailsSizeStop
Numbermore details

Specifies the data value to map to the given size.

more detailsSizeStop

Property Details

declaredClass Stringreadonly inherited

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

label String

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

Autocasts from String

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 Number

Specifies the data value to map to the given size.

Method Overview

Name Return Type Summary Class
SizeStopmore details

Creates a deep clone of the SizeStop.

more detailsSizeStop
*more details

Creates a new instance of this class and initializes it with values from a JSON object generated from an ArcGIS product.

more detailsSizeStop
Objectmore details

Converts an instance of this class to its ArcGIS portal JSON representation.

more detailsSizeStop

Method Details

clone(){SizeStop}

Creates a deep clone of the SizeStop.

Returns:
Type Description
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();
});
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 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.

Parameter:
json Object

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:
Type Description
* Returns a new instance of this class.
toJSON(){Object}

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

Returns:
Type Description
Object The ArcGIS portal JSON representation of an instance of this class.

Your browser is no longer supported. Please upgrade your browser for the best experience. See our browser deprecation post for more details.