Reference NutrientViewer FormFieldsChoiceFormField

Class ChoiceFormField

Base form field type for all form fields that allow multiple choices:

Class

Hierarchy

FormFieldChoiceFormField

Subclasses

Constructors

new ChoiceFormField(args)

Parameters
args
{ … }{
    additionalActions?:
        | {
            onCalculate?: NutrientViewer.Actions.JavaScriptAction;
            onChange?: NutrientViewer.Actions.JavaScriptAction;
            onBlur?: NutrientViewer.Actions.JavaScriptAction;
            onFocus?: NutrientViewer.Actions.JavaScriptAction;
            onFormat?: NutrientViewer.Actions.JavaScriptAction;
            onInput?: NutrientViewer.Actions.JavaScriptAction;
            onPointerDown?: NutrientViewer.Actions.Action;
            onPointerEnter?: NutrientViewer.Actions.Action;
            onPointerLeave?: NutrientViewer.Actions.Action;
            onPointerUp?: NutrientViewer.Actions.Action;
        }
        | null;
    annotationIds?: NutrientViewer.Immutable.List<string>;
    canSetGroup?: boolean;
    group?: string | null;
    id?: string;
    isDeletable?: boolean;
    isEditable?: boolean;
    isFillable?: boolean;
    label?: string;
    name?: string;
    noExport?: boolean;
    pdfObjectId?: number | null;
    readOnly?: boolean;
    required?: boolean;
    [key: string]: any;
}
Optional
Inherited from FormField.constructor

Properties

Property	Description
onCalculate	Action to be performed to recalculate the value of a field. The name of this event in the PDF spec is `C`.
onChange	Execute an action when the value of the field changes. The name of this event in the PDF spec is `V` and can check the new value for validity.
onBlur	Execute an action when the widget loses focus. The name of this event in the PDF spec is `Bl`.
onChange	Action to be performed when the user changes the value of the field. The name of this event in the PDF spec is `V`.
onFocus	Execute an action when the widget is focused. The name of this event in the PDF spec is `Fo`.
onFormat	Action to be performed before the field is formatted to display its current value. The name of this event in the PDF spec is `F`.
onInput	Action to be performed when the user types a key-stroke into a text field or combo box or modifies the selection in a scrollable list box. The name of this event in the PDF spec is `K`.
onPointerDown	Action to be performed when the pointer is pressed.
onPointerEnter	Action to be performed when the pointer enters the field area.
onPointerLeave	Action to be performed when the pointer hovers the field.
onPointerUp	Action to be performed when the pointer is released.

annotationIds

NutrientViewer.Immutable.List<string>

Holds an immutable list of NutrientViewer.Annotations.WidgetAnnotation#ids.

canSetGroup

OptionalReadonly

boolean

This property defines whether the user has permission to edit the group of this form field. The value of this field depends on the set of collaboration permissions defined in the JWT token.

It is only available when collaboration permissions is enabled on Server-Backed deployments.

commitOnChange

boolean

If true, the new value is committed as soon as a selection is made, without requiring the user to exit the field. Otherwise, the new value is not committed until the user exits the field.

Please note that Instance#getFormFieldValues will not return the latest value for this field until the user leaves this field by default. If you want this value to update on every change then set this to true.

Default Value

false

defaultValues

Readonly

NutrientViewer.Immutable.List<string>

Similar to the value property. The default values are only used when a form needs to be reset.

group

Optional

string | null

This property is used to define the permission scope for this form-field, it's corresponding widget-annotations and form field values. If you change the group of a form field, the corresponding widget annotations and form field values will inherit it.

It is only available when collaboration permissions is enabled on Server-Backed deployments.

id

string

A unique identifier to describe the form field record. When a form field is created in the UI, the viewer has to generate a unique ID.

When changes are saved to the underlying form field provider, we call NutrientViewer.Instance#ensureChangesSaved to make sure the form field has been persisted from the provider.

isDeletable

OptionalReadonly

boolean

This property defines whether this form field can be deleted or not. The value of this field depends on the set of collaboration permissions defined in the JWT token.

It is only available when collaboration permissions is enabled on Server-Backed deployments.

isEditable

OptionalReadonly

boolean

This property defines whether this form-field can be edited or not. The value of this field depends on the set of collaboration permissions defined in the JWT token.

It is only available when collaboration permissions is enabled on Server-Backed deployments.

isFillable

OptionalReadonly

boolean

This property defines whether this form-field can be filled or not. The value of this field depends on the set of collaboration permissions defined in the JWT token.

It is only available when collaboration permissions is enabled on Server-Backed deployments.

label

string

Used to identify the form field in the UI or for accessibility.

multiSelect

boolean

If true, more than one of the field’s option items may be selected simultaneously. Otherwise, no more than one item at a time may be selected.

Default Value

false

name

string

Unique name of the form field (often referred to as fully qualified name). This name is used to link NutrientViewer.Annotations.WidgetAnnotation and is also used as an identifier for form field values.

noExport

boolean

Form fields with the noExport flag won't appear in the serialized payload of a form submission.

Default Value

false

options

NutrientViewer.Immutable.List<NutrientViewer.FormOption>

A list of FormOptions. This is necessary for multiple check boxes in a group.

See FormOption for more information.

pdfObjectId

number

The object ID of the form field object in the PDF.

readOnly

boolean

Read only form fields can not be filled out (similar to disabled HTML input elements).

Default Value

false

required

boolean

Required form fields must be filled out in order to submit the form.

NutrientViewer.FormFields.TextFormField, NutrientViewer.FormFields.ComboBoxFormField and NutrientViewer.FormFields.ListBoxFormField with this flag set will be rendered with the PSPDFKit-Annotation-Widget-Required public CSS class and the HTML required attribute set.

Default Value

false

values

Readonly

NutrientViewer.Immutable.List<string>

An immutable list of all selected form option values. If no options are defined, a checked check box will have values: List(["Yes"]);.

If the list is empty, no check box is checked.

In order to modify it, instance.setFormFieldValues() should be used.

Immutable Record API

Indexable

readonly [key: string]: any

displayName

Static

string

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

[iterator]

"[iterator]"(): IterableIterator<[keyof { … }, any]>"[iterator]"(): IterableIterator<
    [
        keyof {
            additionalActions?: | {
                onCalculate?: NutrientViewer.Actions.JavaScriptAction;
                onChange?: NutrientViewer.Actions.JavaScriptAction;
                onBlur?: NutrientViewer.Actions.JavaScriptAction;
                onFocus?: NutrientViewer.Actions.JavaScriptAction;
                onFormat?: NutrientViewer.Actions.JavaScriptAction;
                onInput?: NutrientViewer.Actions.JavaScriptAction;
                onPointerDown?: NutrientViewer.Actions.Action;
                onPointerEnter?: NutrientViewer.Actions.Action;
                onPointerLeave?: NutrientViewer.Actions.Action;
                onPointerUp?: NutrientViewer.Actions.Action;
            }
            | null;
            annotationIds?: NutrientViewer.Immutable.List<string>;
            canSetGroup?: boolean;
            group?: string | null;
            id?: string;
            isDeletable?: boolean;
            isEditable?: boolean;
            isFillable?: boolean;
            label?: string;
            name?: string;
            noExport?: boolean;
            pdfObjectId?: number | null;
            readOnly?: boolean;
            required?: boolean;
            [key: string]: any;
        },
        any,
    ],
>
Returns
IterableIterator<[keyof { … }, any]>IterableIterator<
    [
        keyof {
            additionalActions?: | {
                onCalculate?: NutrientViewer.Actions.JavaScriptAction;
                onChange?: NutrientViewer.Actions.JavaScriptAction;
                onBlur?: NutrientViewer.Actions.JavaScriptAction;
                onFocus?: NutrientViewer.Actions.JavaScriptAction;
                onFormat?: NutrientViewer.Actions.JavaScriptAction;
                onInput?: NutrientViewer.Actions.JavaScriptAction;
                onPointerDown?: NutrientViewer.Actions.Action;
                onPointerEnter?: NutrientViewer.Actions.Action;
                onPointerLeave?: NutrientViewer.Actions.Action;
                onPointerUp?: NutrientViewer.Actions.Action;
            }
            | null;
            annotationIds?: NutrientViewer.Immutable.List<string>;
            canSetGroup?: boolean;
            group?: string | null;
            id?: string;
            isDeletable?: boolean;
            isEditable?: boolean;
            isFillable?: boolean;
            label?: string;
            name?: string;
            noExport?: boolean;
            pdfObjectId?: number | null;
            readOnly?: boolean;
            required?: boolean;
            [key: string]: any;
        },
        any,
    ],
>
Inherited from FormField.[iterator]

asImmutable

asImmutable(): this
Returns
this
See Also
Map#asImmutable
Inherited from FormField.asImmutable

asMutable

asMutable(): this
Returns
this
See Also
Map#asMutable
Inherited from FormField.asMutable

clear

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

Returns
this
Inherited from FormField.clear

delete

delete<K extends keyof { … }>(key: K): thisdelete<
    K extends
        keyof {
            additionalActions?: | {
                onCalculate?: NutrientViewer.Actions.JavaScriptAction;
                onChange?: NutrientViewer.Actions.JavaScriptAction;
                onBlur?: NutrientViewer.Actions.JavaScriptAction;
                onFocus?: NutrientViewer.Actions.JavaScriptAction;
                onFormat?: NutrientViewer.Actions.JavaScriptAction;
                onInput?: NutrientViewer.Actions.JavaScriptAction;
                onPointerDown?: NutrientViewer.Actions.Action;
                onPointerEnter?: NutrientViewer.Actions.Action;
                onPointerLeave?: NutrientViewer.Actions.Action;
                onPointerUp?: NutrientViewer.Actions.Action;
            }
            | null;
            annotationIds?: NutrientViewer.Immutable.List<string>;
            canSetGroup?: boolean;
            group?: string | null;
            id?: string;
            isDeletable?: boolean;
            isEditable?: boolean;
            isFillable?: boolean;
            label?: string;
            name?: string;
            noExport?: boolean;
            pdfObjectId?: number | null;
            readOnly?: boolean;
            required?: boolean;
            [key: string]: any;
        },
>(
    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 keyof { … }extends keyof {
    additionalActions?:
        | {
            onCalculate?: NutrientViewer.Actions.JavaScriptAction;
            onChange?: NutrientViewer.Actions.JavaScriptAction;
            onBlur?: NutrientViewer.Actions.JavaScriptAction;
            onFocus?: NutrientViewer.Actions.JavaScriptAction;
            onFormat?: NutrientViewer.Actions.JavaScriptAction;
            onInput?: NutrientViewer.Actions.JavaScriptAction;
            onPointerDown?: NutrientViewer.Actions.Action;
            onPointerEnter?: NutrientViewer.Actions.Action;
            onPointerLeave?: NutrientViewer.Actions.Action;
            onPointerUp?: NutrientViewer.Actions.Action;
        }
        | null;
    annotationIds?: NutrientViewer.Immutable.List<string>;
    canSetGroup?: boolean;
    group?: string | null;
    id?: string;
    isDeletable?: boolean;
    isEditable?: boolean;
    isFillable?: boolean;
    label?: string;
    name?: string;
    noExport?: boolean;
    pdfObjectId?: number | null;
    readOnly?: boolean;
    required?: boolean;
    [key: string]: any;
}
Parameters
keyK
Returns
this
Inherited from FormField.delete

deleteIn

deleteIn(keyPath: Iterable<unknown>): this
Parameters
keyPathIterable<unknown>
Returns
this
Inherited from FormField.deleteIn

equals

equals(other: unknown): boolean
Parameters
otherunknown
Returns
boolean
Inherited from FormField.equals

get

get<K extends keyof { … }>(key: K, notSetValue?: unknown): { … }[K]get<
    K extends
        keyof {
            additionalActions?: | {
                onCalculate?: NutrientViewer.Actions.JavaScriptAction;
                onChange?: NutrientViewer.Actions.JavaScriptAction;
                onBlur?: NutrientViewer.Actions.JavaScriptAction;
                onFocus?: NutrientViewer.Actions.JavaScriptAction;
                onFormat?: NutrientViewer.Actions.JavaScriptAction;
                onInput?: NutrientViewer.Actions.JavaScriptAction;
                onPointerDown?: NutrientViewer.Actions.Action;
                onPointerEnter?: NutrientViewer.Actions.Action;
                onPointerLeave?: NutrientViewer.Actions.Action;
                onPointerUp?: NutrientViewer.Actions.Action;
            }
            | null;
            annotationIds?: NutrientViewer.Immutable.List<string>;
            canSetGroup?: boolean;
            group?: string | null;
            id?: string;
            isDeletable?: boolean;
            isEditable?: boolean;
            isFillable?: boolean;
            label?: string;
            name?: string;
            noExport?: boolean;
            pdfObjectId?: number | null;
            readOnly?: boolean;
            required?: boolean;
            [key: string]: any;
        },
>(
    key: K,
    notSetValue?: unknown,
): {
    additionalActions?:
        | {
            onCalculate?: NutrientViewer.Actions.JavaScriptAction;
            onChange?: NutrientViewer.Actions.JavaScriptAction;
            onBlur?: NutrientViewer.Actions.JavaScriptAction;
            onFocus?: NutrientViewer.Actions.JavaScriptAction;
            onFormat?: NutrientViewer.Actions.JavaScriptAction;
            onInput?: NutrientViewer.Actions.JavaScriptAction;
            onPointerDown?: NutrientViewer.Actions.Action;
            onPointerEnter?: NutrientViewer.Actions.Action;
            onPointerLeave?: NutrientViewer.Actions.Action;
            onPointerUp?: NutrientViewer.Actions.Action;
        }
        | null;
    annotationIds?: NutrientViewer.Immutable.List<string>;
    canSetGroup?: boolean;
    group?: string | null;
    id?: string;
    isDeletable?: boolean;
    isEditable?: boolean;
    isFillable?: boolean;
    label?: string;
    name?: string;
    noExport?: boolean;
    pdfObjectId?: number | null;
    readOnly?: boolean;
    required?: boolean;
    [key: string]: any;
}[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 keyof { … }extends keyof {
    additionalActions?:
        | {
            onCalculate?: NutrientViewer.Actions.JavaScriptAction;
            onChange?: NutrientViewer.Actions.JavaScriptAction;
            onBlur?: NutrientViewer.Actions.JavaScriptAction;
            onFocus?: NutrientViewer.Actions.JavaScriptAction;
            onFormat?: NutrientViewer.Actions.JavaScriptAction;
            onInput?: NutrientViewer.Actions.JavaScriptAction;
            onPointerDown?: NutrientViewer.Actions.Action;
            onPointerEnter?: NutrientViewer.Actions.Action;
            onPointerLeave?: NutrientViewer.Actions.Action;
            onPointerUp?: NutrientViewer.Actions.Action;
        }
        | null;
    annotationIds?: NutrientViewer.Immutable.List<string>;
    canSetGroup?: boolean;
    group?: string | null;
    id?: string;
    isDeletable?: boolean;
    isEditable?: boolean;
    isFillable?: boolean;
    label?: string;
    name?: string;
    noExport?: boolean;
    pdfObjectId?: number | null;
    readOnly?: boolean;
    required?: boolean;
    [key: string]: any;
}
Parameters
keyK
notSetValueunknown
Optional
Returns
{ … }[K]{
    additionalActions?:
        | {
            onCalculate?: NutrientViewer.Actions.JavaScriptAction;
            onChange?: NutrientViewer.Actions.JavaScriptAction;
            onBlur?: NutrientViewer.Actions.JavaScriptAction;
            onFocus?: NutrientViewer.Actions.JavaScriptAction;
            onFormat?: NutrientViewer.Actions.JavaScriptAction;
            onInput?: NutrientViewer.Actions.JavaScriptAction;
            onPointerDown?: NutrientViewer.Actions.Action;
            onPointerEnter?: NutrientViewer.Actions.Action;
            onPointerLeave?: NutrientViewer.Actions.Action;
            onPointerUp?: NutrientViewer.Actions.Action;
        }
        | null;
    annotationIds?: NutrientViewer.Immutable.List<string>;
    canSetGroup?: boolean;
    group?: string | null;
    id?: string;
    isDeletable?: boolean;
    isEditable?: boolean;
    isFillable?: boolean;
    label?: string;
    name?: string;
    noExport?: boolean;
    pdfObjectId?: number | null;
    readOnly?: boolean;
    required?: boolean;
    [key: string]: any;
}[K]
Inherited from FormField.get
get<T>(key: string, notSetValue: T): T
Type Parameters
T
Parameters
keystring
notSetValueT
Returns
T
Inherited from FormField.get

getIn

getIn(keyPath: Iterable<unknown>): unknown
Parameters
keyPathIterable<unknown>
Returns
unknown
Inherited from FormField.getIn

has

has(key: string): key is string
Parameters
keystring
Returns
key is string
Inherited from FormField.has

hashCode

hashCode(): number
Returns
number
Inherited from FormField.hashCode

hasIn

hasIn(keyPath: Iterable<unknown>): boolean
Parameters
keyPathIterable<unknown>
Returns
boolean
Inherited from FormField.hasIn

merge

merge(
    ...collections: (Iterable<[string, unknown], any, any> | Partial<{ … }>)[],
): thismerge(
    ...collections: (
        | Iterable<[string, unknown], any, any>
        | Partial<
            {
                additionalActions?: | {
                    onCalculate?: NutrientViewer.Actions.JavaScriptAction;
                    onChange?: NutrientViewer.Actions.JavaScriptAction;
                    onBlur?: NutrientViewer.Actions.JavaScriptAction;
                    onFocus?: NutrientViewer.Actions.JavaScriptAction;
                    onFormat?: NutrientViewer.Actions.JavaScriptAction;
                    onInput?: NutrientViewer.Actions.JavaScriptAction;
                    onPointerDown?: NutrientViewer.Actions.Action;
                    onPointerEnter?: NutrientViewer.Actions.Action;
                    onPointerLeave?: NutrientViewer.Actions.Action;
                    onPointerUp?: NutrientViewer.Actions.Action;
                }
                | null;
                annotationIds?: NutrientViewer.Immutable.List<string>;
                canSetGroup?: boolean;
                group?: string | null;
                id?: string;
                isDeletable?: boolean;
                isEditable?: boolean;
                isFillable?: boolean;
                label?: string;
                name?: string;
                noExport?: boolean;
                pdfObjectId?: number | null;
                readOnly?: boolean;
                required?: boolean;
                [key: string]: any;
            },
        >
    )[],
): this
Parameters
...collections
(Iterable<[string, unknown], any, any> | Partial<{ … }>)[](
    | Iterable<[string, unknown], any, any>
    | Partial<
        {
            additionalActions?: | {
                onCalculate?: NutrientViewer.Actions.JavaScriptAction;
                onChange?: NutrientViewer.Actions.JavaScriptAction;
                onBlur?: NutrientViewer.Actions.JavaScriptAction;
                onFocus?: NutrientViewer.Actions.JavaScriptAction;
                onFormat?: NutrientViewer.Actions.JavaScriptAction;
                onInput?: NutrientViewer.Actions.JavaScriptAction;
                onPointerDown?: NutrientViewer.Actions.Action;
                onPointerEnter?: NutrientViewer.Actions.Action;
                onPointerLeave?: NutrientViewer.Actions.Action;
                onPointerUp?: NutrientViewer.Actions.Action;
            }
            | null;
            annotationIds?: NutrientViewer.Immutable.List<string>;
            canSetGroup?: boolean;
            group?: string | null;
            id?: string;
            isDeletable?: boolean;
            isEditable?: boolean;
            isFillable?: boolean;
            label?: string;
            name?: string;
            noExport?: boolean;
            pdfObjectId?: number | null;
            readOnly?: boolean;
            required?: boolean;
            [key: string]: any;
        },
    >
)[]
Returns
this
Inherited from FormField.merge

mergeDeep

mergeDeep(
    ...collections: (Iterable<[string, unknown], any, any> | Partial<{ … }>)[],
): thismergeDeep(
    ...collections: (
        | Iterable<[string, unknown], any, any>
        | Partial<
            {
                additionalActions?: | {
                    onCalculate?: NutrientViewer.Actions.JavaScriptAction;
                    onChange?: NutrientViewer.Actions.JavaScriptAction;
                    onBlur?: NutrientViewer.Actions.JavaScriptAction;
                    onFocus?: NutrientViewer.Actions.JavaScriptAction;
                    onFormat?: NutrientViewer.Actions.JavaScriptAction;
                    onInput?: NutrientViewer.Actions.JavaScriptAction;
                    onPointerDown?: NutrientViewer.Actions.Action;
                    onPointerEnter?: NutrientViewer.Actions.Action;
                    onPointerLeave?: NutrientViewer.Actions.Action;
                    onPointerUp?: NutrientViewer.Actions.Action;
                }
                | null;
                annotationIds?: NutrientViewer.Immutable.List<string>;
                canSetGroup?: boolean;
                group?: string | null;
                id?: string;
                isDeletable?: boolean;
                isEditable?: boolean;
                isFillable?: boolean;
                label?: string;
                name?: string;
                noExport?: boolean;
                pdfObjectId?: number | null;
                readOnly?: boolean;
                required?: boolean;
                [key: string]: any;
            },
        >
    )[],
): this
Parameters
...collections
(Iterable<[string, unknown], any, any> | Partial<{ … }>)[](
    | Iterable<[string, unknown], any, any>
    | Partial<
        {
            additionalActions?: | {
                onCalculate?: NutrientViewer.Actions.JavaScriptAction;
                onChange?: NutrientViewer.Actions.JavaScriptAction;
                onBlur?: NutrientViewer.Actions.JavaScriptAction;
                onFocus?: NutrientViewer.Actions.JavaScriptAction;
                onFormat?: NutrientViewer.Actions.JavaScriptAction;
                onInput?: NutrientViewer.Actions.JavaScriptAction;
                onPointerDown?: NutrientViewer.Actions.Action;
                onPointerEnter?: NutrientViewer.Actions.Action;
                onPointerLeave?: NutrientViewer.Actions.Action;
                onPointerUp?: NutrientViewer.Actions.Action;
            }
            | null;
            annotationIds?: NutrientViewer.Immutable.List<string>;
            canSetGroup?: boolean;
            group?: string | null;
            id?: string;
            isDeletable?: boolean;
            isEditable?: boolean;
            isFillable?: boolean;
            label?: string;
            name?: string;
            noExport?: boolean;
            pdfObjectId?: number | null;
            readOnly?: boolean;
            required?: boolean;
            [key: string]: any;
        },
    >
)[]
Returns
this
Inherited from FormField.mergeDeep

mergeDeepIn

mergeDeepIn(keyPath: Iterable<unknown>, ...collections: unknown[]): this
Parameters
keyPathIterable<unknown>
...collectionsunknown[]
Returns
this
Inherited from FormField.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<
            {
                additionalActions?: | {
                    onCalculate?: NutrientViewer.Actions.JavaScriptAction;
                    onChange?: NutrientViewer.Actions.JavaScriptAction;
                    onBlur?: NutrientViewer.Actions.JavaScriptAction;
                    onFocus?: NutrientViewer.Actions.JavaScriptAction;
                    onFormat?: NutrientViewer.Actions.JavaScriptAction;
                    onInput?: NutrientViewer.Actions.JavaScriptAction;
                    onPointerDown?: NutrientViewer.Actions.Action;
                    onPointerEnter?: NutrientViewer.Actions.Action;
                    onPointerLeave?: NutrientViewer.Actions.Action;
                    onPointerUp?: NutrientViewer.Actions.Action;
                }
                | null;
                annotationIds?: NutrientViewer.Immutable.List<string>;
                canSetGroup?: boolean;
                group?: string | null;
                id?: string;
                isDeletable?: boolean;
                isEditable?: boolean;
                isFillable?: boolean;
                label?: string;
                name?: string;
                noExport?: boolean;
                pdfObjectId?: number | null;
                readOnly?: boolean;
                required?: boolean;
                [key: string]: any;
            },
        >
    )[],
): this
Parameters
merger(oldVal: unknown, newVal: unknown, key: unknown) => unknown
...collections
(Iterable<[string, unknown], any, any> | Partial<{ … }>)[](
    | Iterable<[string, unknown], any, any>
    | Partial<
        {
            additionalActions?: | {
                onCalculate?: NutrientViewer.Actions.JavaScriptAction;
                onChange?: NutrientViewer.Actions.JavaScriptAction;
                onBlur?: NutrientViewer.Actions.JavaScriptAction;
                onFocus?: NutrientViewer.Actions.JavaScriptAction;
                onFormat?: NutrientViewer.Actions.JavaScriptAction;
                onInput?: NutrientViewer.Actions.JavaScriptAction;
                onPointerDown?: NutrientViewer.Actions.Action;
                onPointerEnter?: NutrientViewer.Actions.Action;
                onPointerLeave?: NutrientViewer.Actions.Action;
                onPointerUp?: NutrientViewer.Actions.Action;
            }
            | null;
            annotationIds?: NutrientViewer.Immutable.List<string>;
            canSetGroup?: boolean;
            group?: string | null;
            id?: string;
            isDeletable?: boolean;
            isEditable?: boolean;
            isFillable?: boolean;
            label?: string;
            name?: string;
            noExport?: boolean;
            pdfObjectId?: number | null;
            readOnly?: boolean;
            required?: boolean;
            [key: string]: any;
        },
    >
)[]
Returns
this
Inherited from FormField.mergeDeepWith

mergeIn

mergeIn(keyPath: Iterable<unknown>, ...collections: unknown[]): this
Parameters
keyPathIterable<unknown>
...collectionsunknown[]
Returns
this
Inherited from FormField.mergeIn

mergeWith

mergeWith(
    merger: (oldVal: unknown, newVal: unknown, key: keyof { … }) => unknown,
    ...collections: (Iterable<[string, unknown], any, any> | Partial<{ … }>)[],
): thismergeWith(
    merger: (
        oldVal: unknown,
        newVal: unknown,
        key: keyof {
            additionalActions?:
                | {
                    onCalculate?: NutrientViewer.Actions.JavaScriptAction;
                    onChange?: NutrientViewer.Actions.JavaScriptAction;
                    onBlur?: NutrientViewer.Actions.JavaScriptAction;
                    onFocus?: NutrientViewer.Actions.JavaScriptAction;
                    onFormat?: NutrientViewer.Actions.JavaScriptAction;
                    onInput?: NutrientViewer.Actions.JavaScriptAction;
                    onPointerDown?: NutrientViewer.Actions.Action;
                    onPointerEnter?: NutrientViewer.Actions.Action;
                    onPointerLeave?: NutrientViewer.Actions.Action;
                    onPointerUp?: NutrientViewer.Actions.Action;
                }
                | null;
            annotationIds?: NutrientViewer.Immutable.List<string>;
            canSetGroup?: boolean;
            group?: string | null;
            id?: string;
            isDeletable?: boolean;
            isEditable?: boolean;
            isFillable?: boolean;
            label?: string;
            name?: string;
            noExport?: boolean;
            pdfObjectId?: number | null;
            readOnly?: boolean;
            required?: boolean;
            [key: string]: any;
        },
    ) => unknown,
    ...collections: (
        | Iterable<[string, unknown], any, any>
        | Partial<
            {
                additionalActions?: | {
                    onCalculate?: NutrientViewer.Actions.JavaScriptAction;
                    onChange?: NutrientViewer.Actions.JavaScriptAction;
                    onBlur?: NutrientViewer.Actions.JavaScriptAction;
                    onFocus?: NutrientViewer.Actions.JavaScriptAction;
                    onFormat?: NutrientViewer.Actions.JavaScriptAction;
                    onInput?: NutrientViewer.Actions.JavaScriptAction;
                    onPointerDown?: NutrientViewer.Actions.Action;
                    onPointerEnter?: NutrientViewer.Actions.Action;
                    onPointerLeave?: NutrientViewer.Actions.Action;
                    onPointerUp?: NutrientViewer.Actions.Action;
                }
                | null;
                annotationIds?: NutrientViewer.Immutable.List<string>;
                canSetGroup?: boolean;
                group?: string | null;
                id?: string;
                isDeletable?: boolean;
                isEditable?: boolean;
                isFillable?: boolean;
                label?: string;
                name?: string;
                noExport?: boolean;
                pdfObjectId?: number | null;
                readOnly?: boolean;
                required?: boolean;
                [key: string]: any;
            },
        >
    )[],
): this
Parameters
merger
(oldVal: unknown, newVal: unknown, key: keyof { … }) => unknown(
    oldVal: unknown,
    newVal: unknown,
    key: keyof {
        additionalActions?:
            | {
                onCalculate?: NutrientViewer.Actions.JavaScriptAction;
                onChange?: NutrientViewer.Actions.JavaScriptAction;
                onBlur?: NutrientViewer.Actions.JavaScriptAction;
                onFocus?: NutrientViewer.Actions.JavaScriptAction;
                onFormat?: NutrientViewer.Actions.JavaScriptAction;
                onInput?: NutrientViewer.Actions.JavaScriptAction;
                onPointerDown?: NutrientViewer.Actions.Action;
                onPointerEnter?: NutrientViewer.Actions.Action;
                onPointerLeave?: NutrientViewer.Actions.Action;
                onPointerUp?: NutrientViewer.Actions.Action;
            }
            | null;
        annotationIds?: NutrientViewer.Immutable.List<string>;
        canSetGroup?: boolean;
        group?: string | null;
        id?: string;
        isDeletable?: boolean;
        isEditable?: boolean;
        isFillable?: boolean;
        label?: string;
        name?: string;
        noExport?: boolean;
        pdfObjectId?: number | null;
        readOnly?: boolean;
        required?: boolean;
        [key: string]: any;
    },
) => unknown
...collections
(Iterable<[string, unknown], any, any> | Partial<{ … }>)[](
    | Iterable<[string, unknown], any, any>
    | Partial<
        {
            additionalActions?: | {
                onCalculate?: NutrientViewer.Actions.JavaScriptAction;
                onChange?: NutrientViewer.Actions.JavaScriptAction;
                onBlur?: NutrientViewer.Actions.JavaScriptAction;
                onFocus?: NutrientViewer.Actions.JavaScriptAction;
                onFormat?: NutrientViewer.Actions.JavaScriptAction;
                onInput?: NutrientViewer.Actions.JavaScriptAction;
                onPointerDown?: NutrientViewer.Actions.Action;
                onPointerEnter?: NutrientViewer.Actions.Action;
                onPointerLeave?: NutrientViewer.Actions.Action;
                onPointerUp?: NutrientViewer.Actions.Action;
            }
            | null;
            annotationIds?: NutrientViewer.Immutable.List<string>;
            canSetGroup?: boolean;
            group?: string | null;
            id?: string;
            isDeletable?: boolean;
            isEditable?: boolean;
            isFillable?: boolean;
            label?: string;
            name?: string;
            noExport?: boolean;
            pdfObjectId?: number | null;
            readOnly?: boolean;
            required?: boolean;
            [key: string]: any;
        },
    >
)[]
Returns
this
Inherited from FormField.mergeWith

remove

remove<K extends keyof { … }>(key: K): thisremove<
    K extends
        keyof {
            additionalActions?: | {
                onCalculate?: NutrientViewer.Actions.JavaScriptAction;
                onChange?: NutrientViewer.Actions.JavaScriptAction;
                onBlur?: NutrientViewer.Actions.JavaScriptAction;
                onFocus?: NutrientViewer.Actions.JavaScriptAction;
                onFormat?: NutrientViewer.Actions.JavaScriptAction;
                onInput?: NutrientViewer.Actions.JavaScriptAction;
                onPointerDown?: NutrientViewer.Actions.Action;
                onPointerEnter?: NutrientViewer.Actions.Action;
                onPointerLeave?: NutrientViewer.Actions.Action;
                onPointerUp?: NutrientViewer.Actions.Action;
            }
            | null;
            annotationIds?: NutrientViewer.Immutable.List<string>;
            canSetGroup?: boolean;
            group?: string | null;
            id?: string;
            isDeletable?: boolean;
            isEditable?: boolean;
            isFillable?: boolean;
            label?: string;
            name?: string;
            noExport?: boolean;
            pdfObjectId?: number | null;
            readOnly?: boolean;
            required?: boolean;
            [key: string]: any;
        },
>(
    key: K,
): this
Type Parameters
K
extends keyof { … }extends keyof {
    additionalActions?:
        | {
            onCalculate?: NutrientViewer.Actions.JavaScriptAction;
            onChange?: NutrientViewer.Actions.JavaScriptAction;
            onBlur?: NutrientViewer.Actions.JavaScriptAction;
            onFocus?: NutrientViewer.Actions.JavaScriptAction;
            onFormat?: NutrientViewer.Actions.JavaScriptAction;
            onInput?: NutrientViewer.Actions.JavaScriptAction;
            onPointerDown?: NutrientViewer.Actions.Action;
            onPointerEnter?: NutrientViewer.Actions.Action;
            onPointerLeave?: NutrientViewer.Actions.Action;
            onPointerUp?: NutrientViewer.Actions.Action;
        }
        | null;
    annotationIds?: NutrientViewer.Immutable.List<string>;
    canSetGroup?: boolean;
    group?: string | null;
    id?: string;
    isDeletable?: boolean;
    isEditable?: boolean;
    isFillable?: boolean;
    label?: string;
    name?: string;
    noExport?: boolean;
    pdfObjectId?: number | null;
    readOnly?: boolean;
    required?: boolean;
    [key: string]: any;
}
Parameters
keyK
Returns
this
Inherited from FormField.remove

removeIn

removeIn(keyPath: Iterable<unknown>): this
Parameters
keyPathIterable<unknown>
Returns
this
Inherited from FormField.removeIn

set

set<K extends keyof { … }>(key: K, value: { … }[K]): thisset<
    K extends
        keyof {
            additionalActions?: | {
                onCalculate?: NutrientViewer.Actions.JavaScriptAction;
                onChange?: NutrientViewer.Actions.JavaScriptAction;
                onBlur?: NutrientViewer.Actions.JavaScriptAction;
                onFocus?: NutrientViewer.Actions.JavaScriptAction;
                onFormat?: NutrientViewer.Actions.JavaScriptAction;
                onInput?: NutrientViewer.Actions.JavaScriptAction;
                onPointerDown?: NutrientViewer.Actions.Action;
                onPointerEnter?: NutrientViewer.Actions.Action;
                onPointerLeave?: NutrientViewer.Actions.Action;
                onPointerUp?: NutrientViewer.Actions.Action;
            }
            | null;
            annotationIds?: NutrientViewer.Immutable.List<string>;
            canSetGroup?: boolean;
            group?: string | null;
            id?: string;
            isDeletable?: boolean;
            isEditable?: boolean;
            isFillable?: boolean;
            label?: string;
            name?: string;
            noExport?: boolean;
            pdfObjectId?: number | null;
            readOnly?: boolean;
            required?: boolean;
            [key: string]: any;
        },
>(
    key: K,
    value: {
        additionalActions?:
            | {
                onCalculate?: NutrientViewer.Actions.JavaScriptAction;
                onChange?: NutrientViewer.Actions.JavaScriptAction;
                onBlur?: NutrientViewer.Actions.JavaScriptAction;
                onFocus?: NutrientViewer.Actions.JavaScriptAction;
                onFormat?: NutrientViewer.Actions.JavaScriptAction;
                onInput?: NutrientViewer.Actions.JavaScriptAction;
                onPointerDown?: NutrientViewer.Actions.Action;
                onPointerEnter?: NutrientViewer.Actions.Action;
                onPointerLeave?: NutrientViewer.Actions.Action;
                onPointerUp?: NutrientViewer.Actions.Action;
            }
            | null;
        annotationIds?: NutrientViewer.Immutable.List<string>;
        canSetGroup?: boolean;
        group?: string | null;
        id?: string;
        isDeletable?: boolean;
        isEditable?: boolean;
        isFillable?: boolean;
        label?: string;
        name?: string;
        noExport?: boolean;
        pdfObjectId?: number | null;
        readOnly?: boolean;
        required?: boolean;
        [key: string]: any;
    }[K],
): this
Type Parameters
K
extends keyof { … }extends keyof {
    additionalActions?:
        | {
            onCalculate?: NutrientViewer.Actions.JavaScriptAction;
            onChange?: NutrientViewer.Actions.JavaScriptAction;
            onBlur?: NutrientViewer.Actions.JavaScriptAction;
            onFocus?: NutrientViewer.Actions.JavaScriptAction;
            onFormat?: NutrientViewer.Actions.JavaScriptAction;
            onInput?: NutrientViewer.Actions.JavaScriptAction;
            onPointerDown?: NutrientViewer.Actions.Action;
            onPointerEnter?: NutrientViewer.Actions.Action;
            onPointerLeave?: NutrientViewer.Actions.Action;
            onPointerUp?: NutrientViewer.Actions.Action;
        }
        | null;
    annotationIds?: NutrientViewer.Immutable.List<string>;
    canSetGroup?: boolean;
    group?: string | null;
    id?: string;
    isDeletable?: boolean;
    isEditable?: boolean;
    isFillable?: boolean;
    label?: string;
    name?: string;
    noExport?: boolean;
    pdfObjectId?: number | null;
    readOnly?: boolean;
    required?: boolean;
    [key: string]: any;
}
Parameters
keyK
value
{ … }[K]{
    additionalActions?:
        | {
            onCalculate?: NutrientViewer.Actions.JavaScriptAction;
            onChange?: NutrientViewer.Actions.JavaScriptAction;
            onBlur?: NutrientViewer.Actions.JavaScriptAction;
            onFocus?: NutrientViewer.Actions.JavaScriptAction;
            onFormat?: NutrientViewer.Actions.JavaScriptAction;
            onInput?: NutrientViewer.Actions.JavaScriptAction;
            onPointerDown?: NutrientViewer.Actions.Action;
            onPointerEnter?: NutrientViewer.Actions.Action;
            onPointerLeave?: NutrientViewer.Actions.Action;
            onPointerUp?: NutrientViewer.Actions.Action;
        }
        | null;
    annotationIds?: NutrientViewer.Immutable.List<string>;
    canSetGroup?: boolean;
    group?: string | null;
    id?: string;
    isDeletable?: boolean;
    isEditable?: boolean;
    isFillable?: boolean;
    label?: string;
    name?: string;
    noExport?: boolean;
    pdfObjectId?: number | null;
    readOnly?: boolean;
    required?: boolean;
    [key: string]: any;
}[K]
Returns
this
Inherited from FormField.set

setIn

setIn(keyPath: Iterable<unknown>, value: unknown): this
Parameters
keyPathIterable<unknown>
valueunknown
Returns
this
Inherited from FormField.setIn

toJS

toJS(): { … }toJS(): {
    additionalActions?: unknown;
    annotationIds?: unknown;
    canSetGroup?: boolean;
    group?: string
    | null;
    id?: string;
    isDeletable?: boolean;
    isEditable?: boolean;
    isFillable?: boolean;
    label?: string;
    name?: string;
    noExport?: boolean;
    pdfObjectId?: number | null;
    readOnly?: boolean;
    required?: boolean;
    [key: string]: 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
{ … }{
    additionalActions?: unknown;
    annotationIds?: unknown;
    canSetGroup?: boolean;
    group?: string | null;
    id?: string;
    isDeletable?: boolean;
    isEditable?: boolean;
    isFillable?: boolean;
    label?: string;
    name?: string;
    noExport?: boolean;
    pdfObjectId?: number | null;
    readOnly?: boolean;
    required?: boolean;
    [key: string]: any;
}
Inherited from FormField.toJS

toJSON

toJSON(): { … }toJSON(): {
    additionalActions?: | {
        onCalculate?: NutrientViewer.Actions.JavaScriptAction;
        onChange?: NutrientViewer.Actions.JavaScriptAction;
        onBlur?: NutrientViewer.Actions.JavaScriptAction;
        onFocus?: NutrientViewer.Actions.JavaScriptAction;
        onFormat?: NutrientViewer.Actions.JavaScriptAction;
        onInput?: NutrientViewer.Actions.JavaScriptAction;
        onPointerDown?: NutrientViewer.Actions.Action;
        onPointerEnter?: NutrientViewer.Actions.Action;
        onPointerLeave?: NutrientViewer.Actions.Action;
        onPointerUp?: NutrientViewer.Actions.Action;
    }
    | null;
    annotationIds?: NutrientViewer.Immutable.List<string>;
    canSetGroup?: boolean;
    group?: string | null;
    id?: string;
    isDeletable?: boolean;
    isEditable?: boolean;
    isFillable?: boolean;
    label?: string;
    name?: string;
    noExport?: boolean;
    pdfObjectId?: number | null;
    readOnly?: boolean;
    required?: boolean;
    [key: string]: any;
}
Shallowly converts this Record to equivalent native JavaScript Object.

Returns
{ … }{
    additionalActions?:
        | {
            onCalculate?: NutrientViewer.Actions.JavaScriptAction;
            onChange?: NutrientViewer.Actions.JavaScriptAction;
            onBlur?: NutrientViewer.Actions.JavaScriptAction;
            onFocus?: NutrientViewer.Actions.JavaScriptAction;
            onFormat?: NutrientViewer.Actions.JavaScriptAction;
            onInput?: NutrientViewer.Actions.JavaScriptAction;
            onPointerDown?: NutrientViewer.Actions.Action;
            onPointerEnter?: NutrientViewer.Actions.Action;
            onPointerLeave?: NutrientViewer.Actions.Action;
            onPointerUp?: NutrientViewer.Actions.Action;
        }
        | null;
    annotationIds?: NutrientViewer.Immutable.List<string>;
    canSetGroup?: boolean;
    group?: string | null;
    id?: string;
    isDeletable?: boolean;
    isEditable?: boolean;
    isFillable?: boolean;
    label?: string;
    name?: string;
    noExport?: boolean;
    pdfObjectId?: number | null;
    readOnly?: boolean;
    required?: boolean;
    [key: string]: any;
}
Inherited from FormField.toJSON

toObject

toObject(): { … }toObject(): {
    additionalActions?: | {
        onCalculate?: NutrientViewer.Actions.JavaScriptAction;
        onChange?: NutrientViewer.Actions.JavaScriptAction;
        onBlur?: NutrientViewer.Actions.JavaScriptAction;
        onFocus?: NutrientViewer.Actions.JavaScriptAction;
        onFormat?: NutrientViewer.Actions.JavaScriptAction;
        onInput?: NutrientViewer.Actions.JavaScriptAction;
        onPointerDown?: NutrientViewer.Actions.Action;
        onPointerEnter?: NutrientViewer.Actions.Action;
        onPointerLeave?: NutrientViewer.Actions.Action;
        onPointerUp?: NutrientViewer.Actions.Action;
    }
    | null;
    annotationIds?: NutrientViewer.Immutable.List<string>;
    canSetGroup?: boolean;
    group?: string | null;
    id?: string;
    isDeletable?: boolean;
    isEditable?: boolean;
    isFillable?: boolean;
    label?: string;
    name?: string;
    noExport?: boolean;
    pdfObjectId?: number | null;
    readOnly?: boolean;
    required?: boolean;
    [key: string]: any;
}
Shallowly converts this Record to equivalent JavaScript Object.

Returns
{ … }{
    additionalActions?:
        | {
            onCalculate?: NutrientViewer.Actions.JavaScriptAction;
            onChange?: NutrientViewer.Actions.JavaScriptAction;
            onBlur?: NutrientViewer.Actions.JavaScriptAction;
            onFocus?: NutrientViewer.Actions.JavaScriptAction;
            onFormat?: NutrientViewer.Actions.JavaScriptAction;
            onInput?: NutrientViewer.Actions.JavaScriptAction;
            onPointerDown?: NutrientViewer.Actions.Action;
            onPointerEnter?: NutrientViewer.Actions.Action;
            onPointerLeave?: NutrientViewer.Actions.Action;
            onPointerUp?: NutrientViewer.Actions.Action;
        }
        | null;
    annotationIds?: NutrientViewer.Immutable.List<string>;
    canSetGroup?: boolean;
    group?: string | null;
    id?: string;
    isDeletable?: boolean;
    isEditable?: boolean;
    isFillable?: boolean;
    label?: string;
    name?: string;
    noExport?: boolean;
    pdfObjectId?: number | null;
    readOnly?: boolean;
    required?: boolean;
    [key: string]: any;
}
Inherited from FormField.toObject

toSeq

toSeq(): Keyed<keyof { … }, any>toSeq(): Keyed<
    keyof {
        additionalActions?: | {
            onCalculate?: NutrientViewer.Actions.JavaScriptAction;
            onChange?: NutrientViewer.Actions.JavaScriptAction;
            onBlur?: NutrientViewer.Actions.JavaScriptAction;
            onFocus?: NutrientViewer.Actions.JavaScriptAction;
            onFormat?: NutrientViewer.Actions.JavaScriptAction;
            onInput?: NutrientViewer.Actions.JavaScriptAction;
            onPointerDown?: NutrientViewer.Actions.Action;
            onPointerEnter?: NutrientViewer.Actions.Action;
            onPointerLeave?: NutrientViewer.Actions.Action;
            onPointerUp?: NutrientViewer.Actions.Action;
        }
        | null;
        annotationIds?: NutrientViewer.Immutable.List<string>;
        canSetGroup?: boolean;
        group?: string | null;
        id?: string;
        isDeletable?: boolean;
        isEditable?: boolean;
        isFillable?: boolean;
        label?: string;
        name?: string;
        noExport?: boolean;
        pdfObjectId?: number | null;
        readOnly?: boolean;
        required?: boolean;
        [key: string]: any;
    },
    any,
>
Returns
Keyed<keyof { … }, any>Keyed<
    keyof {
        additionalActions?: | {
            onCalculate?: NutrientViewer.Actions.JavaScriptAction;
            onChange?: NutrientViewer.Actions.JavaScriptAction;
            onBlur?: NutrientViewer.Actions.JavaScriptAction;
            onFocus?: NutrientViewer.Actions.JavaScriptAction;
            onFormat?: NutrientViewer.Actions.JavaScriptAction;
            onInput?: NutrientViewer.Actions.JavaScriptAction;
            onPointerDown?: NutrientViewer.Actions.Action;
            onPointerEnter?: NutrientViewer.Actions.Action;
            onPointerLeave?: NutrientViewer.Actions.Action;
            onPointerUp?: NutrientViewer.Actions.Action;
        }
        | null;
        annotationIds?: NutrientViewer.Immutable.List<string>;
        canSetGroup?: boolean;
        group?: string | null;
        id?: string;
        isDeletable?: boolean;
        isEditable?: boolean;
        isFillable?: boolean;
        label?: string;
        name?: string;
        noExport?: boolean;
        pdfObjectId?: number | null;
        readOnly?: boolean;
        required?: boolean;
        [key: string]: any;
    },
    any,
>
Inherited from FormField.toSeq

update

update<K extends keyof { … }>(
    key: K,
    updater: (value: { … }[K]) => { … }[K],
): thisupdate<
    K extends
        keyof {
            additionalActions?: | {
                onCalculate?: NutrientViewer.Actions.JavaScriptAction;
                onChange?: NutrientViewer.Actions.JavaScriptAction;
                onBlur?: NutrientViewer.Actions.JavaScriptAction;
                onFocus?: NutrientViewer.Actions.JavaScriptAction;
                onFormat?: NutrientViewer.Actions.JavaScriptAction;
                onInput?: NutrientViewer.Actions.JavaScriptAction;
                onPointerDown?: NutrientViewer.Actions.Action;
                onPointerEnter?: NutrientViewer.Actions.Action;
                onPointerLeave?: NutrientViewer.Actions.Action;
                onPointerUp?: NutrientViewer.Actions.Action;
            }
            | null;
            annotationIds?: NutrientViewer.Immutable.List<string>;
            canSetGroup?: boolean;
            group?: string | null;
            id?: string;
            isDeletable?: boolean;
            isEditable?: boolean;
            isFillable?: boolean;
            label?: string;
            name?: string;
            noExport?: boolean;
            pdfObjectId?: number | null;
            readOnly?: boolean;
            required?: boolean;
            [key: string]: any;
        },
>(
    key: K,
    updater: (
        value: {
            additionalActions?:
                | {
                    onCalculate?: NutrientViewer.Actions.JavaScriptAction;
                    onChange?: NutrientViewer.Actions.JavaScriptAction;
                    onBlur?: NutrientViewer.Actions.JavaScriptAction;
                    onFocus?: NutrientViewer.Actions.JavaScriptAction;
                    onFormat?: NutrientViewer.Actions.JavaScriptAction;
                    onInput?: NutrientViewer.Actions.JavaScriptAction;
                    onPointerDown?: NutrientViewer.Actions.Action;
                    onPointerEnter?: NutrientViewer.Actions.Action;
                    onPointerLeave?: NutrientViewer.Actions.Action;
                    onPointerUp?: NutrientViewer.Actions.Action;
                }
                | null;
            annotationIds?: NutrientViewer.Immutable.List<string>;
            canSetGroup?: boolean;
            group?: string | null;
            id?: string;
            isDeletable?: boolean;
            isEditable?: boolean;
            isFillable?: boolean;
            label?: string;
            name?: string;
            noExport?: boolean;
            pdfObjectId?: number | null;
            readOnly?: boolean;
            required?: boolean;
            [key: string]: any;
        }[K],
    ) => {
        additionalActions?: | {
            onCalculate?: NutrientViewer.Actions.JavaScriptAction;
            onChange?: NutrientViewer.Actions.JavaScriptAction;
            onBlur?: NutrientViewer.Actions.JavaScriptAction;
            onFocus?: NutrientViewer.Actions.JavaScriptAction;
            onFormat?: NutrientViewer.Actions.JavaScriptAction;
            onInput?: NutrientViewer.Actions.JavaScriptAction;
            onPointerDown?: NutrientViewer.Actions.Action;
            onPointerEnter?: NutrientViewer.Actions.Action;
            onPointerLeave?: NutrientViewer.Actions.Action;
            onPointerUp?: NutrientViewer.Actions.Action;
        }
        | null;
        annotationIds?: NutrientViewer.Immutable.List<string>;
        canSetGroup?: boolean;
        group?: string | null;
        id?: string;
        isDeletable?: boolean;
        isEditable?: boolean;
        isFillable?: boolean;
        label?: string;
        name?: string;
        noExport?: boolean;
        pdfObjectId?: number | null;
        readOnly?: boolean;
        required?: boolean;
        [key: string]: any;
    }[K],
): this
Type Parameters
K
extends keyof { … }extends keyof {
    additionalActions?:
        | {
            onCalculate?: NutrientViewer.Actions.JavaScriptAction;
            onChange?: NutrientViewer.Actions.JavaScriptAction;
            onBlur?: NutrientViewer.Actions.JavaScriptAction;
            onFocus?: NutrientViewer.Actions.JavaScriptAction;
            onFormat?: NutrientViewer.Actions.JavaScriptAction;
            onInput?: NutrientViewer.Actions.JavaScriptAction;
            onPointerDown?: NutrientViewer.Actions.Action;
            onPointerEnter?: NutrientViewer.Actions.Action;
            onPointerLeave?: NutrientViewer.Actions.Action;
            onPointerUp?: NutrientViewer.Actions.Action;
        }
        | null;
    annotationIds?: NutrientViewer.Immutable.List<string>;
    canSetGroup?: boolean;
    group?: string | null;
    id?: string;
    isDeletable?: boolean;
    isEditable?: boolean;
    isFillable?: boolean;
    label?: string;
    name?: string;
    noExport?: boolean;
    pdfObjectId?: number | null;
    readOnly?: boolean;
    required?: boolean;
    [key: string]: any;
}
Parameters
keyK
updater
(value: { … }[K]) => { … }[K](
    value: {
        additionalActions?:
            | {
                onCalculate?: NutrientViewer.Actions.JavaScriptAction;
                onChange?: NutrientViewer.Actions.JavaScriptAction;
                onBlur?: NutrientViewer.Actions.JavaScriptAction;
                onFocus?: NutrientViewer.Actions.JavaScriptAction;
                onFormat?: NutrientViewer.Actions.JavaScriptAction;
                onInput?: NutrientViewer.Actions.JavaScriptAction;
                onPointerDown?: NutrientViewer.Actions.Action;
                onPointerEnter?: NutrientViewer.Actions.Action;
                onPointerLeave?: NutrientViewer.Actions.Action;
                onPointerUp?: NutrientViewer.Actions.Action;
            }
            | null;
        annotationIds?: NutrientViewer.Immutable.List<string>;
        canSetGroup?: boolean;
        group?: string | null;
        id?: string;
        isDeletable?: boolean;
        isEditable?: boolean;
        isFillable?: boolean;
        label?: string;
        name?: string;
        noExport?: boolean;
        pdfObjectId?: number | null;
        readOnly?: boolean;
        required?: boolean;
        [key: string]: any;
    }[K],
) => {
    additionalActions?: | {
        onCalculate?: NutrientViewer.Actions.JavaScriptAction;
        onChange?: NutrientViewer.Actions.JavaScriptAction;
        onBlur?: NutrientViewer.Actions.JavaScriptAction;
        onFocus?: NutrientViewer.Actions.JavaScriptAction;
        onFormat?: NutrientViewer.Actions.JavaScriptAction;
        onInput?: NutrientViewer.Actions.JavaScriptAction;
        onPointerDown?: NutrientViewer.Actions.Action;
        onPointerEnter?: NutrientViewer.Actions.Action;
        onPointerLeave?: NutrientViewer.Actions.Action;
        onPointerUp?: NutrientViewer.Actions.Action;
    }
    | null;
    annotationIds?: NutrientViewer.Immutable.List<string>;
    canSetGroup?: boolean;
    group?: string | null;
    id?: string;
    isDeletable?: boolean;
    isEditable?: boolean;
    isFillable?: boolean;
    label?: string;
    name?: string;
    noExport?: boolean;
    pdfObjectId?: number | null;
    readOnly?: boolean;
    required?: boolean;
    [key: string]: any;
}[K]
Returns
this
Inherited from FormField.update

updateIn

updateIn(keyPath: Iterable<unknown>, updater: (value: unknown) => unknown): this
Parameters
keyPathIterable<unknown>
updater(value: unknown) => unknown
Returns
this
Inherited from FormField.updateIn

wasAltered

wasAltered(): boolean
Returns
boolean
See Also
Map#wasAltered
Inherited from FormField.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 FormField.withMutations

Class ChoiceFormField

Hierarchy

Subclasses

Constructors

Parameters

Properties

Default Value

Default Value

Default Value

Default Value

Default Value

Default Value

Immutable Record API

Indexable

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