Group

Creates a new Group item and places it at the top of the active layer.

Parameters:
• children: Array — An optional array of children that will be added to the newly created group. — optional

Example — Create a group containing two paths:

Example — Click in the view to add a path to the group, which in turn is rotated every frame:

Specifies whether the group item is to be clipped.

When setting to true, the first child in the group is automatically defined as the clipping mask.

Type:
• Boolean

The unique id of the item.

Type:
• Number

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

The item's position within the project. This is the rectangle.center of the item's bounds rectangle.

Type:
• Point

Example — Changing the position of a path:

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

The path style of the item.

Type:
• PathStyle

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

Example — Copying the style of another item:

Example — Applying the same style object to multiple items:

Specifies whether an item is selected and will also return true if the item is partially selected (groups with some selected items/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.

Type:
• Boolean

See also: project.selectedItems, segment.selected, point.selected

Example — Selecting an item:

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

Default:
• true

Type:
• Boolean

Example — Hiding an item:

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

Type:
• Boolean

The blend mode of the item.

Default:
• 'normal'

Type:
• String('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')

Example — Setting an item's blend mode:

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

Default:
• 1

Type:
• Number

Example — Making an item 50% transparent:

The project that this item belongs to.

Type:
• Project

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.appendTop(path);

// Now the parent of the path has become the group:
console.log(path.parent == group); // true

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

Type:
• Array of Item objects

Example — Accessing items in the children array:

Example — Accessing children by name:

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

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

Type:
• Item

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

Type:
• Item

The next item on the same level as this item.

Type:
• Item

The previous item on the same level as this item.

Type:
• Item

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

Type:
• Number

The bounding rectangle of the item excluding stroke width.

Type:
• Rectangle

The bounding rectangle of the item including stroke width.

Type:
• Rectangle

The color of the stroke.

Type:
• RGBColor / HSBColor / GrayColor

Example — Setting the stroke color of a path:

The width of the stroke.

Type:
• Number

Example — Setting an item's stroke width:

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

Default:
• 'butt'

Type:
• String('round', 'square', 'butt')

Example — A look at the different stroke caps:

The shape to be used at the corners of paths when they have a stroke.

Default:
• 'miter'

Type:
• String ('miter', 'round', 'bevel')

Example — A look at the different stroke joins:

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

The fill color of the item.

Type:
• RGBColor / HSBColor / GrayColor

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

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

Default:
• 'butt'

Type:
• String('round', 'square', 'butt')

Example — A look at the different stroke caps:

Removes the item from the project. If the item has children, they are also removed.

Returns:
• Boolean — true the item was removed, false otherwise

Removes all of the item's children (if any).

Returns:
• Boolean — true removing was successful, false otherwise

When passed a project, copies the item to the project, or duplicates it within the same project. When passed an item, copies the item into the specified item.

Parameters:
• item: Project / Layer / Group / CompoundPath — the item or project to copy the item to

Returns:
• Item — the new copy of the item

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

Returns:
• Item — the newly cloned item

Example — Cloning items:

Reverses the order of the item's children

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 dpi — optional, default: 72

Returns:
• Raster — the newly created raster item

Example — Rasterizing an item:

Checks if the item contains any children items.

Returns:
• Boolean — true it has one or more children, false otherwise

Checks if this item is above the specified item in the stacking order of the project.

Parameters:
• item: Item — The item to check against

Returns:
• Boolean — true if it is above the specified item, false otherwise

Checks if the item is below the specified item in the stacking order of the project.

Parameters:
• item: Item — The item to check against

Returns:
• Boolean — true if it is below the specified item, false otherwise

Checks whether the specified item is the parent of the item.

Parameters:
• item: Item — The item to check against

Returns:
• Boolean — true if it is the parent of the item, false otherwise

Checks whether the specified item is a child of the item.

Parameters:
• item: Item — The item to check against

Returns:
• Boolean — true it is a child of the item, false otherwise

Checks if the item is contained within the specified item.

Parameters:
• item: Item — The item to check against

Returns:
• Boolean — true if it is inside the specified item, false otherwise

Checks if the item is an ancestor of the specified item.

Parameters:
• item: Item — the item to check against

Returns:
• Boolean — true if the item is an ancestor of the specified item, false otherwise

Checks whether the item is grouped with the specified item.

Parameters:
• item: Item

Returns:
• Boolean — true if the items are grouped together, false otherwise

Scales the item by the given value from its center point, or optionally from a supplied point.

Parameters:
• scale: Number — the scale factor
• center: Point — optional, default: the center point of the item

Example — Scaling an item from its center point:

Example — Scaling an item from a specific point:

Scales the item by the given values from its center point, or optionally from a supplied point.

Parameters:
• sx: Number — the horizontal scale factor
• sy: Number — the vertical scale factor
• center: Point — optional, default: the center point of the item

Example — Scaling an item horizontally by 300%:

Translates (moves) the item by the given offset point.

Parameters:
• delta: Point — the offset to translate the item by

Rotates the item by a given angle around the given point.

Angles are oriented clockwise and measured in degrees.

Parameters:
• angle: Number — the rotation angle
• center: Point — optional, default: the center point of the item

See also: matrix.rotate

Example — Rotating an item:

Example — Rotating an item around a specific point:

Shears the item by the given value from its center point, or optionally by a supplied point.

Parameters:
• point: Point
• center: Point — optional, default: the center point of the item

See also: matrix.shear

Shears the item by the given values from its center point, or optionally by a supplied point.

Parameters:
• shx: Number
• shy: Number
• center: Point — optional, default: the center point of the item

See also: matrix.shear

Transform the item.

Parameters:
• matrix: Matrix
• flags: Array — Array of any of the following: 'objects', 'children', 'fill-gradients', 'fill-patterns', 'stroke-patterns', 'lines'. Default: ['objects', 'children']

Inserts the specified item as a child of the item by appending it to the list of children and moving it above all other children. You can use this function for groups, compound paths and layers.

Parameters:
• item: Item — The item that will be appended as a child

Inserts the specified item as a child of this item by appending it to the list of children and moving it below all other children. You can use this function for groups, compound paths and layers.

Parameters:
• item: Item — The item that will be appended as a child

Moves this item above the specified item.

Parameters:
• item: Item — The item above which it should be moved

Returns:
• Boolean — true it was moved, false otherwise

Moves the item below the specified item.

Parameters:
• item: Item — the item below which it should be moved

Returns:
• Boolean — true it was moved, false otherwise

Removes the item when the events specified in the passed object literal occur.

The object literal can contain the following values:

Remove the item when the next tool.onMouseMove event is fired: object.move = true

Remove the item when the next tool.onMouseDrag event is fired: object.drag = true

Remove the item when the next tool.onMouseDown event is fired: object.down = true

Remove the item when the next tool.onMouseUp event is fired: object.up = true

Parameters:
• object: Object

Example — Click and drag below:

Removes the item when the next tool.onMouseMove event is fired.

Example — Move your mouse below:

Removes the item when the next tool.onMouseDown event is fired.

Example — Click a few times below:

Removes the item when the next tool.onMouseDrag event is fired.

Example — Click and drag below:

Removes the item when the next tool.onMouseUp event is fired.

Example — Click a few times below: