Optionalaction
action?: | | { 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: AnnotationReference[] | null; flags: string | null; subactions?: (CoreActionJSON)
[]; type: "resetForm"; } | { fields: string[] | null; flags: ActionFlags[] | null; 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" } | null OptionalAPStreamCache
APStreamCache?: { cache: string } | { attach: string }
OptionalbackgroundColor
backgroundColor?: string | null
bbox
bbox: [left: number, top: number, width: number, height: number]
OptionalblendMode
blendMode?:
| | "normal"
| "multiply"
| "screen"
| "overlay"
| "darken"
| "lighten"
| "colorDodge"
| "colorBurn"
| "hardLight"
| "softLight"
| "difference"
| "exclusion"
| null
OptionalborderColor
borderColor?: string | null
OptionalborderStyle
borderStyle?: "solid" | "dashed" | "beveled" | "inset" | "underline" | null
OptionalborderWidth
borderWidth?: number | null
Optionalcallout
callout?:
| {
cap?: | | "square"
| "circle"
| "diamond"
| "openArrow"
| "closedArrow"
| "butt"
| "reverseOpenArrow"
| "reverseClosedArrow"
| "slash"
| null;
end: [number, number];
innerRectInset?:
| [left: number, top: number, right: number, bottom: number]
| null;
knee?: [number, number] | null;
start: [number, number];
}
| null
OptionalcreatedAt
createdAt?: string | Date OptionalcreatorName
creatorName?: string | null
OptionalcustomData
customData?: Record<string, unknown> | null Optionalflags
flags?:
| (
| "noView"
| "noPrint"
| "locked"
| "lockedContents"
| "readOnly"
| "hidden"
| "noZoom"
| "noRotate"
)[]
| null
Optionalfont
font?: string | null
OptionalfontColor
fontColor?: string | null
OptionalfontSize
fontSize?: number | null
OptionalfontStyle
fontStyle?: string[] | null
Optionalgroup
group?: IGroup
OptionalhorizontalAlign
horizontalAlign?: "left" | "center" | "right"
OptionalisAnonymous
isAnonymous?: boolean
isCommentThreadRoot?: boolean
OptionalisFitting
isFitting?: boolean
OptionallineHeightFactor
lineHeightFactor?: number | null
Optionalname
name?: string | null
Optionalnote
note?: string | null
Optionalopacity
opacity?: number
pageIndex
pageIndex: number
OptionalpdfObjectId
pdfObjectId?: number | null
Optionalpermissions
permissions?: {
delete: boolean;
edit: boolean;
fill?: boolean;
reply?: boolean;
setGroup: boolean;
}
Optionalrotation
rotation?: number | null
Optionalsubject
subject?: string | null
text
text: { format: "xhtml" | "plain"; value: string }
type
type: "pspdfkit/text"
OptionalupdatedAt
updatedAt?: string | Date OptionalverticalAlign
verticalAlign?: "center" | "top" | "bottom"