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.

Example

Setting a form field value.

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

See

Hierarchy

Record<
    {
        isFitting?: boolean;
        name?: string;
        optionIndexes?: NutrientViewer.Immutable.List<number>;
        value?: null | string | number | NutrientViewer.Immutable.List<string>;
    },
    this,
> & Readonly<
    {
        isFitting?: boolean;
        name?: string;
        optionIndexes?: NutrientViewer.Immutable.List<number>;
        value?: null | string | number | NutrientViewer.Immutable.List<string>;
    },
>
- FormFieldValue

Index

Constructors

constructor

Properties

name optionIndexes? value defaultValues

Constructors

constructor

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

Properties

name

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.

`Optional`optionIndexes

optionIndexes?: 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

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

The value of the form field.

`Static`defaultValues

defaultValues: IObject = ...

Methods

[iterator]

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

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

            | undefined
            | null
            | string
            | number
            | boolean
            | NutrientViewer.Immutable.List<string>
            | NutrientViewer.Immutable.List<number>,
    ],
>
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
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
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
- K extends "name" | "isFitting" | "value" | "optionIndexes"
Parameters
- key: K
Returns this
Alias
remove

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<any>): this
Parameters
- keyPath: Iterable<any>
Returns this
Alias
removeIn

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: any): boolean
Parameters
- other: any
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?: any,
): {
    isFitting?: boolean;
    name?: string;
    optionIndexes?: NutrientViewer.Immutable.List<number>;
    value?: null | string | number | NutrientViewer.Immutable.List<string>;
}[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
- K extends "name" | "isFitting" | "value" | "optionIndexes"
Parameters
- key: K
- OptionalnotSetValue: any
Returns {
    isFitting?: boolean;
    name?: string;
    optionIndexes?: NutrientViewer.Immutable.List<number>;
    value?: null | string | number | NutrientViewer.Immutable.List<string>;
}[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
- key: string
- notSetValue: T
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<any>): any
Parameters
- keyPath: Iterable<any>
Returns any
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
- key: string
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<any>): boolean
Parameters
- keyPath: Iterable<any>
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, any]>
        | Partial<
            {
                isFitting?: boolean;
                name?: string;
                optionIndexes?: NutrientViewer.Immutable.List<number>;
                value?: null | string | number | NutrientViewer.Immutable.List<string>;
            },
        >
    )[],
): this
Parameters
- ...collections: (
      | Iterable<[string, any]>
      | Partial<
          {
              isFitting?: boolean;
              name?: string;
              optionIndexes?: NutrientViewer.Immutable.List<number>;
              value?: null | string | number | NutrientViewer.Immutable.List<string>;
          },
      >
  )[]
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, any]>
        | Partial<
            {
                isFitting?: boolean;
                name?: string;
                optionIndexes?: NutrientViewer.Immutable.List<number>;
                value?: null | string | number | NutrientViewer.Immutable.List<string>;
            },
        >
    )[],
): this
Parameters
- ...collections: (
      | Iterable<[string, any]>
      | Partial<
          {
              isFitting?: boolean;
              name?: string;
              optionIndexes?: NutrientViewer.Immutable.List<number>;
              value?: null | string | number | NutrientViewer.Immutable.List<string>;
          },
      >
  )[]
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<any>, ...collections: any[]): this
Parameters
- keyPath: Iterable<any>
- ...collections: any[]
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: any, newVal: any, key: any) => any,
    ...collections: (
        | Iterable<[string, any]>
        | Partial<
            {
                isFitting?: boolean;
                name?: string;
                optionIndexes?: NutrientViewer.Immutable.List<number>;
                value?: null | string | number | NutrientViewer.Immutable.List<string>;
            },
        >
    )[],
): this
Parameters
- merger: (oldVal: any, newVal: any, key: any) => any
- ...collections: (
      | Iterable<[string, any]>
      | Partial<
          {
              isFitting?: boolean;
              name?: string;
              optionIndexes?: NutrientViewer.Immutable.List<number>;
              value?: null | string | number | NutrientViewer.Immutable.List<string>;
          },
      >
  )[]
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<any>, ...collections: any[]): this
Parameters
- keyPath: Iterable<any>
- ...collections: any[]
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: any,
        newVal: any,
        key: "name" | "isFitting" | "value" | "optionIndexes",
    ) => any,
    ...collections: (
        | Iterable<[string, any]>
        | Partial<
            {
                isFitting?: boolean;
                name?: string;
                optionIndexes?: NutrientViewer.Immutable.List<number>;
                value?: null | string | number | NutrientViewer.Immutable.List<string>;
            },
        >
    )[],
): this
Parameters
- merger: (
      oldVal: any,
      newVal: any,
      key: "name" | "isFitting" | "value" | "optionIndexes",
  ) => any
- ...collections: (
      | Iterable<[string, any]>
      | Partial<
          {
              isFitting?: boolean;
              name?: string;
              optionIndexes?: NutrientViewer.Immutable.List<number>;
              value?: null | string | number | NutrientViewer.Immutable.List<string>;
          },
      >
  )[]
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
- K extends "name" | "isFitting" | "value" | "optionIndexes"
Parameters
- key: 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 }>).remove

removeIn

removeIn(keyPath: Iterable<any>): this
Parameters
- keyPath: Iterable<any>
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: {
        isFitting?: boolean;
        name?: string;
        optionIndexes?: NutrientViewer.Immutable.List<number>;
        value?: null | string | number | NutrientViewer.Immutable.List<string>;
    }[K],
): this
Type Parameters
- K extends "name" | "isFitting" | "value" | "optionIndexes"
Parameters
- key: K
- value: {
      isFitting?: boolean;
      name?: string;
      optionIndexes?: NutrientViewer.Immutable.List<number>;
      value?: null | string | number | NutrientViewer.Immutable.List<string>;
  }[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<any>, value: any): this
Parameters
- keyPath: Iterable<any>
- value: any
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(): { isFitting?: any; name?: any; optionIndexes?: any; value?: any }
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?: any; name?: any; optionIndexes?: any; value?: any }
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(): {
    isFitting?: boolean;
    name?: string;
    optionIndexes?: NutrientViewer.Immutable.List<number>;
    value?: null | string | number | NutrientViewer.Immutable.List<string>;
}
Shallowly converts this Record to equivalent native JavaScript Object.

Returns {
    isFitting?: boolean;
    name?: string;
    optionIndexes?: NutrientViewer.Immutable.List<number>;
    value?: null | string | number | NutrientViewer.Immutable.List<string>;
}
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(): {
    isFitting?: boolean;
    name?: string;
    optionIndexes?: NutrientViewer.Immutable.List<number>;
    value?: null | string | number | NutrientViewer.Immutable.List<string>;
}
Shallowly converts this Record to equivalent JavaScript Object.

Returns {
    isFitting?: boolean;
    name?: string;
    optionIndexes?: NutrientViewer.Immutable.List<number>;
    value?: null | string | number | NutrientViewer.Immutable.List<string>;
}
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",

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

        | undefined
        | null
        | string
        | number
        | boolean
        | NutrientViewer.Immutable.List<string>
        | NutrientViewer.Immutable.List<number>,
>
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: {
            isFitting?: boolean;
            name?: string;
            optionIndexes?: NutrientViewer.Immutable.List<number>;
            value?: null | string | number | NutrientViewer.Immutable.List<string>;
        }[K],
    ) => {
        isFitting?: boolean;
        name?: string;
        optionIndexes?: NutrientViewer.Immutable.List<number>;
        value?: null | string | number | NutrientViewer.Immutable.List<string>;
    }[K],
): this
Type Parameters
- K extends "name" | "isFitting" | "value" | "optionIndexes"
Parameters
- key: K
- updater: (
      value: {
          isFitting?: boolean;
          name?: string;
          optionIndexes?: NutrientViewer.Immutable.List<number>;
          value?: null | string | number | NutrientViewer.Immutable.List<string>;
      }[K],
  ) => {
      isFitting?: boolean;
      name?: string;
      optionIndexes?: NutrientViewer.Immutable.List<number>;
      value?: null | string | number | NutrientViewer.Immutable.List<string>;
  }[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<any>, updater: (value: any) => any): this
Parameters
- keyPath: Iterable<any>
- updater: (value: any) => any
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
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) => any): 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) => any
Returns this
See
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

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns NutrientViewer.FormFieldValue

Properties

name

OptionaloptionIndexes

value

StaticdefaultValues

Methods

[iterator]

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

asImmutable

Returns this

See

asMutable

Returns this

See

clear

Returns this

delete

Type Parameters

Parameters

Returns this

Alias

deleteIn

Parameters

Returns this

Alias

equals

Parameters

Returns boolean

get

Type Parameters

Parameters

Returns { isFitting?: boolean; name?: string; optionIndexes?: NutrientViewer.Immutable.List<number>; value?: null | string | number | NutrientViewer.Immutable.List<string>;}[K]

Type Parameters

Parameters

Returns T

getIn

Parameters

Returns any

has

Parameters

Returns key is "name" | "isFitting" | "value" | "optionIndexes"

hashCode

Returns number

hasIn

Parameters

Returns boolean

merge

Parameters

Returns this

mergeDeep

Parameters

Returns this

mergeDeepIn

Parameters

Returns this

mergeDeepWith

Parameters

Returns this

mergeIn

Parameters

Returns this

mergeWith

Parameters

Returns this

remove

Type Parameters

Parameters

Returns this

`Optional`optionIndexes

`Static`defaultValues

Returns IterableIterator<
[
"name"
| "isFitting"
| "value"
| "optionIndexes",

| undefined
| null
| string
| number
| boolean
| NutrientViewer.Immutable.List<string>
| NutrientViewer.Immutable.List<number>,
],
>

Returns {
isFitting?: boolean;
name?: string;
optionIndexes?: NutrientViewer.Immutable.List<number>;
value?: null | string | number | NutrientViewer.Immutable.List<string>;
}[K]

Returns {
isFitting?: boolean;
name?: string;
optionIndexes?: NutrientViewer.Immutable.List<number>;
value?: null | string | number | NutrientViewer.Immutable.List<string>;
}

Returns {
isFitting?: boolean;
name?: string;
optionIndexes?: NutrientViewer.Immutable.List<number>;
value?: null | string | number | NutrientViewer.Immutable.List<string>;
}

Returns Keyed<
"name"
| "isFitting"
| "value"
| "optionIndexes",

| undefined
| null
| string
| number
| boolean
| NutrientViewer.Immutable.List<string>
| NutrientViewer.Immutable.List<number>,
>