Class: CalloutCreateTool

Core.Tools. CalloutCreateTool

Represents the tool for creating Core.Annotations.FreeTextAnnotation.

new CalloutCreateTool(docViewer)

Parameters:
Name Type Description
docViewer Core.DocumentViewer An instance of DocumentViewer.
Properties:
Name Type Description
lineCount number The number of segments for the line of the created callout
defaults object The default styles of the tool
Properties
Name Type Description
StrokeColor Core.Annotations.Color The stroke color of the tool
FillColor Core.Annotations.Color The fill color of the tool
TextColor Core.Annotations.Color The text color of the tool
Opacity number The opacity of the tool
StrokeThickness number The stroke thickness of the tool
FontSize string The font size of the tool. Should be a string with a number followed by units of either pt or px. For example "16pt". If no unit is specified then pt will be used.
Width number The width of the text box
Height number The height of the text box
Font string The font family of the tool. The value should be web safe fonts
TextAlign 'left' | 'center' | 'right' The text alignment of the tool

Extends

Methods


<static> setTextHandler(handler)

Parameters:
Name Type Description
handler function A function that should return a string that will be used as the initial text for a freetext annotation

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:

disableAutoSizedTextBox()

Disables auto resizing of the annotation text box

disableCreationOverAnnotation()

Prevent the tool from creating new annotations when hovering over an existing annotation. The annotation will be selected instead.
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:

enableAutoSizedTextBox()

Enables the text box of the annotation to auto resize with a fixed width when the text changes The width can be adjusted by changing calloutTool.defaults.Width to a different value

enableCreationOverAnnotation()

Allow the tool to create new annotations when hovering over an existing annotation
Inherited From:
Overrides:

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();
  }
}

getDocumentViewer()

Returns the instance of DocumentViewer for this tool.
Inherited From:
Overrides:
Returns:
The instance of DocumentViewer for this tool.
Type
Core.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:
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

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:
Returns:
A promise that resolves when the method execution is finished
Type
Promise.<void>

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:

off( [type] [, fn])

Remove a handler of the given event name
Parameters:
Name Type Argument Description
type string | number <optional>
The name of the event to remove the handler of. If type is undefined, all the handlers of the object will be removed
fn function <optional>
The handler associated with this event to be removed. If fn is undefined, all the handlers of the given event name will be removed
Inherited From:
Overrides:
Deprecated:
Returns:
Returns the object that 'off' is being called on
Type
object
Example
myObject.off();
myObject.off('eventName');
myObject.off('eventName', fn);

on(type, fn)

Add a handler to the given event name
Parameters:
Name Type Description
type string | number The name of the event to listen to
fn function The handler to be called when the event is triggered
Inherited From:
Overrides:
Deprecated:
Returns:
Returns the object that 'on' is being called on
Type
object
Example
myObject.on('eventName', (eventParameter1, eventParameter2) => {
  ...
});

one(type, fn)

Same as 'on' except the handler will be called only once
Parameters:
Name Type Description
type string | number The name of the event to listen to
fn function The handler to be called when the event is triggered
Inherited From:
Overrides:
Deprecated:
  • Since version 8.0. Use addEventListener with {'once': true} as options instead.
Returns:
Returns the object that 'one' is being called on
Type
object
Example
myObject.one('eventName', (eventParameter1, eventParameter2) => {
 ...
});

removeEventListener( [type] [, fn])

Remove a handler of the given event name
Parameters:
Name Type Argument Description
type string | number <optional>
The name of the event to remove the handler of. If type is undefined, all the handlers of the object will be removed
fn function <optional>
The handler associated with this event to be removed. If fn is undefined, all the handlers of the given event name will be removed
Inherited From:
Overrides:
Deprecated:
  • for version 9.0. Use [removeEventListener] with fn specified
Returns:
Returns the object that 'removeEventListener' is being called on
Type
object
Example
myObject.removeEventListener();
myObject.removeEventListener('eventName');
myObject.removeEventListener('eventName', fn);

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:
Deprecated:
  • since version 8.0 Please use enableCreationOverAnnotation or disableCreationOverAnnotation instead

setEnableAutoSized(enable)

Set if the text box of the annotation should auto resize with a fixed width on text change The width can be adjusted by changing calloutTool.defaults.Width to a different value
Parameters:
Name Type Description
enable boolean A boolean indicating whether only the box height will resize on text change
Deprecated:
  • since version 8.0 Please use enableAutoSizedTextBox or disableAutoSizedTextBox instead

setEnableImmediateActionOnAnnotationSelection(enable)

Set if the tool should trigger action 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.
Parameters:
Name Type Description
enable boolean A boolean indicating whether actions are triggered immediately on clicking on an annotation
Inherited From:
Overrides:
Deprecated:
  • since version 8.0 Please use enableImmediateActionOnAnnotationSelection or disableImmediateActionOnAnnotationSelection instead
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.setEnableImmediateActionOnAnnotationSelection(true);

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.setEnableImmediateActionOnAnnotationSelection(true);
  }
}

setMaximumAnnotationSizeWhenResizing(maximumAnnotationSizeGetterFunction)

Sets the maximum size of annotations when resizing.
Parameters:
Name Type Description
maximumAnnotationSizeGetterFunction function A function that receives the annotation being resized and returns an object with width and height values that represent the maximum width and height the annotation should be allowed to resize to.
Inherited From:
Overrides:
Example
instance.Core.Tools.AnnotationSelectTool.setMaximumAnnotationSizeWhenResizing((annotation) => {
  if (annotation instanceof instance.Annotations.RectangleAnnotation) {
    // maximum size for rectangles
    return { width: 100, height: 30 };
  }
  // no maximum size for other types
  return null;
});

setMinimumAnnotationSizeWhenResizing(minimumAnnotationSizeGetterFunction)

Sets the minimum size of annotations when resizing.
Parameters:
Name Type Description
minimumAnnotationSizeGetterFunction function A function that receives the annotation being resized and returns an object with width and height values that represent the minimum width and height the annotation should be allowed to resize to.
Inherited From:
Overrides:
Example
instance.Core.Tools.AnnotationSelectTool.setMinimumAnnotationSizeWhenResizing((annotation) => {
  if (annotation instanceof instance.Annotations.RectangleAnnotation) {
    // minimum size for rectangles
    return { width: 100, height: 30 };
  }
  // no minimum size for other types
  return null;
});

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