biggles
reference guide 1.3.0 : components
( overview
: containers
: components
: style
: config
: functions )
conventions
Below, "s" means s is a string,
[l] means l is a list,
x[] means x is a numeric sequence,
and (p) means p is an (x,y) tuple.
Otherwise the variable is a scalar.
Abbreviated keywords are those for which the
portion in brackets may be omitted.
data components
-
Circle
( x, y, r )
Circles
( x[], y[], r[] )
-
Draws circles centered at (x,y) with radius r.
* Abbreviated keywords: [line]color, [line]type, [line]width.
* Examples: (none)
-
Curve
( x[], y[] )
-
Draws lines connecting (x[i],y[i]) to (x[i+1],y[i+1]).
* Abbreviated keywords: [line]color, [line]type, [line]width.
* Examples: 1, 4, 5
-
Ellipse
( x, y, rx, ry, angle=None )
Ellipses
( x[], y[], rx[], ry[], angle[]=None )
-
Draws ellipses centered at (x,y),
with x-radius rx, y-radius ry,
and rotated counterclockwise by angle.
* Abbreviated keywords: (none)
* Examples: (none)
-
ErrorBarsX
( y[], xerr_lo[], xerr_hi[] )
ErrorBarsY
( x[], yerr_lo[], yerr_hi[] )
-
Draws [XY] error bars.
Specifically, the bars extend from
(xerr_lo[i],y[i]) to (xerr_hi[i],y[i])
for ErrorBarsX, and
(x[i],yerr_lo[i]) to (x[i],yerr_hi[i])
for ErrorBarsY.
* Abbreviated keywords: [line]color, [line]type, [line]width.
* Examples: 4
-
FillBetween
( xA[], yA[], xB[], yB[] )
-
Fill the region bounded by the curves {xA,yA} and {xB,yB}.
* Abbreviated keywords: (none)
* Examples: 1
-
Histogram
( y[], x0=0, binsize=1 )
-
Draws a histogram of the y values
(aren't these descriptions just the best?).
The x-range for y[i] is
(x0+i*binsize, x0+(i+1)*binsize).
* Abbreviated keywords: [line]color, [line]type, [line]width.
* Examples: 3
-
LineX
( x )
LineY
( y )
-
Draws a line parallel to the [XY]-axis.
* Abbreviated keywords: [line]color, [line]type, [line]width.
* Examples: 5
-
Point
( x, y )
Points
( x[], y[] )
-
Draws symbols at the set of points (x,y).
* Abbreviated keywords: [symbol]size, [symbol]type.
* Examples: 2
-
Slope
( slope, p=(0,0) )
-
Draws the line y = p[1] + slope*(x - p[0]).
* Abbreviated keywords: [line]color, [line]type, [line]width.
* Examples: 2
-
SymmetricErrorBarsX
( x[], y[], err[] )
SymmetricErrorBarsY
( x[], y[], err[] )
-
Draws error bars extending from
(x[i]-err[i],y[i]) to (x[i]+err[i],y[i])
for SymmetricErrorBarsX, and
(x[i],y[i]-err[i]) to (x[i],y[i]+err[i])
for SymmetricErrorBarsY.
* Abbreviated keywords: [line]color, [line]type, [line]width.
* Examples: 4
decorative components
These components represent not data necessarily, but annotations made
to the plotting region.
The Plot* objects take plot coordinates,
where the lower-left corner of the plot is at (0,0)
and the upper-right corner is at (1,1).
-
DataInset
( (p), (q), container )
PlotInset
( (p), (q), container )
[ == Inset ]
-
Draws container in the rectangle defined by
points p and q.
* Abbreviated keywords: (none)
* Examples: 4
-
DataLabel
( x, y, "label" )
[ == Label ]
PlotLabel
( x, y, "label" )
-
Write the text string at the position (x,y).
Alignment is governed by halign and valign.
* Abbreviated keywords: [font]face, [font]size, [text]angle, [text]halign, [text]valign.
* Examples: 3
-
DataLine
( (p), (q) )
[ == Line ]
PlotLine
( (p), (q) )
-
Draws a line connecting points p and q.
* Abbreviated keywords: [line]color, [line]type, [line]width.
* Examples: (none)
-
PlotKey
( x, y, [component] )
-
Hmm... you should probably just take a look at the example.
* Abbreviated keywords: [font]face, [font]size, [text]angle, [text]halign, [text]valign.
* Examples: 2
keyword options
( moved )