PDFJS Express WebViewer

Class: CropCreateTool

Tools. CropCreateTool

Represents the tool for cropping a page.

new CropCreateTool(docViewer)

Creates a new instance of the CropCreateTool.
Parameters:
Name Type Description
docViewer CoreControls.DocumentViewer an instance of DocumentViewer.

Extends

Members

<static> CropModes :string

Type:
  • string
Properties:
Name Type Description
SINGLE_PAGE string Sets the CropTool to the default single page mode
ALL_PAGES string Sets the CropTool to apply the crop to all pages

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:

getCropMode()

Gets the current crop mode.
Returns:
Returns the current crop mode;
Type
Tools.CropCreateTool.CropModes

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:

setCropMode(cropMode)

Sets the crop mode for the tool
Parameters:
Name Type Description
cropMode Tools.CropCreateTool.CropModes The crop mode to select
Example
WebViewer(...).then(instance => {
 const tool = instance.docViewer.getTool('CropPage');
 tool.setCropMode(instance.Tools.CropCreateTool.CropModes.ALL_PAGES);
})

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:

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:

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:

cropApplied

Fired when a crop is performed on the document
Parameters:
Name Type Description
cropInfo Object
Properties
Name Type Description
pageNumber number The page number the crop was applied on
left number The number of points (pts) cut off the left edge
right number The number of points (pts) cut off the right edge
bottom number The number of points (pts) cut off the bottom edge
top number The number of points (pts) cut off the top edge