sizeRange

import sizeRange from "@arcgis/core/smartMapping/heuristics/sizeRange.js";

Since: ArcGIS Maps SDK for JavaScript 4.12

Function for determining the suggested minSize and maxSize of a scale-dependent size visual variable.

Known Limitations

This function is not intended for use in 3D SceneViews.

Functions

Name	Return Type	Object
`sizeRange`	`Promise<SizeRangeResult \| null \| undefined>`

Function

Generates a suggested size range (i.e. the minSize and maxSize size variables) for a scale-dependent size visual variable.

Known Limitations

This function is not intended for use in 3D SceneViews.

Signature: sizeRange (parameters: SizeRangeParameters): Promise<SizeRangeResult | null | undefined>

Parameters

Parameter	Type	Description	Required
parameters	`SizeRangeParameters`	The function parameters.

Returns: Promise<SizeRangeResult | null | undefined>
Resolves to an object containing the suggested minSize and maxSize by scale for the layer's renderer.

Example

sizeRange({
  layer: featureLayer,
  view: view
}).then(function(response){

  // update the minSize and maxSize of a size visual variable
  // on a layer's renderer to be scale-dependent
  const renderer = featureLayer.renderer.clone();
  const sizeVariable = renderer.visualVariables.filter( vv => vv.type === "size")[0].clone();
  sizeVariable.minSize = response.minSize;
  sizeVariable.maxSize = response.maxSize;

  renderer.visualVariables = [ sizeVariable ];
  featureLayer.renderer = renderer;
});