Interface MultipleOption

A multiple-choice option.

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

Hierarchy (view full)

Properties

defaultValue? description? identifier label? valueLabels? values?

Properties

Optional Readonly defaultValue

defaultValue?: string

The default value of the option. If omitted, multiple options default to the top 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

defaultValuedescriptionidentifierlabelvalueLabelsvalues