Optionalaction
action?: | null | | { subactions?: (CoreActionJSON)
[]; type: "uri"; uri: string } | { pageIndex: number; subactions?: (CoreActionJSON)
[]; type: "goTo" } | { newWindow: boolean; relativePath: string; subactions?: (CoreActionJSON)
[]; targetType: "parent" | "child"; type: "goToEmbedded"; } | { namedDestination: string; relativePath: string; subactions?: (CoreActionJSON)
[]; type: "goToRemote"; } | { annotationReferences: AnnotationReference[]; hide: boolean; subactions?: (CoreActionJSON)
[]; type: "hide"; } | { fields: null | AnnotationReference[]; flags: null | string; subactions?: (CoreActionJSON)
[]; type: "resetForm"; } | { fields: null | string[]; flags: null | ActionFlags[]; subactions?: (CoreActionJSON)
[]; type: "submitForm"; uri: string; } | { filePath: string; subactions?: (CoreActionJSON)
[]; type: "launch" } | { action: Omit<string, "custom">; subactions?: (CoreActionJSON)
[]; type: "named"; } | { action: "custom"; customAction: NamedCustomAction; subactions?: (CoreActionJSON)
[]; type: "named"; } | { script: string; subactions?: (CoreActionJSON)
[]; type: "javaScript" } OptionalAPStreamCache
APStreamCache?: { cache: string } | { attach: string }
bbox
bbox: [left: number, top: number, width: number, height: number]
OptionalblendMode
blendMode?:
| null
| | "normal"
| "multiply"
| "screen"
| "overlay"
| "darken"
| "lighten"
| "colorDodge"
| "colorBurn"
| "hardLight"
| "softLight"
| "difference"
| "exclusion"
Optionalcolor
color?: null | string
OptionalcreatedAt
createdAt?: string | Date OptionalcreatorName
creatorName?: null | string
OptionalcustomData
customData?: null | Record<string, unknown> Optionalflags
flags?:
| null
| (
| "noView"
| "noPrint"
| "locked"
| "lockedContents"
| "readOnly"
| "hidden"
| "noZoom"
| "noRotate"
)[]
Optionalgroup
group?: IGroup
OptionalisAnonymous
isAnonymous?: boolean
isCommentThreadRoot?: boolean
Optionalkind
kind?:
| "Approved"
| "NotApproved"
| "Draft"
| "Final"
| "Completed"
| "Confidential"
| "ForPublicRelease"
| "NotForPublicRelease"
| "ForComment"
| "Void"
| "PreliminaryResults"
| "InformationOnly"
| "Rejected"
| "Accepted"
| "InitialHere"
| "SignHere"
| "Witness"
| "AsIs"
| "Departmental"
| "Experimental"
| "Expired"
| "Sold"
| "TopSecret"
| "Revised"
| "RejectedWithText"
| "Custom"
Optionalname
name?: null | string
Optionalnote
note?: null | string
Optionalopacity
opacity?: number
pageIndex
pageIndex: number
OptionalpdfObjectId
pdfObjectId?: null | number
Optionalpermissions
permissions?: {
delete: boolean;
edit: boolean;
fill?: boolean;
reply?: boolean;
setGroup: boolean;
}
rotation
rotation: null | number
stampType
stampType:
| "Approved"
| "NotApproved"
| "Draft"
| "Final"
| "Completed"
| "Confidential"
| "ForPublicRelease"
| "NotForPublicRelease"
| "ForComment"
| "Void"
| "PreliminaryResults"
| "InformationOnly"
| "Rejected"
| "Accepted"
| "InitialHere"
| "SignHere"
| "Witness"
| "AsIs"
| "Departmental"
| "Experimental"
| "Expired"
| "Sold"
| "TopSecret"
| "Revised"
| "RejectedWithText"
| "Custom"
Optionalsubject
subject?: null | string
subtitle
subtitle: null | string
OptionalsubTitle
subTitle?: null | string
title
title: null | string
type
type: "pspdfkit/stamp"
OptionalupdatedAt
updatedAt?: string | Date OptionalxfdfAppearanceStream
xfdfAppearanceStream?: string
xfdfAppearanceStreamOriginalPageRotation?: number