2021-10-17 18:26:00 +02:00
---
2021-08-25 16:09:31 +02:00
title: Snippet
2021-10-17 18:26:00 +02:00
---
2021-08-25 16:09:31 +02:00
2022-12-14 21:24:28 -08:00
A Snippet is a reusable bit of markup for your pattern. Snippets are added to the
2021-08-25 16:09:31 +02:00
SVG `defs` section, and rendered with the SVG `use` tag.
2022-09-29 18:08:09 +02:00
## Signature
```js
2022-12-14 21:24:28 -08:00
Snippet new Snippet(String def, Point anchor);
2022-09-29 18:08:09 +02:00
```
2021-08-25 16:09:31 +02:00
The snippet constructor takes two arguments:
2022-12-14 21:29:37 -08:00
- `def` : The `xlink:href` id that links to the relevant entry in the SVG `defs` section. This is also the common name of the snippet (`logo`, `notch`, `button`, etc.)
2022-08-20 18:33:05 -04:00
- `anchor` : A [`Point`](/reference/api/point) on which to anchor the snippet
2021-08-25 16:09:31 +02:00
2022-12-14 21:24:28 -08:00
## Properties
2021-08-25 16:09:31 +02:00
A Snippet object comes with the following properties:
2022-02-20 14:44:38 +01:00
- `def` : The `xlink:href` id that links to the relevant entry in the SVG `defs` section
2022-08-20 18:33:05 -04:00
- `anchor` : A [`Point`](/reference/api/point) on which to anchor the snippet
- `attributes` : An [`Attributes`](/reference/api/attributes) instance holding the snippet's attributes
2021-08-25 16:09:31 +02:00
2024-09-28 13:13:48 +02:00
:::note RELATED
2022-12-14 21:24:28 -08:00
See [Using Attributes](/howtos/code/attributes)
for information about custom Attributes that can be used with Snippets.
2024-09-28 13:13:48 +02:00
:::
2022-12-14 21:24:28 -08:00
2022-09-29 18:08:09 +02:00
## Example
<Example caption="Example of the Snippet constructor">
```js
({ Point, Snippet, snippets, Path, paths, part }) => {
snippets.logo = new Snippet('logo', new Point(0,0))
// Prevent clipping
paths.diag = new Path()
.move(new Point(-25,-40))
.move(new Point(25,15))
return part
}
```
</Example>
## Methods
A Snippet object exposes the following methods:
2021-08-25 16:09:31 +02:00
2024-01-29 08:43:38 -08:00
<ReadMore />