Apryse WebViewer

Class: CalibrationMeasurementTool

Core.Tools. CalibrationMeasurementTool

Represents the tool to help calibrate the scale of a document

new CalibrationMeasurementTool(docViewer)

Parameters:
Name Type Description
docViewer Core.DocumentViewer An instance of DocumentViewer.

Extends

Methods

addEventListener(type, fn [, options])

Add a handler to the given event name
Parameters:
Name Type Argument Description
type string | number The name of the event to listen to
fn function The handler to be called when the event is triggered
options object <optional>
 Optional options object for addEventListener
Properties
Name Type Description
once boolean If true then the handler will be called only once
Inherited From:
Overrides:
Returns:
Returns the object that 'addEventListener' is being called on
Type
object
Example
myObject.addEventListener('eventName', (eventParameter1, eventParameter2) => {
  ...
});

contextMenu(e)

The function is 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:

disableImmediateActionOnAnnotationSelection()

Disable whether the tool should trigger an action immediately after clicking an annotation. When this is disabled you need to first click on annotation to select it before you can drag it. This behavior is disabled by default.
Inherited From:
Overrides:

disableImperialMarks()

Disable the showing of imperial marks for the units of distance annotations created by this tool
Inherited From:
Overrides:
Example
WebViewer(...).then(instance => {
 const { Core } = instance;
 const tool = Core.documentViewer.getTool(Core.Tools.ToolNames.DISTANCE_MEASUREMENT);
 tool.disableImperialMarks();
})

enableImmediateActionOnAnnotationSelection()

Sets if the tool should trigger actions immediately after clicking an annotation. For example, if this is enabled then you can immediately click and drag an annotation without making a separate click to select the annotation.
Inherited From:
Overrides:
Example
To enable this for one tool (The Pan tool, for example), this can be done:

const tool = docViewer.getTool(window.Core.Tools.ToolNames.PAN);
tool.enableImmediateActionOnAnnotationSelection();

To enable this for all selection tools, this can be done:

const allTools = Object.values(docViewer.getToolModeMap());
for (const tool of allTools) {
  if (tool instanceof Tools.AnnotationSelectTool) {
    tool.enableImmediateActionOnAnnotationSelection();
  }
}

enableImperialMarks()

Enables the creation of new distance annotations where the units are shown as imperial marks: ' and "
Inherited From:
Overrides:
Example
WebViewer(...).then(instance => {
 const { Core } = instance;
 const tool = Core.documentViewer.getTool(Core.Tools.ToolNames.DISTANCE_MEASUREMENT);
 tool.enableImperialMarks();
})

getDocumentViewer()

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

getDrawMode()

Gets the draw mode for the tool.
Inherited From:
Overrides:
Returns:
The current draw mode of the tool.
Type
Core.Tools.LineCreateTool.DrawModes

getLeaderLineDefaultOptions()

Gets the default options set for leader line functionality.
Inherited From:
Overrides:
Returns:
Type
Core.Tools.DistanceMeasurementCreateTool.LeaderLineOptions
Example
WebViewer(...).then(instance => {
 const { Core } = instance;
 const tool = Core.documentViewer.getTool(Core.Tools.ToolNames.DISTANCE_MEASUREMENT);
 const defaultLeaderLineOptions = tool.getLeaderLineDefaultOptions();
 console.log(defaultLeaderLineOptions);
});

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:
Returns:
Returns an object with x and y coordinates of the mouse cursor in the viewer
Type
Core.Math.Point

getSnapMode()

Get the current snap mode that will be used to calculate the end point position
Inherited From:
Overrides:
See:
Returns:
Enum for a snapping mode for the snapping.
Type
number

isImperialMarksEnabled()

Check if imperial marks is enabled or disabled
Inherited From:
Overrides:
Returns:
Returns true if tool is imperial marks enabled
Type
boolean
Example
WebViewer(...).then(instance => {
 const tool = instance.Core.documentViewer.getTool('AnnotationCreateDistanceMeasurement');
 tool.isImperialMarksEnabled();
})

keyDown(e)

The function is 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 is 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:

mouseRightDown(e)

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

removeEventListener( [type] [, fn])

Remove a handler of the given event name and namespace (if given) or with a function reference
Parameters:
Name Type Argument Description
type string | number <optional>
 The name of the event to remove the handler of with an optional namespace.
fn function <optional>
 The handler associated with this event to be removed. If fn is undefined, all the handlers of the given event namespace will be removed. If you are not passing in this parameter then a namespace must be used with the event name.
Inherited From:
Overrides:
Returns:
Returns the object that 'removeEventListener' is being called on
Type
object
Example
myObject.removeEventListener('eventName.namespace');
myObject.removeEventListener('eventName', fn);

setDrawMode(drawMode)

Sets the draw mode for the tool.
Parameters:
Name Type Description
drawMode Tools.LineCreateTool.DrawModes One of the available draw modes.
Inherited From:
Overrides:

setLeaderLineDefaultOptions(options)

Sets the default options set for leader lines.
Parameters:
Name Type Description
options Core.Tools.DistanceMeasurementCreateTool.LeaderLineOptions
Inherited From:
Overrides:
Example
WebViewer(...).then(instance => {
 const { Core } = instance;
 const tool = Core.documentViewer.getTool(Core.Tools.ToolNames.DISTANCE_MEASUREMENT);
 const defaultLeaderLineOptions = tool.setLeaderLineDefaultOptions({
   enabled: true,
   autoCreate: true,
   length: 20,
   extendLength: 10,
 });
});

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 if an object is used, it should contain 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 is called when this tool is selected. Typically use for changing mouse cursors, and initializing states for the tool.
Parameters:
Name Type Description
oldTool Core.Tools.Tool The Tool class that was previously selected.
Inherited From:
Overrides:

switchOut(newTool)

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

trigger(type [, data])

Calls the handlers of the event name with given data
Parameters:
Name Type Argument Description
type string | number event name of which the handlers will be called.
data * <optional>
 data that will be passed to the handlers. If data is an array, it will be spread and then passed to the handlers
Inherited From:
Overrides:
Returns:
Returns the object that 'trigger' is being called on
Type
object
Example
myObject.trigger('eventName');
myObject.trigger('eventName', [eventParameter1, eventParameter2]);

Events

annotationAdded

Triggered when an annotation has been added to the document by the tool
Parameters:
Name Type Description
annotation Core.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 Core.Annotations.Annotation The annotation that was created
Inherited From:
Overrides: