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) Perl/PDL: plbox3(xtick,
19 nxsub, ytick, nysub, ztick, nzsub, xopt, xlabel, yopt, ylabel, zopt,
20 zlabel)
21 This function is used in examples 8, 11, 18, and 21.
24
26 xopt (PLCHAR_VECTOR(3plplot), input)
27 An ascii character string specifying options for the x axis.
28 The string can include any combination of the following letters
29 (upper or lower case) in any order: b: Draws axis at base, at
30 height z=zmin where zmin is defined by call to plw3d(3plplot).
31 This character must be specified in order to use any of the
32 other options. d: Plot labels as date / time. Values are
33 assumed to be seconds since the epoch (as used by gmtime). f:
34 Always use fixed point numeric labels. i: Inverts tick marks,
35 so they are drawn downwards, rather than upwards. l: Labels
36 axis logarithmically. This only affects the labels, not the
37 data, and so it is necessary to compute the logarithms of data
38 points before passing them to any of the drawing routines. n:
39 Writes numeric labels at major tick intervals. o: Use custom
40 labelling function to generate axis label text. The custom
41 labelling function can be defined with the plslabelfunc(3plplot)
42 command. s: Enables subticks between major ticks, only valid if
43 t is also specified. t: Draws major ticks. u: If this is spec‐
44 ified, the text label for the axis is written under the axis.
45 xlabel (PLCHAR_VECTOR(3plplot), input)
48 A UTF-8 character string specifying the text label for the x
49 axis. It is only drawn if u is in the xopt string.
50 xtick (PLFLT(3plplot), input)
52 World coordinate interval between major ticks on the x axis. If
53 it is set to zero, PLplot automatically generates a suitable
54 tick interval.
55 nxsub (PLINT(3plplot), input)
57 Number of subintervals between major x axis ticks for minor
58 ticks. If it is set to zero, PLplot automatically generates a
59 suitable minor tick interval.
60 yopt (PLCHAR_VECTOR(3plplot), input)
62 An ascii character string specifying options for the y axis. The
63 string is interpreted in the same way as xopt.
64 ylabel (PLCHAR_VECTOR(3plplot), input)
66 A UTF-8 character string specifying the text label for the y
67 axis. It is only drawn if u is in the yopt string.
68 ytick (PLFLT(3plplot), input)
70 World coordinate interval between major ticks on the y axis. If
71 it is set to zero, PLplot automatically generates a suitable
72 tick interval.
73 nysub (PLINT(3plplot), input)
75 Number of subintervals between major y axis ticks for minor
76 ticks. If it is set to zero, PLplot automatically generates a
77 suitable minor tick interval.
78 zopt (PLCHAR_VECTOR(3plplot), input)
80 An ascii character string specifying options for the z axis. The
81 string can include any combination of the following letters
82 (upper or lower case) in any order: b: Draws z axis to the left
83 of the surface plot. c: Draws z axis to the right of the sur‐
84 face plot. d: Draws grid lines parallel to the x-y plane behind
85 the figure. These lines are not drawn until after
86 plot3d(3plplot) or plmesh(3plplot) are called because of the
87 need for hidden line removal. e: Plot labels as date / time.
88 Values are assumed to be seconds since the epoch (as used by
89 gmtime). Note this suboption is interpreted the same as the d
90 suboption for xopt and yopt, but it has to be identified as e
91 for zopt since d has already been used for the different purpose
92 above. f: Always use fixed point numeric labels. i: Inverts
93 tick marks, so they are drawn away from the center. l: Labels
94 axis logarithmically. This only affects the labels, not the
95 data, and so it is necessary to compute the logarithms of data
96 points before passing them to any of the drawing routines. m:
97 Writes numeric labels at major tick intervals on the right-hand
98 z axis. n: Writes numeric labels at major tick intervals on the
99 left-hand z axis. o: Use custom labelling function to generate
100 axis label text. The custom labelling function can be defined
101 with the plslabelfunc(3plplot) command. s: Enables subticks
102 between major ticks, only valid if t is also specified. t:
103 Draws major ticks. u: If this is specified, the text label is
104 written beside the left-hand axis. v: If this is specified, the
105 text label is written beside the right-hand axis.
106 zlabel (PLCHAR_VECTOR(3plplot), input)
109 A UTF-8 character string specifying the text label for the z
110 axis. It is only drawn if u or v are in the zopt string.
111 ztick (PLFLT(3plplot), input)
113 World coordinate interval between major ticks on the z axis. If
114 it is set to zero, PLplot automatically generates a suitable
115 tick interval.
116 nzsub (PLINT(3plplot), input)
118 Number of subintervals between major z axis ticks for minor
119 ticks. If it is set to zero, PLplot automatically generates a
120 suitable minor tick interval.
121
124 Many developers (who are credited at http://plplot.source‐
125 forge.net/credits.php) have contributed to PLplot over its long his‐
126 tory.
127
129 PLplot documentation at http://plplot.sourceforge.net/documenta‐
130 tion.php.
131 August, 2017 PLBOX3(3plplot)