Skip to content

Commit

Permalink
Fix documentation for ms.setDashArrays
Browse files Browse the repository at this point in the history
The function signature in the documentation for setDashArrays does not match the implementation.
  • Loading branch information
kjellmf authored Jan 20, 2019
1 parent afe637a commit 14221a8
Showing 1 changed file with 11 additions and 8 deletions.
19 changes: 11 additions & 8 deletions docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -892,18 +892,21 @@ Register a ColorMode with a name or override an existing ColorMode.
Object ColorMode
```

## ms.setDashArrays(dash_object)
## ms.setDashArrays(pending, anticipated, feintDummy)

```javascript
Object {
pending: String, // The value for the stroke-dasharray used for symbols with a pending status.
anticipated: String, // The value for the stroke-dasharray used for symbols with a anticipated status.
feintDummy: String // The value for the stroke-dasharray used for the feint/dummy modifier.
}
pending: String, // The value for the stroke-dasharray used for symbols with a pending status.
anticipated: String, // The value for the stroke-dasharray used for symbols with a anticipated status.
feintDummy: String // The value for the stroke-dasharray used for the feint/dummy modifier.
```

Sets the dash arrays used for dashed lines, the dash object should be structured
in the same way as the return object, and all options should be present.
Sets the dash arrays used for dashed lines.

Example:

```javascript
var dashObj = ms.setDashArrays("4,4", "8,12", "8,8");
```

**Returns**

Expand Down

0 comments on commit 14221a8

Please sign in to comment.