import ValuePickerSlider from "@arcgis/core/widgets/ValuePicker/ValuePickerSlider.js";const ValuePickerSlider = await $arcgis.import("@arcgis/core/widgets/ValuePicker/ValuePickerSlider.js");- Inheritance:
- ValuePickerSlider→
ValuePickerBaseComponent→ Widget→ Accessor
- Since
- ArcGIS Maps SDK for JavaScript 4.27
This class represents a slider component that can be assigned to a ValuePicker.component property of a ValuePicker widget. See Using the slider component to navigate numeric values section for more information how to set this up.
Example
// Create a value picker with a slider component show percentages from 0 to 100.const valuePickerSlider = new ValuePickerSlider({ min: 0, max: 100, steps: [0, 10, 20, 30, 40, 50, 60, 70, 80, 90, 100], minorTicks: [5, 15, 25, 35, 45, 55, 65, 75, 85, 95], majorTicks: [0, 10, 20, 30, 40, 50, 60, 70, 80, 90, 100], labels: [0, 20, 40, 60, 80, 100], labelFormatFunction: (value) => `${value}%`});const valuePicker = new ValuePicker({ component: valuePickerSlider, values: [50]});Constructors
Constructor
Parameters
| Parameter | Type | Description | Required |
|---|---|---|---|
| properties | | |
Properties
container
- Type
- HTMLElement | null | undefined
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 containerconst basemapGallery = new BasemapGallery({ view: view, container: document.createElement("div")});
// Add the widget to the top-right corner of the viewview.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 viewview.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 UIconst basemapGallery = new BasemapGallery({ view: view});
// Add the widget to the top-right corner of the viewview.ui.add(basemapGallery, { position: "top-right"}); icon
Icon which represents the widget. It is typically used when the widget is controlled by another one (e.g. in the Expand widget).
- See also
labelFormatFunction
- Type
- LabelFormatFunction | null | undefined
A function used to format labels. Overrides the default label formatter.
- See also
Example
// Display a label for each step. Each label will display the value as a localized distance in abbreviated// kilometers (e.g. "90 km").const formatter = new Intl.NumberFormat(undefined, { style: "unit", unit: "kilometer" });const steps = [0, 10, 20, 30, 40, 50, 60, 70, 80, 90, 100];const valuePicker = new ValuePicker({ component: new ValuePickerSlider({ min: 0, max: 100, steps, labels: steps, labelFormatFunction: (value) => formatter.format(value) }, values: [0]}); labels
Slider tick labels.
Example
// The assigned slider ranges in value from 0 to 100%. Steps are located at every 10% however labels are spaced very 20%.const valuePicker = new ValuePicker({ component: new ValuePickerSlider({ min: 0, max: 100, steps: [0, 10, 20, 30, 40, 50, 60, 70, 80, 90, 100], labels: [0, 20, 40, 60, 80, 100], labelFormatFunction: (value) => `${value}%` }, values: [0]}); majorTicks
The positions of major ticks. Minor ticks are represented as long label-less tick marks.
Example
// Create ValuePicker with steps and minor ticks every 10 units from 0 to 100 and major ticks every 20.const valuePicker = new ValuePicker({ component: new ValuePickerSlider({ min: 0, max: 100, steps: [0, 10, 20, 30, 40, 50, 60, 70, 80, 90, 100], minorTicks: [0, 10, 20, 30, 40, 50, 60, 70, 80, 90, 100], majorTicks: [0, 20, 40, 60, 80, 100] }, values: [0]}); minorTicks
The positions of minor ticks. Minor ticks are represented as short label-less tick marks.
Example
// Create ValuePicker with steps and minor ticks every 10 units from 0 to 100.const valuePicker = new ValuePicker({ component: new ValuePickerSlider({ min: 0, max: 100, steps: [0, 10, 20, 30, 40, 50, 60, 70, 80, 90, 100], minorTicks: [0, 10, 20, 30, 40, 50, 60, 70, 80, 90, 100] }, values: [0]}); reversed
- Type
- boolean
When true, slider values will ascend right to left and bottom to top when horizontal and vertical respectively.
- Default value
- false
Example
// Create a horizontal ValuePicker with slider values in descending order.const valuePicker = new ValuePicker({ layout: "horizontal", component: new ValuePickerSlider({ min: 0, max: 100, reversed: true }, values: [0]}); steps
Positions along the slider that the thumb will snap to when interacted with.
Example
// Create a ValuePicker with a slider showing a date range from 1600 to 1900.const dates = [ new Date(1600, 0, 1), new Date(1700, 0, 1), new Date(1800, 0, 1), new Date(1900, 0, 1)];
const valuePicker = new ValuePicker({ component: new ValuePickerSlider({ min: dates[0].getTime(), max: dates[dates.length - 1].getTime(), steps: dates.map((date) => date.getTime()), labels: dates.map((date) => date.getTime()), labelFormatFunction: (epoch) => new Date(epoch).toDateString() }, values: [0]}); visible
- Type
- boolean
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 DefaultUI, 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 viewwidget.visible = false; visibleElements
This property provides the ability to display or hide the individual elements of the widget.
Example
// Create a ValuePicker widget with a slider and a thumb tooltip.const valuePicker = new ValuePicker({ component: new ValuePickerSlider({ min: 0, max: 100, visibleElements: { thumbTooltip: true } }, values: [0]});Methods
| Method | Signature | Class |
|---|---|---|
classes inherited | classes(...classNames: ((string | null | undefined) | ((string[] | Record<string, boolean>) | null | undefined) | false | null | undefined)[]): string | |
destroy inherited | destroy(): void | |
emit inherited | emit<Type extends EventNames<this>>(type: Type, event?: this["@eventTypes"][Type]): boolean | |
hasEventListener inherited | hasEventListener<Type extends EventNames<this>>(type: Type): boolean | |
isFulfilled inherited | isFulfilled(): boolean | |
isRejected inherited | isRejected(): boolean | |
isResolved inherited | isResolved(): boolean | |
on inherited | on<Type extends EventNames<this>>(type: Type, listener: EventedCallback<this["@eventTypes"][Type]>): ResourceHandle | |
postInitialize inherited | postInitialize(): void | |
render inherited | render(): any | null | |
renderNow inherited | renderNow(): void | |
scheduleRender inherited | scheduleRender(): void | |
when inherited | when<TResult1 = this, TResult2 = never>(onFulfilled?: OnFulfilledCallback<this, TResult1> | null | undefined, onRejected?: OnRejectedCallback<TResult2> | null | undefined): Promise<TResult1 | TResult2> |
classes
- Signature
-
classes (...classNames: ((string | null | undefined) | ((string[] | Record<string, boolean>) | null | undefined) | false | null | undefined)[]): string
A utility method used for building the value for a widget's class property.
This aids in simplifying css class setup.
Parameters
- Returns
- 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)} /> );} emit
- Signature
-
emit <Type extends EventNames<this>>(type: Type, event?: this["@eventTypes"][Type]): boolean
- Type parameters
- <Type extends EventNames<this>>
Emits an event on the instance. This method should only be used when creating subclasses of this class.
hasEventListener
- Signature
-
hasEventListener <Type extends EventNames<this>>(type: Type): boolean
- Type parameters
- <Type extends EventNames<this>>
Indicates whether there is an event listener on the instance that matches the provided event name.
Parameters
| Parameter | Type | Description | Required |
|---|---|---|---|
| type | Type | The name of the event. | |
- Returns
- boolean
Returns true if the class supports the input event.
isFulfilled
- Signature
-
isFulfilled (): boolean
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
- boolean
Indicates whether creating an instance of the class has been fulfilled (either resolved or rejected).
isRejected
- Signature
-
isRejected (): boolean
isRejected() may be used to verify if creating an instance of the class is rejected.
If it is rejected, true will be returned.
- Returns
- boolean
Indicates whether creating an instance of the class has been rejected.
isResolved
- Signature
-
isResolved (): boolean
isResolved() may be used to verify if creating an instance of the class is resolved.
If it is resolved, true will be returned.
- Returns
- boolean
Indicates whether creating an instance of the class has been resolved.
on
- Signature
-
on <Type extends EventNames<this>>(type: Type, listener: EventedCallback<this["@eventTypes"][Type]>): ResourceHandle
- Type parameters
- <Type extends EventNames<this>>
Registers an event handler on the instance. Call this method to hook an event with a listener.
Parameters
| Parameter | Type | Description | Required |
|---|---|---|---|
| type | Type | An event or an array of events to listen for. | |
| listener | EventedCallback<this["@eventTypes"][Type]> | The function to call when the event fires. | |
- Returns
- ResourceHandle
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);}); when
- Signature
-
when <TResult1 = this, TResult2 = never>(onFulfilled?: OnFulfilledCallback<this, TResult1> | null | undefined, onRejected?: OnRejectedCallback<TResult2> | null | undefined): Promise<TResult1 | TResult2>
when() may be leveraged once an instance of the class is created. This method takes two input parameters: an onFulfilled function and an onRejected function.
The onFulfilled executes when the instance of the class loads. The
onRejected executes if the instance of the class fails to load.
Parameters
| Parameter | Type | Description | Required |
|---|---|---|---|
| onFulfilled | OnFulfilledCallback<this, TResult1> | null | undefined | The function to call when the promise resolves. | |
| onRejected | The function to execute when the promise fails. | |
- Returns
- Promise<TResult1 | TResult2>
Returns a new promise for the result of
onFulfilledthat may be used to chain additional functions.
Example
// Although this example uses MapView, any class instance that is a promise may use when() in the same waylet view = new MapView();view.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});