plucky (3) plbox3.3plplot.gz

Provided by: plplot-doc_5.15.0+dfsg2-13ubuntu1_all bug

NAME

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

SYNOPSIS

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

DESCRIPTION

       Draws  axes,  numeric  and  text  labels  for  a  three-dimensional  surface  plot.   For a more complete
       description of three-dimensional plotting see the PLplot documentation.

       Redacted form: General: plbox3(xopt, xlabel, xtick, nxsub, yopt,  ylabel,  ytick,  nysub,  zopt,  zlabel,
       ztick, nzsub)

       This function is used in examples 8, 11, 18, and 21.

ARGUMENTS

       xopt (PLCHAR_VECTOR(3plplot), input)
              An  ascii  character  string  specifying  options  for  the  x  axis.   The string can include any
              combination of the following letters (upper or lower case) in any order: b: Draws axis at base, at
              height  z=zmin  where zmin is defined by call to plw3d(3plplot).  This character must be specified
              in order to use any of the other options.  d: Plot labels as date / time. Values are assumed to be
              seconds  since  the  epoch  (as  used  by  gmtime).  f: Always use fixed point numeric labels.  i:
              Inverts  tick  marks,  so  they  are  drawn  downwards,  rather  than  upwards.   l:  Labels  axis
              logarithmically.   This  only  affects the labels, not the data, and so it is necessary to compute
              the logarithms of data points before passing them to any  of  the  drawing  routines.   n:  Writes
              numeric  labels  at major tick intervals.  o: Use custom labelling function to generate axis label
              text.  The custom labelling function can be defined with the  plslabelfunc(3plplot)  command.   s:
              Enables  subticks  between  major ticks, only valid if t is also specified.  t: Draws major ticks.
              u: If this is specified, the text label for the axis is written under the axis.

       xlabel (PLCHAR_VECTOR(3plplot), input)
              A UTF-8 character string specifying the text label for the x axis.  It is only drawn if  u  is  in
              the xopt string.

       xtick (PLFLT(3plplot), input)
              World  coordinate  interval  between  major  ticks  on  the  x  axis. If it is set to zero, PLplot
              automatically generates a suitable tick interval.

       nxsub (PLINT(3plplot), input)
              Number of subintervals between major x axis ticks for minor ticks.  If it is set to  zero,  PLplot
              automatically generates a suitable minor tick interval.

       yopt (PLCHAR_VECTOR(3plplot), input)
              An ascii character string specifying options for the y axis. The string is interpreted in the same
              way as xopt.

       ylabel (PLCHAR_VECTOR(3plplot), input)
              A UTF-8 character string specifying the text label for the y axis.  It is only drawn if  u  is  in
              the yopt string.

       ytick (PLFLT(3plplot), input)
              World  coordinate  interval  between  major  ticks  on  the  y  axis. If it is set to zero, PLplot
              automatically generates a suitable tick interval.

       nysub (PLINT(3plplot), input)
              Number of subintervals between major y axis ticks for minor ticks.  If it is set to  zero,  PLplot
              automatically generates a suitable minor tick interval.

       zopt (PLCHAR_VECTOR(3plplot), input)
              An  ascii  character  string  specifying  options  for  the  z  axis.  The  string can include any
              combination of the following letters (upper or lower case) in any order: b: Draws z  axis  to  the
              left  of the surface plot.  c: Draws z axis to the right of the surface plot.  d: Draws grid lines
              parallel  to  the  x-y  plane  behind  the  figure.   These  lines  are  not  drawn  until   after
              plot3d(3plplot)  or  plmesh(3plplot)  are  called because of the need for hidden line removal.  e:
              Plot labels as date / time. Values are assumed to be seconds since the epoch (as used by  gmtime).
              Note this suboption is interpreted the same as the d suboption for xopt and yopt, but it has to be
              identified as e for zopt since d has already been used for the different purpose above.  f: Always
              use  fixed  point  numeric labels.  i: Inverts tick marks, so they are drawn away from the center.
              l: Labels axis logarithmically.  This only affects  the  labels,  not  the  data,  and  so  it  is
              necessary  to  compute  the  logarithms  of  data points before passing them to any of the drawing
              routines.  m: Writes numeric labels at major tick intervals on the right-hand z axis.   n:  Writes
              numeric  labels at major tick intervals on the left-hand z axis.  o: Use custom labelling function
              to  generate  axis  label  text.   The  custom  labelling  function  can  be  defined   with   the
              plslabelfunc(3plplot)  command.   s: Enables subticks between major ticks, only valid if t is also
              specified.  t: Draws major ticks.  u: If this is specified, the text label is written  beside  the
              left-hand axis.  v: If this is specified, the text label is written beside the right-hand axis.

       zlabel (PLCHAR_VECTOR(3plplot), input)
              A UTF-8 character string specifying the text label for the z axis.  It is only drawn if u or v are
              in the zopt string.

       ztick (PLFLT(3plplot), input)
              World coordinate interval between major ticks on the  z  axis.  If  it  is  set  to  zero,  PLplot
              automatically generates a suitable tick interval.

       nzsub (PLINT(3plplot), input)
              Number  of  subintervals between major z axis ticks for minor ticks.  If it is set to zero, PLplot
              automatically generates a suitable minor tick interval.

AUTHORS

       Many developers (who are credited at http://plplot.org/credits.php) have contributed to PLplot  over  its
       long history.

SEE ALSO

       PLplot documentation at http://plplot.org/documentation.php.

                                                 February, 2025                                  PLBOX3(3plplot)