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 }
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
OptionalcreatedAt
createdAt?: string | Date OptionalcreatorName
creatorName?: string | null
OptionalcustomData
customData?: Record<string, unknown> | null endPoint
endPoint: [number, number]
fillColor
fillColor: string | null
Optionalflags
flags?:
| (
| "noView"
| "noPrint"
| "locked"
| "lockedContents"
| "readOnly"
| "hidden"
| "noZoom"
| "noRotate"
)[]
| null
Optionalgroup
group?: IGroup
OptionalisAnonymous
isAnonymous?: boolean
isCommentThreadRoot?: boolean
OptionallineCaps
lineCaps?: LineCapsType | null
Optionallines
lines?: { intensities: number[][]; points: [number, number][][] }
OptionallineWidth
lineWidth?: number | null
OptionalmeasurementPrecision
measurementPrecision?:
| | "whole"
| "oneDp"
| "twoDp"
| "threeDp"
| "fourDp"
| "1/2"
| "1/4"
| "1/8"
| "1/16"
| null
OptionalmeasurementScale
measurementScale?:
| {
from: number;
fromDescription?: string;
to: number;
toDescription?: string;
unitFrom: "in"
| "mm"
| "cm"
| "pt";
unitTo: "in" | "mm" | "cm" | "pt" | "ft" | "m" | "yd" | "km" | "mi";
}
| 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;
}
startPoint
startPoint: [number, number]
strokeColor
strokeColor: string | null
OptionalstrokeDashArray
strokeDashArray?: [number, number] | null
strokeWidth
strokeWidth: number
Optionalsubject
subject?: string | null
type
type: "pspdfkit/shape/line"
OptionalupdatedAt
updatedAt?: string | Date