Class: RectangularAreaMeasurementTool

Tools~ RectangularAreaMeasurementTool

Represents the tool for creating rectangular polygon annotations with a measure dictionary.

new RectangularAreaMeasurementTool(docViewer)

Parameters:
Name Type Description
docViewer CoreControls.DocumentViewer an instance of DocumentViewer.

Extends

Members


<static> DrawModes

An enum representing the draw modes available for creating annotations.
Properties:
Name Type Description
HOLD_TO_DRAW string The annotation is created by clicking and dragging
TWO_CLICKS string The annotation is created by one click for the start point and a second click for the end point

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:
Overrides:

getDocumentViewer()

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

getDrawMode()

Sets the draw mode for the tool.
Returns:
The current draw mode of the tool.
Type
Tools.RectangularAreaMeasurementTool.DrawModes

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:
Overrides:

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:
Overrides:

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:
Overrides:

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:
Overrides:

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:
Overrides:

mouseMove(e)

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

setAllowCreationOverAnnotation(val)

Sets whether new annotations can be created by the tool when hovering over an existing annotation
Parameters:
Name Type Description
val boolean Whether creation of annotation is allowed when hovering over another annotation
Inherited From:
Overrides:

setDrawMode(drawMode)

Sets the draw mode for the tool.
Parameters:
Name Type Description
drawMode Tools.RectangularAreaMeasurementTool.DrawModes One of the available draw modes.

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:
Overrides:

setSnapMode(mode)

Set the snap mode that will be used to calculate the end point position
Parameters:
Name Type Description
mode number Enum for a snapping mode for the snapping.
Inherited From:
Overrides:
See:

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:
Overrides:

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:
Overrides:

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:
Overrides:

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
Inherited From:
Overrides:

annotationCreated

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