Skip To ContentArcGIS for DevelopersSign In Dashboard

ClassedSizeSlider

require(["esri/widgets/smartMapping/ClassedSizeSlider"], function(ClassedSizeSlider) { /* code goes here */ });
Class: esri/widgets/smartMapping/ClassedSizeSlider
Inheritance: ClassedSizeSlider SmartMappingSliderBase Widget Accessor
Since: ArcGIS API for JavaScript 4.12

The ClassedSizeSlider widget is designed for authoring and exploring data-driven visualizations in any layer that can be rendered with size in a ClassBreaksRenderer. At a minimum you must set the breaks property of the widget. The breaks are used to set the slider's thumbs.

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

ClassedSizeSlider with annotations

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

const params = {
  layer: layer,
  basemap: map.basemap,
  valueExpression: "( $feature.POP_POVERTY / $feature.TOTPOP_CY ) * 100",
  view: view,
  classificationMethod: "equal-interval"
};

let rendererResult = null;

sizeRendererCreator
  .createClassBreaksRenderer(params)
  .then(function(response) {
    rendererResult = response;
    layer.renderer = response.renderer;

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

This slider should be used to update the classBreaks in a ClassBreaksRenderer. It is the responsibility of the app developer to set up event listeners on this slider that update the breaks of the appropriate renderer.

// when the user slides the handle(s), update the renderer
// with the updated class breaks

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

Constructors

new ClassedSizeSlider(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.
NameTypeSummaryClass
Object[]

An array of class breaks with associated sizes.

more details
more detailsClassedSizeSlider
String|HTMLElement

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

more details
more detailsWidget
String

The name of the class.

more details
more detailsAccessor
HistogramConfig

The Histogram associated with the data represented on the slider.

more details
more detailsSmartMappingSliderBase
String

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

more details
more detailsWidget
LabelFormatter

A function used to format user inputs.

more details
more detailsSmartMappingSliderBase
InputParser

Function used to parse slider inputs formatted by the inputFormatFunction.

more details
more detailsSmartMappingSliderBase
String

The widget's default label.

more details
more detailsClassedSizeSlider
LabelFormatter

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

more details
more detailsSmartMappingSliderBase
Number

The maximum value or upper bound of the slider.

more details
more detailsSmartMappingSliderBase
Number

The minimum value or lower bound of the slider.

more details
more detailsSmartMappingSliderBase
Number

Defines how slider thumb values should be rounded.

more details
more detailsSmartMappingSliderBase
String

The state of the view model.

more details
more detailsSmartMappingSliderBase
Object

Exposes various properties of the widget that can be styled.

more details
more detailsClassedSizeSlider
ClassedSizeSliderViewModel

The view model for the ClassedSizeSlider widget.

more details
more detailsClassedSizeSlider

Property Details

breaks Object[]

An array of class breaks with associated sizes. The size mapped to each break should be used to update the renderer of a layer. A minimum of two breaks must be provided to the slider.

Properties:
size Number

The size in points of the symbol representing features with values within the given min and max.

max Number

The max value of the break. The max of each break should match the min value of the break directly above it.

min Number

The min value of the break. The min of each break should match the max value of the break directly below it.

Example:
slider.breaks = [{
  min: 0,
  max: 20,
  size: 6
}, {
  min: 20,
  max: 40,
  size: 12
}, {
  min: 40,
  max: 60,
  size: 24
}, {
  min: 60,
  max: 80,
  size: 48
}];

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 cases 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 Stringreadonly inherited

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

histogramConfig HistogramConfig inherited

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
  };
});

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 LabelFormatter inherited
Since: ArcGIS API for JavaScript 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.

See also:
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 InputParser inherited
Since: ArcGIS API for JavaScript 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.

See also:
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){
  var charLength = value.length;
  var valuePrefix = parseFloat(value.substring(0,charLength-1));
  var 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 String

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

labelFormatFunction LabelFormatter inherited

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;
}

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;

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;
precision Number inherited
Since: ArcGIS API for JavaScript 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;
state Stringreadonly inherited

The state of the view model.

Possible Values:"ready"|"disabled"

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])
};

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

Method Overview

NameReturn TypeSummaryClass
String

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

more details
more detailsWidget

Destroys the widget instance.

more details
more detailsWidget
Boolean

Emits an event on the instance.

more details
more detailsWidget
ClassedSizeSlider

A convenience function used to create a ClassedSizeSlider widget from the result of the createClassBreaksRenderer() method.

more details
more detailsClassedSizeSlider
Boolean

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

more details
more detailsWidget
Object

Registers an event handler on the instance.

more details
more detailsWidget

Widget teardown helper.

more details
more detailsWidget

This method is primarily used by developers when implementing custom widgets.

more details
more detailsWidget
Object

This method is primarily used by developers when implementing custom widgets.

more details
more detailsWidget

Renders widget to the DOM immediately.

more details
more detailsWidget

This method is primarily used by developers when implementing custom widgets.

more details
more detailsWidget
ClassBreakInfo[]

A convenience function used to update the classBreakInfos of a ClassBreaksRenderer associated with this slider.

more details
more detailsClassedSizeSlider

A convenience function used to update the properties a ClassedSizeSlider from the result of the createClassBreaksRenderer() method.

more details
more detailsClassedSizeSlider

Method Details

classes(classNames){String}inherited

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

Parameter:
classNames Array<(string|Array<string>|Object)>
repeatable

The class names.

Returns:
TypeDescription
StringThe computed class name.
See also:
Example:
// .tsx syntax showing how to set CSS classes while rendering the widget

render() {
  const dynamicIconClasses = {
    [CSS.myIcon]: this.showIcon,
    [CSS.greyIcon]: !this.showIcon
  };

  return (
    <div class={classes(CSS.root, CSS.mixin, dynamicIconClasses)} />
  );
}
destroy()inherited

Destroys the widget instance.

emit(type, event){Boolean}inherited

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:
TypeDescription
Booleantrue if a listener was notified
fromRendererResult(rendererResult, histogramResult){ClassedSizeSlider}static

A convenience function used to create a ClassedSizeSlider widget from the result of the createClassBreaksRenderer() method.

Parameters:

The result object from the createClassBreaksRenderer method.

histogramResult HistogramResult
optional

The result histogram object from the histogram method.

Returns:
TypeDescription
ClassedSizeSliderReturns a ClassedSizeSlider instance. This will not render until you assign it a valid container.
Example:
const params = {
  layer: layer,
  basemap: map.basemap,
  valueExpression: "( $feature.POP_POVERTY / $feature.TOTPOP_CY ) * 100",
  view: view,
  classificationMethod: "equal-interval"
};

let rendererResult = null;

sizeRendererCreator
  .createClassBreaksRenderer(params)
  .then(function(response) {
    rendererResult = response;
    layer.renderer = response.renderer;

    return histogram({
      layer: layer,
      valueExpression: params.valueExpression,
      view: view,
      numBins: 70
    });
  })
   .then(function(histogramResult) {
     const slider = ClassedSizeSlider.fromRendererResult(rendererResult, histogramResult);
     slider.container = "slider";
   })
   .catch(function(error) {
     console.log("there was an error: ", error);
   });
hasEventListener(type){Boolean}inherited

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:
TypeDescription
BooleanReturns true if the class supports the input event.
on(type, listener){Object}inherited

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

Parameters:

A event type, or an array of event types, to listen for.

listener Function

The function to call when the event is fired.

Returns:
TypeDescription
ObjectReturns an event handler with a remove() method that can be called to stop listening for the event(s).
PropertyTypeDescription
removeFunctionWhen 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(handles)inherited

Widget teardown helper. Any handles added to it will be automatically removed when the widget is destroyed.

Parameter:

Handles marked for removal once the widget is destroyed.

postInitialize()inherited

This method is primarily used by developers when implementing custom widgets. Executes after widget is ready for rendering.

render(){Object}inherited

This method is primarily used by developers when implementing custom widgets. It must be implemented by subclasses for rendering.

Returns:
TypeDescription
ObjectThe rendered virtual node.
renderNow()inherited

Renders widget to the DOM immediately.

scheduleRender()inherited

This method is primarily used by developers when implementing custom widgets. Schedules widget rendering. This method is useful for changes affecting the UI.

updateClassBreakInfos(breakInfos){ClassBreakInfo[]}

A convenience function used to update the classBreakInfos of a ClassBreaksRenderer associated with this slider.

The number of breaks from the renderer must match the number of breaks in the slider. Generally, the input breaks for this method should come from the same renderer as one used to create the slider with the fromRendererResult method.

Parameter:
breakInfos ClassBreakInfo[]

The classBreakInfos from a ClassBreaksRenderer instance to update based on the properties of the slider.

Returns:
TypeDescription
ClassBreakInfo[]The updated classBreakInfos to set on a ClassBreaksRenderer object.
Example:
slider.on(["thumb-change", "thumb-drag"], function() {
  const renderer = layer.renderer.clone();
  renderer.classBreaks = slider.updateClassBreakInfos( renderer.classBreaks );
  layer.renderer = renderer;
});
updateClassBreakInfos(rendererResult, histogramResult)

A convenience function used to update the properties a ClassedSizeSlider from the result of the createClassBreaksRenderer() method.

Parameters:

The result object from the createClassBreaksRenderer method.

histogramResult HistogramResult
optional

The result histogram object from the histogram method.

Example:
const params = {
  layer: layer,
  basemap: map.basemap,
  valueExpression: "( $feature.POP_POVERTY / $feature.TOTPOP_CY ) * 100",
  view: view,
  classificationMethod: "equal-interval"
};

let rendererResult = null;

sizeRendererCreator
  .createClassBreaksRenderer(params)
  .then(function(response) {
    rendererResult = response;
    layer.renderer = response.renderer;

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

Event Overview

NameTypeSummaryClass
{oldValue: Number,type: "max-change",value: Number}

Fires when a user changes the max of the slider.

more details
more detailsSmartMappingSliderBase
{oldValue: Number,type: "min-change",value: Number}

Fires when a user changes the min of the slider.

more details
more detailsSmartMappingSliderBase
{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.

more details
more detailsSmartMappingSliderBase
{index: Number,state: "start","drag",type: "thumb-drag",value: Number}

Fires when a user drags a thumb on the widget.

more details
more detailsSmartMappingSliderBase

Event Details

max-changeinherited

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-changeinherited

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;
});
thumb-changeinherited

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-draginherited

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;
});

API Reference search results

NameTypeModule
Loading...