StaticALLOW_Whether annotations can be dragged outside the page (off by default: dragging stops at the page edge and does not move in a direction where the annotation is larger than the page).
Whether annotations can be dragged outside the page (off by default: dragging stops at the page edge and does not move in a direction where the annotation is larger than the page).
With the link tool on, pressing a hand-drawn link selects, drags and resizes it (otherwise a click follows it).
Creates the freehand highlighter tool (20 pt wide, opacity 0.5).
The document viewer the tool works on.
StaticallowAllows annotations to be dragged outside the page (sets ALLOW_ANNOTS_OUTSIDE_PAGE to true).
Called when the context menu is requested on the viewer; does nothing in the base class.
The mouse event.
StaticdisableTurns off hover cursors: the tool's own cursor is always used (sets ENABLE_ANNOTATION_HOVER_CURSORS to false).
StaticdisableTurns off automatic text selection by the edit tool (sets ENABLE_AUTO_SWITCH to false).
Selects an annotation when the press is released (the default); the press does not drag it.
StaticdisallowKeeps dragged annotations inside the page (sets ALLOW_ANNOTS_OUTSIDE_PAGE to false; the default).
StaticenableTurns on hover cursors (sets ENABLE_ANNOTATION_HOVER_CURSORS to true).
StaticenableTurns on automatic text selection by the edit tool (sets ENABLE_AUTO_SWITCH to true).
Selects an annotation as soon as it is pressed, so it can be dragged in the same gesture (text markup is still selected on release).
Adds the annotation being drawn to the document (dropped when too small).
Gets the range within which a finished stroke is straightened into a horizontal line.
The range in PDF points; 30 by default.
Gets how long a finished stroke waits for further strokes before the annotation is added.
The delay in milliseconds; 1000 by default.
Viewport event → the page and page coordinates under the pointer (unrotated page, top-left origin, pt).
Whether strokes drawn with a pen are simplified.
True when pen strokes are simplified.
Escape while waiting for the next stroke adds the strokes drawn so far right away, without selecting them; other keys work as in the base tool.
The keyboard event.
Double-clicking an existing annotation: same as the selection tool (fires annotationDoubleClicked; free text enters inline editing).
Called when the left mouse button or a touch goes down on the viewer; does nothing in the base class.
Called when the left mouse button or a touch is released; does nothing in the base class.
Called when the pointer moves over the viewer; does nothing in the base class.
Called when the right mouse button goes down on the viewer; does nothing in the base class.
The pointer event.
Removes every listener of every event.
Sets the range within which a finished stroke is straightened: when all points are within this distance above or below the first point, the stroke becomes a horizontal line.
The range in PDF points.
Sets how long a finished stroke waits for further strokes on the same page to join the same annotation; 0 adds each stroke immediately.
The delay in milliseconds.
StaticsetSets the maximum size when resizing annotations.
StaticsetSets the minimum size when resizing annotations (static, shared by all select / edit tools).
Sets the name of the tool.
The tool name.
Sets whether strokes drawn with a pen (not mouse or touch) are simplified when finished.
Whether to simplify pen strokes.
Changes the tool's default style (used by annotations created afterwards); fires toolUpdated.
const { documentViewer, Annotations, Tools } = instance.Core;
const freeTextTool = documentViewer.getTool(Tools.ToolNames.FREETEXT);
freeTextTool.setStyles({ TextColor: new Annotations.Color(0, 0, 0), FontSize: '14pt', Font: 'Helvetica' });
documentViewer.getTool(Tools.ToolNames.HIGHLIGHT).setStyles({ StrokeColor: new Annotations.Color(0, 255, 0), Opacity: 0.6 });
Switching away keeps the strokes drawn so far.
Called on a tap (a touch press and release without moving); does nothing in the base class.
The pointer event.
The annotation being drawn, not yet added to the document.
The tool's own cursor: used when switching in and when hovering over empty space (default for the edit tool, crosshair for creation tools, text for text tools, grab for pan...).
Default style of annotations created by the tool (such as StrokeColor, StrokeThickness, Opacity); changed with setStyles.
StaticENABLE_Changes the cursor on hover by what is under the pointer (annotations, handles, text); the stamp, attachment, eraser and marquee zoom tools turn it off, and it is turned back on when they switch out (Tool.ENABLE_ANNOTATION_HOVER_CURSORS).
StaticENABLE_Whether the edit tool selects text automatically when hovering over text (the edit tool selects text itself, so when this is off it neither selects text nor shows the text cursor; the instance enable / disableTextSelection must also be on). Turned off on touch screens.
Name the tool is registered under (one of ToolNames).
ToolNames.FREEHAND_HIGHLIGHT: thick, translucent ink (Opacity 0.5 and width 20 by default) with intent InkHighlight, multiplied with the page. When a stroke is finished and all points are within autoSmoothingRange (30 by default) above or below the first point, it is straightened into a horizontal line (average y); otherwise, when all are within that range left or right, into a vertical line (average x).