arthur/rough-notation
1
0
Fork 0
mirror of https://github.com/slidevjs/rough-notation.git synced 2026-01-14 09:44:21 +01:00
Code Issues Packages Projects Releases Wiki Activity

Update README.md

Browse Source
This commit is contained in:
Preet
2020-06-23 00:28:33 -07:00
committed by GitHub
parent 2e3d7fd59c
commit 9ea6e94230
1 changed files with 4 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
README.md
View File

@@ -82,6 +82,7 @@ This is a mandatory field. It sets the annotation style. Following are the list
* __highlight__: This style creates a highlight effect as if marked by a highlighter.
* __strike-through__: This style draws horizontal lines through the element.
* __crossed-off__: This style draws an 'X' across the element.
* __bracket__: This style draws a bracket around an element, usually a paragraph of text. By default on the right side, but can be configured to any or all of *left, right, top, bottom*.
#### animate
Boolean property to turn on/off animation when annotating. Default value is `true`.
@@ -105,6 +106,9 @@ This property only applies to inline text. To annotate multiline text (each line
#### iterations
By default annotations are drawn in two iterations, e.g. when underlining, drawing from left to right and then back from right to left. Setting this property can let you configure the number of iterations.
#### brackets
Value could be a string or an array of strings, each string being one of these values: **left, right, top, bottom**. When drawing a bracket, this configures which side(s) of the element to bracket. Default value is `right`.
## Annotation Object
When you call the `annotate` function, you get back an annotation object, which has the following methods: