PDFJS Express WebViewer

Class: TextAnnotationCreateTool

Tools. TextAnnotationCreateTool

Represents an abstract class for text-based annotation creation tools.

new TextAnnotationCreateTool(docViewer, textAnnotationPrototype)

This class should not be instantiated.
Parameters:
Name Type Description
docViewer CoreControls.DocumentViewer an instance of DocumentViewer.
textAnnotationPrototype function the prototype the text-based annotation to create.
Properties:
Name Type Description
defaults Object the default styles of the tool
Properties
Name Type Description
StrokeColor Annotations.Color the stroke color of the tool
Opacity number the opacity of the tool

Extends

Members

<static> AUTO_SET_TEXT :boolean

toggle whether selected text should be set as annotation note contents
Type:
  • boolean

Methods

contextMenu(e)

The function called when a context menu should be shown. Use e.preventDefault to disable the default browser context menu
Parameters:
Name Type Description
e the event object
Inherited From:

getDocumentViewer()

Returns the instance of DocumentViewer for this tool.
Inherited From:
Returns:
the instance of DocumentViewer for this tool.
Type
CoreControls.DocumentViewer

getMouseLocation(e)

Takes an event object from a mouse event and converts the location into window coordinates
Parameters:
Name Type Description
e the event object containing mouse coordinates
Inherited From:

keyDown(e)

The function called when a keyboard key is down.
Parameters:
Name Type Description
e the event object containing keyboard key data.
Inherited From:

mouseDoubleClick(e)

The function called when the mouse left button is double clicked.
Parameters:
Name Type Description
e the event object containing mouse coordinates.
Inherited From:

mouseLeftDown(e)

The function called when the left mouse button is down
Parameters:
Name Type Description
e the event object containing mouse coordinates.
Inherited From:

mouseLeftUp(e)

The function called when the left mouse button is up. Typically, annotations are created and added to the annotation manager at this point.
Parameters:
Name Type Description
e the event object containing mouse coordinates.
Inherited From:

mouseMove(e)

The function called when the mouse moves.
Parameters:
Name Type Description
e the event object containing mouse coordinates.
Inherited From:

select(pagePt1, pagePt2)

Select text based on two points
Parameters:
Name Type Description
pagePt1 object The start point to select from. Is an object with pageIndex, x and y properties.
pagePt2 object The end point to select to. Is an object with pageIndex, x and y properties.
Inherited From:

setName(name)

Set the name of the tool, which can be accessed by toolObject.name
Parameters:
Name Type Description
name string name of the tool
Inherited From:

setStyles(newStyles)

Set the style for the tool, which will be applied to annotations drawn afterwards
Parameters:
Name Type Description
newStyles object | function if an object is used, it should contain properties of the new styles. If a function is used, the current styles will be passed as its argument and the function should return an object which contains properties of the new styles. Example of valid properties: StrokeColor, TextColor, FillColor, FontSize, Opacity, StrokeThickness, Precision, Scale, OverlayText, Style and Dashes.
Inherited From:

switchIn(oldTool)

The function called when this tool is selected. Typically use for changing mouse cursors, and initializing states for the tool.
Parameters:
Name Type Description
oldTool Tools.Tool the Tool class that was previously selected.
Inherited From:

switchOut(newTool)

The function called when this tool is deselected. Typically use for changing mouse cursors, and cleaning up states for the tool.
Parameters:
Name Type Description
newTool Tools.Tool the Tool class that was newly selected.
Inherited From:

textSelected(pageIndex, quads, text)

The function called when a text region is selected.
Parameters:
Name Type Description
pageIndex number
quads Annotations.Quad the quad coordinates for the selected text.
text string the text selected.
Inherited From:

Events

annotationAdded

Triggered when an annotation has been added to the document by the tool
Parameters:
Name Type Description
annotation Annotations.Annotation The annotation that was added

annotationCreated

Triggered when an annotation has been created by the tool
Parameters:
Name Type Description
annotations Annotations.Annotation The annotation that was created