Skip to main content
Version: API v2 Preview

Position

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

Represents spatial positioning and location information for PDF objects.

Declaration

class Position

Members

constructor

constructor(pageNumber?: number, shape?: ShapeType, mode?: PositionMode, boundingRect?: BoundingRect): Position

atCoordinates

atCoordinates(point: Point): Position

Sets the position to a specific point location.

atPage

atPage(pageNumber: number): Position

Creates a position specification for an entire page using a 1-based page number.

atPageCoordinates

atPageCoordinates(pageNumber: number, x: number, y: number, tolerance?: number): Position

Creates a position specification for specific coordinates on a page.

byName

byName(name: string): Position

Creates a position specification for finding objects by name.

copy

copy(): Position

Creates a copy of this position.

getX

getX(): number

Returns the X coordinate of this position.

getY

getY(): number

Returns the Y coordinate of this position.

moveX

moveX(xOffset: number): Position

Move the position horizontally by the specified offset.

moveY

moveY(yOffset: number): Position

Move the position vertically by the specified offset.

boundingRect

boundingRect?: BoundingRect

center

center?: Point

mode

mode?: PositionMode

name

name?: string

pageNumber

pageNumber?: number

shape

shape?: ShapeType

tolerance

tolerance?: number

View source at 7bd49ac104cc