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

NAME

6       plbox - Draw a box with axes, etc
7

SYNOPSIS

9       plbox(xopt, xtick, nxsub, yopt, ytick, nysub)
10

DESCRIPTION

12       Draws  a  box around the currently defined viewport, and labels it with
13       world coordinate values appropriate to the window.  Thus plbox(3plplot)
14       should  only  be  called  after defining both viewport and window.  The
15       character strings xopt and yopt specify how the box should be drawn  as
16       described  below.   If ticks and/or subticks are to be drawn for a par‐
17       ticular axis, the tick intervals and  number  of  subintervals  may  be
18       specified explicitly, or they may be defaulted by setting the appropri‐
19       ate arguments to zero.
20
21       Redacted form:  General: plbox(xopt, xtick, nxsub, yopt, ytick,  nysub)
22       Perl/PDL: plbox(xtick, nxsub, ytick, nysub, xopt, yopt)
23
24
25       This function is used in examples 1,2,4,6,6-12,14-18,21,23-26.
26

ARGUMENTS

28       xopt (const char *, input)
29              Pointer  to  character  string specifying options for horizontal
30              axis.  The string can include any combination of  the  following
31              letters  (upper  or  lower case) in any order: a: Draws axis, X-
32              axis is horizontal line  (y=0),  and  Y-axis  is  vertical  line
33              (x=0).  b: Draws bottom (X) or left (Y) edge of frame.  c: Draws
34              top (X) or right (Y) edge of frame.  f:  Always use fixed  point
35              numeric labels.  g: Draws a grid at the major tick interval.  h:
36              Draws a grid at the minor tick interval.  i: Inverts tick marks,
37              so they are drawn outwards, rather than inwards.  l: Labels axis
38              logarithmically.  This only affects the labels,  not  the  data,
39              and  so it is necessary to compute the logarithms of data points
40              before passing them to any of the drawing routines.   m:  Writes
41              numeric  labels  at  major  tick intervals in the unconventional
42              location (above box for X, right  of  box  for  Y).   n:  Writes
43              numeric labels at major tick intervals in the conventional loca‐
44              tion (below box for X, left of box for Y).  s: Enables  subticks
45              between  major  ticks,  only  valid  if t is also specified.  t:
46              Draws major ticks.
47
48
49       xtick (PLFLT, 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
54       nxsub (PLINT, 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
59       yopt (const char *, input)
60              Pointer to character  string  specifying  options  for  vertical
61              axis.   The  string  can  include any combination of the letters
62              defined above for xopt, and in addition may  contain:  v:  Write
63              numeric  labels  for  vertical  axis parallel to the base of the
64              graph, rather than parallel to the axis.
65
66
67       ytick (PLFLT, 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
72       nysub (PLINT, 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
77

AUTHORS

79       Geoffrey Furnish and Maurice LeBrun wrote and  maintain  PLplot.   This
80       man  page  was  automatically  generated from the DocBook source of the
81       PLplot  documentation,  maintained  by  Alan  W.   Irwin   and   Rafael
82       Laboissiere.
83

SEE ALSO

85       PLplot documentation at http://plplot.sourceforge.net/resources.
86
87
88
89                                  March, 2007                   PLBOX(3plplot)
Impressum