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

NAME

6       plmtex3 - Write text relative to viewport boundaries in 3D plots
7

SYNOPSIS

9       plmtex3(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: plmtex3(side, disp, pos, just, text)
21
22       This function is used in example 28.
23

ARGUMENTS

25       side (PLCHAR_VECTOR(3plplot), input)
26              An  ascii  character  string specifying the side of the viewport
27              along which the text is to be written. The string should contain
28              one  or more of the following characters: [xyz][ps][v]. Only one
29              label is drawn at a time, i.e. xyp will only label the  X  axis,
30              not  both the X and Y axes. x: Label the X axis.  y: Label the Y
31              axis.  z: Label the Z axis.  p: Label the primary  axis.  For  Z
32              this is the leftmost Z axis. For X it is the axis that starts at
33              y-min. For Y it is the axis that starts at x-min.  s: Label  the
34              secondary axis.  v: Draw the text perpendicular to the axis.
35
36
37       disp (PLFLT(3plplot), input)
38              Position  of  the  reference  point of string, measured outwards
39              from the specified viewport edge in units of the current charac‐
40              ter height.  Use negative disp to write within the viewport.
41
42       pos (PLFLT(3plplot), input)
43              Position  of  the  reference point of string along the specified
44              edge, expressed as a fraction of the length of the edge.
45
46       just (PLFLT(3plplot), input)
47              Specifies the position of the string relative to  its  reference
48              point.   If  just=0. , the reference point is at the left and if
49              just=1. , it is at the right of the  string.   Other  values  of
50              just give intermediate justifications.
51
52       text (PLCHAR_VECTOR(3plplot), input)
53              A UTF-8 character string to be written out.
54
55

AUTHORS

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

SEE ALSO

61       PLplot documentation at http://plplot.org/documentation.php.
62
63
64
65                                 August, 2021                 PLMTEX3(3plplot)
Impressum