SwitchInput | References | ArcGIS Maps SDK for JavaScript

import SwitchInput from "@arcgis/core/form/elements/inputs/SwitchInput.js";

Inheritance:: SwitchInput→Input→Accessor

Since: ArcGIS Maps SDK 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. This FieldElement.input is used in field elements that are set within a feature layer's or FeatureForm's formTemplate. This is displayed within the Editor widget.

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

Constructor

Parameters

Parameter	Type	Description	Required
properties	`SwitchInputProperties`

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

Properties

Any properties can be set, retrieved or listened to. See the Watch for changes topic.

Property	Type	Class
`declaredClass` readonly inherited	`string`	Accessor
`offValue`	`CodedValue["code"]`
`onValue`	`CodedValue["code"]`
`type` readonly	`"switch"`

declaredClass

readonlyinherited Property

Type: string

Inherited from: Accessor

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

offValue

autocast Property

Type: CodedValue["code"]

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

onValue

autocast Property

Type: CodedValue["code"]

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

type

readonly Property

Type: "switch"

The type of form element input.

Methods

Method	Signature	Class
`fromJSON` inherited static	`fromJSON(json: any): any`	JSONSupportMixin
`toJSON` inherited	`toJSON(): any`	JSONSupportMixin

fromJSON

inheritedstatic Method

Signature: fromJSON (json: any): any

Inherited from: JSONSupportMixin

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.

Parameters

Parameter	Type	Description	Required
json	`any`	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: any
Returns a new instance of this class.

toJSON

inherited Method

Signature: toJSON (): any

Inherited from: JSONSupportMixin

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

Returns: any
The ArcGIS portal JSON representation of an instance of this class.