1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
|
<html><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8"><title>plmtex3: Write text relative to viewport boundaries in 3D plots</title><link rel="stylesheet" type="text/css" href="stylesheet.css"><meta name="generator" content="DocBook XSL Stylesheets V1.79.1"><link rel="home" href="index.html" title="Documentation of the PLplot plotting software"><link rel="up" href="API.html" title="Chapter 17. The Common API for PLplot"><link rel="prev" href="plmtex.html" title="plmtex: Write text relative to viewport boundaries"><link rel="next" href="plot3d.html" title="plot3d: Plot 3-d surface plot"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="3" align="center">
<code class="function">plmtex3</code>: Write text relative to viewport boundaries
in 3D plots
</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="plmtex.html">Prev</a> </td><th width="60%" align="center">Chapter 17. The Common API for PLplot</th><td width="20%" align="right"> <a accesskey="n" href="plot3d.html">Next</a></td></tr></table><hr></div><div class="sect1"><div class="titlepage"><div><div><h4 class="title"><a name="plmtex3"></a>
<code class="function">plmtex3</code>: Write text relative to viewport boundaries
in 3D plots
</h4></div></div></div><p>
</p><div class="funcsynopsis"><table border="0" class="funcprototype-table" summary="Function synopsis" style="cellspacing: 0; cellpadding: 0;"><tr><td><code class="funcdef">
<b class="fsfunc">plmtex3</b>
(</code></td><td>
<var class="pdparam">side</var>
, </td></tr><tr><td> </td><td>
<var class="pdparam">disp</var>
, </td></tr><tr><td> </td><td>
<var class="pdparam">pos</var>
, </td></tr><tr><td> </td><td>
<var class="pdparam">just</var>
, </td></tr><tr><td> </td><td>
<var class="pdparam">text</var>
<code>)</code>;</td></tr></table><div class="funcprototype-spacer"> </div></div><p>
</p><p>
Writes text at a specified position relative to the viewport
boundaries. Text may be written inside or outside the viewport, but
is clipped at the subpage boundaries. The reference point of a
string lies along a line passing through the string at half the
height of a capital letter. The position of the reference point
along this line is determined by
<code class="literal">
<em class="parameter"><code>just</code></em>
</code>, and the position of
the reference point relative to the viewport is set by
<code class="literal">
<em class="parameter"><code>disp</code></em>
</code> and
<code class="literal">
<em class="parameter"><code>pos</code></em>
</code>.
</p><div class="variablelist"><dl class="variablelist"><dt><span class="term">
<em class="parameter"><code>side</code></em>
(<code class="literal"><a class="link" href="c.html#PLCHAR_VECTOR-type"><code class="function">PLCHAR_VECTOR</code></a></code>, input)
</span></dt><dd><p>
An ascii character string specifying the
side of the viewport along which the text is to
be written. The string should contain one or more of the
following characters: <code class="literal">[xyz][ps][v]</code>.
Only one label is drawn at a time, i.e. <code class="literal">xyp</code>
will only label the X axis, not both the X and Y axes.
</p><div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem"><p>
<code class="literal">x</code>: Label the X axis.
</p></li><li class="listitem"><p>
<code class="literal">y</code>: Label the Y axis.
</p></li><li class="listitem"><p>
<code class="literal">z</code>: Label the Z axis.
</p></li><li class="listitem"><p>
<code class="literal">p</code>: Label the <span class="quote">“<span class="quote">primary</span>”</span>
axis. For Z this is the leftmost Z axis. For X it is
the axis that starts at y-min. For Y it is the axis that
starts at x-min.
</p></li><li class="listitem"><p>
<code class="literal">s</code>: Label the <span class="quote">“<span class="quote">secondary</span>”</span>
axis.
</p></li><li class="listitem"><p>
<code class="literal">v</code>: Draw the text perpendicular to the
axis.
</p></li></ul></div><p>
</p></dd><dt><span class="term">
<em class="parameter"><code>disp</code></em>
(<code class="literal"><a class="link" href="c.html#PLFLT-type"><code class="function">PLFLT</code></a></code>, input)
</span></dt><dd><p>
Position of the reference point of string, measured outwards
from the specified viewport edge in units of the current
character height. Use negative
<code class="literal"><em class="parameter"><code>disp</code></em></code> to write within
the viewport.
</p></dd><dt><span class="term">
<em class="parameter"><code>pos</code></em>
(<code class="literal"><a class="link" href="c.html#PLFLT-type"><code class="function">PLFLT</code></a></code>, input)
</span></dt><dd><p>
Position of the reference point of string along the specified
edge, expressed as a fraction of the length of the edge.
</p></dd><dt><span class="term">
<em class="parameter"><code>just</code></em>
(<code class="literal"><a class="link" href="c.html#PLFLT-type"><code class="function">PLFLT</code></a></code>, input)
</span></dt><dd><p>
Specifies the position of the string relative to its reference
point. If <code class="literal">
<em class="parameter"><code>just</code></em>=0.
</code>,
the reference point is at the left and if
<code class="literal">
<em class="parameter"><code>just</code></em>=1.
</code>, it is at the
right of the string. Other values of
<code class="literal">
<em class="parameter"><code>just</code></em>
</code> give
intermediate justifications.
</p></dd><dt><span class="term">
<em class="parameter"><code>text</code></em>
(<code class="literal"><a class="link" href="c.html#PLCHAR_VECTOR-type"><code class="function">PLCHAR_VECTOR</code></a></code>, input)
</span></dt><dd><p>
A UTF-8 character string to be written out.
</p></dd></dl></div><p>
Redacted form: <code class="function">plmtex3(side, disp, pos, just, text)</code>
</p><p>
This function is used in example 28.
</p></div><div class="navfooter"><hr><table width="100%" summary="Navigation footer"><tr><td width="40%" align="left"><a accesskey="p" href="plmtex.html">Prev</a> </td><td width="20%" align="center"><a accesskey="u" href="API.html">Up</a></td><td width="40%" align="right"> <a accesskey="n" href="plot3d.html">Next</a></td></tr><tr><td width="40%" align="left" valign="top">
<code class="function">plmtex</code>: Write text relative to viewport boundaries
</td><td width="20%" align="center"><a accesskey="h" href="index.html">Home</a></td><td width="40%" align="right" valign="top">
<code class="function">plot3d</code>: Plot 3-d surface plot
</td></tr></table></div></body></html>
|
