SizeSlider

AMD: require(["esri/widgets/smartMapping/SizeSlider"], (SizeSlider) => { /* code goes here */ });
ESM: import SizeSlider from "@arcgis/core/widgets/smartMapping/SizeSlider.js";
Class: esri/widgets/smartMapping/SizeSlider
Inheritance: SizeSlider SmartMappingSliderBase Widget Accessor
Since: ArcGIS Maps SDK for JavaScript 4.12

The SizeSlider widget is intended for authoring and exploring data-driven visualizations in any layer that can be rendered with a SizeVariable. At a minimum you must set the min, max, and stops properties of the widget.

See the image below for a summary of the configurable options available on this slider.

SizeSlider with annotations

The fromRendererResult method can be used to conveniently create this slider from the result of the createContinuousRenderer method.

const sizeParams = {
  layer: layer,
  basemap: map.basemap,
  valueExpression: "( $feature.POP_POVERTY / $feature.TOTPOP_CY ) * 100",
  view: view
};

let rendererResult = null;

sizeRendererCreator
  .createContinuousRenderer(sizeParams)
  .then(function(response) {
    rendererResult = response;
    layer.renderer = response.renderer;

    return histogram({
      layer: layer,
      valueExpression: sizeParams.valueExpression,
      view: view,
      numBins: 70
    });
  })
   .then(function(histogramResult) {
     const sizeSlider = SizeSlider.fromRendererResult(rendererResult, histogramResult);
     sizeSlider.container = "slider";
   })
   .catch(function(error) {
     console.log("there was an error: ", error);
   });

This slider should be used to update a size visual variable in a layer's renderer. It is the responsibility of the app developer to set up event listeners on that update the size variable of the appropriate renderer.

// when the user slides the handle(s), update the renderer
// with the updated size stops

sizeSlider.on(["thumb-change", "thumb-drag"], function() {
  const renderer = layer.renderer.clone();
  const sizeVariable = renderer.visualVariables[0];
  renderer.visualVariables = [ sizeSlider.updateVisualVariable(sizeVariable) ];
  layer.renderer = renderer;
});
For information about gaining full control of widget styles, see the Styling topic.
See also

Constructors

SizeSlider

Constructor
new SizeSlider(properties)
Parameter
properties Object
optional

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

Example
// Typical usage
const slider = new SizeSlider({
  container: "sliderDiv",
  min: 0,
  max: 100,
  stops: [
    { value: 0, size: 4 },
    { value: 100, size: 40 }
  ]
});

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

The ID or node representing the DOM element containing the widget.

Widget

The name of the class.

Accessor

Only applicable when three thumbs (i.e.

SizeSlider

The Histogram associated with the data represented on the slider.

SmartMappingSliderBase

The unique ID assigned to the widget when the widget is created.

Widget

A function used to format user inputs.

SmartMappingSliderBase

Function used to parse slider inputs formatted by the inputFormatFunction.

SmartMappingSliderBase

The widget's default label.

SizeSlider

A modified version of Slider.labelFormatFunction, which is a custom function used to format labels on the thumbs, min, max, and average values.

SmartMappingSliderBase

The maximum value or upper bound of the slider.

SmartMappingSliderBase

The minimum value or lower bound of the slider.

SmartMappingSliderBase

Only applicable when three thumbs (i.e.

SizeSlider

Defines how slider thumb values should be rounded.

SmartMappingSliderBase

When true, the slider will render a third handle between the two handles already provided by default.

SizeSlider

The state of the view model.

SmartMappingSliderBase

The size stops from the SizeVariable to link to the slider.

SizeSlider

Exposes various properties of the widget that can be styled.

SizeSlider

When true, all segments will sync together in updating thumb values when the user drags any segment.

SmartMappingSliderBase

The view model for the SizeSlider widget.

SizeSlider

Indicates whether the widget is visible.

Widget

The visible elements that are displayed within the widget.

SmartMappingSliderBase

Zooms the slider track to the bounds provided in this property.

SmartMappingSliderBase

Property Details

container

Inherited
Property
container String |HTMLElement
Inherited from Widget

The ID or node representing the DOM element containing the widget. This property can only be set once. The following examples are all valid use case when working with widgets.

Examples
// Create the HTML div element programmatically at runtime and set to the widget's container
const basemapGallery = new BasemapGallery({
  view: view,
  container: document.createElement("div")
});

// Add the widget to the top-right corner of the view
view.ui.add(basemapGallery, {
  position: "top-right"
});
// Specify an already-defined HTML div element in the widget's container

const basemapGallery = new BasemapGallery({
  view: view,
  container: basemapGalleryDiv
});

// Add the widget to the top-right corner of the view
view.ui.add(basemapGallery, {
  position: "top-right"
});

// HTML markup
<body>
  <div id="viewDiv"></div>
  <div id="basemapGalleryDiv"></div>
</body>
// Specify the widget while adding to the view's UI
const basemapGallery = new BasemapGallery({
  view: view
});

// Add the widget to the top-right corner of the view
view.ui.add(basemapGallery, {
  position: "top-right"
});

declaredClass

Inherited
Property
declaredClass Stringreadonly
Inherited from Accessor

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

handlesSyncedToPrimary

Property
handlesSyncedToPrimary Boolean
Since: ArcGIS Maps SDK for JavaScript 4.18 SizeSlider since 4.12, handlesSyncedToPrimary added at 4.18.

Only applicable when three thumbs (i.e. handles) are set on the slider values. This property indicates whether the position of the outside handles are synced with the middle, or primary, handle. When enabled, if the primary handle is moved then the outside handle positions are updated while maintaining a fixed distance from the primary handle.

Only applicable when primaryHandleEnabled is true.

Default Value:true
See also
Example
// enables the primary handles and syncs it with the others
slider.primaryHandleEnabled = true;
slider.handlesSyncedToPrimary = true;

histogramConfig

Inherited
Property
histogramConfig HistogramConfig
Inherited from SmartMappingSliderBase

The Histogram associated with the data represented on the slider. The bins are typically generated using the histogram statistics function.

See also
Example
histogram({
  layer: featureLayer,
  field: "fieldName",
  numBins: 30
}).then(function(histogramResult){
  // set the histogram to the slider
  slider.histogramConfig = {
    bins: histogramResult.bins
  };
});

id

Inherited
Property
id String
Inherited from Widget

The unique ID assigned to the widget when the widget is created. If not set by the developer, it will default to the container ID, or if that is not present then it will be automatically generated.

inputFormatFunction

Inherited
Property
inputFormatFunction LabelFormatter
Inherited from SmartMappingSliderBase
Since: ArcGIS Maps SDK for JavaScript 4.14 SmartMappingSliderBase since 4.12, inputFormatFunction added at 4.14.

A function used to format user inputs. As opposed to labelFormatFunction, which formats thumb labels, the inputFormatFunction formats thumb values in the input element when the user begins to edit them.

The image below demonstrates how slider input values resemble corresponding slider values by default and won't match the formatting set in labelFormatFunction.

Slider without input formatter

If you want to format slider input values so they match thumb labels, you can pass the same function set in labelFormatFunction to inputFormatFunction for consistent formatting.

Slider with input formatter

However, if an inputFormatFunction is specified, you must also write a corresponding inputParseFunction to parse user inputs to understandable slider values. In most cases, if you specify an inputFormatFunction, you should set the labelFormatFunction to the same value for consistency between labels and inputs.

This property overrides the default input formatter, which formats by calling toString() on the input value.

Example
// Formats the slider input to abbreviated numbers with units
// e.g. a thumb at position 1500 will render with an input label of 1.5k
slider.inputFormatFunction = function(value, type){
  if(value >= 1000000){
    return (value / 1000000).toPrecision(3) + "m"
  }
  if(value >= 100000){
    return (value / 1000).toPrecision(3) + "k"
  }
  if(value >= 1000){
    return (value / 1000).toPrecision(2) + "k"
  }
  return value.toFixed(0);
}

inputParseFunction

Inherited
Property
inputParseFunction InputParser
Inherited from SmartMappingSliderBase
Since: ArcGIS Maps SDK for JavaScript 4.14 SmartMappingSliderBase since 4.12, inputParseFunction added at 4.14.

Function used to parse slider inputs formatted by the inputFormatFunction. This property must be set if an inputFormatFunction is set. Otherwise the slider values will likely not update to their expected positions.

Overrides the default input parses, which is a parsed floating point number.

Example
// Parses the slider input (a string value) to a number value understandable to the slider
// This assumes the slider was already configured with an inputFormatFunction
// For example, if the input is 1.5k this function will parse
// it to a value of 1500
slider.inputParseFunction = function(value, type, index){
  let charLength = value.length;
  let valuePrefix = parseFloat(value.substring(0,charLength-1));
  let finalChar = value.substring(charLength-1);

  if(parseFloat(finalChar) >= 0){
    return parseFloat(value);
  }
  if(finalChar === "k"){
    return valuePrefix * 1000;
  }
  if(finalChar === "m"){
    return valuePrefix * 1000000;
  }
  return value;
}

label

Property
label String

The widget's default label. This label displays when it is used within another widget, such as the Expand or LayerList widgets.

labelFormatFunction

Inherited
Property
labelFormatFunction LabelFormatter
Inherited from SmartMappingSliderBase

A modified version of Slider.labelFormatFunction, which is a custom function used to format labels on the thumbs, min, max, and average values. Overrides the default label formatter. This function also supports date formatting.

Example
// For thumb values, rounds each label to whole numbers
slider.labelFormatFunction = function(value, type) {
  return (type === "value-change") ? value.toFixed(0): value;
}

max

Inherited
Property
max Number
Inherited from SmartMappingSliderBase

The maximum value or upper bound of the slider. If the largest slider value in the constructor is greater than the max set in this property, then the max will update to match the largest slider value.

Example
slider.max = 150;

min

Inherited
Property
min Number
Inherited from SmartMappingSliderBase

The minimum value or lower bound of the slider. If the smallest slider value in the constructor is greater than the min set in this property, then the min will update to match the smallest slider value.

Example
slider.min = -150;

persistSizeRangeEnabled

Property
persistSizeRangeEnabled Boolean
Since: ArcGIS Maps SDK for JavaScript 4.19 SizeSlider since 4.12, persistSizeRangeEnabled added at 4.19.

Only applicable when three thumbs (i.e. handles) are set on the slider (i.e. when primaryHandleEnabled is true). This property is typically used in diverging, or above-and-below renderer configurations.

When true, ensures symbol sizes in the above range are consistent with symbol sizes in the below range for all slider thumb positions. In other words, the size values in the stops will adjust proportionally according to the positions of the data values within the constraints of the size range (maxSize - minSize) as the slider thumbs update. When false, size values in the stops will remain the same even when slider thumb values change.

In most cases, this should be set to true to keep sizes in the above range consistent with sizes in the below range to avoid map misinterpretation.

Default Value:false
See also
Example
slider.primaryHandleEnabled = true;
slider.persistSizeRangeEnabled = true;

precision

Inherited
Property
precision Number
Inherited from SmartMappingSliderBase
Since: ArcGIS Maps SDK for JavaScript 4.14 SmartMappingSliderBase since 4.12, precision added at 4.14.

Defines how slider thumb values should be rounded. This number indicates the number of decimal places slider thumb values should round to when they have been moved.

This value also indicates the precision of thumb labels when the data range is less than 10 (i.e. (max - min) < 10).

When the data range is larger than 10, labels display with a precision of no more than two decimal places, though actual slider thumb values will maintain the precision specified in this property.

For example, given the default precision of 4, and the following slider configuration, The labels of the thumbs will display two decimal places, but the precision of the actual thumb values will not be lost even when the user slides or moves the thumb.

const slider = new Slider({
  min: 20,
  max: 100,  // data range of 80
  values: [50.4331],
  // thumb label will display 50.43
  // thumb value will maintain precision, so
  // value will remain at 50.4331
  container: "sliderDiv"
});

If the user manually enters a value that has a higher precision than what's indicated by this property, the precision of that thumb value will be maintained until the thumb is moved by the user. At that point, the value will be rounded according to the indicated precision.

If thumb labels aren't visible, they must be enabled with labelInputsEnabled.

Keep in mind this property rounds thumb values and shouldn't be used exclusively for formatting purposes. To format thumb labels, use the labelFormatFunction property.

Default Value:4
Example
slider.precision = 7;

primaryHandleEnabled

Property
primaryHandleEnabled Boolean
Since: ArcGIS Maps SDK for JavaScript 4.18 SizeSlider since 4.12, primaryHandleEnabled added at 4.18.

When true, the slider will render a third handle between the two handles already provided by default. This is the primary handle. When handlesSyncedToPrimary is true, then this handle will control the position of the others when moved.

Default Value:false
See also
Example
// enables the primary handles and syncs it with the others
slider.primaryHandleEnabled = true;
slider.handlesSyncedToPrimary = true;
slider.persistSizeRangeEnabled = true;

state

Inherited
Property
state Stringreadonly
Inherited from SmartMappingSliderBase

The state of the view model.

Possible Values:"ready" |"disabled"

stops

Property
stops SizeStop[]

The size stops from the SizeVariable to link to the slider.

Example
const slider = new SizeSlider({
  container: "sliderDiv",
  min: 0,
  max: 100,
  stops: [
    { value: 0, size: 4 },
    { value: 100, size: 40 }
  ]
});

style

Property
style Object

Exposes various properties of the widget that can be styled.

Properties
trackFillColor Color
optional
Default Value:new Color([149, 149, 149])

The color of the slider's track. For single-color visualizations where only a Size variable is present, you should set this color to match the color of the symbol in the SimpleRenderer.

trackBackgroundColor Color
optional
Default Value:new Color([224, 224, 224])

The background color of the slider's track. Generally, this color should be subdued and not interfere with the trackFillColor.

Example
slider.style = {
  trackFillColor: new Color("dodgerblue"),
  trackBackgroundColor: new Color([50,50,50])
};

syncedSegmentsEnabled

Inherited
Property
syncedSegmentsEnabled Boolean
Inherited from SmartMappingSliderBase
Since: ArcGIS Maps SDK for JavaScript 4.20 SmartMappingSliderBase since 4.12, syncedSegmentsEnabled added at 4.20.

When true, all segments will sync together in updating thumb values when the user drags any segment. This maintains the interval between all thumbs when any segment is dragged. Only applicable when visibleElements.interactiveTrack is true.

In sliders where the primary handle is enabled, this allows you to disable handlesSyncedToPrimary to keep handle movements independent of the middle (primary) handle, but still provide an option for the end user to sync handles with the primary handle via slider drag events.

Default Value:false
See also
Example
slider.visibleElements = {
  interactiveTrack: true
};
slider.primaryHandleEnabled = true;
slider.handlesSyncedToPrimary = false;
slider.syncedSegmentsEnabled = true;

viewModel

Property
viewModel SizeSliderViewModel

The view model for the SizeSlider widget. This class contains all the logic (properties and methods) that controls this widget's behavior. See the SizeSliderViewModel class to access all properties and methods on the SizeSlider widget.

visible

Inherited
Property
visible Boolean
Inherited from Widget

Indicates whether the widget is visible.

If false, the widget will no longer be rendered in the web document. This may affect the layout of other elements or widgets in the document. For example, if this widget is the first of three widgets associated to the upper right hand corner of the view UI, then the other widgets will reposition when this widget is made invisible. For more information, refer to the css display value of "none".

Default Value:true
Example
// Hides the widget in the view
widget.visible = false;

visibleElements

Inherited
Property
visibleElements Object
Inherited from SmartMappingSliderBase
Since: ArcGIS Maps SDK for JavaScript 4.20 SmartMappingSliderBase since 4.12, visibleElements added at 4.20.

The visible elements that are displayed within the widget. This property provides the ability to turn individual elements of the widget's display on/off.

Property
interactiveTrack Boolean
optional
Default Value:false

When true, displays interactive segments on the track that maintain the interval between two slider thumbs/handles.

See also
Example
slider.visibleElements = {
  interactiveTrack: true
};
slider.syncedSegmentsEnabled = true;

zoomOptions

Inherited
Property
zoomOptions Object
Inherited from SmartMappingSliderBase

Zooms the slider track to the bounds provided in this property. When min and/or max zoom values are provided, the absolute min and max slider values are preserved and rendered at their typical positions on the slider. However, the slider track itself is zoomed so that thumbs cannot be moved above or below the provided min and max zoomed values.

When a slider is in a zoomed state, the zoomed ends of the track will appear jagged. In the image below, notice how the top thumb cannot be moved past the zoom max of 31 even though the slider max is 200.

slider-zoom

To exit a zoomed state, the user can click the jagged line or the developer can set the zoomOptions to null. It is up to the developer to provide a UI option for end users to enable zooming on the slider.

Setting the zoomOptions is useful when the slider is tied to heavily skewed datasets where the histogram renders only one or two bars because of outliers.

slider-not-zoomed

You can remove the influence of outliers by zooming the slider and regenerating a histogram based on the zoomed min and max. This will provide a better view of the data and make the slider more useful to the end user.

Properties
min Number
optional

The lower bound of the zoom.

max Number
optional

The upper bound of the zoom.

Examples
// zooms the slider to so thumbs can only be moved
// to positions between the values of 10 and 25 while
// maintaining the slider's absolute minimum and
// maximum values
slider.zoomOptions = {
  min: 10,
  max: 25
};
// disables zooming on the slider
slider.zoomOptions = null;
// zooms the slider to so thumbs can only be moved
// to positions above the value of 10, while maintaining
// the slider's absolute minimum value
slider.zoomOptions = {
  min: 10
};
// zooms the slider to so thumbs can only be moved
// to positions below the value of 25, while maintaining
// the slider's absolute maximum value
slider.zoomOptions = {
  max: 25
};
// zooms the slider to the handle positions
// with some padding
document.getElementById("zoomInButton").onclick = function() {
  const lowerThumb = slider.values[0];
  const upperThumb = slider.values[1];

  const range = upperThumb - lowerThumb;
  const padding = range * 0.3;

  const zoomMin = (lowerThumb - padding) > slider.min ? (lowerThumb - padding) : slider.min;
  const zoomMax = (upperThumb + padding) < slider.max ? (upperThumb + padding) : slider.max;

  slider.set({ zoomOptions: { min: zoomMin, max: zoomMax } });
};

Method Overview

Show inherited methods Hide inherited methods
Name Return Type Summary Class

Adds one or more handles which are to be tied to the lifecycle of the object.

Accessor

A utility method used for building the value for a widget's class property.

Widget

Destroys the widget instance.

Widget

Emits an event on the instance.

Widget

A convenience function used to create a SizeSlider widget instance from the result of the createContinuousRenderer method.

SizeSlider

Indicates whether there is an event listener on the instance that matches the provided event name.

Widget

Returns true if a named group of handles exist.

Accessor

isFulfilled() may be used to verify if creating an instance of the class is fulfilled (either resolved or rejected).

Widget

isRejected() may be used to verify if creating an instance of the class is rejected.

Widget

isResolved() may be used to verify if creating an instance of the class is resolved.

Widget

Registers an event handler on the instance.

Widget

Adds one or more handles which are to be tied to the lifecycle of the widget.

Widget

Executes after widget is ready for rendering.

Widget

Removes a group of handles owned by the object.

Accessor

This method is implemented by subclasses for rendering.

Widget

Renders widget to the DOM immediately.

Widget

Schedules widget rendering.

Widget

A convenience function used to update the properties of a SizeSlider widget instance from the result of the createContinuousRenderer method.

SizeSlider

A convenience function used to update the SizeVariable to match the values of the stops on the slider.

SizeSlider

when() may be leveraged once an instance of the class is created.

Widget

Method Details

addHandles

Inherited
Method
addHandles(handleOrHandles, groupKey)
Inherited from Accessor
Since: ArcGIS Maps SDK for JavaScript 4.25 Accessor since 4.0, addHandles added at 4.25.

Adds one or more handles which are to be tied to the lifecycle of the object. The handles will be removed when the object is destroyed.

// Manually manage handles
const handle = reactiveUtils.when(
  () => !view.updating,
  () => {
    wkidSelect.disabled = false;
  },
  { once: true }
);

this.addHandles(handle);

// Destroy the object
this.destroy();
Parameters
handleOrHandles WatchHandle|WatchHandle[]

Handles marked for removal once the object is destroyed.

groupKey *
optional

Key identifying the group to which the handles should be added. All the handles in the group can later be removed with Accessor.removeHandles(). If no key is provided the handles are added to a default group.

classes

Inherited
Method
classes(classNames){String}
Inherited from Widget

A utility method used for building the value for a widget's class property. This aids in simplifying css class setup.

Parameter
classNames String|String[]|Object
repeatable

The class names.

Returns
Type Description
String The computed class name.
Example
// .tsx syntax showing how to set css classes while rendering the widget

render() {
  const dynamicClasses = {
    [css.flip]: this.flip,
    [css.primary]: this.primary
  };

  return (
    <div class={classes(css.root, css.mixin, dynamicClasses)} />
  );
}

destroy

Inherited
Method
destroy()
Inherited from Widget

Destroys the widget instance.

emit

Inherited
Method
emit(type, event){Boolean}
Inherited from Widget

Emits an event on the instance. This method should only be used when creating subclasses of this class.

Parameters
type String

The name of the event.

event Object
optional

The event payload.

Returns
Type Description
Boolean true if a listener was notified

fromRendererResult

Method
fromRendererResult(rendererResult, histogramResult){SizeSlider}static

A convenience function used to create a SizeSlider widget instance from the result of the createContinuousRenderer method.

This method sets the slider stops, min, max, and histogramConfig. It is still the developer's responsibility to assign it a proper container and any other optional properties.

Parameters
rendererResult ContinuousRendererResult

The result object from the createContinuousRenderer method.

histogramResult HistogramResult
optional

The result histogram object from the histogram method.

Returns
Type Description
SizeSlider Returns a SizeSlider instance. This will not render until you assign it a valid container.
Example
const params = {
  layer: layer,
  basemap: map.basemap,
  field: "POP_POVERTY"
};

let rendererResult = null;

sizeRendererCreator
  .createContinuousRenderer(colorParams)
  .then(function(response) {
    rendererResult = response;
    layer.renderer = response.renderer;

    return histogram({
      layer: layer,
      valueExpression: params.field,
      numBins: 30
    });
  })
   .then(function(histogramResult) {

     const sizeSlider = SizeSlider.fromRendererResult(rendererResult, histogramResult);
     sizeSlider.container = "slider";

     // when the user slides the handle(s), update the renderer
     // with the updated size properties

     sizeSlider.on(["thumb-change", "thumb-drag"], function() {
       const renderer = layer.renderer.clone();
       const sizeVariable = renderer.visualVariables[0];
       renderer.visualVariables = [ sizeSlider.updateVisualVariable( sizeVariable ) ];
       layer.renderer = renderer;
     });
   })
   .catch(function(error) {
     console.log("there was an error: ", error);
   });

hasEventListener

Inherited
Method
hasEventListener(type){Boolean}
Inherited from Widget

Indicates whether there is an event listener on the instance that matches the provided event name.

Parameter
type String

The name of the event.

Returns
Type Description
Boolean Returns true if the class supports the input event.

hasHandles

Inherited
Method
hasHandles(groupKey){Boolean}
Inherited from Accessor
Since: ArcGIS Maps SDK for JavaScript 4.25 Accessor since 4.0, hasHandles added at 4.25.

Returns true if a named group of handles exist.

Parameter
groupKey *
optional

A group key.

Returns
Type Description
Boolean Returns true if a named group of handles exist.
Example
// Remove a named group of handles if they exist.
if (obj.hasHandles("watch-view-updates")) {
  obj.removeHandles("watch-view-updates");
}

isFulfilled

Inherited
Method
isFulfilled(){Boolean}
Inherited from Widget
Since: ArcGIS Maps SDK for JavaScript 4.19 Widget since 4.2, isFulfilled added at 4.19.

isFulfilled() may be used to verify if creating an instance of the class is fulfilled (either resolved or rejected). If it is fulfilled, true will be returned.

Returns
Type Description
Boolean Indicates whether creating an instance of the class has been fulfilled (either resolved or rejected).

isRejected

Inherited
Method
isRejected(){Boolean}
Inherited from Widget
Since: ArcGIS Maps SDK for JavaScript 4.19 Widget since 4.2, isRejected added at 4.19.

isRejected() may be used to verify if creating an instance of the class is rejected. If it is rejected, true will be returned.

Returns
Type Description
Boolean Indicates whether creating an instance of the class has been rejected.

isResolved

Inherited
Method
isResolved(){Boolean}
Inherited from Widget
Since: ArcGIS Maps SDK for JavaScript 4.19 Widget since 4.2, isResolved added at 4.19.

isResolved() may be used to verify if creating an instance of the class is resolved. If it is resolved, true will be returned.

Returns
Type Description
Boolean Indicates whether creating an instance of the class has been resolved.

on

Inherited
Method
on(type, listener){Object}
Inherited from Widget

Registers an event handler on the instance. Call this method to hook an event with a listener.

Parameters

An event or an array of events to listen for.

listener Function

The function to call when the event fires.

Returns
Type Description
Object Returns an event handler with a remove() method that should be called to stop listening for the event(s).
Property Type Description
remove Function When called, removes the listener from the event.
Example
view.on("click", function(event){
  // event is the event handle returned after the event fires.
  console.log(event.mapPoint);
});

own

Inherited
Method
own(handleOrHandles)
Inherited from Widget
Since: ArcGIS Maps SDK for JavaScript 4.24 Widget since 4.2, own added at 4.24.
Deprecated since 4.28 Use addHandles() instead.

Adds one or more handles which are to be tied to the lifecycle of the widget. The handles will be removed when the widget is destroyed.

const handle = reactiveUtils.when(
  () => !view.updating,
  () => {
    wkidSelect.disabled = false;
  },
  { once: true}
);

this.own(handle); // Handle gets removed when the widget is destroyed.
Parameter
handleOrHandles WatchHandle|WatchHandle[]

Handles marked for removal once the widget is destroyed.

postInitialize

Inherited
Method
postInitialize()
Inherited from Widget

Executes after widget is ready for rendering.

removeHandles

Inherited
Method
removeHandles(groupKey)
Inherited from Accessor
Since: ArcGIS Maps SDK for JavaScript 4.25 Accessor since 4.0, removeHandles added at 4.25.

Removes a group of handles owned by the object.

Parameter
groupKey *
optional

A group key or an array or collection of group keys to remove.

Example
obj.removeHandles(); // removes handles from default group

obj.removeHandles("handle-group");
obj.removeHandles("other-handle-group");

render

Inherited
Method
render(){Object}
Inherited from Widget

This method is implemented by subclasses for rendering.

Returns
Type Description
Object The rendered virtual node.

renderNow

Inherited
Method
renderNow()
Inherited from Widget

Renders widget to the DOM immediately.

scheduleRender

Inherited
Method
scheduleRender()
Inherited from Widget

Schedules widget rendering. This method is useful for changes affecting the UI.

updateFromRendererResult

Method
updateFromRendererResult(rendererResult, histogramResult)

A convenience function used to update the properties of a SizeSlider widget instance from the result of the createContinuousRenderer method. This method is useful for cases when the app allows the end user to switch data variables used to render the data.

Parameters
rendererResult ContinuousRendererResult

The result object from the createContinuousRenderer method.

histogramResult HistogramResult
optional

The result histogram object from the histogram method.

Example
const params = {
  layer: layer,
  basemap: map.basemap,
  field: "POP_POVERTY"
};

let rendererResult = null;

sizeRendererCreator
  .createContinuousRenderer(colorParams)
  .then(function(response) {
    rendererResult = response;
    layer.renderer = response.renderer;

    return histogram({
      layer: layer,
      valueExpression: params.field,
      numBins: 30
    });
  })
   .then(function(histogramResult) {
     sizeSlider.updateFromRendererResult(rendererResult, histogramResult);
   })
   .catch(function(error) {
     console.log("there was an error: ", error);
   });

updateVisualVariable

Method
updateVisualVariable(sizeVariable){SizeVariable}

A convenience function used to update the SizeVariable to match the values of the stops on the slider.

This is particularly useful for Size visual variables that have a set minDataValue and maxDataValue. This method will properly reconstruct the variable to set on the renderer so it matches the stops on the slider.

Parameter
sizeVariable SizeVariable

The size visual variable from the renderer to update to the set stops on the slider.

Returns
Type Description
SizeVariable Returns the updated visual variable to set back on the renderer.
Example
sizeSlider.on(["thumb-change", "thumb-drag"], function() {
  const renderer = layer.renderer.clone();
  const sizeVariable = renderer.visualVariables[0];
  renderer.visualVariables = [ sizeSlider.updateVisualVariable( sizeVariable ) ];
  layer.renderer = renderer;
});

when

Inherited
Method
when(callback, errback){Promise}
Inherited from Widget
Since: ArcGIS Maps SDK for JavaScript 4.19 Widget since 4.2, when added at 4.19.

when() may be leveraged once an instance of the class is created. This method takes two input parameters: a callback function and an errback function. The callback executes when the instance of the class loads. The errback executes if the instance of the class fails to load.

Parameters
callback Function
optional

The function to call when the promise resolves.

errback Function
optional

The function to execute when the promise fails.

Returns
Type Description
Promise Returns a new Promise for the result of callback.
Example
// Although this example uses the BasemapGallery widget, any class instance that is a promise may use when() in the same way
let bmGallery = new BasemapGallery();
bmGallery.when(function(){
  // This function will execute once the promise is resolved
}, function(error){
  // This function will execute if the promise is rejected due to an error
});

Event Overview

Show inherited events Hide inherited events
Name Type Summary Class
{oldValue: Number,type: "max-change",value: Number}

Fires when a user changes the max of the slider.

SmartMappingSliderBase
{oldValue: Number,type: "min-change",value: Number}

Fires when a user changes the min of the slider.

SmartMappingSliderBase
{index: Number,state: "start"|"drag",type: "segment-drag",thumbIndices: Number[]}

Fires when a user drags a segment of the slider.

SmartMappingSliderBase
{index: Number,oldValue: Number,type: "thumb-change",value: Number}

Fires when a user changes the value of a thumb via arrow keys and keyboard editing of the label on the widget.

SmartMappingSliderBase
{index: Number,state: "start"|"drag",type: "thumb-drag",value: Number}

Fires when a user drags a thumb on the widget.

SmartMappingSliderBase

Event Details

max-change

Inherited
Event
max-change
Inherited from SmartMappingSliderBase

Fires when a user changes the max of the slider.

Properties
oldValue Number

The former max (or bound) of the slider.

type String

The type of the event.

The value is always "max-change".

value Number

The value of the max (or bound) of the slider when the event is emitted.

Example
slider.on("max-change", function() {
  const renderer = layer.renderer.clone();
  const visualVariable = renderer.visualVariables[0].clone();
  colorVariable.stops = slider.stops;
  renderer.visualVariables = [ visualVariable ];
  layer.renderer = renderer;
});

min-change

Inherited
Event
min-change
Inherited from SmartMappingSliderBase

Fires when a user changes the min of the slider.

Properties
oldValue Number

The former min value (or bound) of the slider.

type String

The type of the event.

The value is always "min-change".

value Number

The value of the min value (or bound) of the slider when the event is emitted.

Example
slider.on("min-change", function() {
  const renderer = layer.renderer.clone();
  const visualVariable = renderer.visualVariables[0].clone();
  colorVariable.stops = slider.stops;
  renderer.visualVariables = [ visualVariable ];
  layer.renderer = renderer;
});

segment-drag

Inherited
Event
segment-drag
Inherited from SmartMappingSliderBase
Since: ArcGIS Maps SDK for JavaScript 4.20 SmartMappingSliderBase since 4.12, segment-drag added at 4.20.

Fires when a user drags a segment of the slider. A segment is the portion of the track that lies between two thumbs. This is only applicable when visibleElements.interactiveTrack is true.

Properties
index Number

The 1-based index of the segment in the slider.

state String

The state of the drag.

Possible Values:"start"|"drag"

type String

The type of the event.

The value is always "segment-drag".

thumbIndices Number[]

The indices of the thumbs on each end of the segment.

See also
Example
slider.on("segment-drag", () => {
  const renderer = layer.renderer.clone();
  const visualVariable = renderer.visualVariables[0].clone();
  colorVariable.stops = slider.stops;
  renderer.visualVariables = [ visualVariable ];
  layer.renderer = renderer;
});

thumb-change

Inherited
Event
thumb-change
Inherited from SmartMappingSliderBase

Fires when a user changes the value of a thumb via arrow keys and keyboard editing of the label on the widget.

Properties
index Number

The 0-based index of the thumb emitting the event.

oldValue Number

The former value of the thumb before the change was made.

type String

The type of the event.

The value is always "thumb-change".

value Number

The value of the thumb when the event is emitted.

Example
slider.on("thumb-change", function() {
  const renderer = layer.renderer.clone();
  const visualVariable = renderer.visualVariables[0].clone();
  colorVariable.stops = slider.stops;
  renderer.visualVariables = [ visualVariable ];
  layer.renderer = renderer;
});

thumb-drag

Inherited
Event
thumb-drag
Inherited from SmartMappingSliderBase

Fires when a user drags a thumb on the widget.

Properties
index Number

The 0-based index of the thumb emitting the event.

state String

The state of the drag.

Possible Values:"start"|"drag"

type String

The type of the event.

The value is always "thumb-drag".

value Number

The value of the thumb when the event is emitted.

Example
slider.on("thumb-drag", function() {
  const renderer = layer.renderer.clone();
  const visualVariable = renderer.visualVariables[0].clone();
  colorVariable.stops = slider.stops;
  renderer.visualVariables = [ visualVariable ];
  layer.renderer = renderer;
});

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