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.
- See also:
// 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 Objectoptional
See the properties for a list of all the properties that may be passed into the constructor.
Property Overview
| Name | Type | Summary | Class | |
|---|---|---|---|---|
| String | more details The name of the class. | more details | Accessor | |
| String | more details The text used to represent a null value. | more details | RadioButtonsInput | |
| Boolean | more details Determines whether a null value option is displayed. | more details | RadioButtonsInput | |
| String | more details The type of form element input. | more details | RadioButtonsInput |
Property Details
-
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 | |
|---|---|---|---|---|
| * | more details Creates a new instance of this class and initializes it with values from a JSON object generated from an ArcGIS product. | more details | RadioButtonsInput | |
| more details Adds one or more handles which are to be tied to the lifecycle of the object. | more details | Accessor | ||
| Object | more details Converts an instance of this class to its ArcGIS portal JSON representation. | more details | RadioButtonsInput |
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
jsonparameter 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 ObjectA 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.
-
own(handleOrHandles)inheritedSince: ArcGIS API for JavaScript 4.24
-
Adds one or more handles which are to be tied to the lifecycle of the object. The handles will be removed when the object is destroyed.
// Manually manage handles const handle = reactiveUtils.whenOnce(() => !view.updating) .then(() => { wkidSelect.disabled = false; }); handle.remove(); // Assign a handle using own() this.own(reactiveUtils.whenOnce(() => !view.updating) .then(() => { wkidSelect.disabled = false; }));Parameter:handleOrHandles WatchHandle|WatchHandle[]Handles marked for removal once the object is destroyed.
-
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.