Item

The Item type allows you to access and modify the items in Paper.js projects. Its functionality is inherited by different project item types such as Path, CompoundPath, Group, Layer and Raster. They each add a layer of functionality that is unique to their type, but share the underlying properties and functions that they inherit from Item.

Properties

  • id

    The unique id of the item.

    Read only.

    • Type:

    • Number

  • className

    The class name of the item as a string.

    • Values:

    • 'Group', 'Layer', 'Path', 'CompoundPath', 'Shape', 'Raster', 'SymbolItem', 'PointText'

    • Type:

    • String

    name

    The name of the item. If the item has a name, it can be accessed by name through its parent’s children list.

    • Type:

    • String

    Example:

    var path = new Path.Circle({
        center: [80, 50],
        radius: 35
    });
    // Set the name of the path:
    path.name = 'example';
    
    // Create a group and add path to it as a child:
    var group = new Group();
    group.addChild(path);
    
    // The path can be accessed by name:
    group.children['example'].fillColor = 'red';
  • style

    The path style of the item.

    • Type:

    • Style

    Example:Applying several styles to an item in one go, by passing an object to its style property:

    var circle = new Path.Circle({
        center: [80, 50],
        radius: 30
    });
    circle.style = {
        fillColor: 'blue',
        strokeColor: 'red',
        strokeWidth: 5
    };

    Example:Copying the style of another item:

    var path = new Path.Circle({
        center: [50, 50],
        radius: 30,
        fillColor: 'red'
    });
    
    var path2 = new Path.Circle({
        center: new Point(180, 50),
        radius: 20
    });
    
    // Copy the path style of path:
    path2.style = path.style;

    Example:Applying the same style object to multiple items:

    var myStyle = {
        fillColor: 'red',
        strokeColor: 'blue',
        strokeWidth: 4
    };
    
    var path = new Path.Circle({
        center: [50, 50],
        radius: 30
    });
    path.style = myStyle;
    
    var path2 = new Path.Circle({
        center: new Point(150, 50),
        radius: 20
    });
    path2.style = myStyle;
  • locked

    Specifies whether the item is locked. When set to true, item interactions with the mouse are disabled.

    • Default:

    • false

    • Type:

    • Boolean

    Example:

    var unlockedItem = new Path.Circle({
        center: view.center - [35, 0],
        radius: 30,
        fillColor: 'springgreen',
        onMouseDown: function() {
            this.fillColor = Color.random();
        }
    });
    
    var lockedItem = new Path.Circle({
        center: view.center + [35, 0],
        radius: 30,
        fillColor: 'crimson',
        locked: true,
        // This event won't be triggered because the item is locked.
        onMouseDown: function() {
            this.fillColor = Color.random();
        }
    });
    
    new PointText({
        content: 'Click on both circles to see which one is locked.',
        point: view.center - [0, 35],
        justification: 'center'
    });
  • visible

    Specifies whether the item is visible. When set to false, the item won’t be drawn.

    • Default:

    • true

    • Type:

    • Boolean

    Example:Hiding an item:

    var path = new Path.Circle({
        center: [50, 50],
        radius: 20,
        fillColor: 'red'
    });
    
    // Hide the path:
    path.visible = false;
  • blendMode

    The blend mode with which the item is composited onto the canvas. Both the standard canvas compositing modes, as well as the new CSS blend modes are supported. If blend-modes cannot be rendered natively, they are emulated. Be aware that emulation can have an impact on performance.

    • Values:

    • 'normal', 'multiply', 'screen', 'overlay', 'soft-light', 'hard- light', 'color-dodge', 'color-burn', 'darken', 'lighten', 'difference', 'exclusion', 'hue', 'saturation', 'luminosity', 'color', 'add', 'subtract', 'average', 'pin-light', 'negation', 'source-over', 'source-in', 'source-out', 'source-atop', 'destination-over', 'destination-in', 'destination-out', 'destination-atop', 'lighter', 'darker', 'copy', 'xor'

    • Default:

    • 'normal'

    • Type:

    • String

    Example:Setting an item's blend mode:

    // Create a white rectangle in the background
    // with the same dimensions as the view:
    var background = new Path.Rectangle(view.bounds);
    background.fillColor = 'white';
    
    var circle = new Path.Circle({
        center: [80, 50],
        radius: 35,
        fillColor: 'red'
    });
    
    var circle2 = new Path.Circle({
        center: new Point(120, 50),
        radius: 35,
        fillColor: 'blue'
    });
    
    // Set the blend mode of circle2:
    circle2.blendMode = 'multiply';
  • opacity

    The opacity of the item as a value between 0 and 1.

    • Default:

    • 1

    • Type:

    • Number

    Example:Making an item 50% transparent:

    var circle = new Path.Circle({
        center: [80, 50],
        radius: 35,
        fillColor: 'red'
    });
    
    var circle2 = new Path.Circle({
        center: new Point(120, 50),
        radius: 35,
        fillColor: 'blue',
        strokeColor: 'green',
        strokeWidth: 10
    });
    
    // Make circle2 50% transparent:
    circle2.opacity = 0.5;
  • selected

    Specifies whether the item is selected. This will also return true for Group items if they are partially selected, e.g. groups containing selected or partially selected paths.

    Paper.js draws the visual outlines of selected items on top of your project. This can be useful for debugging, as it allows you to see the construction of paths, position of path curves, individual segment points and bounding boxes of symbol and raster items.

    • Default:

    • false

    • Type:

    • Boolean

    • See also:

    • project.selectedItems

    • segment.selected

    • curve.selected

    • point.selected

    Example:Selecting an item:

    var path = new Path.Circle({
        center: [80, 50],
        radius: 35
    });
    path.selected = true; // Select the path
  • clipMask

    Specifies whether the item defines a clip mask. This can only be set on paths and compound paths, and only if the item is already contained within a clipping group.

    • Default:

    • false

    • Type:

    • Boolean

  • data

    A plain javascript object which can be used to store arbitrary data on the item.

    • Type:

    • Object

    Example:

    var path = new Path();
    path.data.remember = 'milk';

    Example:

    var path = new Path();
    path.data.malcolm = new Point(20, 30);
    console.log(path.data.malcolm.x); // 20

    Example:

    var path = new Path();
    path.data = {
        home: 'Omicron Theta',
        found: 2338,
        pets: ['Spot']
    };
    console.log(path.data.pets.length); // 1

    Example:

    var path = new Path({
        data: {
            home: 'Omicron Theta',
            found: 2338,
            pets: ['Spot']
        }
    });
    console.log(path.data.pets.length); // 1

Position and Bounding Boxes

  • position

    The item’s position within the parent item’s coordinate system. By default, this is the rectangle.center of the item’s bounds rectangle.

    • Type:

    • Point

    Example:Changing the position of a path:

    // Create a circle at position { x: 10, y: 10 }
    var circle = new Path.Circle({
        center: new Point(10, 10),
        radius: 10,
        fillColor: 'red'
    });
    
    // Move the circle to { x: 20, y: 20 }
    circle.position = new Point(20, 20);
    
    // Move the circle 100 points to the right and 50 points down
    circle.position += new Point(100, 50);

    Example:Changing the x coordinate of an item's position:

    // Create a circle at position { x: 20, y: 20 }
    var circle = new Path.Circle({
        center: new Point(20, 20),
        radius: 10,
        fillColor: 'red'
    });
    
    // Move the circle 100 points to the right
    circle.position.x += 100;
  • pivot

    The item’s pivot point specified in the item coordinate system, defining the point around which all transformations are hinging. This is also the reference point for position. By default, it is set to null, meaning the rectangle.center of the item’s bounds rectangle is used as pivot.

    • Default:

    • null

    • Type:

    • Point

  • bounds

    The bounding rectangle of the item excluding stroke width.

    • Type:

    • Rectangle

  • strokeBounds

    The bounding rectangle of the item including stroke width.

    • Type:

    • Rectangle

  • handleBounds

    The bounding rectangle of the item including handles.

    • Type:

    • Rectangle

  • internalBounds

    The bounding rectangle of the item without any matrix transformations.

    Typical use case would be drawing a frame around the object where you want to draw something of the same size, position, rotation, and scaling, like a selection frame.

    • Type:

    • Rectangle

  • rotation

    The current rotation angle of the item, as described by its matrix. Please note that this only returns meaningful values for items with applyMatrix set to false, meaning they do not directly bake transformations into their content.

    • Type:

    • Number

  • scaling

    The current scale factor of the item, as described by its matrix. Please note that this only returns meaningful values for items with applyMatrix set to false, meaning they do not directly bake transformations into their content.

    • Type:

    • Point

  • matrix

    The item’s transformation matrix, defining position and dimensions in relation to its parent item in which it is contained.

    • Type:

    • Matrix

  • globalMatrix

    The item’s global transformation matrix in relation to the global project coordinate space. Note that the view’s transformations resulting from zooming and panning are not factored in.

    Read only.

    • Type:

    • Matrix

  • viewMatrix

    The item’s global matrix in relation to the view coordinate space. This means that the view’s transformations resulting from zooming and panning are factored in.

    Read only.

    • Type:

    • Matrix

  • applyMatrix

    Controls whether the transformations applied to the item (e.g. through transform(matrix), rotate(angle), scale(scale), etc.) are stored in its matrix property, or whether they are directly applied to its contents or children (passed on to the segments in Path items, the children of Group items, etc.).

    • Default:

    • true

    • Type:

    • Boolean

Project Hierarchy

  • project

    The project that this item belongs to.

    Read only.

    • Type:

    • Project

  • view

    The view that this item belongs to.

    Read only.

    • Type:

    • View

  • layer

    The layer that this item is contained within.

    Read only.

    • Type:

    • Layer

  • parent

    The item that this item is contained within.

    • Type:

    • Item

    Example:

    var path = new Path();
    
    // New items are placed in the active layer:
    console.log(path.parent == project.activeLayer); // true
    
    var group = new Group();
    group.addChild(path);
    
    // Now the parent of the path has become the group:
    console.log(path.parent == group); // true

    Example:Setting the parent of the item to another item

    var path = new Path();
    
    // New items are placed in the active layer:
    console.log(path.parent == project.activeLayer); // true
    
    var group = new Group();
    path.parent = group;
    
    // Now the parent of the path has become the group:
    console.log(path.parent == group); // true
    
    // The path is now contained in the children list of group:
    console.log(group.children[0] == path); // true

    Example:Setting the parent of an item in the constructor

    var group = new Group();
    
    var path = new Path({
        parent: group
    });
    
    // The parent of the path is the group:
    console.log(path.parent == group); // true
    
    // The path is contained in the children list of group:
    console.log(group.children[0] == path); // true
  • children

    The children items contained within this item. Items that define a name can also be accessed by name.

    Please note: The children array should not be modified directly using array functions. To remove single items from the children list, use item.remove(), to remove all items from the children list, use item.removeChildren(). To add items to the children list, use item.addChild(item) or item.insertChild(index, item).

    • Type:

    • Array of Item objects

    Example:Accessing items in the children array:

    var path = new Path.Circle({
        center: [80, 50],
        radius: 35
    });
    
    // Create a group and move the path into it:
    var group = new Group();
    group.addChild(path);
    
    // Access the path through the group's children array:
    group.children[0].fillColor = 'red';

    Example:Accessing children by name:

    var path = new Path.Circle({
        center: [80, 50],
        radius: 35
    });
    // Set the name of the path:
    path.name = 'example';
    
    // Create a group and move the path into it:
    var group = new Group();
    group.addChild(path);
    
    // The path can be accessed by name:
    group.children['example'].fillColor = 'orange';

    Example:Passing an array of items to item.children:

    var path = new Path.Circle({
        center: [80, 50],
        radius: 35
    });
    
    var group = new Group();
    group.children = [path];
    
    // The path is the first child of the group:
    group.firstChild.fillColor = 'green';
  • firstChild

    The first item contained within this item. This is a shortcut for accessing item.children[0].

    Read only.

    • Type:

    • Item

  • lastChild

    The last item contained within this item.This is a shortcut for accessing item.children[item.children.length - 1].

    Read only.

    • Type:

    • Item

  • nextSibling

    The next item on the same level as this item.

    Read only.

    • Type:

    • Item

  • previousSibling

    The previous item on the same level as this item.

    Read only.

    • Type:

    • Item

  • index

    The index of this item within the list of its parent’s children.

    Read only.

    • Type:

    • Number

Stroke Style

  • strokeColor

    The color of the stroke.

    • Type:

    • Colornull

    Example:Setting the stroke color of a path:

    // Create a circle shaped path at { x: 80, y: 50 }
    // with a radius of 35:
    var circle = new Path.Circle({
        center: [80, 50],
        radius: 35
    });
    
    // Set its stroke color to RGB red:
    circle.strokeColor = new Color(1, 0, 0);
  • strokeWidth

    The width of the stroke.

    • Type:

    • Number

    Example:Setting an item's stroke width:

    // Create a circle shaped path at { x: 80, y: 50 }
    // with a radius of 35:
    var circle = new Path.Circle({
        center: [80, 50],
        radius: 35,
        strokeColor: 'red'
    });
    
    // Set its stroke width to 10:
    circle.strokeWidth = 10;
  • strokeCap

    The shape to be used at the beginning and end of open Path items, when they have a stroke.

    • Values:

    • 'round', 'square', 'butt'

    • Default:

    • 'butt'

    • Type:

    • String

    Example:A look at the different stroke caps:

    var line = new Path({
        segments: [[80, 50], [420, 50]],
        strokeColor: 'black',
        strokeWidth: 20,
        selected: true
    });
    
    // Set the stroke cap of the line to be round:
    line.strokeCap = 'round';
    
    // Copy the path and set its stroke cap to be square:
    var line2 = line.clone();
    line2.position.y += 50;
    line2.strokeCap = 'square';
    
    // Make another copy and set its stroke cap to be butt:
    var line2 = line.clone();
    line2.position.y += 100;
    line2.strokeCap = 'butt';
  • strokeJoin

    The shape to be used at the segments and corners of Path items when they have a stroke.

    • Values:

    • 'miter', 'round', 'bevel'

    • Default:

    • 'miter'

    • Type:

    • String

    Example:A look at the different stroke joins:

    var path = new Path({
        segments: [[80, 100], [120, 40], [160, 100]],
        strokeColor: 'black',
        strokeWidth: 20,
        // Select the path, in order to see where the stroke is formed:
        selected: true
    });
    
    var path2 = path.clone();
    path2.position.x += path2.bounds.width * 1.5;
    path2.strokeJoin = 'round';
    
    var path3 = path2.clone();
    path3.position.x += path3.bounds.width * 1.5;
    path3.strokeJoin = 'bevel';
  • dashOffset

    The dash offset of the stroke.

    • Default:

    • 0

    • Type:

    • Number

  • strokeScaling

    Specifies whether the stroke is to be drawn taking the current affine transformation into account (the default behavior), or whether it should appear as a non-scaling stroke.

    • Default:

    • true

    • Type:

    • Boolean

  • dashArray

    Specifies an array containing the dash and gap lengths of the stroke.

    • Default:

    • []

    • Type:

    • Array of Numbers

    Example:

    var path = new Path.Circle({
        center: [80, 50],
        radius: 40,
        strokeWidth: 2,
        strokeColor: 'black'
    });
    
    // Set the dashed stroke to [10pt dash, 4pt gap]:
    path.dashArray = [10, 4];
  • miterLimit

    The miter limit of the stroke. When two line segments meet at a sharp angle and miter joins have been specified for item.strokeJoin, it is possible for the miter to extend far beyond the item.strokeWidth of the path. The miterLimit imposes a limit on the ratio of the miter length to the item.strokeWidth.

    • Default:

    • 10

    • Type:

    • Number

Fill Style

  • fillColor

    The fill color of the item.

    • Type:

    • Colornull

    Example:Setting the fill color of a path to red:

    // Create a circle shaped path at { x: 80, y: 50 }
    // with a radius of 35:
    var circle = new Path.Circle({
        center: [80, 50],
        radius: 35
    });
    
    // Set the fill color of the circle to RGB red:
    circle.fillColor = new Color(1, 0, 0);
  • fillRule

    The fill-rule with which the shape gets filled. Please note that only modern browsers support fill-rules other than 'nonzero'.

    • Values:

    • 'nonzero', 'evenodd'

    • Default:

    • 'nonzero'

    • Type:

    • String

Shadow Style

  • shadowColor

    The shadow color.

    • Type:

    • Colornull

    Example:Creating a circle with a black shadow:

    var circle = new Path.Circle({
        center: [80, 50],
        radius: 35,
        fillColor: 'white',
        // Set the shadow color of the circle to RGB black:
        shadowColor: new Color(0, 0, 0),
        // Set the shadow blur radius to 12:
        shadowBlur: 12,
        // Offset the shadow by { x: 5, y: 5 }
        shadowOffset: new Point(5, 5)
    });
  • shadowBlur

    The shadow’s blur radius.

    • Default:

    • 0

    • Type:

    • Number

  • shadowOffset

    The shadow’s offset.

    • Default:

    • 0

    • Type:

    • Point

Selection Style

  • selectedColor

    The color the item is highlighted with when selected. If the item does not specify its own color, the color defined by its layer is used instead.

    • Type:

    • Colornull

Event Handlers

  • onFrame

    Item level handler function to be called on each frame of an animation. The function receives an event object which contains information about the frame event:

    • Type:

    • Functionnull

    • Options:

    • event.count: Number — the number of times the frame event was fired

    • event.time: Number — the total amount of time passed since the first frame event in seconds

    • event.delta: Number — the time passed in seconds since the last frame event

    • See also:

    • view.onFrame

    Example:Creating an animation:

    // Create a rectangle shaped path with its top left point at:
    // {x: 50, y: 25} and a size of {width: 50, height: 50}
    var path = new Path.Rectangle(new Point(50, 25), new Size(50, 50));
    path.fillColor = 'black';
    
    path.onFrame = function(event) {
        // Every frame, rotate the path by 3 degrees:
        this.rotate(3);
    }
  • onMouseDown

    The function to be called when the mouse button is pushed down on the item. The function receives a MouseEvent object which contains information about the mouse event. Note that such mouse events bubble up the scene graph hierarchy and will reach the view, unless they are stopped with event.stopPropagation() or by returning false from the handler.

    • Type:

    • Functionnull

    • See also:

    • view.onMouseDown

    Example:Press the mouse button down on the circle shaped path, to make it red:

    // Create a circle shaped path at the center of the view:
    var path = new Path.Circle({
        center: view.center,
        radius: 25,
        fillColor: 'black'
    });
    
    // When the mouse is pressed on the item,
    // set its fill color to red:
    path.onMouseDown = function(event) {
        this.fillColor = 'red';
    }

    Example:Press the mouse on the circle shaped paths to remove them:

    // Loop 30 times:
    for (var i = 0; i < 30; i++) {
        // Create a circle shaped path at a random position
        // in the view:
        var path = new Path.Circle({
            center: Point.random() * view.size,
            radius: 25,
            fillColor: 'black',
            strokeColor: 'white'
        });
    
        // When the mouse is pressed on the item, remove it:
        path.onMouseDown = function(event) {
            this.remove();
        }
    }
  • onMouseDrag

    The function to be called when the mouse position changes while the mouse is being dragged over the item. The function receives a MouseEvent object which contains information about the mouse event. Note that such mouse events bubble up the scene graph hierarchy and will reach the view, unless they are stopped with event.stopPropagation() or by returning false from the handler.

    • Type:

    • Functionnull

    • See also:

    • view.onMouseDrag

    Example:Press and drag the mouse on the blue circle to move it:

    // Create a circle shaped path at the center of the view:
    var path = new Path.Circle({
        center: view.center,
        radius: 50,
        fillColor: 'blue'
    });
    
    // Install a drag event handler that moves the path along.
    path.onMouseDrag = function(event) {
        path.position += event.delta;
    }
  • onMouseUp

    The function to be called when the mouse button is released over the item. The function receives a MouseEvent object which contains information about the mouse event. Note that such mouse events bubble up the scene graph hierarchy and will reach the view, unless they are stopped with event.stopPropagation() or by returning false from the handler.

    • Type:

    • Functionnull

    • See also:

    • view.onMouseUp

    Example:Release the mouse button over the circle shaped path, to make it red:

    // Create a circle shaped path at the center of the view:
    var path = new Path.Circle({
        center: view.center,
        radius: 25,
        fillColor: 'black'
    });
    
    // When the mouse is released over the item,
    // set its fill color to red:
    path.onMouseUp = function(event) {
        this.fillColor = 'red';
    }
  • onClick

    The function to be called when the mouse clicks on the item. The function receives a MouseEvent object which contains information about the mouse event. Note that such mouse events bubble up the scene graph hierarchy and will reach the view, unless they are stopped with event.stopPropagation() or by returning false from the handler.

    • Type:

    • Functionnull

    • See also:

    • view.onClick

    Example:Click on the circle shaped path, to make it red:

    // Create a circle shaped path at the center of the view:
    var path = new Path.Circle({
        center: view.center,
        radius: 25,
        fillColor: 'black'
    });
    
    // When the mouse is clicked on the item,
    // set its fill color to red:
    path.onClick = function(event) {
        this.fillColor = 'red';
    }

    Example:Click on the circle shaped paths to remove them:

    // Loop 30 times:
    for (var i = 0; i < 30; i++) {
        // Create a circle shaped path at a random position
        // in the view:
        var path = new Path.Circle({
            center: Point.random() * view.size,
            radius: 25,
            fillColor: 'black',
            strokeColor: 'white'
        });
    
        // When the mouse clicks on the item, remove it:
        path.onClick = function(event) {
            this.remove();
        }
    }
  • onDoubleClick

    The function to be called when the mouse double clicks on the item. The function receives a MouseEvent object which contains information about the mouse event. Note that such mouse events bubble up the scene graph hierarchy and will reach the view, unless they are stopped with event.stopPropagation() or by returning false from the handler.

    • Type:

    • Functionnull

    • See also:

    • view.onDoubleClick

    Example:Double click on the circle shaped path, to make it red:

    // Create a circle shaped path at the center of the view:
    var path = new Path.Circle({
        center: view.center,
        radius: 25,
        fillColor: 'black'
    });
    
    // When the mouse is double clicked on the item,
    // set its fill color to red:
    path.onDoubleClick = function(event) {
        this.fillColor = 'red';
    }

    Example:Double click on the circle shaped paths to remove them:

    // Loop 30 times:
    for (var i = 0; i < 30; i++) {
        // Create a circle shaped path at a random position
        // in the view:
        var path = new Path.Circle({
            center: Point.random() * view.size,
            radius: 25,
            fillColor: 'black',
            strokeColor: 'white'
        });
    
        // When the mouse is double clicked on the item, remove it:
        path.onDoubleClick = function(event) {
            this.remove();
        }
    }
  • onMouseMove

    The function to be called repeatedly while the mouse moves over the item. The function receives a MouseEvent object which contains information about the mouse event. Note that such mouse events bubble up the scene graph hierarchy and will reach the view, unless they are stopped with event.stopPropagation() or by returning false from the handler.

    • Type:

    • Functionnull

    • See also:

    • view.onMouseMove

    Example:Move over the circle shaped path, to change its opacity:

    // Create a circle shaped path at the center of the view:
        var path = new Path.Circle({
        center: view.center,
        radius: 25,
        fillColor: 'black'
        });
    
    // When the mouse moves on top of the item, set its opacity
    // to a random value between 0 and 1:
    path.onMouseMove = function(event) {
        this.opacity = Math.random();
    }
  • onMouseEnter

    The function to be called when the mouse moves over the item. This function will only be called again, once the mouse moved outside of the item first. The function receives a MouseEvent object which contains information about the mouse event. Note that such mouse events bubble up the scene graph hierarchy and will reach the view, unless they are stopped with event.stopPropagation() or by returning false from the handler.

    • Type:

    • Functionnull

    • See also:

    • view.onMouseEnter

    Example:When you move the mouse over the item, its fill color is set to red. When you move the mouse outside again, its fill color is set back to black.

    // Create a circle shaped path at the center of the view:
    var path = new Path.Circle({
        center: view.center,
        radius: 25,
        fillColor: 'black'
    });
    
    // When the mouse enters the item, set its fill color to red:
    path.onMouseEnter = function(event) {
        this.fillColor = 'red';
    }
    
    // When the mouse leaves the item, set its fill color to black:
    path.onMouseLeave = function(event) {
        this.fillColor = 'black';
    }

    Example:When you click the mouse, you create new circle shaped items. When you move the mouse over the item, its fill color is set to red. When you move the mouse outside again, its fill color is set back to black.

    function enter(event) {
        this.fillColor = 'red';
    }
    
    function leave(event) {
        this.fillColor = 'black';
    }
    
    // When the mouse is pressed:
    function onMouseDown(event) {
        // Create a circle shaped path at the position of the mouse:
        var path = new Path.Circle(event.point, 25);
        path.fillColor = 'black';
    
        // When the mouse enters the item, set its fill color to red:
        path.onMouseEnter = enter;
    
        // When the mouse leaves the item, set its fill color to black:
        path.onMouseLeave = leave;
    }
  • onMouseLeave

    The function to be called when the mouse moves out of the item. The function receives a MouseEvent object which contains information about the mouse event. Note that such mouse events bubble up the scene graph hierarchy and will reach the view, unless they are stopped with event.stopPropagation() or by returning false from the handler.

    • Type:

    • Functionnull

    • See also:

    • view.onMouseLeave

    Example:Move the mouse over the circle shaped path and then move it out of it again to set its fill color to red:

    // Create a circle shaped path at the center of the view:
    var path = new Path.Circle({
        center: view.center,
        radius: 25,
        fillColor: 'black'
    });
    
    // When the mouse leaves the item, set its fill color to red:
    path.onMouseLeave = function(event) {
        this.fillColor = 'red';
    }

Methods

  • set(props)

    Sets the properties of the passed object literal on this item to the values defined in the object literal, if the item has property of the given name (or a setter defined for it).

    • Parameters:

    • props: Object

    • Returns:

    • Item — the item itself

    Example:Setting properties through an object literal

    var circle = new Path.Circle({
        center: [80, 50],
        radius: 35
    });
    
    circle.set({
        strokeColor: 'red',
        strokeWidth: 10,
        fillColor: 'black',
        selected: true
    });
  • clone([options])

    Clones the item within the same project and places the copy above the item.

    • Options:

    • insert: undefined — specifies whether the copy should be inserted into the scene graph. When set to true, it is inserted above the original — default: true

    • deep: undefined — specifies whether the item’s children should also be cloned — default: true

    • Parameters:

    • options: Object — optional, default: { insert: true, deep: true }

    • Returns:

    • Item — the newly cloned item

    Example:Cloning items:

    var circle = new Path.Circle({
        center: [50, 50],
        radius: 10,
        fillColor: 'red'
    });
    
    // Make 20 copies of the circle:
    for (var i = 0; i < 20; i++) {
        var copy = circle.clone();
    
        // Distribute the copies horizontally, so we can see them:
        copy.position.x += i * copy.bounds.width;
    }
  • copyContent(source)

    Copies the content of the specified item over to this item.

    • Parameters:

    • source: Item — the item to copy the content from

  • copyAttributes(source, excludeMatrix)

    Copies all attributes of the specified item over to this item. This includes its style, visibility, matrix, pivot, blend-mode, opacity, selection state, data, name, etc.

    • Parameters:

    • source: Item — the item to copy the attributes from

    • excludeMatrix: Boolean — whether to exclude the transformation matrix when copying all attributes

  • rasterize([resolution[, insert]])

    Rasterizes the item into a newly created Raster object. The item itself is not removed after rasterization.

    • Parameters:

    • resolution: Number — the resolution of the raster in pixels per inch (DPI). If not specified, the value of view.resolution is used. — optional, default: view.resolution

    • insert: Boolean — specifies whether the raster should be inserted into the scene graph. When set to true, it is inserted above the original — optional, default: true

    • Returns:

    • Raster — the newly created raster item

    Example:Rasterizing an item:

    var circle = new Path.Circle({
        center: [50, 50],
        radius: 5,
        fillColor: 'red'
    });
    
    // Create a rasterized version of the path:
    var raster = circle.rasterize();
    
    // Move it 100pt to the right:
    raster.position.x += 100;
    
    // Scale the path and the raster by 300%, so we can compare them:
    circle.scale(5);
    raster.scale(5);

Geometric Tests

  • contains(point)

    Checks whether the item’s geometry contains the given point.

    • Parameters:

    • point: Point — the point to check for

    • Returns:

    • Boolean

    Example:Click within and outside the star below Create a star shaped path:

    var path = new Path.Star({
        center: [50, 50],
        points: 12,
        radius1: 20,
        radius2: 40,
        fillColor: 'black'
    });
    
    // Whenever the user presses the mouse:
    function onMouseDown(event) {
        // If the position of the mouse is within the path,
        // set its fill color to red, otherwise set it to
        // black:
        if (path.contains(event.point)) {
            path.fillColor = 'red';
        } else {
            path.fillColor = 'black';
        }
    }
  • isInside(rect)

    • Parameters:

    • rect: Rectangle — the rectangle to check against

    • Returns:

    • Boolean

  • intersects(item)

    • Parameters:

    • item: Item — the item to check against

    • Returns:

    • Boolean

Hit-testing, Fetching and Matching Items

  • hitTest(point[, options])

    Performs a hit-test on the item and its children (if it is a Group or Layer) at the location of the specified point, returning the first found hit.

    The options object allows you to control the specifics of the hit- test and may contain a combination of the following values:

    • Options:

    • options.tolerance: Number — the tolerance of the hit-test — default: paperScope.settings.hitTolerance

    • options.class: Function — only hit-test against a specific item class, or any of its sub-classes, by providing the constructor function against which an instanceof check is performed: Group, Layer, Path, CompoundPath, Shape, Raster, SymbolItem, PointText, …

    • options.match: Function — a match function to be called for each found hit result: Return true to return the result, false to keep searching

    • options.fill: Boolean — hit-test the fill of items — default: true

    • options.stroke: Boolean — hit-test the stroke of path items, taking into account the setting of stroke color and width — default: true

    • options.segments: Boolean — hit-test for segment.point of Path items — default: true

    • options.curves: Boolean — hit-test the curves of path items, without taking the stroke color or width into account

    • options.handles: Boolean — hit-test for the handles (segment.handleIn / segment.handleOut) of path segments.

    • options.ends: Boolean — only hit-test for the first or last segment points of open path items

    • options.position: Boolean — hit-test the item.position of of items, which depends on the setting of item.pivot

    • options.center: Boolean — hit-test the rectangle.center of the bounding rectangle of items (item.bounds)

    • options.bounds: Boolean — hit-test the corners and side-centers of the bounding rectangle of items (item.bounds)

    • options.guides: Boolean — hit-test items that have Item#guide set to true

    • options.selected: Boolean — only hit selected items

    • Parameters:

    • point: Point — the point where the hit-test should be performed (in global coordinates system).

    • options: Object — optional, default: { fill: true, stroke: true, segments: true, tolerance: settings.hitTolerance }

    • Returns:

    • HitResult — a hit result object describing what exactly was hit or null if nothing was hit

  • hitTestAll(point[, options])

    Performs a hit-test on the item and its children (if it is a Group or Layer) at the location of the specified point, returning all found hits.

    The options object allows you to control the specifics of the hit- test. See hitTest(point[, options]) for a list of all options.

    • Parameters:

    • point: Point — the point where the hit-test should be performed (in global coordinates system).

    • options: Object — optional, default: { fill: true, stroke: true, segments: true, tolerance: settings.hitTolerance }

    • Returns:

    • Array of HitResult objects — hit result objects for all hits, describing what exactly was hit or null if nothing was hit

    • See also:

    • hitTest(point[, options]);

  • matches(options)

    Checks whether the item matches the criteria described by the given object, by iterating over all of its properties and matching against their values through matches(name, compare).

    See project.getItems(options) for a selection of illustrated examples.

    • Parameters:

    • options: ObjectFunction — the criteria to match against

    • Returns:

    • Booleantrue if the item matches all the criteria, false otherwise

    • See also:

    • getItems(options)

  • matches(name, compare)

    Checks whether the item matches the given criteria. Extended matching is possible by providing a compare function or a regular expression. Matching points, colors only work as a comparison of the full object, not partial matching (e.g. only providing the x-coordinate to match all points with that x-value). Partial matching does work for item.data.

    See project.getItems(options) for a selection of illustrated examples.

    • Parameters:

    • name: String — the name of the state to match against

    • compare: Object — the value, function or regular expression to compare against

    • Returns:

    • Booleantrue if the item matches the state, false otherwise

    • See also:

    • getItems(options)

  • getItems(options)

    Fetch the descendants (children or children of children) of this item that match the properties in the specified object. Extended matching is possible by providing a compare function or regular expression. Matching points, colors only work as a comparison of the full object, not partial matching (e.g. only providing the x- coordinate to match all points with that x-value). Partial matching does work for item.data.

    Matching items against a rectangular area is also possible, by setting either options.inside or options.overlapping to a rectangle describing the area in which the items either have to be fully or partly contained.

    See project.getItems(options) for a selection of illustrated examples.

    • Options:

    • options.recursive: Boolean — whether to loop recursively through all children, or stop at the current level — default: true

    • options.match: Function — a match function to be called for each item, allowing the definition of more flexible item checks that are not bound to properties. If no other match properties are defined, this function can also be passed instead of the options object

    • options.class: Function — the constructor function of the item type to match against

    • options.inside: Rectangle — the rectangle in which the items need to be fully contained

    • options.overlapping: Rectangle — the rectangle with which the items need to at least partly overlap

    • Parameters:

    • options: ObjectFunction — the criteria to match against

    • Returns:

    • Array of Item objects — the list of matching descendant items

    • See also:

    • matches(options)

  • getItem(options)

    Fetch the first descendant (child or child of child) of this item that matches the properties in the specified object. Extended matching is possible by providing a compare function or regular expression. Matching points, colors only work as a comparison of the full object, not partial matching (e.g. only providing the x- coordinate to match all points with that x-value). Partial matching does work for item.data. See project.getItems(match) for a selection of illustrated examples.

    • Parameters:

    • options: ObjectFunction — the criteria to match against

    • Returns:

    • Item — the first descendant item matching the given criteria

    • See also:

    • getItems(options)

Importing / Exporting JSON and SVG

  • exportJSON([options])

    Exports (serializes) the item with its content and child items to a JSON data string.

    • Options:

    • options.asString: Boolean — whether the JSON is returned as a Object or a String — default: true

    • options.precision: Number — the amount of fractional digits in numbers used in JSON data — default: 5

    • Parameters:

    • options: Object — the serialization options — optional

    • Returns:

    • String — the exported JSON data

  • importJSON(json)

    Imports (deserializes) the stored JSON data into this item. If the data describes an item of the same class or a parent class of the item, the data is imported into the item itself. If not, the imported item is added to this item’s item.children list. Note that not all type of items can have children.

    • Parameters:

    • json: String — the JSON data to import from

    • Returns:

    • Item

  • exportSVG([options])

    Exports the item with its content and child items as an SVG DOM.

    • Options:

    • options.bounds: StringRectangle — the bounds of the area to export, either as a string (‘view’, content’), or a Rectangle object: 'view' uses the view bounds, 'content' uses the stroke bounds of all content — default: ‘view’

    • options.matrix: Matrix — the matrix with which to transform the exported content: If options.bounds is set to 'view', paper.view.matrix is used, for all other settings of options.bounds the identity matrix is used. — default: paper.view.matrix

    • options.asString: Boolean — whether a SVG node or a String is to be returned — default: false

    • options.precision: Number — the amount of fractional digits in numbers used in SVG data — default: 5

    • options.matchShapes: Boolean — whether path items should tried to be converted to SVG shape items (rect, circle, ellipse, line, polyline, polygon), if their geometries match — default: false

    • options.embedImages: Boolean — whether raster images should be embedded as base64 data inlined in the xlink:href attribute, or kept as a link to their external URL. — default: true

    • Parameters:

    • options: Object — the export options — optional

    • Returns:

    • SVGElementString — the item converted to an SVG node or a String depending on option.asString value

  • importSVG(svg[, options])

    Converts the provided SVG content into Paper.js items and adds them to the this item’s children list. Note that the item is not cleared first. You can call item.removeChildren() to do so.

    • Options:

    • options.expandShapes: Boolean — whether imported shape items should be expanded to path items — default: false

    • options.onLoad: Function — the callback function to call once the SVG content is loaded from the given URL receiving two arguments: the converted item and the original svg data as a string. Only required when loading from external resources.

    • options.onError: Function — the callback function to call if an error occurs during loading. Only required when loading from external resources.

    • options.insert: Boolean — whether the imported items should be added to the item that importSVG() is called on — default: true

    • options.applyMatrix: Boolean — whether the imported items should have their transformation matrices applied to their contents or not — default: paperScope.settings.applyMatrix

    • Parameters:

    • svg: SVGElementString — the SVG content to import, either as a SVG DOM node, a string containing SVG content, or a string describing the URL of the SVG file to fetch.

    • options: Object — the import options — optional

    • Returns:

    • Item — the newly created Paper.js item containing the converted SVG content

  • importSVG(svg, onLoad)

    Imports the provided external SVG file, converts it into Paper.js items and adds them to the this item’s children list. Note that the item is not cleared first. You can call item.removeChildren() to do so.

    • Parameters:

    • svg: SVGElementString — the URL of the SVG file to fetch.

    • onLoad: Function — the callback function to call once the SVG content is loaded from the given URL receiving two arguments: the converted item and the original svg data as a string. Only required when loading from external files.

    • Returns:

    • Item — the newly created Paper.js item containing the converted SVG content

Hierarchy Operations

  • addChild(item)

    Adds the specified item as a child of this item at the end of the its children list. You can use this function for groups, compound paths and layers.

    • Parameters:

    • item: Item — the item to be added as a child

    • Returns:

    • Item — the added item, or null if adding was not possible

  • insertChild(index, item)

    Inserts the specified item as a child of this item at the specified index in its children list. You can use this function for groups, compound paths and layers.

    • Parameters:

    • index: Number — the index at which to insert the item

    • item: Item — the item to be inserted as a child

    • Returns:

    • Item — the inserted item, or null if inserting was not possible

  • addChildren(items)

    Adds the specified items as children of this item at the end of the its children list. You can use this function for groups, compound paths and layers.

    • Parameters:

    • items: Array of Item objects — the items to be added as children

    • Returns:

    • Array of Item objects — the added items, or null if adding was not possible

  • insertChildren(index, items)

    Inserts the specified items as children of this item at the specified index in its children list. You can use this function for groups, compound paths and layers.

    • Parameters:

    • index: Number

    • items: Array of Item objects — the items to be appended as children

    • Returns:

    • Array of Item objects — the inserted items, or null if inserted was not possible

  • insertAbove(item)

    Inserts this item above the specified item.

    • Parameters:

    • item: Item — the item above which it should be inserted

    • Returns:

    • Item — the inserted item, or null if inserting was not possible

  • insertBelow(item)

    Inserts this item below the specified item.

    • Parameters:

    • item: Item — the item below which it should be inserted

    • Returns:

    • Item — the inserted item, or null if inserting was not possible

  • sendToBack()

    Sends this item to the back of all other items within the same parent.

  • bringToFront()

    Brings this item to the front of all other items within the same parent.

  • addTo(owner)

    Adds it to the specified owner, which can be either a Item or a Project.

    • Parameters:

    • owner: ProjectLayerGroupCompoundPath — the item or project to add the item to

    • Returns:

    • Item — the item itself, if it was successfully added

  • copyTo(owner)

    Clones the item and adds it to the specified owner, which can be either a Item or a Project.

    • Parameters:

    • owner: ProjectLayerGroupCompoundPath — the item or project to copy the item to

    • Returns:

    • Item — the new copy of the item, if it was successfully added

  • reduce(options)

    If this is a group, layer or compound-path with only one child-item, the child-item is moved outside and the parent is erased. Otherwise, the item itself is returned unmodified.

    • Parameters:

    • options:

    • Returns:

    • Item — the reduced item

  • remove()

    Removes the item and all its children from the project. The item is not destroyed and can be inserted again after removal.

    • Returns:

    • Booleantrue if the item was removed, false otherwise

  • replaceWith(item)

    Replaces this item with the provided new item which will takes its place in the project hierarchy instead.

    • Parameters:

    • item: Item — the item that will replace this item

    • Returns:

    • Booleantrue if the item was replaced, false otherwise