SwitchInput

AMD: require(["esri/form/elements/inputs/SwitchInput"], (SwitchInput) => { /* code goes here */ });
ESM: import SwitchInput from "@arcgis/core/form/elements/inputs/SwitchInput";
Class: esri/form/elements/inputs/SwitchInput
Inheritance: SwitchInput Accessor
Since: ArcGIS API for JavaScript 4.20

The SwitchInput class defines the desired user interface for a binary switch or toggle. This should be used when selecting between two options.

Coded-value domains are required when using this input type.

form field element switch input

See also:
Example:
// Creates a new Switch input for a field element within a form
const switchInput = new SwitchInput({
  offValue: "No",
  onValue: "Yes"
});

Constructors

new SwitchInput(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.
Show inherited properties Hide inherited properties
Name Type Summary Class
Stringmore details

The name of the class.

more detailsAccessor
String|Numbermore details

Coded value used when the switch state is turned off.

more detailsSwitchInput
String|Numbermore details

Coded value used when the switch state is turned on.

more detailsSwitchInput
Stringmore details

The type of form element input.

more detailsSwitchInput

Property Details

declaredClass Stringreadonly inherited

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

offValue String|Number

Coded value used when the switch state is turned off. This value can be of either a string or number.

onValue String|Number

Coded value used when the switch state is turned on. This value can be of either a string or number.

type Stringreadonly

The type of form element input.

For SwitchInput the type is always "switch".

Method Overview

Name Return Type Summary Class
*more details

Creates a new instance of this class and initializes it with values from a JSON object generated from an ArcGIS product.

more detailsSwitchInput
Objectmore details

Converts an instance of this class to its ArcGIS portal JSON representation.

more detailsSwitchInput

Method Details

fromJSON(json){*}static

Creates a new instance of this class and initializes it with values from a JSON object generated from an ArcGIS product. The object passed into the input json parameter often comes from a response to a query operation in the REST API or a toJSON() method from another ArcGIS product. See the Using fromJSON() topic in the Guide for details and examples of when and how to use this function.

Parameter:
json Object

A JSON representation of the instance in the ArcGIS format. See the ArcGIS REST API documentation for examples of the structure of various input JSON objects.

Returns:
Type Description
* Returns a new instance of this class.
toJSON(){Object}

Converts an instance of this class to its ArcGIS portal JSON representation. See the Using fromJSON() guide topic for more information.

Returns:
Type Description
Object The ArcGIS portal JSON representation of an instance of this class.

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