1
0
Fork 0

Merge pull request #5990 from BenJamesBen/path-doc-update

fix(markdown): Path doc updates for optional parameters
This commit is contained in:
Joost De Cock 2024-02-11 17:37:39 +01:00 committed by GitHub
commit 2d43e0408e
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
5 changed files with 5 additions and 5 deletions

View file

@ -7,7 +7,7 @@ The `Path.addText()` method adds text to the path.
## Signature
```js
Path path.addText(string text, string className)
Path path.addText(string text, string className = '')
```
The second argument will optionally be used to set the CSS class for the text.

View file

@ -5,7 +5,7 @@ title: Path.attr()
This `Path.attr()` method can be used to add attributes to the Path object.
It calls `this.attributes.add()` under the hood, and returns the Path object.
If the third parameter is set to `true` it will call `this.attributes.set()`
If the optional third parameter is set to `true` it will call `this.attributes.set()`
instead, thereby overwriting the value of the attribute.
## Signature

View file

@ -7,7 +7,7 @@ The `Path.setText()` method sets text on the path.
## Signature
```js
Path path.setText(string text, string className)
Path path.setText(string text, string className = '')
```
The second argument will optionally be used to set the CSS class for the text.

View file

@ -8,7 +8,7 @@ along the path.
## Signature
```js
Point path.shiftAlong(float distance[, int stepsPerMm=10])
Point path.shiftAlong(float distance, int stepsPerMm = 10)
```
The second parameter controls the precision by which the path will be _walked_.

View file

@ -8,7 +8,7 @@ length of the path travelled along the path.
## Signature
```js
Point path.shiftFractionAlong(float fraction[, int stepsPerMm=25])
Point path.shiftFractionAlong(float fraction, int stepsPerMm = 25)
```
The second parameter controls the precision by which the path will be _walked_.