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 ascii character strings xopt and yopt specify how the box should be
16 drawn as described below. If ticks and/or subticks are to be drawn for
17 a particular 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 This function is used in examples 1, 2, 4, 6, 6-12, 14-18, 21, 23-26,
25 and 29.
26
28 xopt (PLCHAR_VECTOR(3plplot), input)
29 An ascii character string specifying options for the x axis.
30 The string can include any combination of the following letters
31 (upper or lower case) in any order: a: Draws axis, X-axis is
32 horizontal line (y=0), and Y-axis is vertical line (x=0). b:
33 Draws bottom (X) or left (Y) edge of frame. c: Draws top (X) or
34 right (Y) edge of frame. d: Plot labels as date / time. Values
35 are assumed to be seconds since the epoch (as used by gmtime).
36 f: Always use fixed point numeric labels. g: Draws a grid at
37 the major tick interval. h: Draws a grid at the minor tick in‐
38 terval. i: Inverts tick marks, so they are drawn outwards,
39 rather than inwards. l: Labels axis logarithmically. This only
40 affects the labels, not the data, and so it is necessary to com‐
41 pute the logarithms of data points before passing them to any of
42 the drawing routines. m: Writes numeric labels at major tick
43 intervals in the unconventional location (above box for X, right
44 of box for Y). n: Writes numeric labels at major tick intervals
45 in the conventional location (below box for X, left of box for
46 Y). o: Use custom labelling function to generate axis label
47 text. The custom labelling function can be defined with the
48 plslabelfunc(3plplot) command. s: Enables subticks between ma‐
49 jor ticks, only valid if t is also specified. t: Draws major
50 ticks. u: Exactly like "b" except don't draw edge line. w: Ex‐
51 actly like "c" except don't draw edge line. x: Exactly like "t"
52 (including the side effect of the numerical labels for the major
53 ticks) except exclude drawing the major and minor tick marks.
54 xtick (PLFLT(3plplot), input)
57 World coordinate interval between major ticks on the x axis. If
58 it is set to zero, PLplot automatically generates a suitable
59 tick interval.
60 nxsub (PLINT(3plplot), input)
62 Number of subintervals between major x axis ticks for minor
63 ticks. If it is set to zero, PLplot automatically generates a
64 suitable minor tick interval.
65 yopt (PLCHAR_VECTOR(3plplot), input)
67 An ascii character string specifying options for the y axis.
68 The string can include any combination of the letters defined
69 above for xopt, and in addition may contain: v: Write numeric
70 labels for the y axis parallel to the base of the graph, rather
71 than parallel to the axis.
72 ytick (PLFLT(3plplot), input)
75 World coordinate interval between major ticks on the y axis. If
76 it is set to zero, PLplot automatically generates a suitable
77 tick interval.
78 nysub (PLINT(3plplot), input)
80 Number of subintervals between major y axis ticks for minor
81 ticks. If it is set to zero, PLplot automatically generates a
82 suitable minor tick interval.
83
86 Many developers (who are credited at http://plplot.org/credits.php)
87 have contributed to PLplot over its long history.
88
90 PLplot documentation at http://plplot.org/documentation.php.
91 July, 2023 PLBOX(3plplot)