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
31 assumed to be seconds since the epoch (as used by gmtime). f:
32 Always use fixed point numeric labels. i: Inverts tick marks,
33 so they are drawn downwards, rather than upwards. l: Labels
34 axis logarithmically. This only affects the labels, not the
35 data, and so it is necessary to compute the logarithms of data
36 points before passing them to any of the drawing routines. n:
37 Writes numeric labels at major tick intervals. o: Use custom
38 labelling function to generate axis label text. The custom
39 labelling function can be defined with the plslabelfunc(3plplot)
40 command. s: Enables subticks between major ticks, only valid if
41 t is also specified. t: Draws major ticks. u: If this is spec‐
42 ified, the 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
80 (upper or lower case) in any order: b: Draws z axis to the left
81 of the surface plot. c: Draws z axis to the right of the sur‐
82 face plot. d: Draws grid lines parallel to the x-y plane behind
83 the figure. These lines are not drawn until after
84 plot3d(3plplot) or plmesh(3plplot) are called because of the
85 need for hidden line removal. e: Plot labels as date / time.
86 Values are assumed to be seconds since the epoch (as used by
87 gmtime). Note this suboption is interpreted the same as the d
88 suboption for xopt and yopt, but it has to be identified as e
89 for zopt since d has already been used for the different purpose
90 above. f: Always use fixed point numeric labels. i: Inverts
91 tick marks, so they are drawn away from the center. l: Labels
92 axis logarithmically. This only affects the labels, not the
93 data, and so it is necessary to compute the logarithms of data
94 points before passing them to any of the drawing routines. m:
95 Writes numeric labels at major tick intervals on the right-hand
96 z axis. n: Writes numeric labels at major tick intervals on the
97 left-hand z axis. o: Use custom labelling function to generate
98 axis label text. The custom labelling function can be defined
99 with the plslabelfunc(3plplot) command. s: Enables subticks
100 between major ticks, only valid if t is also specified. t:
101 Draws major ticks. u: If this is specified, the text label is
102 written beside the left-hand axis. v: If this is specified, the
103 text label is written 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 September, 2020 PLBOX3(3plplot)