Reference NutrientViewer ActionsJavaScriptAction

Class JavaScriptAction

PDF action to run arbitrary JavaScript.

It is an Immutable.Record and thus can be updated using set(key, value), for example: action.set("script", "alert(...)");.

Class

Example

Create a new JavaScriptAction

const action = new NutrientViewer.Actions.JavaScriptAction({
  script: "alert(...)"
});

Create a button to import a image using a JavaScriptAction

const widget = new NutrientViewer.Annotations.WidgetAnnotation({
  id: NutrientViewer.generateInstantId(),
  pageIndex: 0,
  formFieldName: "buttonIcon",
  boundingBox: new NutrientViewer.Geometry.Rect({
    left: 100,
    top: 200,
    width: 100,
    height: 100
  }),
  action: new NutrientViewer.Actions.JavaScriptAction({
    script: "event.target.buttonImportIcon()"
  }),
  borderWidth: 0
});
const formField = new NutrientViewer.FormFields.ButtonFormField({
  name: "buttonIcon",
  annotationIds: NutrientViewer.Immutable.List([widget.id])
});
await instance.create([widget, formField]);

Hierarchy

JavaScriptActionDataActionJavaScriptAction

Constructors

new JavaScriptAction(args)

Parameters
args
{ … }{
    script?: string;
    subActions?:
        | NutrientViewer.Immutable.List<NutrientViewer.Actions.Action>
        | null;
}
Optional
Inherited from JavaScriptActionData.constructor

Properties

script

string

The JavaScript to run.

subActions

Optional

NutrientViewer.Immutable.List<NutrientViewer.Actions.Action> | null

Actions can be chained by adding them to this immutable List.

Immutable Record API

asImmutable

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

asMutable

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

clear

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

Returns
this
Inherited from Action.clear

delete

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

Type Parameters
Kextends "subActions"
Parameters
keyK
Returns
this
Inherited from Action.delete

deleteIn

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

equals

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

get

get<K extends "subActions">(key: K): { … }[K]get<K extends "subActions">(
    key: K,
): {
    subActions?:
        | NutrientViewer.Immutable.List<NutrientViewer.Actions.Action>
        | null;
}[K]
Returns the value associated with the provided key, which may be the default value defined when creating the Record factory function.

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

Type Parameters
Kextends "subActions"
Parameters
keyK
Returns
{ … }[K]{
    subActions?:
        | NutrientViewer.Immutable.List<NutrientViewer.Actions.Action>
        | null;
}[K]
Inherited from Action.get

getIn

getIn(keyPath: Iterable<unknown>, notSetValue?: unknown): unknown
Parameters
keyPathIterable<unknown>
notSetValueunknown
Optional
Returns
unknown
Inherited from Action.getIn

has

has(key: unknown): boolean
Parameters
keyunknown
Returns
boolean
Inherited from Action.has

merge

merge(...collections: Partial<{ … }>[]): thismerge(
    ...collections: Partial<
        {
            subActions?: | NutrientViewer.Immutable.List<
                NutrientViewer.Actions.Action,
            >
            | null;
        },
    >[],
): this
Parameters
...collections
Partial<{ … }>[]Partial<
    {
        subActions?: | NutrientViewer.Immutable.List<
            NutrientViewer.Actions.Action,
        >
        | null;
    },
>[]
Returns
this
Inherited from Action.merge

mergeDeep

mergeDeep(
    ...collections: (Iterable<[string, unknown], any, any> | Partial<{ … }>)[],
): thismergeDeep(
    ...collections: (
        | Iterable<[string, unknown], any, any>
        | Partial<
            {
                subActions?: | NutrientViewer.Immutable.List<
                    NutrientViewer.Actions.Action,
                >
                | null;
            },
        >
    )[],
): this
Parameters
...collections
(Iterable<[string, unknown], any, any> | Partial<{ … }>)[](
    | Iterable<[string, unknown], any, any>
    | Partial<
        {
            subActions?: | NutrientViewer.Immutable.List<
                NutrientViewer.Actions.Action,
            >
            | null;
        },
    >
)[]
Returns
this
Inherited from Action.mergeDeep

mergeDeepIn

mergeDeepIn(
    keyPath: Iterable<unknown>,
    ...collections: (Iterable<[string, unknown], any, any> | Partial<{ … }>)[],
): thismergeDeepIn(
    keyPath: Iterable<unknown>,
    ...collections: (
        | Iterable<[string, unknown], any, any>
        | Partial<
            {
                subActions?: | NutrientViewer.Immutable.List<
                    NutrientViewer.Actions.Action,
                >
                | null;
            },
        >
    )[],
): this
Parameters
keyPathIterable<unknown>
...collections
(Iterable<[string, unknown], any, any> | Partial<{ … }>)[](
    | Iterable<[string, unknown], any, any>
    | Partial<
        {
            subActions?: | NutrientViewer.Immutable.List<
                NutrientViewer.Actions.Action,
            >
            | null;
        },
    >
)[]
Returns
this
Inherited from Action.mergeDeepIn

mergeDeepWith

mergeDeepWith(
    merger: (previous?: unknown, next?: unknown, key?: string) => unknown,
    ...collections: (Iterable<[string, unknown], any, any> | Partial<{ … }>)[],
): thismergeDeepWith(
    merger: (previous?: unknown, next?: unknown, key?: string) => unknown,
    ...collections: (
        | Iterable<[string, unknown], any, any>
        | Partial<
            {
                subActions?: | NutrientViewer.Immutable.List<
                    NutrientViewer.Actions.Action,
                >
                | null;
            },
        >
    )[],
): this
Parameters
merger(previous?: unknown, next?: unknown, key?: string) => unknown
...collections
(Iterable<[string, unknown], any, any> | Partial<{ … }>)[](
    | Iterable<[string, unknown], any, any>
    | Partial<
        {
            subActions?: | NutrientViewer.Immutable.List<
                NutrientViewer.Actions.Action,
            >
            | null;
        },
    >
)[]
Returns
this
Inherited from Action.mergeDeepWith

mergeIn

mergeIn(
    keyPath: Iterable<unknown>,
    ...collections: (Iterable<[string, unknown], any, any> | Partial<{ … }>)[],
): thismergeIn(
    keyPath: Iterable<unknown>,
    ...collections: (
        | Iterable<[string, unknown], any, any>
        | Partial<
            {
                subActions?: | NutrientViewer.Immutable.List<
                    NutrientViewer.Actions.Action,
                >
                | null;
            },
        >
    )[],
): this
Parameters
keyPathIterable<unknown>
...collections
(Iterable<[string, unknown], any, any> | Partial<{ … }>)[](
    | Iterable<[string, unknown], any, any>
    | Partial<
        {
            subActions?: | NutrientViewer.Immutable.List<
                NutrientViewer.Actions.Action,
            >
            | null;
        },
    >
)[]
Returns
this
Inherited from Action.mergeIn

mergeWith

mergeWith(
    merger: (previous?: unknown, next?: unknown, key?: string) => unknown,
    ...collections: (Iterable<[string, unknown], any, any> | Partial<{ … }>)[],
): thismergeWith(
    merger: (previous?: unknown, next?: unknown, key?: string) => unknown,
    ...collections: (
        | Iterable<[string, unknown], any, any>
        | Partial<
            {
                subActions?: | NutrientViewer.Immutable.List<
                    NutrientViewer.Actions.Action,
                >
                | null;
            },
        >
    )[],
): this
Parameters
merger(previous?: unknown, next?: unknown, key?: string) => unknown
...collections
(Iterable<[string, unknown], any, any> | Partial<{ … }>)[](
    | Iterable<[string, unknown], any, any>
    | Partial<
        {
            subActions?: | NutrientViewer.Immutable.List<
                NutrientViewer.Actions.Action,
            >
            | null;
        },
    >
)[]
Returns
this
Inherited from Action.mergeWith

removeIn

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

set

set<K extends "subActions">(key: K, value: { … }[K]): thisset<K extends "subActions">(
    key: K,
    value: {
        subActions?:
            | NutrientViewer.Immutable.List<NutrientViewer.Actions.Action>
            | null;
    }[K],
): this
Type Parameters
Kextends "subActions"
Parameters
keyK
value
{ … }[K]{
    subActions?:
        | NutrientViewer.Immutable.List<NutrientViewer.Actions.Action>
        | null;
}[K]
Returns
this
Inherited from Action.set

setIn

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

toJS

toJS(): { … }toJS(): {
    subActions?: | NutrientViewer.Immutable.List<
        NutrientViewer.Actions.Action,
    >
    | null;
}
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
{ … }{
    subActions?:
        | NutrientViewer.Immutable.List<NutrientViewer.Actions.Action>
        | null;
}
Inherited from Action.toJS

toJSON

toJSON(): { … }toJSON(): {
    subActions?: | NutrientViewer.Immutable.List<
        NutrientViewer.Actions.Action,
    >
    | null;
}
Shallowly converts this Record to equivalent native JavaScript Object.

Returns
{ … }{
    subActions?:
        | NutrientViewer.Immutable.List<NutrientViewer.Actions.Action>
        | null;
}
Inherited from Action.toJSON

toSeq

toSeq(): Keyed<string, unknown>
Returns
Keyed<string, unknown>
Inherited from Action.toSeq

update

update<K extends "subActions">(
    key: K,
    updater: (value: { … }[K]) => { … }[K],
): thisupdate<K extends "subActions">(
    key: K,
    updater: (
        value: {
            subActions?:
                | NutrientViewer.Immutable.List<NutrientViewer.Actions.Action>
                | null;
        }[K],
    ) => {
        subActions?: | NutrientViewer.Immutable.List<
            NutrientViewer.Actions.Action,
        >
        | null;
    }[K],
): this
Type Parameters
Kextends "subActions"
Parameters
keyK
updater
(value: { … }[K]) => { … }[K](
    value: {
        subActions?:
            | NutrientViewer.Immutable.List<NutrientViewer.Actions.Action>
            | null;
    }[K],
) => {
    subActions?: | NutrientViewer.Immutable.List<
        NutrientViewer.Actions.Action,
    >
    | null;
}[K]
Returns
this
Inherited from Action.update

updateIn

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

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 Action.withMutations

Class JavaScriptAction

Example

Hierarchy

Constructors

Parameters

Properties

Immutable Record API

Returns

See Also

Returns

See Also

Returns

Type Parameters

Parameters

Returns

Parameters

Returns

Parameters

Returns

Type Parameters

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Type Parameters

Parameters

Returns

Parameters

Returns

Returns

Returns

Returns

Type Parameters

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

See Also