PatternDefinition

Creates a pattern definition.

Options:

• [options.tile] {Rectangle} the rectangle that is repeated, the bounds of the item by default
• options.spacing: Size — the gap between the tiles — default: 0
• [options.name] {String} the name of the pattern

Parameters:

• item: Item — the item to repeat, which is removed from the scene graph and becomes the pattern’s tile content
• options: Object — optional

Returns:

• PatternDefinition

The project that this pattern belongs to.

Read only.

Type:

• Project

The name of the pattern.

Type:

• String

The item that the pattern repeats. Unlike the items of symbols, it isn’t moved to 0, 0, so the tiles are at its own coordinates.

Type:

• Item

The rectangle that is repeated, in the coordinates of the pattern’s item.

Default:

• the bounds of the pattern's item

Type:

• Rectangle

The gap between the tiles, horizontally and vertically.

Default:

• 0

Type:

• Size

Returns a copy of the pattern, with a copy of its item and its name.

Returns:

• PatternDefinition

Checks whether the pattern is equal to the supplied pattern.

Parameters:

• pattern: PatternDefinition

Returns:

• Boolean — true if they are equal, false otherwise