Module

RoughNotation

Package
purescript-rough-notation
Repository
MitchStevens/purescript-rough-notation

#Annotation Source

#animationDuration Source

animationDuration :: Annotation -> Aff Milliseconds

total duration of an annotation, used to block Aff while annotation is running

#annotate Source

annotate :: forall config rest. Union config rest ConfigRows => Nub ConfigRows ConfigRows => Element -> RoughAnnotationType -> Record config -> Aff Annotation

Creates an annotation from a target element, an annotation type, and a config record. Note that the config record must be a subrecord of Config type, see README.md for more details

#hideAnnotation Source

hideAnnotation :: Annotation -> Aff Unit

Hides annotation, annotation can be shown again

#removeAnnotation Source

removeAnnotation :: Annotation -> Aff Unit

Removes annotation, annotation cannot be run again

#showAnnotation Source

showAnnotation :: Annotation -> Aff Unit

Shows annotation, blocks until annotation is completed