MultipleChoiceInput | References | ArcGIS Maps SDK for JavaScript

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

const MultipleChoiceInput = await $arcgis.import("@arcgis/core/form/elements/inputs/MultipleChoiceInput.js");

Inheritance: MultipleChoiceInput→Input→Accessor

Since: ArcGIS Maps SDK for JavaScript 5.1

The MultipleChoiceInput class defines the desired user interface for a multiple choice group input. 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.

See also

FieldElement

Example

// Creates a new multiple choice input for a field element within a form
const multipleChoiceInput = new MultipleChoiceInput({
  includeSelectAllChoices: true,
  otherChoice: {
    fieldName: "other",
    label: "Other",
    hint: "Provide additional details"
  },
  minimumChoices: 1,
  maximumChoices: 3,
  choices: [
    { label: "Option 1", value: "option1" },
    { label: "Option 2", value: "option2" },
    { label: "Option 3", value: "option3" }
  ]
});

Constructors

Constructor

Parameters

Parameter	Type	Description	Required
properties	MultipleChoiceInputProperties

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
choiceDelimiter	string
choices	Choice[]
declaredClass readonly inherited	string	Accessor
includeSelectAllChoices	boolean \| null \| undefined
maximumChoices	number \| null \| undefined
minimumChoices	number \| null \| undefined
otherChoice	OtherChoice \| null \| undefined
type readonly	"multiple-choice"

choiceDelimiter

Property

Type: string

Defines the delimiter used to separate multiple selected choice values.

Default value: ","

choices

autocast Property

Type: Choice[]

An array of available choices.

declaredClass

readonlyinherited Property

Type: string

Inherited from: Accessor

Since: ArcGIS Maps SDK for JavaScript 4.7

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

includeSelectAllChoices

Property

Type: boolean | null | undefined

Indicates whether a select all choice should be displayed.

maximumChoices

Property

Type: number | null | undefined

The maximum number of choices allowed.

minimumChoices

Property

Type: number | null | undefined

The minimum number of choices required.

otherChoice

autocast Property

Type: OtherChoice | null | undefined

The configuration for the other choice.

type

readonly Property

Type: "multiple-choice"

The type of form element input.

Methods

Method	Signature	Class
fromJSON inherited static	fromJSON(json: any): any	JSONSupportMixin
clone	clone(): MultipleChoiceInput
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.

clone

Method

Signature: clone (): MultipleChoiceInput

Creates a deep clone of the MultipleChoiceInput class.

Returns: MultipleChoiceInput
A deep clone of the MultipleChoiceInput instance.

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.