VSinerva/freesewing
1
0
Fork 0
Code Activity

chore: Updating final Attributes docs for v3

Browse source
This commit is contained in:
Joost De Cock 2022-09-29 19:01:10 +02:00
parent 80a3dd1a2c
commit e298d14b8f
12 changed files with 220 additions and 93 deletions
Download patch file Download diff file Expand all files Collapse all files

24
markdown/dev/reference/api/attributes/en.md
View file

@ -1,15 +1,29 @@
---
title: Attributes
order: 40
---
Attributes is an object that holds attributes for a variety of other objects.
An Attributes object holds attributes for a variety of other objects.
Attributes are attached to [`Point`](/reference/api/point), [`Path`](/reference/api/path), and [`Snippet`](/reference/api/snippet) objects,
as well as the internal [`Svg`](/reference/api/svg) object.
## Signature
All of these have an instantiated Attributes object in their `attributes` property.
```js
Attributes new Attributes()
```
The Attributes constructor takes no arguments.
## Methods
An Attributes object exposes the following methods:
<ReadMore list />
## Notes
Attributes are attached to [`Point`](/reference/api/point),
[`Path`](/reference/api/path), and [`Snippet`](/reference/api/snippet) objects,
as well as the internal [`Svg`](/reference/api/svg) object.
All of these have an instantiated Attributes object in their `attributes`
property, as well as a number of (chainable) helper methods to manipulate the
attributes. You will typically use these higher-level method and thus are
unlikely to interact with an Attributes object directly.