PDFTron WebViewer

Class: ControlHandle

Annotations. ControlHandle

Represents a base class for control handles for selected annotations that can be moved. Control handles are typically used to resize an annotation or other operations that modify the annotation.

new ControlHandle(x, y, width, height)

Creates a new ControlHandle with the specified dimensions.
Parameters:
Name Type Description
x number the x-coordinate of the upper-left point
y number the y-coordinate of the upper-left point
width number the width of the control handle
height number the width of the control handle

Members

<static> handleHeight

Defines the height of all control handles. Default is 12.

<static> handleWidth

Defines the width of all control handles. Default is 12.

<static> rotationHandleHeight

Defines the height of all rotation control handles. Default is 25.

<static> rotationHandleWidth

Defines the width of all rotation control handles. Default is 25.

<static> selectionAccuracyPadding

Defines a padding for selection accuracy. Default is 1. Increase this value to make selection more forgiving.

Methods

draw(ctx, annotation, selectionBox, zoom)

Draws the control handle's appearance on the provided canvas context
Parameters:
Name Type Description
ctx CanvasRenderingContext2D the annotation canvas context
annotation Annotations.Annotation the annotation to modify
selectionBox Annotations.Rect the selection rect
zoom number the current zoom level of the document

testSelection(annotation, selectionBox, zoom, x, y)

Determines if the provided point is a hit on the control handle. See Annotations.SelectionAlgorithm for usuable selection algorithms.
Parameters:
Name Type Description
annotation Annotations.Annotation the annotation
selectionBox Annotations.Rect the selection rect
zoom number the current zoom level of the document
x number the x-coordinate of the point to test, in page coordinates
y number the y-coordinate of the point to test, in page coordinates
Returns:
true if the provided point is a hit
Type
boolean