Free cookie consent management tool by TermsFeed

Multiple Dropdown By Index Component

Function
Copy link to clipboard

a!multipleDropdownFieldByIndex( label, labelPosition, instructions, required, disabled, placeholder, choiceLabels, value, validations, saveInto, validationGroup, requiredMessage, helpTooltip, accessibilityText, showWhen, searchDisplay )

Displays a list of choices for the user to select multiple items and saves the indices of the selected choices. To save a value instead of the index, use a multiple dropdown component.

Parameters
Copy link to clipboard

Name Keyword Types Description

Label

label

Text

Text to display as the field label.

Label Position

labelPosition

Text

Determines where the label appears. Valid values:

  • "ABOVE" (default) Displays the label above the component.
  • "ADJACENT" Displays the label to the left of the component.
  • "COLLAPSED" Hides the label. The label will still be read by screen readers; see accessibility considerations for more information.
  • "JUSTIFIED" Aligns the label alongside the component starting at the edge of the page.

Instructions

instructions

Text

Supplemental text about this field.

Required

required

Boolean

Determines if a value is required to submit the form. Default: false.

Disabled

disabled

Boolean

Determines if the field should display as potentially editable but grayed out. Default: false.

Placeholder

placeholder

Text

Text to display in the field when it is empty.

Choice Labels

choiceLabels

List of Text String

Array of options for the user to select.

Selected Indices

value

List of Number (Integer)

Indices of choices to display as selected.

Validations

validations

List of Text String

Validation errors to display below the field when the value is not null.

Save Selection To

saveInto

List of Save

One or more variables that are updated with the choice indexes when the user changes the selections. Use a!save() to save a modified or alternative value to a variable.

Validation Group

validationGroup

Text

When present, the requiredness of the field is only evaluated when a button in the same validation group is pressed. The value for this parameter cannot contain spaces. For example, “validation group” is not a valid value. You need to add an underscore between words: “validation_group”. See the following recipes for more information:

Required Message

requiredMessage

Text

Custom message to display when the field's value is required and not provided.

Help Tooltip

helpTooltip

Text

Displays a help icon with the specified text as a tooltip. The tooltip displays a maximum of 500 characters. The help icon does not show when the label position is "COLLAPSED".

Accessibility Text

accessibilityText

Text

Additional text to be announced by screen readers. Used only for accessibility; produces no visible change.

Visibility

showWhen

Boolean

Determines whether the component is displayed on the interface. When set to false, the component is hidden and is not evaluated. Default: true.

Search Display

searchDisplay

Text

Determines when a search box displays above the options. Valid values: "AUTO" (default), "ON", "OFF". When set to "AUTO", the search box displays if there are more than 11 options.

Usage considerations
Copy link to clipboard

Using the selectedIndices parameter
Copy link to clipboard

  • The indices passed to the selectedIndices parameter display as selected by default. If null is passed to selectedIndices, none of the options are selected. However, if a list is passed to selectedIndices, it cannot contain a null value.
  • Choice index numbers start at 1. Indices passed selectedIndices cannot be less than 1 or greater than the length of the choiceLabels array.
  • If a single item is selected, the system saves a single-item array.

Using the choiceLabels parameters
Copy link to clipboard

  • Options display in the same order as defined in the choiceLabels parameter. The choiceLabels argument cannot be null.

Saving and clearing values
Copy link to clipboard

  • If no selection is made or the selection is cleared, the system saves a null value into the component's Save Selection To field.
  • Users can always clear the value using the x icon on web or the Clear link on the mobile application.

Examples
Copy link to clipboard

Use the interactive editor below to test out your code:

Multiple dropdown by index with initial values
Copy link to clipboard

Feature compatibility
Copy link to clipboard

The table below lists this component's compatibility with various features in Appian.
Feature Compatibility Note
Portals Compatible
Offline Mobile Compatible
Sync-Time Custom Record Fields Incompatible
Real-Time Custom Record Fields Incompatible

Custom record fields that evaluate in real time must be configured using one or more Custom Field functions.
Process Reports Incompatible

Cannot be used to configure a process report.
Process Events Incompatible

Cannot be used to configure a process event node, such as a start event or timer event.
Process Autoscaling Compatible

Old versions
Copy link to clipboard

There are older versions of this interface component. You can identify older versions by looking at the name to see if there is a version suffix. If you are using an old version, be sure to refer to the corresponding documentation from the list below.

Old Versions Reason for Update
a!multipleDropdownFieldByIndex_20r2

Added an optional search box.

To learn more about how Appian handles this kind of versioning, see the Function and Component Versions page.

Feedback
Copy link to clipboard