1PLBOX3(3plplot) PLplot API PLBOX3(3plplot)
2
6 plbox3 - Draw a box with axes, etc, in 3-d
7
9 plbox3(xopt, xlabel, xtick, nxsub, yopt, ylabel, ytick, nysub, zopt,
10 zlabel, ztick, nzsub)
11
13 Draws axes, numeric and text labels for a three-dimensional surface
14 plot. For a more complete description of three-dimensional plotting
15 see the PLplot documentation.
16 Redacted form: General: plbox3(xopt, xlabel, xtick, nxsub, yopt, yla‐
18 bel, ytick, nysub, zopt, zlabel, ztick, nzsub)
19 This function is used in examples 8, 11, 18, and 21.
22
24 xopt (PLCHAR_VECTOR(3plplot), input)
25 An ascii character string specifying options for the x axis.
26 The string can include any combination of the following letters
27 (upper or lower case) in any order: b: Draws axis at base, at
28 height z=zmin where zmin is defined by call to plw3d(3plplot).
29 This character must be specified in order to use any of the
30 other options. d: Plot labels as date / time. Values are as‐
31 sumed to be seconds since the epoch (as used by gmtime). f: Al‐
32 ways use fixed point numeric labels. i: Inverts tick marks, so
33 they are drawn downwards, rather than upwards. l: Labels axis
34 logarithmically. This only affects the labels, not the data,
35 and so it is necessary to compute the logarithms of data points
36 before passing them to any of the drawing routines. n: Writes
37 numeric labels at major tick intervals. o: Use custom labelling
38 function to generate axis label text. The custom labelling
39 function can be defined with the plslabelfunc(3plplot) command.
40 s: Enables subticks between major ticks, only valid if t is also
41 specified. t: Draws major ticks. u: If this is specified, the
42 text label for the axis is written under the axis.
43 xlabel (PLCHAR_VECTOR(3plplot), input)
46 A UTF-8 character string specifying the text label for the x
47 axis. It is only drawn if u is in the xopt string.
48 xtick (PLFLT(3plplot), input)
50 World coordinate interval between major ticks on the x axis. If
51 it is set to zero, PLplot automatically generates a suitable
52 tick interval.
53 nxsub (PLINT(3plplot), input)
55 Number of subintervals between major x axis ticks for minor
56 ticks. If it is set to zero, PLplot automatically generates a
57 suitable minor tick interval.
58 yopt (PLCHAR_VECTOR(3plplot), input)
60 An ascii character string specifying options for the y axis. The
61 string is interpreted in the same way as xopt.
62 ylabel (PLCHAR_VECTOR(3plplot), input)
64 A UTF-8 character string specifying the text label for the y
65 axis. It is only drawn if u is in the yopt string.
66 ytick (PLFLT(3plplot), input)
68 World coordinate interval between major ticks on the y axis. If
69 it is set to zero, PLplot automatically generates a suitable
70 tick interval.
71 nysub (PLINT(3plplot), input)
73 Number of subintervals between major y axis ticks for minor
74 ticks. If it is set to zero, PLplot automatically generates a
75 suitable minor tick interval.
76 zopt (PLCHAR_VECTOR(3plplot), input)
78 An ascii character string specifying options for the z axis. The
79 string can include any combination of the following letters (up‐
80 per or lower case) in any order: b: Draws z axis to the left of
81 the surface plot. c: Draws z axis to the right of the surface
82 plot. d: Draws grid lines parallel to the x-y plane behind the
83 figure. These lines are not drawn until after plot3d(3plplot)
84 or plmesh(3plplot) are called because of the need for hidden
85 line removal. e: Plot labels as date / time. Values are assumed
86 to be seconds since the epoch (as used by gmtime). Note this
87 suboption is interpreted the same as the d suboption for xopt
88 and yopt, but it has to be identified as e for zopt since d has
89 already been used for the different purpose above. f: Always
90 use fixed point numeric labels. i: Inverts tick marks, so they
91 are drawn away from the center. l: Labels axis logarithmically.
92 This only affects the labels, not the data, and so it is neces‐
93 sary to compute the logarithms of data points before passing
94 them to any of the drawing routines. m: Writes numeric labels
95 at major tick intervals on the right-hand z axis. n: Writes nu‐
96 meric labels at major tick intervals on the left-hand z axis.
97 o: Use custom labelling function to generate axis label text.
98 The custom labelling function can be defined with the plslabel‐
99 func(3plplot) command. s: Enables subticks between major ticks,
100 only valid if t is also specified. t: Draws major ticks. u: If
101 this is specified, the text label is written beside the left-
102 hand axis. v: If this is specified, the text label is written
103 beside the right-hand axis.
104 zlabel (PLCHAR_VECTOR(3plplot), input)
107 A UTF-8 character string specifying the text label for the z
108 axis. It is only drawn if u or v are in the zopt string.
109 ztick (PLFLT(3plplot), input)
111 World coordinate interval between major ticks on the z axis. If
112 it is set to zero, PLplot automatically generates a suitable
113 tick interval.
114 nzsub (PLINT(3plplot), input)
116 Number of subintervals between major z axis ticks for minor
117 ticks. If it is set to zero, PLplot automatically generates a
118 suitable minor tick interval.
119
122 Many developers (who are credited at http://plplot.org/credits.php)
123 have contributed to PLplot over its long history.
124
126 PLplot documentation at http://plplot.org/documentation.php.
127 January, 2023 PLBOX3(3plplot)