1PLBOX3(3plplot)                   PLplot API                   PLBOX3(3plplot)
2
3
4

NAME

6       plbox3 - Draw a box with axes, etc, in 3-d
7

SYNOPSIS

9       plbox3(xopt,  xlabel,  xtick,  nxsub, yopt, ylabel, ytick, nysub, zopt,
10       zlabel, ztick, nzsub)
11

DESCRIPTION

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
17       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
22
23       This function is used in examples 8,11,18,21.
24

ARGUMENTS

26       xopt (const char *, input)
27              Pointer  to  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.  f: Always use fixed point  numeric  labels.   i:
33              Inverts  tick  marks,  so  they are drawn downwards, rather than
34              upwards.  l: Labels axis logarithmically.  This only affects the
35              labels, not the data, and so it is necessary to compute the log‐
36              arithms of data points before passing them to any of the drawing
37              routines.  n: Writes numeric labels at major tick intervals.  o:
38              Use custom labeling function to generate axis label  text.   The
39              custom  labeling  function can be defined with the plslabelfunc‐
40              plslabelfunc; command.  s: Enables subticks between major ticks,
41              only valid if t is also specified.  t: Draws major ticks.  u: If
42              this is specified, the text label for the axis is written  under
43              the axis.
44
45
46       xlabel (const char *, input)
47              Pointer  to  character  string  specifying  text label for the x
48              axis.  It is only drawn if u is in the xopt string.
49
50       xtick (PLFLT, input)
51              World coordinate interval between major ticks on the x axis.  If
52              it  is  set  to  zero, PLplot automatically generates a suitable
53              tick interval.
54
55       nxsub (PLINT, input)
56              Number of subintervals between major  x  axis  ticks  for  minor
57              ticks.   If  it is set to zero, PLplot automatically generates a
58              suitable minor tick interval.
59
60       yopt (const char *, input)
61              Pointer to character string specifying options for the  y  axis.
62              The string is interpreted in the same way as xopt.
63
64       ylabel (const char *, input)
65              Pointer  to  character  string  specifying  text label for the y
66              axis.  It is only drawn if u is in the yopt string.
67
68       ytick (PLFLT, input)
69              World coordinate interval between major ticks on the y axis.  If
70              it  is  set  to  zero, PLplot automatically generates a suitable
71              tick interval.
72
73       nysub (PLINT, input)
74              Number of subintervals between major  y  axis  ticks  for  minor
75              ticks.   If  it is set to zero, PLplot automatically generates a
76              suitable minor tick interval.
77
78       zopt (const char *, input)
79              Pointer to character string specifying options for the  z  axis.
80              The  string can include any combination of the following letters
81              (upper or lower case) in any order: b: Draws z axis to the  left
82              of  the  surface plot.  c: Draws z axis to the right of the sur‐
83              face plot.  d: Draws grid lines parallel to the x-y plane behind
84              the   figure.    These   lines   are   not   drawn  until  after
85              plot3d(3plplot) or plmesh(3plplot) are  called  because  of  the
86              need for hidden line removal.  f: Always use fixed point numeric
87              labels.  i: Inverts tick marks, so they are drawn away from  the
88              center.   l: Labels axis logarithmically.  This only affects the
89              labels, not the data, and so it is necessary to compute the log‐
90              arithms of data points before passing them to any of the drawing
91              routines.  m: Writes numeric labels at major tick  intervals  on
92              the right-hand vertical axis.  n: Writes numeric labels at major
93              tick intervals on the left-hand vertical axis.   o:  Use  custom
94              labeling  function  to  generate  axis  label  text.  The custom
95              labeling function can be defined with the  plslabelfuncplslabel‐
96              func;  command.   s:  Enables subticks between major ticks, only
97              valid if t is also specified.  t: Draws major ticks.  u: If this
98              is  specified,  the  text  label is written beside the left-hand
99              axis.  v: If this is specified, the text label is written beside
100              the right-hand axis.
101
102
103       zlabel (const char *, input)
104              Pointer  to  character  string  specifying  text label for the z
105              axis.  It is only drawn if u or v are in the zopt string.
106
107       ztick (PLFLT, input)
108              World coordinate interval between major ticks on the z axis.  If
109              it  is  set  to  zero, PLplot automatically generates a suitable
110              tick interval.
111
112       nzsub (PLINT, input)
113              Number of subintervals between major  z  axis  ticks  for  minor
114              ticks.   If  it is set to zero, PLplot automatically generates a
115              suitable minor tick interval.
116
117

AUTHORS

119       Geoffrey Furnish and Maurice LeBrun wrote and  maintain  PLplot.   This
120       man  page  was  automatically  generated from the DocBook source of the
121       PLplot  documentation,  maintained  by  Alan  W.   Irwin   and   Rafael
122       Laboissiere.
123

SEE ALSO

125       PLplot documentation at http://plplot.sourceforge.net/resources.
126
127
128
129                                  July, 2010                   PLBOX3(3plplot)
Impressum