Method Overview

Method Details

sizeRange(params){Promise<SizeRangeResult>}

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

Known Limitations

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

Parameters:

Specification:

params Object See the table below for details about parameters that may be passed to this function. Specification: layer FeatureLayer|GeoJSONLayer The layer for which to generate a suggested min/max size range based on scale for a size visual variable. view MapView The MapView where the layer will be rendered. signal AbortSignal optional Allows for cancelable requests. If canceled, the promise will be rejected with an error named AbortError. See also AbortController.

Returns:

Type	Description
Promise<SizeRangeResult>	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;
});

Type Definitions

SizeRangeResult

The suggested minSize and maxSize size stops generated from the sizeRange() function to apply to the scale-dependent size visual variable.

Properties:

minSize ScaleDependentStops The suggested sizes of the smallest symbols at various scales in a layer with a size visualization.

maxSize ScaleDependentStops The suggested sizes of the largest symbols at various scales in a layer with a size visualization.