Hi there! Are you looking for the official Deno documentation? Try docs.deno.com for all your Deno learning needs.

PDFAnnotation

class PDFAnnotation extends Userdata<"pdf_annot"> {
constructor(doc: PDFDocument, pointer: Pointer<"pdf_annot">);
 
addBorderDashItem(v: number): void;
addInkListStroke(): void;
addInkListStrokeVertex(v: Point): void;
addQuadPoint(quad: Quad): void;
addVertex(vertex: Point): void;
applyRedaction(black_boxes?: number, image_method?: number): void;
clearBorderDash(): void;
clearInkList(): void;
clearQuadPoints(): void;
clearVertices(): void;
getAuthor(): string;
getBorderDashCount(): number;
getBorderDashItem(idx: number): number;
getBorderDashPattern(): any[];
getBorderEffect(): PDFAnnotationBorderEffect;
getBorderEffectIntensity(): number;
getBorderStyle(): PDFAnnotationBorderStyle;
getBorderWidth(): number;
getBounds(): Rect;
getColor(): Color;
getContents(): string;
getCreationDate(): Date;
getDefaultAppearance(): {
font: string;
size: number;
color: Color;
}
;
getFileSpec(): PDFObject;
getFlags(): number;
getHiddenForEditing(): boolean;
getIcon(): string;
getInkList(): Point[][];
getIntent(): PDFAnnotationIntent;
getInteriorColor(): Color;
getIsOpen(): boolean;
getLanguage(): string;
getLine(): Point[];
getLineEndingStyles(): {
start: PDFAnnotationLineEndingStyle;
end: PDFAnnotationLineEndingStyle;
}
;
getModificationDate(): Date;
getObject(): PDFObject;
getOpacity(): number;
getPopup(): Rect;
getQuadding(): number;
getQuadPoints(): Quad[];
getRect(): Rect;
getType(): PDFAnnotationType;
getVertices(): Point[];
hasAuthor(): boolean;
hasBorder(): boolean;
hasBorderEffect(): boolean;
hasFilespec(): boolean;
hasIcon(): boolean;
hasInkList(): boolean;
hasInteriorColor(): boolean;
hasLine(): boolean;
hasLineEndingStyles(): boolean;
hasOpen(): boolean;
hasQuadPoints(): boolean;
hasRect(): boolean;
hasVertices(): boolean;
run(device: Device, matrix: Matrix): void;
setAppearance(
appearance: string | null,
state: string | null,
transform: Matrix,
bbox: Rect,
resources: any,
contents: AnyBuffer,
): void;
setAppearanceFromDisplayList(
appearance: string | null,
state: string | null,
transform: Matrix,
): void;
setAuthor(text: string): void;
setBorderDashPattern(list: number[]): void;
setBorderEffect(value: PDFAnnotationBorderEffect): void;
setBorderEffectIntensity(value: number): void;
setBorderStyle(value: PDFAnnotationBorderStyle): void;
setBorderWidth(value: number): void;
setColor(color: Color): void;
setContents(text: string): void;
setCreationDate(date: Date): void;
setDefaultAppearance(
fontName: string,
size: number,
color: Color,
): void;
setFileSpec(fs: PDFObject): void;
setFlags(flags: number): void;
setHiddenForEditing(isHidden: boolean): void;
setIcon(text: string): void;
setInkList(inklist: Point[][]): void;
setIntent(value: PDFAnnotationIntent): void;
setInteriorColor(color: Color): void;
setIsOpen(isOpen: boolean): void;
setLanguage(lang: string): void;
setLine(a: Point, b: Point): void;
setLineEndingStyles(start: PDFAnnotationLineEndingStyle, end: PDFAnnotationLineEndingStyle): void;
setModificationDate(date: Date): void;
setOpacity(opacity: number): void;
setPopup(rect: Rect): void;
setQuadding(quadding: number): void;
setQuadPoints(quadlist: Quad[]): void;
setRect(rect: Rect): void;
setVertices(vertexlist: Point[]): void;
toDisplayList(): DisplayList;
toPixmap(
matrix: Matrix,
colorspace: ColorSpace,
alpha?: boolean,
): Pixmap;
update(): boolean;
 
static readonly _drop: (p: Pointer<"pdf_annot">) => void;
static readonly ANNOT_TYPES: PDFAnnotationType[];
static readonly BORDER_EFFECT: PDFAnnotationBorderEffect[];
static readonly BORDER_STYLE: PDFAnnotationBorderStyle[];
static readonly INTENT: PDFAnnotationIntent[];
static readonly IS_HIDDEN: number;
static readonly IS_INVISIBLE: number;
static readonly IS_LOCKED: number;
static readonly IS_LOCKED_CONTENTS: number;
static readonly IS_NO_ROTATE: number;
static readonly IS_NO_VIEW: number;
static readonly IS_NO_ZOOM: number;
static readonly IS_PRINT: number;
static readonly IS_READ_ONLY: number;
static readonly IS_TOGGLE_NO_VIEW: number;
static readonly LINE_ENDING: PDFAnnotationLineEndingStyle[];
}

§Extends

§
Userdata<"pdf_annot">
[src]

§Constructors

§
new PDFAnnotation(doc: PDFDocument, pointer: Pointer<"pdf_annot">)
[src]

§Properties

§Methods

§
addBorderDashItem(v: number): void
[src]
§
addInkListStroke(): void
[src]
§
addInkListStrokeVertex(v: Point): void
[src]
§
addQuadPoint(quad: Quad): void
[src]
§
addVertex(vertex: Point): void
[src]
§
applyRedaction(black_boxes?: number, image_method?: number): void
[src]
§
clearBorderDash(): void
[src]
§
clearInkList(): void
[src]
§
clearQuadPoints(): void
[src]
§
clearVertices(): void
[src]
§
getAuthor(): string
[src]
§
getBorderDashCount(): number
[src]
§
getBorderDashItem(idx: number): number
[src]
§
getBorderDashPattern(): any[]
[src]
§
getBorderEffect(): PDFAnnotationBorderEffect
[src]
§
getBorderEffectIntensity(): number
[src]
§
getBorderStyle(): PDFAnnotationBorderStyle
[src]
§
getBorderWidth(): number
[src]
§
getBounds(): Rect
[src]
§
getColor(): Color
[src]
§
getContents(): string
[src]
§
getCreationDate(): Date
[src]
§
getDefaultAppearance(): {
font: string;
size: number;
color: Color;
}
[src]
§
getFileSpec(): PDFObject
[src]
§
getFlags(): number
[src]
§
getHiddenForEditing(): boolean
[src]
§
getIcon(): string
[src]
§
getInkList(): Point[][]
[src]
§
getIntent(): PDFAnnotationIntent
[src]
§
getInteriorColor(): Color
[src]
§
getIsOpen(): boolean
[src]
§
getLanguage(): string
[src]
§
getLine(): Point[]
[src]
§
getLineEndingStyles(): {
start: PDFAnnotationLineEndingStyle;
end: PDFAnnotationLineEndingStyle;
}
[src]
§
getModificationDate(): Date
[src]
§
getObject(): PDFObject
[src]
§
getOpacity(): number
[src]
§
getPopup(): Rect
[src]
§
getQuadding(): number
[src]
§
getQuadPoints(): Quad[]
[src]
§
getRect(): Rect
[src]
§
getType(): PDFAnnotationType
[src]
§
getVertices(): Point[]
[src]
§
hasAuthor(): boolean
[src]
§
hasBorder(): boolean
[src]
§
hasBorderEffect(): boolean
[src]
§
hasFilespec(): boolean
[src]
§
hasIcon(): boolean
[src]
§
hasInkList(): boolean
[src]
§
hasInteriorColor(): boolean
[src]
§
hasLine(): boolean
[src]
§
hasLineEndingStyles(): boolean
[src]
§
hasOpen(): boolean
[src]
§
hasQuadPoints(): boolean
[src]
§
hasRect(): boolean
[src]
§
hasVertices(): boolean
[src]
§
run(device: Device, matrix: Matrix): void
[src]
§
setAppearance(appearance: string | null, state: string | null, transform: Matrix, bbox: Rect, resources: any, contents: AnyBuffer): void
[src]
§
setAppearanceFromDisplayList(appearance: string | null, state: string | null, transform: Matrix, list: DisplayList): void
[src]
§
setAuthor(text: string): void
[src]
§
setBorderDashPattern(list: number[]): void
[src]
§
setBorderEffect(value: PDFAnnotationBorderEffect): void
[src]
§
setBorderEffectIntensity(value: number): void
[src]
§
setBorderStyle(value: PDFAnnotationBorderStyle): void
[src]
§
setBorderWidth(value: number): void
[src]
§
setColor(color: Color): void
[src]
§
setContents(text: string): void
[src]
§
setCreationDate(date: Date): void
[src]
§
setDefaultAppearance(fontName: string, size: number, color: Color): void
[src]
§
setFileSpec(fs: PDFObject): void
[src]
§
setFlags(flags: number): void
[src]
§
setHiddenForEditing(isHidden: boolean): void
[src]
§
setIcon(text: string): void
[src]
§
setInkList(inklist: Point[][]): void
[src]
§
setIntent(value: PDFAnnotationIntent): void
[src]
§
setInteriorColor(color: Color): void
[src]
§
setIsOpen(isOpen: boolean): void
[src]
§
setLanguage(lang: string): void
[src]
§
setLine(a: Point, b: Point): void
[src]
§
setLineEndingStyles(start: PDFAnnotationLineEndingStyle, end: PDFAnnotationLineEndingStyle): void
[src]
§
setModificationDate(date: Date): void
[src]
§
setOpacity(opacity: number): void
[src]
§
setPopup(rect: Rect): void
[src]
§
setQuadding(quadding: number): void
[src]
§
setQuadPoints(quadlist: Quad[]): void
[src]
§
setRect(rect: Rect): void
[src]
§
setVertices(vertexlist: Point[]): void
[src]
§
toDisplayList(): DisplayList
[src]
§
toPixmap(matrix: Matrix, colorspace: ColorSpace, alpha?: boolean): Pixmap
[src]
§
update(): boolean
[src]

§Static Properties

§
_drop: (p: Pointer<"pdf_annot">) => void
[src]
§
ANNOT_TYPES: PDFAnnotationType[]
[src]
§
BORDER_EFFECT: PDFAnnotationBorderEffect[]
[src]
§
BORDER_STYLE: PDFAnnotationBorderStyle[]
[src]
§
INTENT: PDFAnnotationIntent[]
[src]
§
IS_HIDDEN: number
[src]
§
IS_INVISIBLE: number
[src]
§
IS_LOCKED: number
[src]
§
IS_LOCKED_CONTENTS: number
[src]
§
IS_NO_ROTATE: number
[src]
§
IS_NO_VIEW: number
[src]
§
IS_NO_ZOOM: number
[src]
§
IS_PRINT: number
[src]
§
IS_READ_ONLY: number
[src]
§
IS_TOGGLE_NO_VIEW: number
[src]
§
LINE_ENDING: PDFAnnotationLineEndingStyle[]
[src]