Class FormField

Form field type from which all form fields inherit. You can not instantiate from this type.

To retrieve a list of all form fields, use NutrientViewer.Instance#getFormFields.

Please see our forms guide article to learn more about form fields and for examples on how to create them.

Example

Creating a form field.

const widget = new NutrientViewer.Annotations.WidgetAnnotation({
   // Generate unique ID so it can be referenced in form field before the widget is created.
   id: NutrientViewer.generateInstantId(),
   pageIndex: 0,
   formFieldName: 'form-field',
   boundingBox: new NutrientViewer.Geometry.Rect({
      left: 50,
      top: 50,
      width: 50,
      height: 50,
   }),
}),
const formField = new NutrientViewer.FormFields.TextFormField({
   name: 'form-field',
   annotationIds: new NutrientViewer.Immutable.List([widget.id]),
})
instance.create([widget, formField]);

See

Hierarchy

Record<
    {
        additionalActions?: any;
        annotationIds?: NutrientViewer.Immutable.List<string>;
        canSetGroup?: boolean;
        group?: null | string;
        id?: string;
        isDeletable?: boolean;
        isEditable?: boolean;
        isFillable?: boolean;
        label?: string;
        name?: string;
        noExport?: boolean;
        pdfObjectId?: null | number;
        readOnly?: boolean;
        required?: boolean;
        [key: string]: any;
    },
    this,
> & Readonly<
    {
        additionalActions?: any;
        annotationIds?: NutrientViewer.Immutable.List<string>;
        canSetGroup?: boolean;
        group?: null | string;
        id?: string;
        isDeletable?: boolean;
        isEditable?: boolean;
        isFillable?: boolean;
        label?: string;
        name?: string;
        noExport?: boolean;
        pdfObjectId?: null | number;
        readOnly?: boolean;
        required?: boolean;
        [key: string]: any;
    },
>
- FormField

Indexable

readonly [key: string]: any

Constructors

constructor

new FormField(
    args?: {
        additionalActions?: any;
        annotationIds?: NutrientViewer.Immutable.List<string>;
        canSetGroup?: boolean;
        group?: null | string;
        id?: string;
        isDeletable?: boolean;
        isEditable?: boolean;
        isFillable?: boolean;
        label?: string;
        name?: string;
        noExport?: boolean;
        pdfObjectId?: null | number;
        readOnly?: boolean;
        required?: boolean;
        [key: string]: any;
    },
): NutrientViewer.FormFields.FormField
Parameters
- Optionalargs: {
      additionalActions?: any;
      annotationIds?: NutrientViewer.Immutable.List<string>;
      canSetGroup?: boolean;
      group?: null | string;
      id?: string;
      isDeletable?: boolean;
      isEditable?: boolean;
      isFillable?: boolean;
      label?: string;
      name?: string;
      noExport?: boolean;
      pdfObjectId?: null | number;
      readOnly?: boolean;
      required?: boolean;
      [key: string]: any;
  }
Returns NutrientViewer.FormFields.FormField
Overrides (InheritableImmutableRecord as Immutable.Record.Factory<IFormField>).constructor

Properties

additionalActions

additionalActions:
    | undefined
    | null
    | {
        onCalculate?: NutrientViewer.Actions.Action;
        onChange?: NutrientViewer.Actions.Action;
    } & {
        onBlur?: NutrientViewer.Actions.JavaScriptAction;
        onChange?: 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;
    }

Optional actions to execute when an event is triggered.

Type Declaration

undefined
null
{
    onCalculate?: NutrientViewer.Actions.Action;
    onChange?: NutrientViewer.Actions.Action;
} & {
    onBlur?: NutrientViewer.Actions.JavaScriptAction;
    onChange?: 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;
}
- OptionalonCalculate?: NutrientViewer.Actions.Action
  Action to be performed to recalculate the value of a field.
  
  The name of this event in the PDF spec is C.
- OptionalonChange?: NutrientViewer.Actions.Action
  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.
- OptionalonBlur?: NutrientViewer.Actions.JavaScriptAction
  Execute an action when the widget loses focus.
  
  The name of this event in the PDF spec is Bl.
- OptionalonChange?: NutrientViewer.Actions.JavaScriptAction
  Action to be performed when the user changes the value of the field.
  
  The name of this event in the PDF spec is V.
- OptionalonFocus?: NutrientViewer.Actions.JavaScriptAction
  Execute an action when the widget is focused.
  
  The name of this event in the PDF spec is Fo.
- OptionalonFormat?: NutrientViewer.Actions.JavaScriptAction
  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.
- OptionalonInput?: NutrientViewer.Actions.JavaScriptAction
  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.
- OptionalonPointerDown?: NutrientViewer.Actions.Action
  Action to be performed when the pointer is pressed.
- OptionalonPointerEnter?: NutrientViewer.Actions.Action
  Action to be performed when the pointer enters the field area.
- OptionalonPointerLeave?: NutrientViewer.Actions.Action
  Action to be performed when the pointer hovers the field.
- OptionalonPointerUp?: NutrientViewer.Actions.Action
  Action to be performed when the pointer is released.

Default

null

TODO_RITESH: https://www.nutrient.io/api/web/NutrientViewer.FormFieldAdditionalActions.html

annotationIds

annotationIds: NutrientViewer.Immutable.List<string>

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

`Optional` `Readonly`canSetGroup

canSetGroup?: 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.

`Optional`group

group?: null | string

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

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.

`Optional` `Readonly`isDeletable

isDeletable?: 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.

`Optional` `Readonly`isEditable

isEditable?: 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.

`Optional` `Readonly`isFillable

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

label: string

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

name

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

noExport: boolean

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

Default

false

pdfObjectId

pdfObjectId: number

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

readOnly

readOnly: boolean

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

Default

false

required

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]https://www.nutrient.io/api/web/css-Widget-Annotation.html#.PSPDFKit-Annotation-Widget-Required public CSS class and the HTML required attribute set.

Default

false

Methods

[iterator]

"[iterator]"(): IterableIterator<
    [
        keyof {
            additionalActions?: any;
            annotationIds?: NutrientViewer.Immutable.List<string>;
            canSetGroup?: boolean;
            group?: null | string;
            id?: string;
            isDeletable?: boolean;
            isEditable?: boolean;
            isFillable?: boolean;
            label?: string;
            name?: string;
            noExport?: boolean;
            pdfObjectId?: null | number;
            readOnly?: boolean;
            required?: boolean;
            [key: string]: any;
        },
        any,
    ],
>
Returns IterableIterator<
    [
        keyof {
            additionalActions?: any;
            annotationIds?: NutrientViewer.Immutable.List<string>;
            canSetGroup?: boolean;
            group?: null | string;
            id?: string;
            isDeletable?: boolean;
            isEditable?: boolean;
            isFillable?: boolean;
            label?: string;
            name?: string;
            noExport?: boolean;
            pdfObjectId?: null | number;
            readOnly?: boolean;
            required?: boolean;
            [key: string]: any;
        },
        any,
    ],
>
Inherited from (InheritableImmutableRecord as Immutable.Record.Factory<IFormField>).[iterator]

asImmutable

asImmutable(): this
Returns this
See
Map#asImmutable

Inherited from (InheritableImmutableRecord as Immutable.Record.Factory<IFormField>).asImmutable

asMutable

asMutable(): this
Returns this
See
Map#asMutable

Inherited from (InheritableImmutableRecord as Immutable.Record.Factory<IFormField>).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<IFormField>).clear

delete

delete<
    K extends
        keyof {
            additionalActions?: any;
            annotationIds?: NutrientViewer.Immutable.List<string>;
            canSetGroup?: boolean;
            group?: null | string;
            id?: string;
            isDeletable?: boolean;
            isEditable?: boolean;
            isFillable?: boolean;
            label?: string;
            name?: string;
            noExport?: boolean;
            pdfObjectId?: null | number;
            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 {
      additionalActions?: any;
      annotationIds?: NutrientViewer.Immutable.List<string>;
      canSetGroup?: boolean;
      group?: null | string;
      id?: string;
      isDeletable?: boolean;
      isEditable?: boolean;
      isFillable?: boolean;
      label?: string;
      name?: string;
      noExport?: boolean;
      pdfObjectId?: null | number;
      readOnly?: boolean;
      required?: boolean;
      [key: string]: any;
  }
Parameters
- key: K
Returns this
Alias
remove

Inherited from (InheritableImmutableRecord as Immutable.Record.Factory<IFormField>).delete

deleteIn

deleteIn(keyPath: Iterable<any>): this
Parameters
- keyPath: Iterable<any>
Returns this
Alias
removeIn

Inherited from (InheritableImmutableRecord as Immutable.Record.Factory<IFormField>).deleteIn

equals

equals(other: any): boolean
Parameters
- other: any
Returns boolean
Inherited from (InheritableImmutableRecord as Immutable.Record.Factory<IFormField>).equals

get

get<
    K extends
        keyof {
            additionalActions?: any;
            annotationIds?: NutrientViewer.Immutable.List<string>;
            canSetGroup?: boolean;
            group?: null | string;
            id?: string;
            isDeletable?: boolean;
            isEditable?: boolean;
            isFillable?: boolean;
            label?: string;
            name?: string;
            noExport?: boolean;
            pdfObjectId?: null | number;
            readOnly?: boolean;
            required?: boolean;
            [key: string]: any;
        },
>(
    key: K,
    notSetValue?: any,
): {
    additionalActions?: any;
    annotationIds?: NutrientViewer.Immutable.List<string>;
    canSetGroup?: boolean;
    group?: null | string;
    id?: string;
    isDeletable?: boolean;
    isEditable?: boolean;
    isFillable?: boolean;
    label?: string;
    name?: string;
    noExport?: boolean;
    pdfObjectId?: null | number;
    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 {
      additionalActions?: any;
      annotationIds?: NutrientViewer.Immutable.List<string>;
      canSetGroup?: boolean;
      group?: null | string;
      id?: string;
      isDeletable?: boolean;
      isEditable?: boolean;
      isFillable?: boolean;
      label?: string;
      name?: string;
      noExport?: boolean;
      pdfObjectId?: null | number;
      readOnly?: boolean;
      required?: boolean;
      [key: string]: any;
  }
Parameters
- key: K
- OptionalnotSetValue: any
Returns {
    additionalActions?: any;
    annotationIds?: NutrientViewer.Immutable.List<string>;
    canSetGroup?: boolean;
    group?: null | string;
    id?: string;
    isDeletable?: boolean;
    isEditable?: boolean;
    isFillable?: boolean;
    label?: string;
    name?: string;
    noExport?: boolean;
    pdfObjectId?: null | number;
    readOnly?: boolean;
    required?: boolean;
    [key: string]: any;
}[K]
Inherited from (InheritableImmutableRecord as Immutable.Record.Factory<IFormField>).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<IFormField>).get

getIn

getIn(keyPath: Iterable<any>): any
Parameters
- keyPath: Iterable<any>
Returns any
Inherited from (InheritableImmutableRecord as Immutable.Record.Factory<IFormField>).getIn

has

has(key: string): key is string
Parameters
- key: string
Returns key is string
Inherited from (InheritableImmutableRecord as Immutable.Record.Factory<IFormField>).has

hashCode

hashCode(): number
Returns number
Inherited from (InheritableImmutableRecord as Immutable.Record.Factory<IFormField>).hashCode

hasIn

hasIn(keyPath: Iterable<any>): boolean
Parameters
- keyPath: Iterable<any>
Returns boolean
Inherited from (InheritableImmutableRecord as Immutable.Record.Factory<IFormField>).hasIn

merge

merge(
    ...collections: (
        | Iterable<[string, any], any, any>
        | Partial<
            {
                additionalActions?: any;
                annotationIds?: NutrientViewer.Immutable.List<string>;
                canSetGroup?: boolean;
                group?: null | string;
                id?: string;
                isDeletable?: boolean;
                isEditable?: boolean;
                isFillable?: boolean;
                label?: string;
                name?: string;
                noExport?: boolean;
                pdfObjectId?: null | number;
                readOnly?: boolean;
                required?: boolean;
                [key: string]: any;
            },
        >
    )[],
): this
Parameters
- ...collections: (
      | Iterable<[string, any], any, any>
      | Partial<
          {
              additionalActions?: any;
              annotationIds?: NutrientViewer.Immutable.List<string>;
              canSetGroup?: boolean;
              group?: null | string;
              id?: string;
              isDeletable?: boolean;
              isEditable?: boolean;
              isFillable?: boolean;
              label?: string;
              name?: string;
              noExport?: boolean;
              pdfObjectId?: null | number;
              readOnly?: boolean;
              required?: boolean;
              [key: string]: any;
          },
      >
  )[]
Returns this
Inherited from (InheritableImmutableRecord as Immutable.Record.Factory<IFormField>).merge

mergeDeep

mergeDeep(
    ...collections: (
        | Iterable<[string, any], any, any>
        | Partial<
            {
                additionalActions?: any;
                annotationIds?: NutrientViewer.Immutable.List<string>;
                canSetGroup?: boolean;
                group?: null | string;
                id?: string;
                isDeletable?: boolean;
                isEditable?: boolean;
                isFillable?: boolean;
                label?: string;
                name?: string;
                noExport?: boolean;
                pdfObjectId?: null | number;
                readOnly?: boolean;
                required?: boolean;
                [key: string]: any;
            },
        >
    )[],
): this
Parameters
- ...collections: (
      | Iterable<[string, any], any, any>
      | Partial<
          {
              additionalActions?: any;
              annotationIds?: NutrientViewer.Immutable.List<string>;
              canSetGroup?: boolean;
              group?: null | string;
              id?: string;
              isDeletable?: boolean;
              isEditable?: boolean;
              isFillable?: boolean;
              label?: string;
              name?: string;
              noExport?: boolean;
              pdfObjectId?: null | number;
              readOnly?: boolean;
              required?: boolean;
              [key: string]: any;
          },
      >
  )[]
Returns this
Inherited from (InheritableImmutableRecord as Immutable.Record.Factory<IFormField>).mergeDeep

mergeDeepIn

mergeDeepIn(keyPath: Iterable<any>, ...collections: any[]): this
Parameters
- keyPath: Iterable<any>
- ...collections: any[]
Returns this
Inherited from (InheritableImmutableRecord as Immutable.Record.Factory<IFormField>).mergeDeepIn

mergeDeepWith

mergeDeepWith(
    merger: (oldVal: any, newVal: any, key: any) => any,
    ...collections: (
        | Iterable<[string, any], any, any>
        | Partial<
            {
                additionalActions?: any;
                annotationIds?: NutrientViewer.Immutable.List<string>;
                canSetGroup?: boolean;
                group?: null | string;
                id?: string;
                isDeletable?: boolean;
                isEditable?: boolean;
                isFillable?: boolean;
                label?: string;
                name?: string;
                noExport?: boolean;
                pdfObjectId?: null | number;
                readOnly?: boolean;
                required?: boolean;
                [key: string]: any;
            },
        >
    )[],
): this
Parameters
- merger: (oldVal: any, newVal: any, key: any) => any
- ...collections: (
      | Iterable<[string, any], any, any>
      | Partial<
          {
              additionalActions?: any;
              annotationIds?: NutrientViewer.Immutable.List<string>;
              canSetGroup?: boolean;
              group?: null | string;
              id?: string;
              isDeletable?: boolean;
              isEditable?: boolean;
              isFillable?: boolean;
              label?: string;
              name?: string;
              noExport?: boolean;
              pdfObjectId?: null | number;
              readOnly?: boolean;
              required?: boolean;
              [key: string]: any;
          },
      >
  )[]
Returns this
Inherited from (InheritableImmutableRecord as Immutable.Record.Factory<IFormField>).mergeDeepWith

mergeIn

mergeIn(keyPath: Iterable<any>, ...collections: any[]): this
Parameters
- keyPath: Iterable<any>
- ...collections: any[]
Returns this
Inherited from (InheritableImmutableRecord as Immutable.Record.Factory<IFormField>).mergeIn

mergeWith

mergeWith(
    merger: (
        oldVal: any,
        newVal: any,
        key: keyof {
            additionalActions?: any;
            annotationIds?: NutrientViewer.Immutable.List<string>;
            canSetGroup?: boolean;
            group?: null | string;
            id?: string;
            isDeletable?: boolean;
            isEditable?: boolean;
            isFillable?: boolean;
            label?: string;
            name?: string;
            noExport?: boolean;
            pdfObjectId?: null | number;
            readOnly?: boolean;
            required?: boolean;
            [key: string]: any;
        },
    ) => any,
    ...collections: (
        | Iterable<[string, any], any, any>
        | Partial<
            {
                additionalActions?: any;
                annotationIds?: NutrientViewer.Immutable.List<string>;
                canSetGroup?: boolean;
                group?: null | string;
                id?: string;
                isDeletable?: boolean;
                isEditable?: boolean;
                isFillable?: boolean;
                label?: string;
                name?: string;
                noExport?: boolean;
                pdfObjectId?: null | number;
                readOnly?: boolean;
                required?: boolean;
                [key: string]: any;
            },
        >
    )[],
): this
Parameters
- merger: (
      oldVal: any,
      newVal: any,
      key: keyof {
          additionalActions?: any;
          annotationIds?: NutrientViewer.Immutable.List<string>;
          canSetGroup?: boolean;
          group?: null | string;
          id?: string;
          isDeletable?: boolean;
          isEditable?: boolean;
          isFillable?: boolean;
          label?: string;
          name?: string;
          noExport?: boolean;
          pdfObjectId?: null | number;
          readOnly?: boolean;
          required?: boolean;
          [key: string]: any;
      },
  ) => any
- ...collections: (
      | Iterable<[string, any], any, any>
      | Partial<
          {
              additionalActions?: any;
              annotationIds?: NutrientViewer.Immutable.List<string>;
              canSetGroup?: boolean;
              group?: null | string;
              id?: string;
              isDeletable?: boolean;
              isEditable?: boolean;
              isFillable?: boolean;
              label?: string;
              name?: string;
              noExport?: boolean;
              pdfObjectId?: null | number;
              readOnly?: boolean;
              required?: boolean;
              [key: string]: any;
          },
      >
  )[]
Returns this
Inherited from (InheritableImmutableRecord as Immutable.Record.Factory<IFormField>).mergeWith

remove

remove<
    K extends
        keyof {
            additionalActions?: any;
            annotationIds?: NutrientViewer.Immutable.List<string>;
            canSetGroup?: boolean;
            group?: null | string;
            id?: string;
            isDeletable?: boolean;
            isEditable?: boolean;
            isFillable?: boolean;
            label?: string;
            name?: string;
            noExport?: boolean;
            pdfObjectId?: null | number;
            readOnly?: boolean;
            required?: boolean;
            [key: string]: any;
        },
>(
    key: K,
): this
Type Parameters
- K extends keyof {
      additionalActions?: any;
      annotationIds?: NutrientViewer.Immutable.List<string>;
      canSetGroup?: boolean;
      group?: null | string;
      id?: string;
      isDeletable?: boolean;
      isEditable?: boolean;
      isFillable?: boolean;
      label?: string;
      name?: string;
      noExport?: boolean;
      pdfObjectId?: null | number;
      readOnly?: boolean;
      required?: boolean;
      [key: string]: any;
  }
Parameters
- key: K
Returns this
Inherited from (InheritableImmutableRecord as Immutable.Record.Factory<IFormField>).remove

removeIn

removeIn(keyPath: Iterable<any>): this
Parameters
- keyPath: Iterable<any>
Returns this
Inherited from (InheritableImmutableRecord as Immutable.Record.Factory<IFormField>).removeIn

set

set<
    K extends
        keyof {
            additionalActions?: any;
            annotationIds?: NutrientViewer.Immutable.List<string>;
            canSetGroup?: boolean;
            group?: null | string;
            id?: string;
            isDeletable?: boolean;
            isEditable?: boolean;
            isFillable?: boolean;
            label?: string;
            name?: string;
            noExport?: boolean;
            pdfObjectId?: null | number;
            readOnly?: boolean;
            required?: boolean;
            [key: string]: any;
        },
>(
    key: K,
    value: {
        additionalActions?: any;
        annotationIds?: NutrientViewer.Immutable.List<string>;
        canSetGroup?: boolean;
        group?: null | string;
        id?: string;
        isDeletable?: boolean;
        isEditable?: boolean;
        isFillable?: boolean;
        label?: string;
        name?: string;
        noExport?: boolean;
        pdfObjectId?: null | number;
        readOnly?: boolean;
        required?: boolean;
        [key: string]: any;
    }[K],
): this
Type Parameters
- K extends keyof {
      additionalActions?: any;
      annotationIds?: NutrientViewer.Immutable.List<string>;
      canSetGroup?: boolean;
      group?: null | string;
      id?: string;
      isDeletable?: boolean;
      isEditable?: boolean;
      isFillable?: boolean;
      label?: string;
      name?: string;
      noExport?: boolean;
      pdfObjectId?: null | number;
      readOnly?: boolean;
      required?: boolean;
      [key: string]: any;
  }
Parameters
- key: K
- value: {
      additionalActions?: any;
      annotationIds?: NutrientViewer.Immutable.List<string>;
      canSetGroup?: boolean;
      group?: null | string;
      id?: string;
      isDeletable?: boolean;
      isEditable?: boolean;
      isFillable?: boolean;
      label?: string;
      name?: string;
      noExport?: boolean;
      pdfObjectId?: null | number;
      readOnly?: boolean;
      required?: boolean;
      [key: string]: any;
  }[K]
Returns this
Inherited from (InheritableImmutableRecord as Immutable.Record.Factory<IFormField>).set

setIn

setIn(keyPath: Iterable<any>, value: any): this
Parameters
- keyPath: Iterable<any>
- value: any
Returns this
Inherited from (InheritableImmutableRecord as Immutable.Record.Factory<IFormField>).setIn

toJS

toJS(): {
    additionalActions?: any;
    annotationIds?: any;
    canSetGroup?: any;
    group?: any;
    id?: any;
    isDeletable?: any;
    isEditable?: any;
    isFillable?: any;
    label?: any;
    name?: any;
    noExport?: any;
    pdfObjectId?: any;
    readOnly?: any;
    required?: any;
    [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?: any;
    annotationIds?: any;
    canSetGroup?: any;
    group?: any;
    id?: any;
    isDeletable?: any;
    isEditable?: any;
    isFillable?: any;
    label?: any;
    name?: any;
    noExport?: any;
    pdfObjectId?: any;
    readOnly?: any;
    required?: any;
    [key: string]: any;
}
Inherited from (InheritableImmutableRecord as Immutable.Record.Factory<IFormField>).toJS

toJSON

toJSON(): {
    additionalActions?: any;
    annotationIds?: NutrientViewer.Immutable.List<string>;
    canSetGroup?: boolean;
    group?: null | string;
    id?: string;
    isDeletable?: boolean;
    isEditable?: boolean;
    isFillable?: boolean;
    label?: string;
    name?: string;
    noExport?: boolean;
    pdfObjectId?: null | number;
    readOnly?: boolean;
    required?: boolean;
    [key: string]: any;
}
Shallowly converts this Record to equivalent native JavaScript Object.

Returns {
    additionalActions?: any;
    annotationIds?: NutrientViewer.Immutable.List<string>;
    canSetGroup?: boolean;
    group?: null | string;
    id?: string;
    isDeletable?: boolean;
    isEditable?: boolean;
    isFillable?: boolean;
    label?: string;
    name?: string;
    noExport?: boolean;
    pdfObjectId?: null | number;
    readOnly?: boolean;
    required?: boolean;
    [key: string]: any;
}
Inherited from (InheritableImmutableRecord as Immutable.Record.Factory<IFormField>).toJSON

toObject

toObject(): {
    additionalActions?: any;
    annotationIds?: NutrientViewer.Immutable.List<string>;
    canSetGroup?: boolean;
    group?: null | string;
    id?: string;
    isDeletable?: boolean;
    isEditable?: boolean;
    isFillable?: boolean;
    label?: string;
    name?: string;
    noExport?: boolean;
    pdfObjectId?: null | number;
    readOnly?: boolean;
    required?: boolean;
    [key: string]: any;
}
Shallowly converts this Record to equivalent JavaScript Object.

Returns {
    additionalActions?: any;
    annotationIds?: NutrientViewer.Immutable.List<string>;
    canSetGroup?: boolean;
    group?: null | string;
    id?: string;
    isDeletable?: boolean;
    isEditable?: boolean;
    isFillable?: boolean;
    label?: string;
    name?: string;
    noExport?: boolean;
    pdfObjectId?: null | number;
    readOnly?: boolean;
    required?: boolean;
    [key: string]: any;
}
Inherited from (InheritableImmutableRecord as Immutable.Record.Factory<IFormField>).toObject

toSeq

toSeq(): Keyed<
    keyof {
        additionalActions?: any;
        annotationIds?: NutrientViewer.Immutable.List<string>;
        canSetGroup?: boolean;
        group?: null | string;
        id?: string;
        isDeletable?: boolean;
        isEditable?: boolean;
        isFillable?: boolean;
        label?: string;
        name?: string;
        noExport?: boolean;
        pdfObjectId?: null | number;
        readOnly?: boolean;
        required?: boolean;
        [key: string]: any;
    },
    any,
>
Returns Keyed<
    keyof {
        additionalActions?: any;
        annotationIds?: NutrientViewer.Immutable.List<string>;
        canSetGroup?: boolean;
        group?: null | string;
        id?: string;
        isDeletable?: boolean;
        isEditable?: boolean;
        isFillable?: boolean;
        label?: string;
        name?: string;
        noExport?: boolean;
        pdfObjectId?: null | number;
        readOnly?: boolean;
        required?: boolean;
        [key: string]: any;
    },
    any,
>
Inherited from (InheritableImmutableRecord as Immutable.Record.Factory<IFormField>).toSeq

update

update<
    K extends
        keyof {
            additionalActions?: any;
            annotationIds?: NutrientViewer.Immutable.List<string>;
            canSetGroup?: boolean;
            group?: null | string;
            id?: string;
            isDeletable?: boolean;
            isEditable?: boolean;
            isFillable?: boolean;
            label?: string;
            name?: string;
            noExport?: boolean;
            pdfObjectId?: null | number;
            readOnly?: boolean;
            required?: boolean;
            [key: string]: any;
        },
>(
    key: K,
    updater: (
        value: {
            additionalActions?: any;
            annotationIds?: NutrientViewer.Immutable.List<string>;
            canSetGroup?: boolean;
            group?: null | string;
            id?: string;
            isDeletable?: boolean;
            isEditable?: boolean;
            isFillable?: boolean;
            label?: string;
            name?: string;
            noExport?: boolean;
            pdfObjectId?: null | number;
            readOnly?: boolean;
            required?: boolean;
            [key: string]: any;
        }[K],
    ) => {
        additionalActions?: any;
        annotationIds?: NutrientViewer.Immutable.List<string>;
        canSetGroup?: boolean;
        group?: null | string;
        id?: string;
        isDeletable?: boolean;
        isEditable?: boolean;
        isFillable?: boolean;
        label?: string;
        name?: string;
        noExport?: boolean;
        pdfObjectId?: null | number;
        readOnly?: boolean;
        required?: boolean;
        [key: string]: any;
    }[K],
): this
Type Parameters
- K extends keyof {
      additionalActions?: any;
      annotationIds?: NutrientViewer.Immutable.List<string>;
      canSetGroup?: boolean;
      group?: null | string;
      id?: string;
      isDeletable?: boolean;
      isEditable?: boolean;
      isFillable?: boolean;
      label?: string;
      name?: string;
      noExport?: boolean;
      pdfObjectId?: null | number;
      readOnly?: boolean;
      required?: boolean;
      [key: string]: any;
  }
Parameters
- key: K
- updater: (
      value: {
          additionalActions?: any;
          annotationIds?: NutrientViewer.Immutable.List<string>;
          canSetGroup?: boolean;
          group?: null | string;
          id?: string;
          isDeletable?: boolean;
          isEditable?: boolean;
          isFillable?: boolean;
          label?: string;
          name?: string;
          noExport?: boolean;
          pdfObjectId?: null | number;
          readOnly?: boolean;
          required?: boolean;
          [key: string]: any;
      }[K],
  ) => {
      additionalActions?: any;
      annotationIds?: NutrientViewer.Immutable.List<string>;
      canSetGroup?: boolean;
      group?: null | string;
      id?: string;
      isDeletable?: boolean;
      isEditable?: boolean;
      isFillable?: boolean;
      label?: string;
      name?: string;
      noExport?: boolean;
      pdfObjectId?: null | number;
      readOnly?: boolean;
      required?: boolean;
      [key: string]: any;
  }[K]
Returns this
Inherited from (InheritableImmutableRecord as Immutable.Record.Factory<IFormField>).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<IFormField>).updateIn

wasAltered

wasAltered(): boolean
Returns boolean
See
Map#wasAltered

Inherited from (InheritableImmutableRecord as Immutable.Record.Factory<IFormField>).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<IFormField>).withMutations

Class FormField

Example

See

Hierarchy

Indexable

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns NutrientViewer.FormFields.FormField

Properties

additionalActions

Type Declaration

OptionalonCalculate?: NutrientViewer.Actions.Action

OptionalonChange?: NutrientViewer.Actions.Action

OptionalonBlur?: NutrientViewer.Actions.JavaScriptAction

OptionalonChange?: NutrientViewer.Actions.JavaScriptAction

OptionalonFocus?: NutrientViewer.Actions.JavaScriptAction

OptionalonFormat?: NutrientViewer.Actions.JavaScriptAction

OptionalonInput?: NutrientViewer.Actions.JavaScriptAction

OptionalonPointerDown?: NutrientViewer.Actions.Action

OptionalonPointerEnter?: NutrientViewer.Actions.Action

OptionalonPointerLeave?: NutrientViewer.Actions.Action

OptionalonPointerUp?: NutrientViewer.Actions.Action

Default

annotationIds

Optional ReadonlycanSetGroup

Optionalgroup

id

Optional ReadonlyisDeletable

Optional ReadonlyisEditable

Optional ReadonlyisFillable

label

name

noExport

Default

pdfObjectId

readOnly

Default

required

Default

Methods

[iterator]

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

Type Parameters

Parameters

Returns T

getIn

Parameters

Returns any

has

Parameters

Returns key is string

hashCode

Returns number

`Optional`onCalculate?: NutrientViewer.Actions.Action

`Optional`onChange?: NutrientViewer.Actions.Action

`Optional`onBlur?: NutrientViewer.Actions.JavaScriptAction

`Optional`onChange?: NutrientViewer.Actions.JavaScriptAction

`Optional`onFocus?: NutrientViewer.Actions.JavaScriptAction

`Optional`onFormat?: NutrientViewer.Actions.JavaScriptAction

`Optional`onInput?: NutrientViewer.Actions.JavaScriptAction

`Optional`onPointerDown?: NutrientViewer.Actions.Action

`Optional`onPointerEnter?: NutrientViewer.Actions.Action

`Optional`onPointerLeave?: NutrientViewer.Actions.Action

`Optional`onPointerUp?: NutrientViewer.Actions.Action

`Optional` `Readonly`canSetGroup

`Optional`group

`Optional` `Readonly`isDeletable

`Optional` `Readonly`isEditable

`Optional` `Readonly`isFillable

Returns {
additionalActions?: any;
annotationIds?: any;
canSetGroup?: any;
group?: any;
id?: any;
isDeletable?: any;
isEditable?: any;
isFillable?: any;
label?: any;
name?: any;
noExport?: any;
pdfObjectId?: any;
readOnly?: any;
required?: any;
[key: string]: any;
}