Class FormFieldValue

Record representing a form field value.

To retrieve a list of all form field values, use Instance#getFormFieldValues.

Please see our forms guide article to learn more about forms and for examples on how to set form field values.

Class

Example

Setting a form field value.

const formFieldValue = new FormFieldValue({
  name: 'Form field name',
  value: 'Form field value'
});
instance.update(formFieldValue);

Hierarchy

RecordFormFieldValue

Constructors

new FormFieldValue(args)

Parameters
args{ [key: string]: any }
Optional
Overrides (InheritableImmutableRecord as Immutable.Record.Factory<{ name?: string value?: string | Immutable.List<string> | number | null optionIndexes?: Immutable.List<number> isFitting?: boolean }>).constructor

Properties

name

string

Unique name of the form field (often referred to as fully qualified name). This name is used to link form field value to a FormFields.FormField.

optionIndexes

Optional

NutrientViewer.Immutable.List<number>

Radio buttons and checkboxes can have multiple widgets with the same form value associated, but can be selected independently. optionIndexes contains the value indexes that should be actually set.

If set, the value field doesn't get used, and the widget found at the corresponding indexes in the form field's annotationIds property are checked.

If set on fields other than radio buttons or checkboxes, setting the form value will fail.

value

string | NutrientViewer.Immutable.List<string> | null

The value of the form field.

defaultValues

Static

IObject

Immutable Record API

displayName

Static

string

The name provided to Record(values, name) can be accessed with displayName.

[iterator]

"[iterator]"(): IterableIterator<
    [
        "name"
        | "isFitting"
        | "value"
        | "optionIndexes",

            | string
            | number
            | boolean
            | NutrientViewer.Immutable.List<string>
            | NutrientViewer.Immutable.List<number>
            | null
            | undefined,
    ],
>
Returns
IterableIterator<
[
"name"
| "isFitting"
| "value"
| "optionIndexes",

| string
| number
| boolean
| NutrientViewer.Immutable.List<string>
| NutrientViewer.Immutable.List<number>
| null
| undefined
]
>
Inherited from (InheritableImmutableRecord as Immutable.Record.Factory<{ name?: string value?: string | Immutable.List<string> | number | null optionIndexes?: Immutable.List<number> isFitting?: boolean }>).[iterator]

asImmutable

asImmutable(): this
Returns
this
See Also
Map#asImmutable
Inherited from (InheritableImmutableRecord as Immutable.Record.Factory<{ name?: string value?: string | Immutable.List<string> | number | null optionIndexes?: Immutable.List<number> isFitting?: boolean }>).asImmutable

asMutable

asMutable(): this
Returns
this
See Also
Map#asMutable
Inherited from (InheritableImmutableRecord as Immutable.Record.Factory<{ name?: string value?: string | Immutable.List<string> | number | null optionIndexes?: Immutable.List<number> isFitting?: boolean }>).asMutable

clear

clear(): this
Returns a new instance of this Record type with all values set to their default values.

Returns
this
Inherited from (InheritableImmutableRecord as Immutable.Record.Factory<{ name?: string value?: string | Immutable.List<string> | number | null optionIndexes?: Immutable.List<number> isFitting?: boolean }>).clear

delete

delete<K extends "name" | "isFitting" | "value" | "optionIndexes">(key: K): this
Returns a new instance of this Record type with the value for the specific key set to its default value.

Type Parameters
Kextends "name" | "isFitting" | "value" | "optionIndexes"
Parameters
keyK
Returns
this
Inherited from (InheritableImmutableRecord as Immutable.Record.Factory<{ name?: string value?: string | Immutable.List<string> | number | null optionIndexes?: Immutable.List<number> isFitting?: boolean }>).delete

deleteIn

deleteIn(keyPath: Iterable<unknown>): this
Parameters
keyPathIterable<unknown>
Returns
this
Inherited from (InheritableImmutableRecord as Immutable.Record.Factory<{ name?: string value?: string | Immutable.List<string> | number | null optionIndexes?: Immutable.List<number> isFitting?: boolean }>).deleteIn

equals

equals(other: unknown): boolean
Parameters
otherunknown
Returns
boolean
Inherited from (InheritableImmutableRecord as Immutable.Record.Factory<{ name?: string value?: string | Immutable.List<string> | number | null optionIndexes?: Immutable.List<number> isFitting?: boolean }>).equals

get

get<K extends "name" | "isFitting" | "value" | "optionIndexes">(
    key: K,
    notSetValue?: unknown,
): { … }[K]get<K extends "name" | "isFitting" | "value" | "optionIndexes">(
    key: K,
    notSetValue?: unknown,
): {
    isFitting?: boolean;
    name?: string;
    optionIndexes?: NutrientViewer.Immutable.List<number>;
    value?: string | number | NutrientViewer.Immutable.List<string> | null;
}[K]
Returns the value associated with the provided key, which may be the default value defined when creating the Record factory function.

If the requested key is not defined by this Record type, then notSetValue will be returned if provided. Note that this scenario would produce an error when using Flow or TypeScript.

Type Parameters
Kextends "name" | "isFitting" | "value" | "optionIndexes"
Parameters
keyK
notSetValueunknown
Optional
Returns
{ … }[K]{
    isFitting?: boolean;
    name?: string;
    optionIndexes?: NutrientViewer.Immutable.List<number>;
    value?: string | number | NutrientViewer.Immutable.List<string> | null;
}[K]
Inherited from (InheritableImmutableRecord as Immutable.Record.Factory<{ name?: string value?: string | Immutable.List<string> | number | null optionIndexes?: Immutable.List<number> isFitting?: boolean }>).get
get<T>(key: string, notSetValue: T): T
Type Parameters
T
Parameters
keystring
notSetValueT
Returns
T
Inherited from (InheritableImmutableRecord as Immutable.Record.Factory<{ name?: string value?: string | Immutable.List<string> | number | null optionIndexes?: Immutable.List<number> isFitting?: boolean }>).get

getIn

getIn(keyPath: Iterable<unknown>): unknown
Parameters
keyPathIterable<unknown>
Returns
unknown
Inherited from (InheritableImmutableRecord as Immutable.Record.Factory<{ name?: string value?: string | Immutable.List<string> | number | null optionIndexes?: Immutable.List<number> isFitting?: boolean }>).getIn

has

has(key: string): key is "name" | "isFitting" | "value" | "optionIndexes"
Parameters
keystring
Returns
key is "name" | "isFitting" | "value" | "optionIndexes"
Inherited from (InheritableImmutableRecord as Immutable.Record.Factory<{ name?: string value?: string | Immutable.List<string> | number | null optionIndexes?: Immutable.List<number> isFitting?: boolean }>).has

hashCode

hashCode(): number
Returns
number
Inherited from (InheritableImmutableRecord as Immutable.Record.Factory<{ name?: string value?: string | Immutable.List<string> | number | null optionIndexes?: Immutable.List<number> isFitting?: boolean }>).hashCode

hasIn

hasIn(keyPath: Iterable<unknown>): boolean
Parameters
keyPathIterable<unknown>
Returns
boolean
Inherited from (InheritableImmutableRecord as Immutable.Record.Factory<{ name?: string value?: string | Immutable.List<string> | number | null optionIndexes?: Immutable.List<number> isFitting?: boolean }>).hasIn

merge

merge(
    ...collections: (Iterable<[string, unknown], any, any> | Partial<{ … }>)[],
): thismerge(
    ...collections: (
        | Iterable<[string, unknown], any, any>
        | Partial<
            {
                isFitting?: boolean;
                name?: string;
                optionIndexes?: NutrientViewer.Immutable.List<number>;
                value?: string | number | NutrientViewer.Immutable.List<string> | null;
            },
        >
    )[],
): this
Parameters
...collections
(Iterable<[string, unknown], any, any> | Partial<{ … }>)[](
    | Iterable<[string, unknown], any, any>
    | Partial<
        {
            isFitting?: boolean;
            name?: string;
            optionIndexes?: NutrientViewer.Immutable.List<number>;
            value?: string | number | NutrientViewer.Immutable.List<string> | null;
        },
    >
)[]
Returns
this
Inherited from (InheritableImmutableRecord as Immutable.Record.Factory<{ name?: string value?: string | Immutable.List<string> | number | null optionIndexes?: Immutable.List<number> isFitting?: boolean }>).merge

mergeDeep

mergeDeep(
    ...collections: (Iterable<[string, unknown], any, any> | Partial<{ … }>)[],
): thismergeDeep(
    ...collections: (
        | Iterable<[string, unknown], any, any>
        | Partial<
            {
                isFitting?: boolean;
                name?: string;
                optionIndexes?: NutrientViewer.Immutable.List<number>;
                value?: string | number | NutrientViewer.Immutable.List<string> | null;
            },
        >
    )[],
): this
Parameters
...collections
(Iterable<[string, unknown], any, any> | Partial<{ … }>)[](
    | Iterable<[string, unknown], any, any>
    | Partial<
        {
            isFitting?: boolean;
            name?: string;
            optionIndexes?: NutrientViewer.Immutable.List<number>;
            value?: string | number | NutrientViewer.Immutable.List<string> | null;
        },
    >
)[]
Returns
this
Inherited from (InheritableImmutableRecord as Immutable.Record.Factory<{ name?: string value?: string | Immutable.List<string> | number | null optionIndexes?: Immutable.List<number> isFitting?: boolean }>).mergeDeep

mergeDeepIn

mergeDeepIn(keyPath: Iterable<unknown>, ...collections: unknown[]): this
Parameters
keyPathIterable<unknown>
...collectionsunknown[]
Returns
this
Inherited from (InheritableImmutableRecord as Immutable.Record.Factory<{ name?: string value?: string | Immutable.List<string> | number | null optionIndexes?: Immutable.List<number> isFitting?: boolean }>).mergeDeepIn

mergeDeepWith

mergeDeepWith(
    merger: (oldVal: unknown, newVal: unknown, key: unknown) => unknown,
    ...collections: (Iterable<[string, unknown], any, any> | Partial<{ … }>)[],
): thismergeDeepWith(
    merger: (oldVal: unknown, newVal: unknown, key: unknown) => unknown,
    ...collections: (
        | Iterable<[string, unknown], any, any>
        | Partial<
            {
                isFitting?: boolean;
                name?: string;
                optionIndexes?: NutrientViewer.Immutable.List<number>;
                value?: string | number | NutrientViewer.Immutable.List<string> | null;
            },
        >
    )[],
): this
Parameters
merger(oldVal: unknown, newVal: unknown, key: unknown) => unknown
...collections
(Iterable<[string, unknown], any, any> | Partial<{ … }>)[](
    | Iterable<[string, unknown], any, any>
    | Partial<
        {
            isFitting?: boolean;
            name?: string;
            optionIndexes?: NutrientViewer.Immutable.List<number>;
            value?: string | number | NutrientViewer.Immutable.List<string> | null;
        },
    >
)[]
Returns
this
Inherited from (InheritableImmutableRecord as Immutable.Record.Factory<{ name?: string value?: string | Immutable.List<string> | number | null optionIndexes?: Immutable.List<number> isFitting?: boolean }>).mergeDeepWith

mergeIn

mergeIn(keyPath: Iterable<unknown>, ...collections: unknown[]): this
Parameters
keyPathIterable<unknown>
...collectionsunknown[]
Returns
this
Inherited from (InheritableImmutableRecord as Immutable.Record.Factory<{ name?: string value?: string | Immutable.List<string> | number | null optionIndexes?: Immutable.List<number> isFitting?: boolean }>).mergeIn

mergeWith

mergeWith(
    merger: (
        oldVal: unknown,
        newVal: unknown,
        key: "name" | "isFitting" | "value" | "optionIndexes",
    ) => unknown,
    ...collections: (Iterable<[string, unknown], any, any> | Partial<{ … }>)[],
): thismergeWith(
    merger: (
        oldVal: unknown,
        newVal: unknown,
        key: "name" | "isFitting" | "value" | "optionIndexes",
    ) => unknown,
    ...collections: (
        | Iterable<[string, unknown], any, any>
        | Partial<
            {
                isFitting?: boolean;
                name?: string;
                optionIndexes?: NutrientViewer.Immutable.List<number>;
                value?: string | number | NutrientViewer.Immutable.List<string> | null;
            },
        >
    )[],
): this
Parameters
merger(
oldVal: unknown,
newVal: unknown,
key: "name" | "isFitting" | "value" | "optionIndexes"
) => unknown
...collections
(Iterable<[string, unknown], any, any> | Partial<{ … }>)[](
    | Iterable<[string, unknown], any, any>
    | Partial<
        {
            isFitting?: boolean;
            name?: string;
            optionIndexes?: NutrientViewer.Immutable.List<number>;
            value?: string | number | NutrientViewer.Immutable.List<string> | null;
        },
    >
)[]
Returns
this
Inherited from (InheritableImmutableRecord as Immutable.Record.Factory<{ name?: string value?: string | Immutable.List<string> | number | null optionIndexes?: Immutable.List<number> isFitting?: boolean }>).mergeWith

remove

remove<K extends "name" | "isFitting" | "value" | "optionIndexes">(key: K): this
Type Parameters
Kextends "name" | "isFitting" | "value" | "optionIndexes"
Parameters
keyK
Returns
this
Inherited from (InheritableImmutableRecord as Immutable.Record.Factory<{ name?: string value?: string | Immutable.List<string> | number | null optionIndexes?: Immutable.List<number> isFitting?: boolean }>).remove

removeIn

removeIn(keyPath: Iterable<unknown>): this
Parameters
keyPathIterable<unknown>
Returns
this
Inherited from (InheritableImmutableRecord as Immutable.Record.Factory<{ name?: string value?: string | Immutable.List<string> | number | null optionIndexes?: Immutable.List<number> isFitting?: boolean }>).removeIn

set

set<K extends "name" | "isFitting" | "value" | "optionIndexes">(
    key: K,
    value: { … }[K],
): thisset<K extends "name" | "isFitting" | "value" | "optionIndexes">(
    key: K,
    value: {
        isFitting?: boolean;
        name?: string;
        optionIndexes?: NutrientViewer.Immutable.List<number>;
        value?: string | number | NutrientViewer.Immutable.List<string> | null;
    }[K],
): this
Type Parameters
Kextends "name" | "isFitting" | "value" | "optionIndexes"
Parameters
keyK
value
{ … }[K]{
    isFitting?: boolean;
    name?: string;
    optionIndexes?: NutrientViewer.Immutable.List<number>;
    value?: string | number | NutrientViewer.Immutable.List<string> | null;
}[K]
Returns
this
Inherited from (InheritableImmutableRecord as Immutable.Record.Factory<{ name?: string value?: string | Immutable.List<string> | number | null optionIndexes?: Immutable.List<number> isFitting?: boolean }>).set

setIn

setIn(keyPath: Iterable<unknown>, value: unknown): this
Parameters
keyPathIterable<unknown>
valueunknown
Returns
this
Inherited from (InheritableImmutableRecord as Immutable.Record.Factory<{ name?: string value?: string | Immutable.List<string> | number | null optionIndexes?: Immutable.List<number> isFitting?: boolean }>).setIn

toJS

toJS(): { … }toJS(): {
    isFitting?: boolean;
    name?: string;
    optionIndexes?: unknown;
    value?: unknown;
}
Deeply converts this Record to equivalent native JavaScript Object.

Note: This method may not be overridden. Objects with custom serialization to plain JS may override toJSON() instead.

Returns
{ … }{ isFitting?: boolean; name?: string; optionIndexes?: unknown; value?: unknown }
Inherited from (InheritableImmutableRecord as Immutable.Record.Factory<{ name?: string value?: string | Immutable.List<string> | number | null optionIndexes?: Immutable.List<number> isFitting?: boolean }>).toJS

toJSON

toJSON(): { … }toJSON(): {
    isFitting?: boolean;
    name?: string;
    optionIndexes?: NutrientViewer.Immutable.List<number>;
    value?: string | number | NutrientViewer.Immutable.List<string> | null;
}
Shallowly converts this Record to equivalent native JavaScript Object.

Returns
{ … }{
    isFitting?: boolean;
    name?: string;
    optionIndexes?: NutrientViewer.Immutable.List<number>;
    value?: string | number | NutrientViewer.Immutable.List<string> | null;
}
Inherited from (InheritableImmutableRecord as Immutable.Record.Factory<{ name?: string value?: string | Immutable.List<string> | number | null optionIndexes?: Immutable.List<number> isFitting?: boolean }>).toJSON

toObject

toObject(): { … }toObject(): {
    isFitting?: boolean;
    name?: string;
    optionIndexes?: NutrientViewer.Immutable.List<number>;
    value?: string | number | NutrientViewer.Immutable.List<string> | null;
}
Shallowly converts this Record to equivalent JavaScript Object.

Returns
{ … }{
    isFitting?: boolean;
    name?: string;
    optionIndexes?: NutrientViewer.Immutable.List<number>;
    value?: string | number | NutrientViewer.Immutable.List<string> | null;
}
Inherited from (InheritableImmutableRecord as Immutable.Record.Factory<{ name?: string value?: string | Immutable.List<string> | number | null optionIndexes?: Immutable.List<number> isFitting?: boolean }>).toObject

toSeq

toSeq(): Keyed<
    "name"
    | "isFitting"
    | "value"
    | "optionIndexes",

        | string
        | number
        | boolean
        | NutrientViewer.Immutable.List<string>
        | NutrientViewer.Immutable.List<number>
        | null
        | undefined,
>
Returns
Keyed<
"name"
| "isFitting"
| "value"
| "optionIndexes",

| string
| number
| boolean
| NutrientViewer.Immutable.List<string>
| NutrientViewer.Immutable.List<number>
| null
| undefined
>
Inherited from (InheritableImmutableRecord as Immutable.Record.Factory<{ name?: string value?: string | Immutable.List<string> | number | null optionIndexes?: Immutable.List<number> isFitting?: boolean }>).toSeq

update

update<K extends "name" | "isFitting" | "value" | "optionIndexes">(
    key: K,
    updater: (value: { … }[K]) => { … }[K],
): thisupdate<K extends "name" | "isFitting" | "value" | "optionIndexes">(
    key: K,
    updater: (
        value: {
            isFitting?: boolean;
            name?: string;
            optionIndexes?: NutrientViewer.Immutable.List<number>;
            value?: string | number | NutrientViewer.Immutable.List<string> | null;
        }[K],
    ) => {
        isFitting?: boolean;
        name?: string;
        optionIndexes?: NutrientViewer.Immutable.List<number>;
        value?: string | number | NutrientViewer.Immutable.List<string> | null;
    }[K],
): this
Type Parameters
Kextends "name" | "isFitting" | "value" | "optionIndexes"
Parameters
keyK
updater
(value: { … }[K]) => { … }[K](
    value: {
        isFitting?: boolean;
        name?: string;
        optionIndexes?: NutrientViewer.Immutable.List<number>;
        value?: string | number | NutrientViewer.Immutable.List<string> | null;
    }[K],
) => {
    isFitting?: boolean;
    name?: string;
    optionIndexes?: NutrientViewer.Immutable.List<number>;
    value?: string | number | NutrientViewer.Immutable.List<string> | null;
}[K]
Returns
this
Inherited from (InheritableImmutableRecord as Immutable.Record.Factory<{ name?: string value?: string | Immutable.List<string> | number | null optionIndexes?: Immutable.List<number> isFitting?: boolean }>).update

updateIn

updateIn(keyPath: Iterable<unknown>, updater: (value: unknown) => unknown): this
Parameters
keyPathIterable<unknown>
updater(value: unknown) => unknown
Returns
this
Inherited from (InheritableImmutableRecord as Immutable.Record.Factory<{ name?: string value?: string | Immutable.List<string> | number | null optionIndexes?: Immutable.List<number> isFitting?: boolean }>).updateIn

wasAltered

wasAltered(): boolean
Returns
boolean
See Also
Map#wasAltered
Inherited from (InheritableImmutableRecord as Immutable.Record.Factory<{ name?: string value?: string | Immutable.List<string> | number | null optionIndexes?: Immutable.List<number> isFitting?: boolean }>).wasAltered

withMutations

withMutations(mutator: (mutable: this) => unknown): this
Note: Not all methods can be used on a mutable collection or within withMutations! Only set may be used mutatively.
Parameters
mutator(mutable: this) => unknown
Returns
this
See Also
Map#withMutations
Inherited from (InheritableImmutableRecord as Immutable.Record.Factory<{ name?: string value?: string | Immutable.List<string> | number | null optionIndexes?: Immutable.List<number> isFitting?: boolean }>).withMutations

Class FormFieldValue

Example

See Also

Hierarchy

Constructors

Parameters

Properties

Immutable Record API

Returns

Returns

See Also

Returns

See Also

Returns

Type Parameters

Parameters

Returns

Parameters

Returns

Parameters

Returns

Type Parameters

Parameters

Returns

Type Parameters

Parameters

Returns

Parameters

Returns

Parameters

Returns

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Type Parameters

Parameters

Returns

Parameters

Returns

Type Parameters

Parameters

Returns

Parameters

Returns

Returns

Returns

Returns

Returns

Type Parameters

Parameters

Returns

Parameters

Returns

Returns

See Also

Parameters

Returns

See Also