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

Merge pull request #20 from linkstrifer/patch-1

Browse Source 
Add Annotation Group Object documentation
This commit is contained in:
Preet
2020-05-31 13:36:23 -07:00
committed by GitHub
parent 6de75b6a9f a2abcee2c0
commit 8dd999aeb4
1 changed files with 10 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

10
README.md
View File

@@ -110,6 +110,16 @@ Hides the annotation if showing. This is not animated.
#### remove()
Unlinks the annotation from the element.
## Annotation Group Object
When you call the `annotationGroup` function, you get back an annotation group object, which has the following methods:
#### show()
Draws all the annotations in order. If the annotation is set to animate (default), it will animate the drawing. If called again, it will re-draw the animation.
#### hide()
Hides all the annotations if showing. This is not animated.
## Wrappers
Rough Notation has wrappers for multiple libraries and frameworks: