Class: HideAction

PSPDFKit.Actions.HideAction

PDF action to hide an annotation or form field.

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

When clicking on an annotation with a HideAction, the annotations specified in its annotationReferences property will be hidden.

Constructor

new PSPDFKit.Actions.HideAction(args)

Hide an annotation or form field.

Parameters:
Name Type Description
args object
Example

Create a new HideAction

const action = new PSPDFKit.Actions.HideAction({ hide: true });

Extends

Members




Members

annotationReferences: PSPDFKit.Immutable.List.<({fieldName: string}|{pdfObjectId: number})>

A list of references to annotations, either via the pdfObjectId or a form field name.

Type:

hide: boolean

If true, the action will hide the annotation, otherwise it will show it.

Type:
  • boolean

subActions: PSPDFKit.Immutable.List.<Action>

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

Type: