Interface MultipleOption

A multiple-choice option.

interface MultipleOption {
    allowNone?: boolean;
    allowOther?: boolean;
    defaultValue?: string;
    description?: LocalizableString;
    identifier: string;
    label?: LocalizableString;
    valueLabels?: readonly LocalizableString[];
    values?: readonly string[];
}

Hierarchy (view full)

Properties

allowNone? allowOther? defaultValue? description? identifier label? valueLabels? values?

Properties

Optional Readonly allowNone

allowNone?: boolean

If true, the option UI offers a "None" row in addition to the defined values, whose value is the empty string. An option with allowNone and no defaultValue defaults to None rather than to the first value.

Optional Readonly allowOther

allowOther?: boolean

If true, the UI offers an "Other…" row in addition to the defined values, allowing the user to type a value of their own.

Optional Readonly defaultValue

defaultValue?: string

The default value of the option. If omitted, multiple options default to None if allowNone is set, or else the first item in the list.

Optional Readonly description

description?: LocalizableString

An optional longer explanantion of this option, to be shown in the UI.

Readonly identifier

identifier: string

An identifying string for this option.

Optional Readonly label

label?: LocalizableString

A short label for this option.

Optional Readonly valueLabels

valueLabels?: readonly LocalizableString[]

Display names corresponding to the entries in the values array. These are shown in the option UI. If ommitted, the raw value strings are shown instead.

Optional Readonly values

values?: readonly string[]

The possible values for a multiple option.

Settings

Member Visibility

Theme

On This Page

allowNoneallowOtherdefaultValuedescriptionidentifierlabelvalueLabelsvalues