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)
21
22
23       This  function  is  used in examples 3, 4, 6-8, 11, 12, 14, 18, 23, and
24       26.
25

ARGUMENTS

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

AUTHORS

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

SEE ALSO

64       PLplot documentation at http://plplot.org/documentation.php.
65
66
67
68                                February, 2022                 PLMTEX(3plplot)
Impressum