Skip to content

Commit 68ad4b2

Browse files
committed
doc typo fix
1 parent a8be5c9 commit 68ad4b2

2 files changed

Lines changed: 6 additions & 10 deletions

File tree

QtSLiM/help/SLiMHelpClasses.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -757,7 +757,7 @@
757757
<p class="p5">– (void)abline([Nif a = NULL], [Nif b = NULL], [Nif h = NULL], [Nif v = NULL], [string color = "red"], [numeric lwd = 1.0], [float alpha = 1.0])</p>
758758
<p class="p6">Adds one or more straight lines to the plot.<span class="Apple-converted-space">  </span>There are three supported modes of operation for this method.<span class="Apple-converted-space">  </span>In the first mode, the lines are specified by <span class="s1">a</span> and <span class="s1">b</span>, representing the intercepts and slopes of the lines, respectively; in this case, <span class="s1">a</span> and <span class="s1">b</span> may be the same length, or one of them may be a singleton to provide a single value used for all of the lines specified by the other.<span class="Apple-converted-space">  </span>In the second mode, the lines are specified by <span class="s1">h</span>, representing the <i>y</i>-values of horizontal lines.<span class="Apple-converted-space">  </span>In the third mode, the lines are specified by <span class="s1">v</span>, representing the <i>x</i>-values of vertical lines.<span class="Apple-converted-space">  </span>These modes are mutually exclusive and cannot be mixed within one call to <span class="s1">abline()</span>.<span class="Apple-converted-space">  </span>The new lines will be plotted on top of any previously added data.</p>
759759
<p class="p6">The lines will be drawn in colors, line widths, and alpha (opacity) values specified by <span class="s1">color</span>, <span class="s1">lwd</span>, and <span class="s1">alpha</span>, each of which may be either a singleton (to provide one value used for all lines) or a vector equal in length to the number of lines plotted (to provide one value per line).<span class="Apple-converted-space">  </span>Alpha values must be in [<span class="s1">0.0</span>, <span class="s1">1.0</span>], where <span class="s1">0.0</span> is fully transparent and <span class="s1">1.0</span> is fully opaque.</p>
760-
<p class="p6">See also <span class="s1">lines()</span> and <span class="s1">segments()</span>, for a more common approaches to line plotting.<span class="Apple-converted-space">  </span>The <span class="s1">abline()</span> method is different, and more specialized; the lines plotted by it span the full extent of the plot area, and their coordinates are not considered when dynamically resizing the axes of the plot (i.e., when <span class="s1">createPlot()</span> is not passed explicit, non-<span class="s1">NULL</span> values for <span class="s1">xrange</span> or <span class="s1">yrange</span>).<span class="Apple-converted-space">  </span>This is typically useful for plotting things such as expected values and fit lines.</p>
760+
<p class="p6">See also <span class="s1">lines()</span> and <span class="s1">segments()</span> for more common approaches to line plotting.<span class="Apple-converted-space">  </span>The <span class="s1">abline()</span> method is different, and more specialized; the lines plotted by it span the full extent of the plot area, and their coordinates are not considered when dynamically resizing the axes of the plot (i.e., when <span class="s1">createPlot()</span> is not passed explicit, non-<span class="s1">NULL</span> values for <span class="s1">xrange</span> or <span class="s1">yrange</span>).<span class="Apple-converted-space">  </span>This is typically useful for plotting things such as expected values and fit lines.</p>
761761
<p class="p5">– (void)addLegend([Ns$ position = NULL], [Ni$ inset = NULL], [Nif$ labelSize = NULL], [Nif$ lineHeight = NULL], [Nif$ graphicsWidth = NULL], [Nif$ exteriorMargin = NULL], [Nif$ interiorMargin = NULL])</p>
762762
<p class="p6">Adds a legend to the plot.<span class="Apple-converted-space">  </span>The legend will be displayed within the plot at the location specified by position, which must be <span class="s1">"topRight"</span>, <span class="s1">"topLeft"</span>, <span class="s1">"bottomRight"</span>, or <span class="s1">"bottomLeft"</span>, or <span class="s1">NULL</span> (the default) requesting that SLiMgui choose the position.<span class="Apple-converted-space">  </span>The position of the legend will be inset from the chosen corner by a margin <span class="s1">inset</span>, measured in pixels; the default of <span class="s1">NULL</span> allows SLiMgui to choose the inset.</p>
763763
<p class="p6">The internal layout of the legend is a bit complex, and can be controlled by five parameters; in all cases, the default value of <span class="s1">NULL</span> requests that SLiMgui provide a reasonable default.<span class="Apple-converted-space">  </span>The <span class="s1">labelSize</span> parameter specifies the font size used for the text labels for each legend entry (measured in “points”, the standard metric of font sizes).<span class="Apple-converted-space">  </span>The <span class="s1">lineHeight</span> parameter specifies the vertical size, in pixels, of one entry line.<span class="Apple-converted-space">  </span>The <span class="s1">graphicsWidth</span> parameter species the width, in pixels, of the column used to display the “graphics” (whether a line segment, a point symbol, a swatch, or a combination of those) associated with each entry.<span class="Apple-converted-space">  </span>The <span class="s1">exteriorMargin</span> parameter specifies the width/height of margins, in pixels, outside of the entries (between the entries and the legend’s frame).<span class="Apple-converted-space">  </span>Finally, the <span class="s1">interiorMargin</span> parameter specifies the width/height of margins, in pixels, vertically between entries, and also between the “graphics” column and the label.<span class="Apple-converted-space">  </span>It is easy to produce a legend that looks terrible, using these layout metrics; SLiMgui does only minimal sanity-checking of their values, to provide maximal flexibility.</p>

SLiMgui/SLiMHelpClasses.rtf

Lines changed: 5 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -6673,7 +6673,7 @@ See also
66736673
\f3\fs18 lines()
66746674
\f4\fs20 and
66756675
\f3\fs18 segments()
6676-
\f4\fs20 , for a more common approaches to line plotting. The
6676+
\f4\fs20 for more common approaches to line plotting. The
66776677
\f3\fs18 abline()
66786678
\f4\fs20 method is different, and more specialized; the lines plotted by it span the full extent of the plot area, and their coordinates are not considered when dynamically resizing the axes of the plot (i.e., when
66796679
\f3\fs18 createPlot()
@@ -7140,8 +7140,7 @@ See the
71407140
\f4\fs20 methods; rather than being in the coordinate system of the plot, they are in a coordinate system in which the plot area spans [0,1] on both axes. This is intended to make positioning text outside of the plot area not depend upon the axis ranges of the plot; those axis ranges might vary, but the positions at which
71417141
\f3\fs18 mtext()
71427142
\f4\fs20 draws, relative to the plot area, will remain fixed. The new marginal text data will be plotted on top of any previously added data.\
7143-
\pard\pardeftab720\li547\ri720\sb60\sa60\partightenfactor0
7144-
\cf2 The text will be drawn in color
7143+
The text will be drawn in color
71457144
\f3\fs18 color
71467145
\f4\fs20 , at the font size given by
71477146
\f3\fs18 size
@@ -7166,8 +7165,7 @@ See the
71667165
\f4\fs20 , and
71677166
\f3\fs18 angle
71687167
\f4\fs20 ) may either be a singleton value applied to all points, or a vector with one value per corresponding point.\
7169-
\pard\pardeftab720\li547\ri720\sb60\sa60\partightenfactor0
7170-
\cf2 The exact position of the text, relative to each point (
7168+
The exact position of the text, relative to each point (
71717169
\f1\i x
71727170
\f4\i0 ,
71737171
\f1\i y
@@ -7444,8 +7442,7 @@ Note that the
74447442
\f4\fs20 , and
74457443
\f3\fs18 labels
74467444
\f4\fs20 must all be the same length. The new text data will be plotted on top of any previously added data.\
7447-
\pard\pardeftab720\li547\ri720\sb60\sa60\partightenfactor0
7448-
\cf2 The text will be drawn in color
7445+
The text will be drawn in color
74497446
\f3\fs18 color
74507447
\f4\fs20 , at the font size given by
74517448
\f3\fs18 size
@@ -7470,8 +7467,7 @@ Note that the
74707467
\f4\fs20 , and
74717468
\f3\fs18 angle
74727469
\f4\fs20 ) may either be a singleton value applied to all points, or a vector with one value per corresponding point.\
7473-
\pard\pardeftab720\li547\ri720\sb60\sa60\partightenfactor0
7474-
\cf2 The exact position of the text, relative to each point (
7470+
The exact position of the text, relative to each point (
74757471
\f1\i x
74767472
\f4\i0 ,
74777473
\f1\i y

0 commit comments

Comments
 (0)