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 page crop tool.
The document viewer the tool works on.
StaticallowAllows annotations to be dragged outside the page (sets ALLOW_ANNOTS_OUTSIDE_PAGE to true).
Crops pages by the distances between the crop box and the page edges, then clears the box. Which pages are cropped depends on the crop mode. Does nothing without a crop 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).
The box stays in the tool and is not added to the document; boxes that are too small count as accidental clicks.
Gets the crop mode.
The mode; 'SINGLE_PAGE' by default.
Whether a crop box has been drawn and not yet applied or cleared.
True while cropping.
Viewport event → the page and page coordinates under the pointer (unrotated page, top-left origin, pt).
Gets the pages cropped in 'MULTI_PAGE' mode.
A copy of the page numbers (1-based).
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).
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.
Applies the same crop box to these pages (switches to MULTI_PAGE and records the pages).
Removes every listener of every event.
Removes the crop box.
Sets the crop mode. Throws for unknown modes.
'SINGLE_PAGE', 'ALL_PAGES' or 'MULTI_PAGE'.
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 pages cropped in 'MULTI_PAGE' mode (the box's page when empty).
Page numbers (1-based).
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.
Static ReadonlyCropValues of the crop mode.
ReadonlyALL_PAGES: "ALL_PAGES"Crop all pages.
ReadonlyMULTI_PAGE: "MULTI_PAGE"Crop the pages set with setPagesToCrop.
ReadonlySINGLE_PAGE: "SINGLE_PAGE"Crop the page the crop box is on.
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.RECTANGLE: drag out a rectangle; after setSnapMode both corners snap to the page's vector content.