Tool

The minimum distance the mouse has to drag before firing the onMouseDrag event, since the last onMouseDrag event.

Type:

• Number

The maximum distance the mouse has to drag before firing the onMouseDrag event, since the last onMouseDrag event.

Type:

• Number

Type:

• Number

The function to be called when the mouse button is pushed down. The function receives a ToolEvent object which contains information about the tool event.

Type:

• Function⟋null

Example:Creating circle shaped paths where the user presses the mouse button:

The function to be called when the mouse position changes while the mouse is being dragged. The function receives a ToolEvent object which contains information about the tool event.

Type:

• Function⟋null

Example:Draw a line by adding a segment to a path on every mouse drag event:

The function to be called the mouse moves within the project view. The function receives a ToolEvent object which contains information about the tool event.

Type:

• Function⟋null

Example:Moving a path to the position of the mouse:

The function to be called when the mouse button is released. The function receives a ToolEvent object which contains information about the tool event.

Type:

• Function⟋null

Example:Creating circle shaped paths where the user releases the mouse:

The function to be called when the user presses a key on the keyboard. The function receives a KeyEvent object which contains information about the keyboard event.

If the function returns false, the keyboard event will be prevented from bubbling up. This can be used for example to stop the window from scrolling, when you need the user to interact with arrow keys.

Type:

• Function⟋null

Example:Scaling a path whenever the user presses the space bar:

The function to be called when the user releases a key on the keyboard. The function receives a KeyEvent object which contains information about the keyboard event.

If the function returns false, the keyboard event will be prevented from bubbling up. This can be used for example to stop the window from scrolling, when you need the user to interact with arrow keys.

Type:

• Function⟋null

Example:

tool.onKeyUp = function(event) {
    if (event.key == 'space') {
        console.log('The spacebar was released!');
    }
}

Activates this tool, meaning paperScope.tool will point to it and it will be the one that receives tool events.

Removes this tool from the paperScope.tools list.

Attach an event handler to the tool.

Parameters:

• type: String — the event type: ‘mousedown’, ‘mouseup’, ‘mousedrag’, ‘mousemove’, ‘keydown’, ‘keyup’
• function: Function — the function to be called when the event occurs, receiving a ToolEvent object as its sole argument

Returns:

• Tool — this tool itself, so calls can be chained

Attach one or more event handlers to the tool.

Parameters:

• param: Object — an object literal containing one or more of the following properties: mousedown, mouseup, mousedrag, mousemove, keydown, keyup

Returns:

• Tool — this tool itself, so calls can be chained

Detach an event handler from the tool.

Parameters:

• type: String — the event type: ‘mousedown’, ‘mouseup’, ‘mousedrag’, ‘mousemove’, ‘keydown’, ‘keyup’
• function: Function — the function to be detached

Returns:

• Tool — this tool itself, so calls can be chained

Detach one or more event handlers from the tool.

Parameters:

• param: Object — an object literal containing one or more of the following properties: mousedown, mouseup, mousedrag, mousemove, keydown, keyup

Returns:

• Tool — this tool itself, so calls can be chained

Emit an event on the tool.

Parameters:

• type: String — the event type: ‘mousedown’, ‘mouseup’, ‘mousedrag’, ‘mousemove’, ‘keydown’, ‘keyup’
• event: Object — an object literal containing properties describing the event

Returns:

• Boolean — true if the event had listeners, false otherwise

Check if the tool has one or more event handlers of the specified type.

Parameters:

• type: String — the event type: ‘mousedown’, ‘mouseup’, ‘mousedrag’, ‘mousemove’, ‘keydown’, ‘keyup’

Returns:

• Boolean — true if the tool has one or more event handlers of the specified type, false otherwise