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).
The finished box (for the viewer's selection box); null when there is no box or it is still being drawn.
With the link tool on, pressing a hand-drawn link selects, drags and resizes it (otherwise a click follows it).
Creates the snipping tool.
The document viewer the tool works on.
StaticallowAllows annotations to be dragged outside the page (sets ALLOW_ANNOTS_OUTSIDE_PAGE to true).
Applies the snip box by the snipping mode: copies the rendered area to the clipboard, downloads it as PNG, or crops the page to the box and removes the other pages. Then fires snippingApplied. Does nothing without a snip box.
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).
Whether a snip box has been drawn and not yet applied or cleared.
True while snipping.
Viewport event → the page and page coordinates under the pointer (unrotated page, top-left origin, pt).
Snap mode (a SnapModes value or combination): once set, snaps to the page's vector content both before and while drawing (see tools/snapping.ts).
Gets the snipping mode.
The mode; 'CLIPBOARD' by default.
Called when a key is pressed while the viewer has focus; does nothing in the base class.
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.
Clears the snip box (fires snippingCancelled when one was drawn).
StaticsetFile name for download (without .png).
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 the snipping mode.
'CLIPBOARD', 'DOWNLOAD' or 'CROP_AND_REMOVE'.
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 });
Switch out: the cursor returns to default.
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.
Static ReadonlyEventsEvent names of the snipping tool.
ReadonlySNIPPING_APPLIED: "snippingApplied"'snippingApplied': the snip was applied; receives the page number and the distances from the box to the page edges.
ReadonlySNIPPING_CANCELLED: "snippingCancelled"'snippingCancelled': the snip box was cleared without being applied.
ReadonlySNIPPING_CHANGED: "snippingChanged"'snippingChanged': the snip box was moved or resized; receives the box.
Name the tool is registered under (one of ToolNames).
Static ReadonlySnippingValues of the snipping mode.
ReadonlyCLIPBOARD: "CLIPBOARD"Copy the snipped area to the clipboard as PNG.
ReadonlyCROP_AND_REMOVE: "CROP_AND_REMOVE"Crop the page to the snip box and remove all other pages.
ReadonlyDOWNLOAD: "DOWNLOAD"Download the snipped area as a PNG file.
ToolNames.RECTANGLE: drag out a rectangle; after setSnapMode both corners snap to the page's vector content.