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

NAME

6       plmtex - Write text relative to viewport boundaries
7

SYNOPSIS

9       plmtex(side, disp, pos, just, text)
10

DESCRIPTION

12       Writes  text  at  a  specified position relative to the viewport bound‐
13       aries.  Text may be written inside or  outside  the  viewport,  but  is
14       clipped  at  the  subpage  boundaries.  The reference point of a string
15       lies along a line passing through the string at half the  height  of  a
16       capital letter.  The position of the reference point along this line is
17       determined by just, and the position of the reference point relative to
18       the viewport is set by disp and pos.
19
20       Redacted  form:  General: plmtex(side, disp, pos, just, text) Perl/PDL:
21       plmtex(disp, pos, just, side, text)
22
23
24       This function is used in examples 3, 4, 6-8, 11, 12, 14,  18,  23,  and
25       26.
26

ARGUMENTS

28       side (PLCHAR_VECTOR(3plplot), input)
29              An  ascii  character  string specifying the side of the viewport
30              along which the text is to be written. The string  must  be  one
31              of:  b:  Bottom of viewport, text written parallel to edge.  bv:
32              Bottom of viewport, text written at right angles  to  edge.   l:
33              Left  of  viewport,  text written parallel to edge.  lv: Left of
34              viewport, text written at right angles to  edge.   r:  Right  of
35              viewport, text written parallel to edge.  rv: Right of viewport,
36              text written at right angles to edge.  t: Top of viewport,  text
37              written  parallel to edge.  tv: Top of viewport, text written at
38              right angles to edge.
39
40
41       disp (PLFLT(3plplot), input)
42              Position of the reference point  of  string,  measured  outwards
43              from the specified viewport edge in units of the current charac‐
44              ter height.  Use negative disp to write within the viewport.
45
46       pos (PLFLT(3plplot), input)
47              Position of the reference point of string  along  the  specified
48              edge, expressed as a fraction of the length of the edge.
49
50       just (PLFLT(3plplot), input)
51              Specifies  the  position of the string relative to its reference
52              point.  If just=0. , the reference point is at the left  and  if
53              just=1.  ,  it  is  at the right of the string.  Other values of
54              just give intermediate justifications.
55
56       text (PLCHAR_VECTOR(3plplot), input)
57              A UTF-8 character string to be written out.
58
59

AUTHORS

61       Many   developers   (who   are   credited   at    http://plplot.source‐
62       forge.net/credits.php)  have  contributed  to PLplot over its long his‐
63       tory.
64

SEE ALSO

66       PLplot   documentation   at    http://plplot.sourceforge.net/documenta‐
67       tion.php.
68
69
70
71                                 August, 2017                  PLMTEX(3plplot)
Impressum