ValuePickerCombobox

AMD: require(["esri/widgets/ValuePicker/ValuePickerCombobox"], (ValuePickerCombobox) => { /* code goes here */ });
ESM: import ValuePickerCombobox from "@arcgis/core/widgets/ValuePicker/ValuePickerCombobox.js";
Class: esri/widgets/ValuePicker/ValuePickerCombobox
Since: ArcGIS Maps SDK for JavaScript 4.27

This class represents a searchable combobox list component that can be assigned to a component property of the ValuePicker widget. See Using the combobox component to present selectable items section for more information how to set this up.

Example
// Create a ValuePicker widget with a combobox component.
const valuePicker = new ValuePicker({
  component: new ValuePickerCombobox({
    placeholder: "Pick Zoning Type",
    items: [
      { value: "ind", label: "Industrial" },
      { value: "res", label: "Residential" },
      { value: "com", label: "Commercial" }
    ]
  }),
  values: ["res"]
});

Constructors

ValuePickerCombobox

Constructor
new ValuePickerCombobox(properties)
Parameter
properties Object
optional

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

Property Overview

Name Type Summary Class

An array of combobox items.

ValuePickerCombobox

Combobox label.

ValuePickerCombobox

Combobox placeholder text.

ValuePickerCombobox
For ValuePickerCombobox the type is always "combobox". ValuePickerCombobox

Property Details

items

Property
items ComboboxItem[]

An array of combobox items.

Default Value:null
Example
// Create a ValuePicker with a zip code combobox component.
const valuePicker = new ValuePicker({
  component: new ValuePickerCombobox({
    placeholder: "Pick a Zip Code",
    items: [
      { value: "90606", label: "Whittier, CA (90606)" },
      { value: "76001", label: "Arlington, TX (76001)" },
      { value: "92335", label: "Fontana, CA (92335)" }
    ]
  }),
  values: ["90606"]
});

label

Property
label String

Combobox label.

Default Value:"ValuePickerCombobox"
See also

placeholder

Property
placeholder String

Combobox placeholder text.

Default Value:null
See also

type

Property
type Stringreadonly

For ValuePickerCombobox the type is always "combobox".

Type Definitions

ComboboxItem

Type Definition
ComboboxItem Object

Object used to define the combobox item.

Properties
value String

The value of the combobox item.

label String

The label for this item that users will see in the combobox.

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