Namespace: Tools

Core. Tools

Contains tools for pan scrolling, text selection, annotation editing and annotation creation. You can access it as follows:

Example

WebViewer(...)
  .then(function(instance) {
    const Tools = instance.Core.Tools;
    // Tools.SomeClass
  });

Classes

AnnotationEditTool
AnnotationSelectTool
ArcCreateTool
ArcMeasurementCreateTool
AreaMeasurementCreateTool
ArrowCreateTool
CalloutCreateTool
CheckBoxFormFieldCreateTool
CloudyRectangularAreaMeasurementTool
ComboBoxFormFieldCreateTool
ContentEditTool
CountMeasurementCreateTool
DateFreeTextCreateTool
DistanceMeasurementCreateTool
EllipseCreateTool
EllipseMeasurementCreateTool
EraserTool
FileAttachmentCreateTool
FreeHandCreateTool
FreeHandHighlightCreateTool
FreeTextCreateTool
GenericAnnotationCreateTool
LineCreateTool
ListBoxFormFieldCreateTool
MarqueeZoomTool
PageCoordinate
PanTool
PerimeterMeasurementCreateTool
PolygonCloudCreateTool
PolygonCreateTool
PolylineCreateTool
RadioButtonFormFieldCreateTool
RectangleCreateTool
RectangularAreaMeasurementTool
RedactionCreateTool
RubberStampCreateTool
SignatureCreateTool
StampCreateTool
StickyCreateTool
TextAnnotationCreateTool
TextFormFieldCreateTool
TextHighlightCreateTool
TextSelectTool
TextSquigglyCreateTool
TextStrikeoutCreateTool
TextTool
TextUnderlineCreateTool
Tool

Members


<static> SnapModes

Enum for snap mode name and values. Snap modes control which point within the page is considered as the queried point.
Properties:
Name Type Description
DEFAULT number
POINT_ON_LINE number
LINE_MID_POINT number
LINE_INTERSECTION number
PATH_ENDPOINT number

<static> ToolNames

Represents the names for the built-in tools
Properties:
Name Type Description
ARROW string name of the arrow line tool
ARROW2 string name of the second arrow line tool
ARROW3 string name of the third arrow line tool
ARROW4 string name of the fourth arrow line tool
CALLOUT string name of the callout tool
CALLOUT2 string name of the second callout tool
CALLOUT3 string name of the third callout tool
CALLOUT4 string name of the fourth callout tool
ELLIPSE string name of the ellipse tool
ELLIPSE2 string name of the second ellipse tool
ELLIPSE3 string name of the third ellipse tool
ELLIPSE4 string name of the fourth ellipse tool
FREEHAND string name of the freehand tool
FREEHAND2 string name of the second freehand tool
FREEHAND3 string name of the third freehand tool
FREEHAND4 string name of the fourth freehand tool
FREEHAND_HIGHLIGHT string name of the freehand highlight tool
FREEHAND_HIGHLIGHT2 string name of the second freehand highlight tool
FREEHAND_HIGHLIGHT3 string name of the third freehand highlight tool
FREEHAND_HIGHLIGHT4 string name of the fourth freehand highlight tool
FREETEXT string name of the freetext tool
FREETEXT2 string name of the second freetext tool
FREETEXT3 string name of the third freetext tool
FREETEXT4 string name of the fourth freetext tool
FORM_FILL_CROSS string name of the cross stamp tool
FORM_FILL_CHECKMARK string name of the check stamp tool
FORM_FILL_DOT string name of the dot stamp tool
LINE string name of the line tool
LINE2 string name of the second line tool
LINE3 string name of the third line tool
LINE4 string name of the fourth line tool
POLYGON string name of the polygon tool
POLYGON2 string name of the second polygon tool
POLYGON3 string name of the third polygon tool
POLYGON4 string name of the fourth polygon tool
POLYGON_CLOUD string name of the polygon cloud tool
POLYGON_CLOUD2 string name of the second polygon cloud tool
POLYGON_CLOUD3 string name of the third polygon cloud tool
POLYGON_CLOUD4 string name of the fourth polygon cloud tool
POLYLINE string name of the polyline tool
POLYLINE2 string name of the second polyline tool
POLYLINE3 string name of the third polyline tool
POLYLINE4 string name of the fourth polyline tool
RECTANGLE string name of the rectangle tool
RECTANGLE2 string name of the second rectangle tool
RECTANGLE3 string name of the third rectangle tool
RECTANGLE4 string name of the fourth rectangle tool
DISTANCE_MEASUREMENT string name of the distance measurement tool
DISTANCE_MEASUREMENT2 string name of the second distance measurement tool
DISTANCE_MEASUREMENT3 string name of the third distance measurement tool
DISTANCE_MEASUREMENT4 string name of the fourth distance measurement tool
PERIMETER_MEASUREMENT string name of the perimeter measurement tool
PERIMETER_MEASUREMENT2 string name of the second perimeter measurement tool
PERIMETER_MEASUREMENT3 string name of the third perimeter measurement tool
PERIMETER_MEASUREMENT4 string name of the fourth perimeter measurement tool
AREA_MEASUREMENT string name of the area measurement tool
AREA_MEASUREMENT2 string name of the second area measurement tool
AREA_MEASUREMENT3 string name of the third area measurement tool
AREA_MEASUREMENT4 string name of the fourth area measurement tool
CLOUDY_RECTANGULAR_AREA_MEASUREMENT string name of the cloudy area measurement tool
CLOUDY_RECTANGULAR_AREA_MEASUREMENT2 string name of the second cloudy area measurement tool
CLOUDY_RECTANGULAR_AREA_MEASUREMENT3 string name of the third cloudy area measurement tool
CLOUDY_RECTANGULAR_AREA_MEASUREMENT4 string name of the fourth cloudy area measurement tool
COUNT_MEASUREMENT string name of the count measurement tool
COUNT_MEASUREMENT2 string name of the second count measurement tool
COUNT_MEASUREMENT3 string name of the third count measurement tool
COUNT_MEASUREMENT4 string name of the fourth count measurement tool
SIGNATURE string name of the signature tool
STAMP string name of the stamp tool
FILEATTACHMENT string name of the file attachment tool
STICKY string name of the sticky note tool
STICKY2 string name of the second sticky note tool
STICKY3 string name of the third sticky note tool
STICKY4 string name of the fourth sticky note tool
HIGHLIGHT string name of the text highlight tool
HIGHLIGHT2 string name of the second text highlight tool
HIGHLIGHT3 string name of the third text highlight tool
HIGHLIGHT4 string name of the fourth text highlight tool
SQUIGGLY string name of the text squiggly tool
SQUIGGLY2 string name of the second text squiggly tool
SQUIGGLY3 string name of the third text squiggly tool
SQUIGGLY4 string name of the fourth text squiggly tool
STRIKEOUT string name of the text strikeout tool
STRIKEOUT2 string name of the second text strikeout tool
STRIKEOUT3 string name of the third text strikeout tool
STRIKEOUT4 string name of the fourth text strikeout tool
UNDERLINE string name of the text underline tool
UNDERLINE2 string name of the second text underline tool
UNDERLINE3 string name of the third text underline tool
UNDERLINE4 string name of the fourth text underline tool
REDACTION string Name of the text redaction tool
REDACTION2 string Name of the second text redaction tool
REDACTION3 string Name of the third text redaction tool
REDACTION4 string Name of the fourth text redaction tool
TEXT_SELECT string name of the text select tool
EDIT string name of the edit(select) tool
PAN string name of the pan tool
CROP string name of the page crop tool
MARQUEE string name of the marquee zoom tool
ERASER string name of the eraser tool
CONTENT_EDIT string name of the content edit tool
TEXT_FORM_FIELD string name of the Text Form Field creation tool
TEXT_FORM_FIELD2 string name of the second Text Form Field creation tool
TEXT_FORM_FIELD3 string name of the third Text Form Field creation tool
TEXT_FORM_FIELD4 string name of the fourth Text Form Field creation tool
SIG_FORM_FIELD string name of the Signature Form Field creation tool
SIG_FORM_FIELD2 string name of the second Signature Form Field creation tool
SIG_FORM_FIELD3 string name of the third Signature Form Field creation tool
SIG_FORM_FIELD4 string name of the fourth Signature Form Field creation tool
CHECK_BOX_FIELD string name of the Check Box Form Field creation tool
RADIO_FORM_FIELD string name of the Radio Button Form Field creation tool
LIST_BOX_FIELD string name of the List Box Form Field creation tool
LIST_BOX_FIELD2 string name of the second List Box Form Field creation tool
LIST_BOX_FIELD3 string name of the third List Box Form Field creation tool
LIST_BOX_FIELD4 string name of the fourth List Box Form Field creation tool
COMBO_BOX_FIELD string name of the Combo Box Form Field creation tool
COMBO_BOX_FIELD2 string name of the second Combo Box Form Field creation tool
COMBO_BOX_FIELD3 string name of the third Combo Box Form Field creation tool
COMBO_BOX_FIELD4 string name of the fourth Combo Box Form Field creation tool