Skip to content

Commit fd3903d

Browse files
committed
add docs to animation
1 parent d1d1f29 commit fd3903d

File tree

1 file changed

+15
-1
lines changed

1 file changed

+15
-1
lines changed

lib/gnuplotrb/animation.rb

Lines changed: 15 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,21 @@ module GnuplotRB
33
# === Overview
44
# Animation allows to create gif animation with given plots
55
# as frames. Possible frames: Plot, Splot, Multiplot.
6-
# More about its usage in {animation notebook}[http://nbviewer.ipython.org/github/dilcom/gnuplotrb/blob/master/notebooks/animated_plots.ipynb].
6+
# More about its usage in
7+
# {animation notebook}[http://nbviewer.ipython.org/github/dilcom/gnuplotrb/blob/master/notebooks/animated_plots.ipynb].
8+
#
9+
# === Options
10+
# Animations has several specific options:
11+
# * animate - allows to get animated gif's. Possible values are true (just turn on animation),
12+
# ot hash with suboptions (:loop - count of loops, default 0 - infinity$;
13+
# :delay - delay between frames; :optimize - boolean, reduces file size).
14+
# * size - size of gif file in pixels (size: [500, 500]) or (size: 500)
15+
# * background - background color
16+
# * transparent
17+
# * enhanced
18+
# * font
19+
# * fontscale
20+
# * crop
721
class Animation < Multiplot
822
##
923
# *Plot* here is also named as *frame*

0 commit comments

Comments
 (0)