ColorSizeSlider

require(["esri/widgets/smartMapping/ColorSizeSlider"], function(ColorSizeSlider) { /* code goes here */ });

Class: esri/widgets/smartMapping/ColorSizeSlider

Inheritance: ColorSizeSlider SmartMappingSliderBase Widget Accessor

Since: ArcGIS API for JavaScript 4.12

The ColorSizeSlider widget is intended for authoring and exploring data-driven visualizations in any layer that can be rendered with a ColorVariable and a SizeVariable. Both visual variables should be used to visualize the same data variable.

This slider and visualization style is designed specifically for 3D thematic visualizations where both size and color are used to visualize the same data variable in order to minimize confusion because of distortion in perception. For example, a visualization of extruded points may be difficult to understand if two features of similar sizes (and therefore data values) are located far apart from one another; the feature furthest from the Camera will appear smaller than the feature closer to the camera. The color variable can help the user understand that both features have similar values.

ColorSizeSlider with perspective

At a minimum you must set the min, max, and stops properties of the widget. The stops are used to render a color gradient on the track of the slider.

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

ColorSizeSlider with annotations

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

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

let rendererResult = null;

univariateColorSizeRendererCreator
  .createContinuousRenderer(params)
  .then(function(response) {
    rendererResult = response;
    layer.renderer = response.renderer;

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

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

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

slider.on(["thumb-change", "thumb-drag"], function() {
  const renderer = layer.renderer.clone();
  renderer.visualVariables = slider.updateVisualVariables( renderer.visualVariables );
  layer.renderer = renderer;
});

For information about gaining full control of widget styles, see the Styling topic.

See also:

Constructors

new ColorSizeSlider(properties)

Parameter:

properties Object

optional

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

Example:

const slider = new ColorSizeSlider({
  min: 0,
  max: 100,
  stops: [
    { value: 25, color: "white", size: 1000 },
    { value: 75, color: "dodgerblue", size: 100000 }
  ]
});

Property Overview

Any properties can be set, retrieved or listened to. See the Working with Properties topic.

Show inherited properties Hide inherited properties

Type	Summary	Class
String\|HTMLElement	The ID or node representing the DOM element containing the widget. more details	more details	Widget
String	The name of the class. more details	more details	Accessor
Boolean	When `true`, this property indicates whether the widget has been destroyed. more details	more details	Widget
HistogramConfig	The Histogram associated with the data represented on the slider. more details	more details	SmartMappingSliderBase
String	The unique ID assigned to the widget when the widget is created. more details	more details	Widget
LabelFormatter	A function used to format user inputs. more details	more details	SmartMappingSliderBase
InputParser	Function used to parse slider inputs formatted by the inputFormatFunction. more details	more details	SmartMappingSliderBase
String	The widget's default label. more details	more details	ColorSizeSlider
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 details	SmartMappingSliderBase
Number	The maximum value or upper bound of the slider. more details	more details	SmartMappingSliderBase
Number	The minimum value or lower bound of the slider. more details	more details	SmartMappingSliderBase
Number	Defines how slider thumb values should be rounded. more details	more details	SmartMappingSliderBase
String	The state of the view model. more details	more details	SmartMappingSliderBase
ColorSizeStop []	The colors and sizes corresponding with data values in the ColorVariable and SizeVariable of the renderer associated with the slider. more details	more details	ColorSizeSlider
ColorSizeSliderViewModel	The view model for the ColorSizeSlider widget. more details	more details	ColorSizeSlider
Object	Zooms the slider track to the bounds provided in this property. more details	more details	SmartMappingSliderBase

Property Details

container String|HTMLElement inherited

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.

destroyed Boolean inherited

When true, this property indicates whether the widget has been destroyed.

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

id String inherited

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:

inputParseFunction

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:

inputFormatFunction

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

max Number inherited

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 Number inherited

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"

stops ColorSizeStop []

The colors and sizes corresponding with data values in the ColorVariable and SizeVariable of the renderer associated with the slider.

Use the fromRendererResult() method to conveniently construct these stops from a renderer generated from the univariateColorSize smart mapping module.

Use updateVisualVariables() to update the renderer's visual variables with the values matching the slider thumb positions.

See also:

fromRendererResult()
updateVisualVariables()

Example:

slider.stops = [
  { value: 25, color: "white", size: 1000 },
  { value: 75, color: "dodgerblue", size: 100000 }
];

viewModel ColorSizeSliderViewModel

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

zoomOptions Object inherited

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

Return Type	Summary	Class
String	A utility method used for building the value for a widget's `class` property. more details	more details	Widget
	Destroys the widget instance. more details	more details	Widget
Boolean	Emits an event on the instance. more details	more details	Widget
ColorSizeSlider	A convenience function used to create a ColorSizeSlider widget instance from the result of the univariateColorSize.createContinuousRenderer() method. more details	more details	ColorSizeSlider
Boolean	Indicates whether there is an event listener on the instance that matches the provided event name. more details	more details	Widget
Object	Registers an event handler on the instance. more details	more details	Widget
	Widget teardown helper. more details	more details	Widget
	This method is primarily used by developers when implementing custom widgets. more details	more details	Widget
Object	This method is primarily used by developers when implementing custom widgets. more details	more details	Widget
	Renders widget to the DOM immediately. more details	more details	Widget
	This method is primarily used by developers when implementing custom widgets. more details	more details	Widget
	A convenience function used to update the properties of a ColorSizeSlider widget instance from the result of the univariateColorSize.createContinuousRenderer() method. more details	more details	ColorSizeSlider
Array<(ColorVariable\|SizeVariable)>	A convenience function used to update the visual variables of a renderer generated with the univariateColorSize.createContinuousRenderer() method with the values obtained from the slider. more details	more details	ColorSizeSlider

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:

Type	Description
String	The computed class name.

See also:

Guide - Widget development (rendering)

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:

Type	Description
Boolean	`true` if a listener was notified

fromRendererResult(rendererResult, histogramResult){ColorSizeSlider}static

A convenience function used to create a ColorSizeSlider widget instance from the result of the univariateColorSize.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
ColorSizeSlider	Returns a ColorSizeSlider instance. This will not render until you assign it a valid container.

Example:

var params = {
  layer: layer,
  basemap: map.basemap,
  field: "POP",
  view: view,
  symbolType: "3d-volumetric",
  min: 0,
  max: 500000
};
colorAndSizeRendererCreator
  .createContinuousRenderer(params)
  .then(function(response) {
    // set generated renderer on the layer and add it to the map
    rendererResult = response;
    layer.renderer = response.renderer;

    return histogram({
      layer: layer,
      field: params.field,
      numBins: 70,
      maxValue: params.max,
      minValue: params.min
    });
  })
  .then(function(histogramResult) {
    var slider = ColorSizeSlider.fromRendererResult(rendererResult, histogramResult);
    slider.container = "slider";
  });

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:

Type	Description
Boolean	Returns 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:

type String|String []

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

listener Function

The function to call when the event is fired.

Returns:

Type Description

Object

Returns an event handler with a remove() method that can 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(handles)inherited

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

Parameter:

handles WatchHandle|WatchHandle []

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:

Type	Description
Object	The 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.

updateFromRendererResult(rendererResult, histogramResult)

A convenience function used to update the properties of a ColorSizeSlider widget instance from the result of the univariateColorSize.createContinuousRenderer() method.

Parameters:

rendererResult ContinuousRendererResult

The result object from the createContinuousRenderer method.

histogramResult HistogramResult

optional

The result histogram object from the histogram method.

Example:

var params = {
  layer: layer,
  basemap: map.basemap,
  field: "POP",
  view: view,
  symbolType: "3d-volumetric",
  minValue: 0,
  maxValue: 500000
};
colorAndSizeRendererCreator
  .createContinuousRenderer(params)
  .then(function(response) {
    // set generated renderer on the layer and add it to the map
    rendererResult = response;
    layer.renderer = response.renderer;

    return histogram({
      layer: layer,
      field: params.field,
      numBins: 70,
      maxValue: params.maxValue,
      minValue: params.minValue
    });
  })
  .then(function(histogramResult) {
    slider.fromRendererResult(rendererResult, histogramResult);
  });

updateVisualVariables(variables){Array<(ColorVariable|SizeVariable)>}

A convenience function used to update the visual variables of a renderer generated with the univariateColorSize.createContinuousRenderer() method with the values obtained from the slider. This method is useful for cases when the app allows the end user to switch data variables used to render the data.

Parameter:

variables Array<(ColorVariable|SizeVariable)>

The visual variables to update from the renderer associated with the slider. The properties of the color and size variables will update based on the slider thumb values.

Returns:

Type	Description
Array<(ColorVariable\|SizeVariable)>	Returns the input visual variables updated to match the current slider values. These should be set directly back to the renderer where they came from.

Example:

slider.on(["thumb-change", "thumb-drag"], function() {
  const renderer = layer.renderer.clone();
  renderer.visualVariables = slider.updateVisualVariables( renderer.visualVariables );
  layer.renderer = renderer;
});

Type Definitions

ColorSizeStop

Defines the object specification for each stops.

Properties:

color Color

Features with the given stop value will be rendered with the associated color.

label String

optional

Label describing the given value.

size Number

Features with the given stop value will be rendered with the associated size.

value Number

The data value associated with the given color and size.

Event Overview

Show inherited events Hide inherited events

Type	Summary	Class
{oldValue: Number,type: "max-change",value: Number}	Fires when a user changes the max of the slider. more details	more details	SmartMappingSliderBase
{oldValue: Number,type: "min-change",value: Number}	Fires when a user changes the min of the slider. more details	more details	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. more details	more details	SmartMappingSliderBase
{index: Number,state: "start","drag",type: "thumb-drag",value: Number}	Fires when a user drags a thumb on the widget. more details	more details	SmartMappingSliderBase

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

	Site wide shortcuts
`?`	Bring up this help dialog
`esc`	Dismiss this help dialog
`gh`	Go to Home
`gg`	Go to Guide
`ga`	Go to API Reference
`gs`	Go to Sample Code
`gt`	Scroll to top of page
`spacebar`	Scroll page down
`shift spacebar`	Scroll page up
`gb`	Scroll to bottom of page

	API Reference
`/`	Focus search
`esc`	Remove search focus
`enter`	Focus first search result
`c`	Go to Constructors
`p`	Go to Properties
`m`	Go to Methods
`t`	Go to Type definitions
`e`	Go to Events

JavaScript API 4.14 API Reference

JavaScript API API Reference

ColorSizeSlider

ColorSizeSlider

Constructors

Property Overview

Property Details

Method Overview

Method Details

Type Definitions

Event Overview

Event Details

JavaScript API 4.14 API Reference

JavaScript API API Reference

Constructors

Property Overview

Property Details

Method Overview

Method Details

Type Definitions

Event Overview

Event Details

API Reference search results