1PLBOX(3plplot) PLplot API PLBOX(3plplot)
2
6 plbox - Draw a box with axes, etc
7
9 plbox(xopt, xtick, nxsub, yopt, ytick, nysub)
10
12 Draws a box around the currently defined viewport, and labels it with
13 world coordinate values appropriate to the window. Thus plbox(3plplot)
14 should only be called after defining both viewport and window. The
15 character strings xopt and yopt specify how the box should be drawn as
16 described below. If ticks and/or subticks are to be drawn for a par‐
17 ticular axis, the tick intervals and number of subintervals may be
18 specified explicitly, or they may be defaulted by setting the appropri‐
19 ate arguments to zero.
20 Redacted form: General: plbox(xopt, xtick, nxsub, yopt, ytick, nysub)
22 Perl/PDL: plbox(xtick, nxsub, ytick, nysub, xopt, yopt)
23 This function is used in examples 1,2,4,6,6-12,14-18,21,23-26,29.
26
28 xopt (const char *, input)
29 Pointer to character string specifying options for horizontal
30 axis. The string can include any combination of the following
31 letters (upper or lower case) in any order: a: Draws axis, X-
32 axis is horizontal line (y=0), and Y-axis is vertical line
33 (x=0). b: Draws bottom (X) or left (Y) edge of frame. c: Draws
34 top (X) or right (Y) edge of frame. d: Plot labels as date /
35 time. Values are assumed to be seconds since the epoch (as
36 used by gmtime). f: Always use fixed point numeric labels. g:
37 Draws a grid at the major tick interval. h: Draws a grid at the
38 minor tick interval. i: Inverts tick marks, so they are drawn
39 outwards, rather than inwards. l: Labels axis logarithmically.
40 This only affects the labels, not the data, and so it is neces‐
41 sary to compute the logarithms of data points before passing
42 them to any of the drawing routines. m: Writes numeric labels
43 at major tick intervals in the unconventional location (above
44 box for X, right of box for Y). n: Writes numeric labels at
45 major tick intervals in the conventional location (below box for
46 X, left of box for Y). o: Use custom labeling function to gen‐
47 erate axis label text. The custom labeling function can be
48 defined with the plslabelfuncplslabelfunc; command. s: Enables
49 subticks between major ticks, only valid if t is also specified.
50 t: Draws major ticks.
51 xtick (PLFLT, input)
54 World coordinate interval between major ticks on the x axis. If
55 it is set to zero, PLplot automatically generates a suitable
56 tick interval.
57 nxsub (PLINT, input)
59 Number of subintervals between major x axis ticks for minor
60 ticks. If it is set to zero, PLplot automatically generates a
61 suitable minor tick interval.
62 yopt (const char *, input)
64 Pointer to character string specifying options for vertical
65 axis. The string can include any combination of the letters
66 defined above for xopt, and in addition may contain: v: Write
67 numeric labels for vertical axis parallel to the base of the
68 graph, rather than parallel to the axis.
69 ytick (PLFLT, input)
72 World coordinate interval between major ticks on the y axis. If
73 it is set to zero, PLplot automatically generates a suitable
74 tick interval.
75 nysub (PLINT, input)
77 Number of subintervals between major y axis ticks for minor
78 ticks. If it is set to zero, PLplot automatically generates a
79 suitable minor tick interval.
80
83 Geoffrey Furnish and Maurice LeBrun wrote and maintain PLplot. This
84 man page was automatically generated from the DocBook source of the
85 PLplot documentation, maintained by Alan W. Irwin and Rafael
86 Laboissiere.
87
89 PLplot documentation at http://plplot.sourceforge.net/resources.
90 July, 2010 PLBOX(3plplot)