Skip to main content
Version: API v2 Preview

PageClient

Kind: class
Module/package: pdfdancer_v2
SDK: pdfdancer-client-typescript 2.0.0

Declaration​

class PageClient

Members​

constructor​

constructor(client: PDFDancer, pageNumber: number, pageRef?: PageRef): PageClient

delete​

delete(): Promise<boolean>

getPathGroups​

getPathGroups(): Promise<PathGroupObject[]>

getSnapshot​

getSnapshot(types?: ObjectType[]): Promise<PageSnapshot>

Gets a snapshot of this page, including all elements. Optionally filter by object types.

groupPaths​

groupPaths(pathIds: string[]): Promise<PathGroupObject>

groupPathsInRegion​

groupPathsInRegion(region: BoundingRect): Promise<PathGroupObject>

moveTo​

moveTo(targetPageNumber: number): Promise<boolean>

newBezier​

newBezier(): BezierBuilder

newImage​

newImage(): ImageBuilder

newLine​

newLine(): LineBuilder

newPath​

newPath(): PathBuilder

newRectangle​

newRectangle(): RectangleBuilder

selectElements​

selectElements(types?: ObjectType[]): Promise<ObjectRef[]>

selectForm​

selectForm(): Promise<FormXObject>

selectFormAt​

selectFormAt(x: number, y: number, tolerance?: number): Promise<FormXObject>

selectFormFieldAt​

selectFormFieldAt(x: number, y: number, tolerance?: number): Promise<FormFieldObject>

selectFormFieldByName​

selectFormFieldByName(fieldName: string): Promise<FormFieldObject>

selectFormFields​

selectFormFields(): Promise<FormFieldObject[]>

selectFormFieldsAt​

selectFormFieldsAt(x: number, y: number, tolerance?: number): Promise<FormFieldObject[]>

selectFormFieldsByName​

selectFormFieldsByName(fieldName: string): Promise<FormFieldObject[]>

selectForms​

selectForms(): Promise<FormXObject[]>

selectFormsAt​

selectFormsAt(x: number, y: number, tolerance?: number): Promise<FormXObject[]>

selectImage​

selectImage(): Promise<ImageObject>

selectImageAt​

selectImageAt(x: number, y: number, tolerance?: number): Promise<ImageObject>

selectImages​

selectImages(): Promise<ImageObject[]>

selectImagesAt​

selectImagesAt(x: number, y: number, tolerance?: number): Promise<ImageObject[]>

selectPath​

selectPath(): Promise<PathObject>

selectPathAt​

selectPathAt(x: number, y: number, tolerance?: number): Promise<PathObject>

selectPaths​

selectPaths(): Promise<PathObject[]>

selectPathsAt​

selectPathsAt(x: number, y: number, tolerance?: number): Promise<PathObject[]>

text​

text(): TextClient

internalId​

internalId: string

orientation​

orientation?: Orientation

pageSize​

pageSize?: PageSize

position​

position: Position

type​

type: ObjectType

View source at 7bd49ac104cc