RadioButtonsInput

require(["esri/form/elements/inputs/RadioButtonsInput"], function(RadioButtonsInput) { /* code goes here */ });
Class: esri/form/elements/inputs/RadioButtonsInput
Inheritance: RadioButtonsInput Accessor
Since: ArcGIS API for JavaScript 4.19

The RadioButtonsInput class defines the desired user interface for a radio button group.

Coded-value domains are required when using this input type. Previously, fields containing values that weren't compatible with their associated coded-value domain(s) displayed the option and would remove it once a user updated the value. The RadioButtonsInput will now keep the value, but it will not display an option in the user interface.

form field element radio buttons input

See also:
Example:
// Creates a new Radio buttons input for a field element within a form
const radioButtonsInput = new RadioButtonsInput({
  noValueOptionLabel: "Unknown",
  showNoValueOption: true
});

Constructors

new RadioButtonsInput(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
String

The name of the class.

more details
more detailsAccessor
String

The text used to represent a null value.

more details
more detailsRadioButtonsInput
Boolean

Determines whether a null value option is displayed.

more details
more detailsRadioButtonsInput
String

The type of form element input.

more details
more detailsRadioButtonsInput

Property Details

declaredClass Stringreadonly inherited

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

noValueOptionLabel String

The text used to represent a null value.

showNoValueOption Boolean

Determines whether a null value option is displayed.

This only applies to fields that support null values.

Default Value:false
type Stringreadonly

The type of form element input.

For RadioButtonsInput the type is always "radio-buttons".

Method Overview

Name Return Type Summary Class
RadioButtonsInput

Creates a deep clone of the RadioButtonsInput class.

more details
more detailsRadioButtonsInput
*

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

more details
more detailsRadioButtonsInput
Object

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

more details
more detailsRadioButtonsInput

Method Details

Creates a deep clone of the RadioButtonsInput class.

Returns:
Type Description
RadioButtonsInput A deep clone of the RadioButtonsInput instance.
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.