From: <ai...@us...> - 2008-10-01 01:47:07
|
Revision: 8843 http://plplot.svn.sourceforge.net/plplot/?rev=8843&view=rev Author: airwin Date: 2008-10-01 01:46:57 +0000 (Wed, 01 Oct 2008) Log Message: ----------- Correct plspage documentation error. Modified Paths: -------------- trunk/doc/docbook/src/api.xml Modified: trunk/doc/docbook/src/api.xml =================================================================== --- trunk/doc/docbook/src/api.xml 2008-09-30 22:34:25 UTC (rev 8842) +++ trunk/doc/docbook/src/api.xml 2008-10-01 01:46:57 UTC (rev 8843) @@ -12022,7 +12022,7 @@ </term> <listitem> <para> - Number of pixels, x. + Number of pixels/inch (DPI), x. </para> </listitem> </varlistentry> @@ -12033,7 +12033,7 @@ </term> <listitem> <para> - Number of pixels, y. + Number of pixels/inch (DPI), y. </para> </listitem> </varlistentry> This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site. |
From: <and...@us...> - 2008-12-03 15:48:51
|
Revision: 9033 http://plplot.svn.sourceforge.net/plplot/?rev=9033&view=rev Author: andrewross Date: 2008-12-03 15:48:46 +0000 (Wed, 03 Dec 2008) Log Message: ----------- Update documentation - plimagefr is used in example 20. Modified Paths: -------------- trunk/doc/docbook/src/api.xml Modified: trunk/doc/docbook/src/api.xml =================================================================== --- trunk/doc/docbook/src/api.xml 2008-12-03 08:00:06 UTC (rev 9032) +++ trunk/doc/docbook/src/api.xml 2008-12-03 15:48:46 UTC (rev 9033) @@ -5667,7 +5667,7 @@ </para> <para> - This function is not used in any examples. + This function is used in example 20. </para> </sect1> This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site. |
From: <ai...@us...> - 2008-12-16 23:02:00
|
Revision: 9156 http://plplot.svn.sourceforge.net/plplot/?rev=9156&view=rev Author: airwin Date: 2008-12-16 23:01:56 +0000 (Tue, 16 Dec 2008) Log Message: ----------- Correct and extend the plspage and plgpage documentation. Modified Paths: -------------- trunk/doc/docbook/src/api.xml Modified: trunk/doc/docbook/src/api.xml =================================================================== --- trunk/doc/docbook/src/api.xml 2008-12-16 22:27:09 UTC (rev 9155) +++ trunk/doc/docbook/src/api.xml 2008-12-16 23:01:56 UTC (rev 9156) @@ -4306,7 +4306,7 @@ </para> <para> - Gets the current page configuration. The parameters are expressed + Gets the current page configuration. The length and offset values are expressed in units that are specific to the current driver. For instance: screen drivers will usually interpret them as number of pixels, whereas printer drivers will usually use mm. @@ -4320,7 +4320,7 @@ </term> <listitem> <para> - Pointer to number of pixels in x. + Pointer to number of pixels/inch (DPI), x. </para> </listitem> </varlistentry> @@ -4331,7 +4331,7 @@ </term> <listitem> <para> - Pointer to number of pixels in y. + Pointer to number of pixels/inch (DPI) in y. </para> </listitem> </varlistentry> @@ -12054,10 +12054,15 @@ </para> <para> - Sets the page configuration (optional). Not all parameters are + Sets the page configuration (optional). If an individual parameter + is zero then that parameter value is not updated. Not all parameters are recognized by all drivers and the interpretation is device-dependent. The X-window driver uses the length and offset parameters to determine - the window size and location. This routine, if used, must be called + the window size and location. The length and offset values are expressed + in units that are specific to the current driver. For instance: + screen drivers will usually interpret them as number of pixels, + whereas printer drivers will usually use mm. + This routine, if used, must be called before initializing PLplot. </para> This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site. |
From: <and...@us...> - 2008-12-17 21:49:32
|
Revision: 9173 http://plplot.svn.sourceforge.net/plplot/?rev=9173&view=rev Author: andrewross Date: 2008-12-17 21:45:28 +0000 (Wed, 17 Dec 2008) Log Message: ----------- Update plsdidev documentation to make it clear that jx and jy are in the range -0.5 to 0.5. Modified Paths: -------------- trunk/doc/docbook/src/api.xml Modified: trunk/doc/docbook/src/api.xml =================================================================== --- trunk/doc/docbook/src/api.xml 2008-12-17 20:27:34 UTC (rev 9172) +++ trunk/doc/docbook/src/api.xml 2008-12-17 21:45:28 UTC (rev 9173) @@ -10043,7 +10043,8 @@ </term> <listitem> <para> - Relative justification in x. + Relative justification in x. Value must lie in the + range -0.5 to 0.5. </para> </listitem> </varlistentry> @@ -10054,7 +10055,8 @@ </term> <listitem> <para> - Relative justification in y. + Relative justification in y. Value must lie in the + range -0.5 to 0.5. </para> </listitem> </varlistentry> This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site. |
From: <and...@us...> - 2008-12-19 11:56:57
|
Revision: 9204 http://plplot.svn.sourceforge.net/plplot/?rev=9204&view=rev Author: andrewross Date: 2008-12-19 11:56:53 +0000 (Fri, 19 Dec 2008) Log Message: ----------- Update plscompression documentation to describe those devices that use the compression parameter and what it means. Modified Paths: -------------- trunk/doc/docbook/src/api.xml Modified: trunk/doc/docbook/src/api.xml =================================================================== --- trunk/doc/docbook/src/api.xml 2008-12-19 10:20:49 UTC (rev 9203) +++ trunk/doc/docbook/src/api.xml 2008-12-19 11:56:53 UTC (rev 9204) @@ -9906,7 +9906,7 @@ <para> Set device-compression level. Only used for drivers that provide compression. This function, if used, should be invoked - before a call to &plinit;. + before a call to &plinit;. </para> <variablelist> @@ -9919,8 +9919,16 @@ <para> The desired compression level. This is a device-dependent value. + Currently only the jpeg and png devices use these values. For jpeg + value is the jpeg quality which should normally be in the range 0-95. + Higher values denote higher quality and hence larger image sizes. For + png values are in the range -1 to 99. Values of 0-9 are taken as the + compression level for zlib. A value of -1 denotes the default zlib + compression level. Values in the range 10-99 are divided by 10 and + then used as the zlib compression level. Higher compression levels + correspond to greater compression and small file sizes at the + expense of more computation. </para> - <!-- TODO: what is the interpretation? In general: what documentation on devices? --> </listitem> </varlistentry> </variablelist> This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site. |
From: <and...@us...> - 2009-01-07 16:11:47
|
Revision: 9274 http://plplot.svn.sourceforge.net/plplot/?rev=9274&view=rev Author: andrewross Date: 2009-01-07 16:11:43 +0000 (Wed, 07 Jan 2009) Log Message: ----------- Update documentation to reflect recent changes in examples 14 and 17. Modified Paths: -------------- trunk/doc/docbook/src/api.xml Modified: trunk/doc/docbook/src/api.xml =================================================================== --- trunk/doc/docbook/src/api.xml 2009-01-07 16:10:59 UTC (rev 9273) +++ trunk/doc/docbook/src/api.xml 2009-01-07 16:11:43 UTC (rev 9274) @@ -2671,7 +2671,7 @@ </para> <para> - This function is used in example 2,14,17. + This function is used in example 2,14. </para> </sect1> @@ -4039,7 +4039,7 @@ </para> <para> - This function is used in example 31. + This function is used in examples 14,31. </para> </sect1> @@ -10584,7 +10584,7 @@ </para> <para> - This function is used in examples 14,17. + This function is used in example 14. </para> </sect1> @@ -10655,7 +10655,7 @@ </para> <para> - This function is used in example 31. + This function is used in examples 14,31. </para> </sect1> This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site. |
From: <and...@us...> - 2009-01-08 20:14:39
|
Revision: 9281 http://plplot.svn.sourceforge.net/plplot/?rev=9281&view=rev Author: andrewross Date: 2009-01-08 20:14:29 +0000 (Thu, 08 Jan 2009) Log Message: ----------- Fix missing tag from last documentation update. Modified Paths: -------------- trunk/doc/docbook/src/api.xml Modified: trunk/doc/docbook/src/api.xml =================================================================== --- trunk/doc/docbook/src/api.xml 2009-01-08 14:50:14 UTC (rev 9280) +++ trunk/doc/docbook/src/api.xml 2009-01-08 20:14:29 UTC (rev 9281) @@ -10487,6 +10487,8 @@ </para> </listitem> </varlistentry> + </variablelist> + <para> Redacted form: <function>plseed(seed)</function> </para> This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site. |
From: <and...@us...> - 2009-01-09 00:49:19
|
Revision: 9288 http://plplot.svn.sourceforge.net/plplot/?rev=9288&view=rev Author: andrewross Date: 2009-01-09 00:49:14 +0000 (Fri, 09 Jan 2009) Log Message: ----------- Example 12 now uses plscmap1l. Modified Paths: -------------- trunk/doc/docbook/src/api.xml Modified: trunk/doc/docbook/src/api.xml =================================================================== --- trunk/doc/docbook/src/api.xml 2009-01-09 00:48:43 UTC (rev 9287) +++ trunk/doc/docbook/src/api.xml 2009-01-09 00:49:14 UTC (rev 9288) @@ -9360,7 +9360,7 @@ </para> <para> - This function is used in examples 8,11,15,20,21. + This function is used in examples 8,11,12,15,20,21. </para> </sect1> This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site. |
From: <ai...@us...> - 2009-07-10 01:54:11
|
Revision: 10134 http://plplot.svn.sourceforge.net/plplot/?rev=10134&view=rev Author: airwin Date: 2009-07-10 01:54:08 +0000 (Fri, 10 Jul 2009) Log Message: ----------- Correct from plscol0 to plscol0a in the function prototype for plscol0a. Modified Paths: -------------- trunk/doc/docbook/src/api.xml Modified: trunk/doc/docbook/src/api.xml =================================================================== --- trunk/doc/docbook/src/api.xml 2009-07-10 00:20:46 UTC (rev 10133) +++ trunk/doc/docbook/src/api.xml 2009-07-10 01:54:08 UTC (rev 10134) @@ -9638,7 +9638,7 @@ <funcsynopsis> <funcprototype> <funcdef> - <function>plscol0</function> + <function>plscol0a</function> </funcdef> <paramdef><parameter>icol0</parameter></paramdef> <paramdef><parameter>r</parameter></paramdef> This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site. |
From: <hba...@us...> - 2009-07-12 23:00:15
|
Revision: 10143 http://plplot.svn.sourceforge.net/plplot/?rev=10143&view=rev Author: hbabcock Date: 2009-07-12 23:00:11 +0000 (Sun, 12 Jul 2009) Log Message: ----------- Add documentation for plspal0 and plspal1 functions. Modified Paths: -------------- trunk/doc/docbook/src/api.xml Modified: trunk/doc/docbook/src/api.xml =================================================================== --- trunk/doc/docbook/src/api.xml 2009-07-12 19:30:47 UTC (rev 10142) +++ trunk/doc/docbook/src/api.xml 2009-07-12 23:00:11 UTC (rev 10143) @@ -7,7 +7,7 @@ Copyright (C) 1999, 2000, 2001, 2002, 2003, 2004 Rafael Laboissiere Copyright (C) 2003 Joao Cardoso Copyright (C) 2004, 2007 Andrew Ross -Copyright (C) 2007 Hazen Babcock +Copyright (C) 2007, 2009 Hazen Babcock Redistribution and use in source (XML DocBook) and "compiled" forms (HTML, PDF, PostScript, DVI, TeXinfo and so forth) with or without @@ -12125,6 +12125,7 @@ </sect1> + <sect1 id="plspage" renderas="sect3"> <title> <function>plspage</function>: Set page parameters @@ -12238,6 +12239,105 @@ </sect1> + <sect1 id="plspal0" renderas="sect3"> + <title> + <function>plspal0</function>: Set PLplot color table 0 using a PLplot cmap0 palette file. + </title> + + <para> + <funcsynopsis> + <funcprototype> + <funcdef> + <function>plspal0</function> + </funcdef> + <paramdef><parameter>filename</parameter></paramdef> + </funcprototype> + </funcsynopsis> + </para> + + <para> + Sets color table 0 using the PLplot palette file specified by + filename. Example palette files for color table 0 can be found + in the installed PLplot directory. Note also that you don't need + to include the path in the filename if the file is located in the + directories that are searched by default by PLplot. + </para> + + <variablelist> + <varlistentry> + <term> + <parameter>filename</parameter> + (<literal>const char *</literal>, input) + </term> + <listitem> + <para> + A string containing the filename of the desired color table 0 + palette file. + </para> + </listitem> + </varlistentry> + </variablelist> + + <para> + Redacted form: <function>plspal0(filename)</function> + </para> + + <para> + This function is used in example 16. + </para> + + </sect1> + + + <sect1 id="plspal1" renderas="sect3"> + <title> + <function>plspal1</function>: Set PLplot color table 1 using a PLplot cmap1 palette file. + </title> + + <para> + <funcsynopsis> + <funcprototype> + <funcdef> + <function>plspal1</function> + </funcdef> + <paramdef><parameter>filename</parameter></paramdef> + </funcprototype> + </funcsynopsis> + </para> + + <para> + Sets color table 1 using the PLplot palette file specified by + filename. Example palette files for color table 1 can be found + in the installed PLplot directory. Note also that you don't need + to include the path in the filename if the file is located in the + directories that are searched by default by PLplot. + </para> + + <variablelist> + <varlistentry> + <term> + <parameter>filename</parameter> + (<literal>const char *</literal>, input) + </term> + <listitem> + <para> + A string containing the filename of the desired color table 1 + palette file. + </para> + </listitem> + </varlistentry> + </variablelist> + + <para> + Redacted form: <function>plspal1(filename)</function> + </para> + + <para> + This function is used in example 16. + </para> + + </sect1> + <sect1 id="plspause" renderas="sect3"> <title> <function>plspause</function>: Set the pause (on end-of-page) status This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site. |
From: <ai...@us...> - 2009-07-16 17:21:53
|
Revision: 10152 http://plplot.svn.sourceforge.net/plplot/?rev=10152&view=rev Author: airwin Date: 2009-07-16 17:21:51 +0000 (Thu, 16 Jul 2009) Log Message: ----------- Rework documentation of plsdiori to mention aspect-ratio issues. Rework documentation of plsori to simply refer to plsdiori. Modified Paths: -------------- trunk/doc/docbook/src/api.xml Modified: trunk/doc/docbook/src/api.xml =================================================================== --- trunk/doc/docbook/src/api.xml 2009-07-15 23:37:09 UTC (rev 10151) +++ trunk/doc/docbook/src/api.xml 2009-07-16 17:21:51 UTC (rev 10152) @@ -7,7 +7,7 @@ Copyright (C) 1999, 2000, 2001, 2002, 2003, 2004 Rafael Laboissiere Copyright (C) 2003 Joao Cardoso Copyright (C) 2004, 2007 Andrew Ross -Copyright (C) 2007, 2009 Hazen Babcock +Copyright (C) 2007 Hazen Babcock Redistribution and use in source (XML DocBook) and "compiled" forms (HTML, PDF, PostScript, DVI, TeXinfo and so forth) with or without @@ -10243,15 +10243,25 @@ <para> Set plot orientation parameter which is multiplied by 90° to - obtain the angle of rotation. Note, arbitrary rotation parameters such as 0.2 - (corresponding to 18°) are possible, but the usual values for - the rotation parameter are 0., 1., 2., and 3. corresponding to 0° - (landscape mode), 90° (portrait mode), 180° (seascape - mode), and 270° (upside-down mode). - If &plsdiori; is not called the default value - of <literal><parameter>rot</parameter></literal> - is 0. + obtain the angle of rotation. Note, arbitrary rotation parameters + such as 0.2 (corresponding to 18°) are possible, but the usual + values for the rotation parameter are 0., 1., 2., and 3. corresponding + to 0° (landscape mode), 90° (portrait mode), 180° + (seascape mode), and 270° (upside-down mode). If &plsdiori; is + not called the default value of + <literal><parameter>rot</parameter></literal> is 0. </para> + <para> + N.B. aspect ratio is unaffected by calls to &plsdiori;. So you will + probably want to change the aspect ratio to a value suitable for the + plot orientation using a call to &plsdidev; or the command-line + options <literal><parameter>-a</parameter></literal> or + <literal><parameter>-freeaspect</parameter></literal>. For more + documentation of those options see <xref linkend="arguments"/>. Such + command-line options can be set internally using &plsetopt; or set + directly using the command line and parsed using a call to + &plparseopts;. + </para> <variablelist> <varlistentry> @@ -12091,13 +12101,10 @@ </para> <para> - Sets the current orientation. If - <literal><parameter>ori</parameter></literal> is equal to zero - (default) then landscape is used (x axis is parallel to the longest - edge of the page), otherwise portrait is used. This option is not - supported by all output drivers (in particular, most interactive - screen drivers ignore the orientation). This routine, if used, must - be called before initializing PLplot. + Set integer plot orientation parameter. This function is + identical to &plsdiori; except for the type of the argument, and + should be used in the same way. See <xref linkend="plsdiori"/> for + details. </para> <variablelist> @@ -12108,8 +12115,8 @@ </term> <listitem> <para> - Orientation value (0 for landscape, 1 for portrait; the value is - multiplied by 90 degrees to get the angle) + Orientation value (0 for landscape, 1 for portrait, etc.) + The value is multiplied by 90 degrees to get the angle. </para> </listitem> </varlistentry> @@ -12125,7 +12132,6 @@ </sect1> - <sect1 id="plspage" renderas="sect3"> <title> <function>plspage</function>: Set page parameters @@ -12239,105 +12245,6 @@ </sect1> - <sect1 id="plspal0" renderas="sect3"> - <title> - <function>plspal0</function>: Set PLplot color table 0 using a PLplot cmap0 palette file. - </title> - - <para> - <funcsynopsis> - <funcprototype> - <funcdef> - <function>plspal0</function> - </funcdef> - <paramdef><parameter>filename</parameter></paramdef> - </funcprototype> - </funcsynopsis> - </para> - - <para> - Sets color table 0 using the PLplot palette file specified by - filename. Example palette files for color table 0 can be found - in the installed PLplot directory. Note also that you don't need - to include the path in the filename if the file is located in the - directories that are searched by default by PLplot. - </para> - - <variablelist> - <varlistentry> - <term> - <parameter>filename</parameter> - (<literal>const char *</literal>, input) - </term> - <listitem> - <para> - A string containing the filename of the desired color table 0 - palette file. - </para> - </listitem> - </varlistentry> - </variablelist> - - <para> - Redacted form: <function>plspal0(filename)</function> - </para> - - <para> - This function is used in example 16. - </para> - - </sect1> - - - <sect1 id="plspal1" renderas="sect3"> - <title> - <function>plspal1</function>: Set PLplot color table 1 using a PLplot cmap1 palette file. - </title> - - <para> - <funcsynopsis> - <funcprototype> - <funcdef> - <function>plspal1</function> - </funcdef> - <paramdef><parameter>filename</parameter></paramdef> - </funcprototype> - </funcsynopsis> - </para> - - <para> - Sets color table 1 using the PLplot palette file specified by - filename. Example palette files for color table 1 can be found - in the installed PLplot directory. Note also that you don't need - to include the path in the filename if the file is located in the - directories that are searched by default by PLplot. - </para> - - <variablelist> - <varlistentry> - <term> - <parameter>filename</parameter> - (<literal>const char *</literal>, input) - </term> - <listitem> - <para> - A string containing the filename of the desired color table 1 - palette file. - </para> - </listitem> - </varlistentry> - </variablelist> - - <para> - Redacted form: <function>plspal1(filename)</function> - </para> - - <para> - This function is used in example 16. - </para> - - </sect1> - <sect1 id="plspause" renderas="sect3"> <title> <function>plspause</function>: Set the pause (on end-of-page) status This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site. |
From: <ai...@us...> - 2009-08-19 21:37:46
|
Revision: 10301 http://plplot.svn.sourceforge.net/plplot/?rev=10301&view=rev Author: airwin Date: 2009-08-19 21:37:38 +0000 (Wed, 19 Aug 2009) Log Message: ----------- Fix typographical errors in function names for some alpha-aware plscmap* functions. Modified Paths: -------------- trunk/doc/docbook/src/api.xml Modified: trunk/doc/docbook/src/api.xml =================================================================== --- trunk/doc/docbook/src/api.xml 2009-08-19 19:18:06 UTC (rev 10300) +++ trunk/doc/docbook/src/api.xml 2009-08-19 21:37:38 UTC (rev 10301) @@ -8871,7 +8871,7 @@ <funcsynopsis> <funcprototype> <funcdef> - <function>plscmap0</function> + <function>plscmap0a</function> </funcdef> <paramdef><parameter>r</parameter></paramdef> <paramdef><parameter>g</parameter></paramdef> @@ -9109,7 +9109,7 @@ <funcsynopsis> <funcprototype> <funcdef> - <function>plscmap1</function> + <function>plscmap1a</function> </funcdef> <paramdef><parameter>r</parameter></paramdef> <paramdef><parameter>g</parameter></paramdef> @@ -9375,7 +9375,7 @@ <funcsynopsis> <funcprototype> <funcdef> - <function>plscmap1l</function> + <function>plscmap1la</function> </funcdef> <paramdef><parameter>itype</parameter></paramdef> <paramdef><parameter>npts</parameter></paramdef> This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site. |
From: <ai...@us...> - 2009-09-02 16:29:06
|
Revision: 10364 http://plplot.svn.sourceforge.net/plplot/?rev=10364&view=rev Author: airwin Date: 2009-09-02 16:28:52 +0000 (Wed, 02 Sep 2009) Log Message: ----------- Document the meaning of the last argument of plenv when it is 70-73. Modified Paths: -------------- trunk/doc/docbook/src/api.xml Modified: trunk/doc/docbook/src/api.xml =================================================================== --- trunk/doc/docbook/src/api.xml 2009-09-01 10:34:16 UTC (rev 10363) +++ trunk/doc/docbook/src/api.xml 2009-09-02 16:28:52 UTC (rev 10364) @@ -2629,6 +2629,30 @@ <literal>x</literal> and <literal>y</literal> labels. </para> </listitem> + <listitem> + <para> + <literal>70</literal>: same as 0 except custom + <literal>x</literal> and <literal>y</literal> labels. + </para> + </listitem> + <listitem> + <para> + <literal>71</literal>: same as 1 except custom + <literal>x</literal> and <literal>y</literal> labels. + </para> + </listitem> + <listitem> + <para> + <literal>72</literal>: same as 2 except custom + <literal>x</literal> and <literal>y</literal> labels. + </para> + </listitem> + <listitem> + <para> + <literal>73</literal>: same as 3 except custom + <literal>x</literal> and <literal>y</literal> labels. + </para> + </listitem> </itemizedlist> </para> </listitem> This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site. |
From: <ai...@us...> - 2009-11-17 01:24:20
|
Revision: 10606 http://plplot.svn.sourceforge.net/plplot/?rev=10606&view=rev Author: airwin Date: 2009-11-17 01:24:10 +0000 (Tue, 17 Nov 2009) Log Message: ----------- Remind users of plpause in plend documentation. Thanks to David Sagan for this change. Modified Paths: -------------- trunk/doc/docbook/src/api.xml Modified: trunk/doc/docbook/src/api.xml =================================================================== --- trunk/doc/docbook/src/api.xml 2009-11-16 22:33:58 UTC (rev 10605) +++ trunk/doc/docbook/src/api.xml 2009-11-17 01:24:10 UTC (rev 10606) @@ -1976,6 +1976,13 @@ </para> <para> + By default, PLplot's interactive devices (Xwin, TK, etc.) + go into a wait state after a call to plend + or other functions which trigger the end of a plot page. + To avoid this, use the &plspause; function. + </para> + + <para> Redacted form: <function>plend()</function> </para> This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site. |
From: <ai...@us...> - 2009-11-26 22:53:30
|
Revision: 10629 http://plplot.svn.sourceforge.net/plplot/?rev=10629&view=rev Author: airwin Date: 2009-11-26 22:53:23 +0000 (Thu, 26 Nov 2009) Log Message: ----------- Tweak plshades argument description. Modified Paths: -------------- trunk/doc/docbook/src/api.xml Modified: trunk/doc/docbook/src/api.xml =================================================================== --- trunk/doc/docbook/src/api.xml 2009-11-26 19:07:08 UTC (rev 10628) +++ trunk/doc/docbook/src/api.xml 2009-11-26 22:53:23 UTC (rev 10629) @@ -11130,7 +11130,6 @@ Defines the "grid" coordinates. The data a[0][0] has a position of (xmin,ymin), a[nx-1][0] has a position at (xmax,ymin) and so on. - (xmax,ymin) </para> </listitem> </varlistentry> This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site. |
From: <ai...@us...> - 2009-11-28 22:03:50
|
Revision: 10639 http://plplot.svn.sourceforge.net/plplot/?rev=10639&view=rev Author: airwin Date: 2009-11-28 22:03:39 +0000 (Sat, 28 Nov 2009) Log Message: ----------- Tweak introductory paragraph for plscmap1la. Modified Paths: -------------- trunk/doc/docbook/src/api.xml Modified: trunk/doc/docbook/src/api.xml =================================================================== --- trunk/doc/docbook/src/api.xml 2009-11-28 01:15:51 UTC (rev 10638) +++ trunk/doc/docbook/src/api.xml 2009-11-28 22:03:39 UTC (rev 10639) @@ -9473,11 +9473,13 @@ </funcsynopsis> </para> - <para> This the alpha value supporting version of plscmap1l. It sets color - map1 colors using a piece-wise linear relationship between position in the - color map (from 0 to 1) and position in HLS or RGB color space - (see <xref linkend="color-map-1"/>) with alpha value (0.0 - 1.0). It may be - called at any time. </para> + <para> + This is a version of &plscmap1l; that supports alpha + transparency. It sets color map1 colors using a piece-wise linear + relationship between position in the color map (from 0 to 1) and + position in HLS or RGB color space (see <xref linkend="color-map-1"/>) + with alpha value (0.0 - 1.0). It may be called at any time. + </para> <variablelist> <varlistentry> This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site. |
From: <ai...@us...> - 2009-12-02 17:20:49
|
Revision: 10670 http://plplot.svn.sourceforge.net/plplot/?rev=10670&view=rev Author: airwin Date: 2009-12-02 17:20:42 +0000 (Wed, 02 Dec 2009) Log Message: ----------- Indentation (as set by emacs cmake mode). Modified Paths: -------------- trunk/doc/docbook/src/api.xml Modified: trunk/doc/docbook/src/api.xml =================================================================== --- trunk/doc/docbook/src/api.xml 2009-12-02 12:33:47 UTC (rev 10669) +++ trunk/doc/docbook/src/api.xml 2009-12-02 17:20:42 UTC (rev 10670) @@ -491,9 +491,9 @@ </listitem> <listitem> <para> - <literal>o</literal>: Use custom labeling function to - generate axis label text. The custom labeling function - can be defined with the plslabelfuncplslabelfunc; command. + <literal>o</literal>: Use custom labeling function to + generate axis label text. The custom labeling function + can be defined with the plslabelfuncplslabelfunc; command. </para> </listitem> <listitem> @@ -914,9 +914,9 @@ </listitem> <listitem> <para> - <literal>o</literal>: Use custom labeling function to - generate axis label text. The custom labeling function - can be defined with the plslabelfuncplslabelfunc; command. + <literal>o</literal>: Use custom labeling function to + generate axis label text. The custom labeling function + can be defined with the plslabelfuncplslabelfunc; command. </para> </listitem> <listitem> @@ -1115,9 +1115,9 @@ </listitem> <listitem> <para> - <literal>o</literal>: Use custom labeling function to - generate axis label text. The custom labeling function - can be defined with the plslabelfuncplslabelfunc; command. + <literal>o</literal>: Use custom labeling function to + generate axis label text. The custom labeling function + can be defined with the plslabelfuncplslabelfunc; command. </para> </listitem> <listitem> @@ -1297,9 +1297,9 @@ </listitem> <listitem> <para> - <literal>o</literal>: Use custom labeling function to - generate axis label text. The custom labeling function - can be defined with the plslabelfuncplslabelfunc; command. + <literal>o</literal>: Use custom labeling function to + generate axis label text. The custom labeling function + can be defined with the plslabelfuncplslabelfunc; command. </para> </listitem> <listitem> @@ -5697,42 +5697,42 @@ </para> </listitem> </varlistentry> - <varlistentry> - <term> - <parameter>pltr</parameter> - (<literal>void (*) (PLFLT, PLFLT, PLFLT *, PLFLT *, PLPointer) - </literal>, input) - </term> - <listitem> - <para> - Pointer to function that defines transformation between indices - in array <literal><parameter>idata</parameter></literal> and the - world coordinates (C only). Transformation functions are - provided in the PLplot library: - &pltr0; for identity mapping, and &pltr1; and &pltr2; for - arbitrary mappings respectively defined by one- and - two-dimensional arrays. In addition, user-supplied routines - for the transformation can be used as well. Examples of - all of these approaches are given in - <xref linkend="contour-plots-c"/>. - The transformation function should - have the form given by any of &pltr0;, &pltr1;, or &pltr2;. - </para> + <varlistentry> + <term> + <parameter>pltr</parameter> + (<literal>void (*) (PLFLT, PLFLT, PLFLT *, PLFLT *, PLPointer) + </literal>, input) + </term> + <listitem> + <para> + Pointer to function that defines transformation between indices + in array <literal><parameter>idata</parameter></literal> and the + world coordinates (C only). Transformation functions are + provided in the PLplot library: + &pltr0; for identity mapping, and &pltr1; and &pltr2; for + arbitrary mappings respectively defined by one- and + two-dimensional arrays. In addition, user-supplied routines + for the transformation can be used as well. Examples of + all of these approaches are given in + <xref linkend="contour-plots-c"/>. + The transformation function should + have the form given by any of &pltr0;, &pltr1;, or &pltr2;. + </para> </listitem> - </varlistentry> - <varlistentry> - <term> - <parameter>pltr_data</parameter> - (<literal>PLPointer</literal>, input) - </term> - <listitem> - <para> - Extra parameter to help - pass information to &pltr0;, &pltr1;, &pltr2;, or whatever routine - that is externally supplied. - </para> - </listitem> - </varlistentry> + </varlistentry> + <varlistentry> + <term> + <parameter>pltr_data</parameter> + (<literal>PLPointer</literal>, input) + </term> + <listitem> + <para> + Extra parameter to help + pass information to &pltr0;, &pltr1;, &pltr2;, or whatever routine + that is externally supplied. + </para> + </listitem> + </varlistentry> </variablelist> <para> @@ -7584,7 +7584,7 @@ <funcsynopsis> <funcprototype> <funcdef>int - <function>plparseopts</function> + <function>plparseopts</function> </funcdef> <paramdef><parameter>p_argc</parameter></paramdef> <paramdef><parameter>argv</parameter></paramdef> @@ -7676,47 +7676,47 @@ </varlistentry> </variablelist> - <para> - &plparseopts; removes all recognized flags - (decreasing argc accordingly), so that invalid input may be readily - detected. It can also be used to process user command line flags. The - user can merge an option table of type PLOptionTable into the internal - option table info structure using &plMergeOpts;. Or, the user can - specify that ONLY the external table(s) be parsed by calling - &plClearOpts; before &plMergeOpts;. + <para> + &plparseopts; removes all recognized flags + (decreasing argc accordingly), so that invalid input may be readily + detected. It can also be used to process user command line flags. The + user can merge an option table of type PLOptionTable into the internal + option table info structure using &plMergeOpts;. Or, the user can + specify that ONLY the external table(s) be parsed by calling + &plClearOpts; before &plMergeOpts;. </para> <para> - The default action taken by &plparseopts; is as follows: - <simplelist columns="1"> - <member> - Returns with an error if an unrecognized option or badly formed - option-value pair are encountered. - </member> - <member> - Returns immediately (return code 0) when the first non-option - command line argument is found. - </member> - <member> - Returns with the return code of the option handler, if one - was called. - </member> - <member> - Deletes command line arguments from argv list as they are found, - and decrements argc accordingly. - </member> - <member> - Does not show "invisible" options in usage or help messages. - </member> - <member> - Assumes the program name is contained in argv[0]. - </member> - </simplelist> + The default action taken by &plparseopts; is as follows: + <simplelist columns="1"> + <member> + Returns with an error if an unrecognized option or badly formed + option-value pair are encountered. + </member> + <member> + Returns immediately (return code 0) when the first non-option + command line argument is found. + </member> + <member> + Returns with the return code of the option handler, if one + was called. + </member> + <member> + Deletes command line arguments from argv list as they are found, + and decrements argc accordingly. + </member> + <member> + Does not show "invisible" options in usage or help messages. + </member> + <member> + Assumes the program name is contained in argv[0]. + </member> + </simplelist> </para> <para> - These behaviors may be controlled through the - <parameter>mode</parameter> argument. + These behaviors may be controlled through the + <parameter>mode</parameter> argument. </para> <para> @@ -10042,15 +10042,15 @@ <para> The desired compression level. This is a device-dependent value. - Currently only the jpeg and png devices use these values. For jpeg - value is the jpeg quality which should normally be in the range 0-95. - Higher values denote higher quality and hence larger image sizes. For - png values are in the range -1 to 99. Values of 0-9 are taken as the - compression level for zlib. A value of -1 denotes the default zlib - compression level. Values in the range 10-99 are divided by 10 and - then used as the zlib compression level. Higher compression levels - correspond to greater compression and small file sizes at the - expense of more computation. + Currently only the jpeg and png devices use these values. For jpeg + value is the jpeg quality which should normally be in the range 0-95. + Higher values denote higher quality and hence larger image sizes. For + png values are in the range -1 to 99. Values of 0-9 are taken as the + compression level for zlib. A value of -1 denotes the default zlib + compression level. Values in the range 10-99 are divided by 10 and + then used as the zlib compression level. Higher compression levels + correspond to greater compression and small file sizes at the + expense of more computation. </para> </listitem> </varlistentry> @@ -10175,7 +10175,7 @@ <listitem> <para> Relative justification in x. Value must lie in the - range -0.5 to 0.5. + range -0.5 to 0.5. </para> </listitem> </varlistentry> @@ -10187,7 +10187,7 @@ <listitem> <para> Relative justification in y. Value must lie in the - range -0.5 to 0.5. + range -0.5 to 0.5. </para> </listitem> </varlistentry> @@ -10567,8 +10567,8 @@ </para> <para> - Set the seed for the internal random number generator. See &plrandd; - for further details. + Set the seed for the internal random number generator. See &plrandd; + for further details. </para> <variablelist> @@ -10713,7 +10713,7 @@ <funcsynopsis> <funcprototype> <funcdef>int - <function>plsetopt</function> + <function>plsetopt</function> </funcdef> <paramdef><parameter>opt</parameter></paramdef> <paramdef><parameter>optarg</parameter></paramdef> @@ -12005,48 +12005,48 @@ </term> <listitem> <para> - This is the custom label function. In order to reset to the - default labeling, set this to <literal>NULL</literal>. - The labeling function parameters are, in order: - <variablelist> - <varlistentry> - <term><parameter>axis</parameter></term> - <listitem> - <para> - This indicates which axis a label is being requested for. - The value will be one of <literal>PL_X_AXIS</literal>, - <literal>PL_Y_AXIS</literal> or - <literal>PL_Z_AXIS</literal>. - </para> - </listitem> - </varlistentry> - <varlistentry> - <term><parameter>value</parameter></term> - <listitem> - <para> - This is the value along the axis which is being labeled. - </para> - </listitem> - </varlistentry> - <varlistentry> - <term><parameter>label_text</parameter></term> - <listitem> - <para> - The string representation of the label - <literal>value</literal>. - </para> - </listitem> - </varlistentry> - <varlistentry> - <term><parameter>length</parameter></term> - <listitem> - <para> - The maximum length in characters allowed for - <literal>label_text</literal>. - </para> - </listitem> - </varlistentry> - </variablelist> + This is the custom label function. In order to reset to the + default labeling, set this to <literal>NULL</literal>. + The labeling function parameters are, in order: + <variablelist> + <varlistentry> + <term><parameter>axis</parameter></term> + <listitem> + <para> + This indicates which axis a label is being requested for. + The value will be one of <literal>PL_X_AXIS</literal>, + <literal>PL_Y_AXIS</literal> or + <literal>PL_Z_AXIS</literal>. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>value</parameter></term> + <listitem> + <para> + This is the value along the axis which is being labeled. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>label_text</parameter></term> + <listitem> + <para> + The string representation of the label + <literal>value</literal>. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>length</parameter></term> + <listitem> + <para> + The maximum length in characters allowed for + <literal>label_text</literal>. + </para> + </listitem> + </varlistentry> + </variablelist> </para> </listitem> </varlistentry> @@ -12057,8 +12057,8 @@ </term> <listitem> <para> - This parameter may be used to pass data to the - <literal>label_func</literal> function. + This parameter may be used to pass data to the + <literal>label_func</literal> function. </para> </listitem> </varlistentry> This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site. |
From: <hez...@us...> - 2010-03-06 19:11:26
|
Revision: 10857 http://plplot.svn.sourceforge.net/plplot/?rev=10857&view=rev Author: hezekiahcarty Date: 2010-03-06 19:11:19 +0000 (Sat, 06 Mar 2010) Log Message: ----------- Update documentation for plimagefr per David MacMahon's suggestions Modified Paths: -------------- trunk/doc/docbook/src/api.xml Modified: trunk/doc/docbook/src/api.xml =================================================================== --- trunk/doc/docbook/src/api.xml 2010-03-06 07:10:32 UTC (rev 10856) +++ trunk/doc/docbook/src/api.xml 2010-03-06 19:11:19 UTC (rev 10857) @@ -5804,18 +5804,21 @@ </term> <listitem> <para> - Pointer to function that defines transformation between indices - in array <literal><parameter>idata</parameter></literal> and the - world coordinates (C only). Transformation functions are - provided in the PLplot library: - &pltr0; for identity mapping, and &pltr1; and &pltr2; for - arbitrary mappings respectively defined by one- and - two-dimensional arrays. In addition, user-supplied routines - for the transformation can be used as well. Examples of - all of these approaches are given in - <xref linkend="contour-plots-c"/>. - The transformation function should - have the form given by any of &pltr0;, &pltr1;, or &pltr2;. + Pointer to function that defines a transformation between the data + in the array <literal><parameter>idata</parameter></literal> and + world coordinates. An input coordinate of + <literal>(0, 0)</literal> corresponds to the "top-left" corner of + <literal><parameter>idata</parameter></literal> while + <literal>(nx, ny)</literal> corresponds to the "bottom-right" + corner of <literal><parameter>idata</parameter></literal>. Some + transformation functions are provided in the PLplot library: + &pltr0; for identity mapping, and &pltr1; and &pltr2; for + arbitrary mappings respectively defined by one- and + two-dimensional arrays. In addition, user-supplied routines for + the transformation can be used as well. Examples of all of these + approaches are given in <xref linkend="contour-plots-c"/>. The + transformation function should have the form given by any of + &pltr0;, &pltr1;, or &pltr2;. </para> </listitem> </varlistentry> @@ -5828,7 +5831,7 @@ <para> Extra parameter to help pass information to &pltr0;, &pltr1;, &pltr2;, or whatever routine - that is externally supplied. + is externally supplied. </para> </listitem> </varlistentry> This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site. |
From: <ai...@us...> - 2010-04-10 16:40:34
|
Revision: 10897 http://plplot.svn.sourceforge.net/plplot/?rev=10897&view=rev Author: airwin Date: 2010-04-10 16:40:14 +0000 (Sat, 10 Apr 2010) Log Message: ----------- Tweak wording of plfontld description. Modified Paths: -------------- trunk/doc/docbook/src/api.xml Modified: trunk/doc/docbook/src/api.xml =================================================================== --- trunk/doc/docbook/src/api.xml 2010-04-08 21:45:12 UTC (rev 10896) +++ trunk/doc/docbook/src/api.xml 2010-04-10 16:40:14 UTC (rev 10897) @@ -3312,7 +3312,7 @@ <para> Sets the character set to use for subsequent character drawing. May - be called before calling initializing PLplot. + be called before initializing PLplot. </para> <variablelist> This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site. |
From: <hba...@us...> - 2010-06-24 13:21:26
|
Revision: 11082 http://plplot.svn.sourceforge.net/plplot/?rev=11082&view=rev Author: hbabcock Date: 2010-06-24 13:21:16 +0000 (Thu, 24 Jun 2010) Log Message: ----------- Add documentation for plarc. Modified Paths: -------------- trunk/doc/docbook/src/api.xml Modified: trunk/doc/docbook/src/api.xml =================================================================== --- trunk/doc/docbook/src/api.xml 2010-06-21 07:22:35 UTC (rev 11081) +++ trunk/doc/docbook/src/api.xml 2010-06-24 13:21:16 UTC (rev 11082) @@ -345,6 +345,131 @@ </sect1> + <sect1 id="plarc" renderas="sect3"> + <title> + <function>plarc</function>: Draw a circular or elliptical arc + </title> + + <para> + <funcsynopsis> + <funcprototype> + <funcdef> + <function>plarc</function> + </funcdef> + <paramdef><parameter>x</parameter></paramdef> + <paramdef><parameter>y</parameter></paramdef> + <paramdef><parameter>a</parameter></paramdef> + <paramdef><parameter>b</parameter></paramdef> + <paramdef><parameter>angle1</parameter></paramdef> + <paramdef><parameter>angle2</parameter></paramdef> + <paramdef><parameter>fill</parameter></paramdef> + </funcprototype> + </funcsynopsis> + </para> + + <para> + Draw a possible filled arc centered at x,y with + semimajor axis a and semiminor axis b, starting + at angle1 and ending at angle2. + </para> + + <variablelist> + <varlistentry> + <term> + <parameter>x</parameter> + (<literal>PLFLT</literal>, input) + </term> + <listitem> + <para> + X coordinate of arc center. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term> + <parameter>y</parameter> + (<literal>PLFLT</literal>, input) + </term> + <listitem> + <para> + Y coordinate of arc center. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term> + <parameter>a</parameter> + (<literal>PLFLT</literal>, input) + </term> + <listitem> + <para> + Length of the semimajor axis of the arc. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term> + <parameter>b</parameter> + (<literal>PLFLT</literal>, input) + </term> + <listitem> + <para> + Length of the semiminor axis of the arc. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term> + <parameter>angle1</parameter> + (<literal>PLFLT</literal>, input) + </term> + <listitem> + <para> + Starting angle of the arc. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term> + <parameter>angle2</parameter> + (<literal>PLFLT</literal>, input) + </term> + <listitem> + <para> + Ending angle of the arc. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term> + <parameter>fill</parameter> + (<literal>PLBOOL</literal>, input) + </term> + <listitem> + <para> + Draw a filled arc. + </para> + </listitem> + </varlistentry> + </variablelist> + + <para> + Redacted form: + <itemizedlist> + <listitem> + <para> + General: <function>plarc(x, y, a, b, angle1, angle2, fill)</function> + </para> + </listitem> + </itemizedlist> + </para> + + <para> + This function is used in example 3. + </para> + + </sect1> + <sect1 id="plaxes" renderas="sect3"> <title> <function>plaxes</function>: Draw a box with axes, etc. with arbitrary This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site. |
From: <hba...@us...> - 2010-07-02 22:30:18
|
Revision: 11085 http://plplot.svn.sourceforge.net/plplot/?rev=11085&view=rev Author: hbabcock Date: 2010-07-02 22:30:12 +0000 (Fri, 02 Jul 2010) Log Message: ----------- Tweak plarc docs. Add documentation for plfsurf3d. Modified Paths: -------------- trunk/doc/docbook/src/api.xml Modified: trunk/doc/docbook/src/api.xml =================================================================== --- trunk/doc/docbook/src/api.xml 2010-06-30 09:57:53 UTC (rev 11084) +++ trunk/doc/docbook/src/api.xml 2010-07-02 22:30:12 UTC (rev 11085) @@ -368,9 +368,13 @@ </para> <para> - Draw a possible filled arc centered at x,y with - semimajor axis a and semiminor axis b, starting - at angle1 and ending at angle2. + Draw a possible filled arc centered at + <literal><parameter>x</parameter></literal>, + <literal><parameter>y</parameter></literal> with semimajor axis + <literal><parameter>a</parameter></literal> and semiminor axis + <literal><parameter>b</parameter></literal>, starting at + <literal><parameter>angle1</parameter></literal> and ending at + <literal><parameter>angle2</parameter></literal>. </para> <variablelist> @@ -13882,6 +13886,218 @@ </para> <para> + This function is not used in any examples. + </para> + + </sect1> + + <sect1 id="plfsurf3d" renderas="sect3"> + <title> + <function>plfsurf3d</function>: Plot shaded 3-d surface plot + </title> + + <para> + <funcsynopsis> + <funcprototype> + <funcdef> + <function>plsurf3d</function> + </funcdef> + <paramdef><parameter>x</parameter></paramdef> + <paramdef><parameter>y</parameter></paramdef> + <paramdef><parameter>zops</parameter></paramdef> + <paramdef><parameter>zp</parameter></paramdef> + <paramdef><parameter>nx</parameter></paramdef> + <paramdef><parameter>ny</parameter></paramdef> + <paramdef><parameter>opt</parameter></paramdef> + <paramdef><parameter>clevel</parameter></paramdef> + <paramdef><parameter>nlevel</parameter></paramdef> + </funcprototype> + </funcsynopsis> + </para> + + <para> + Plots a three dimensional shaded surface plot within the environment set up + by &plw3d;. The surface is defined by the data contained in the 2D + <literal>PLFLT **</literal> matrix or the <literal>PLfGrid2</literal> structure + <literal><parameter>zp</parameter></literal>. How the data in + <literal><parameter>zp</parameter></literal> is rendered is determined by the + <literal><parameter>zops</parameter></literal> parameter. + <literal><parameter>zops</parameter></literal> is a pointer to a function + that reads the data out of the grid structure. The following functions in + PLplot core will return an appropriate function pointer: + <literal>plf2ops_c()</literal> (use when + <literal><parameter>zp</parameter></literal> is of type + <literal>PLFLT **</literal>), + <literal>plf2ops_grid_c()</literal> (use when + <literal><parameter>zp</parameter></literal> + is a pointer to a row-major <literal>PLfGrid2</literal> structure), + <literal>plf2ops_grid_row_major()</literal> + (same as <literal>plf2ops_grid_c()</literal>?) and + <literal>plf2ops_grid_col_major()</literal> + (use when <literal><parameter>zp</parameter></literal> is a pointer to a + column-major <literal>PLfGrid2</literal> structure). + <literal><parameter>nx</parameter></literal>, + <literal><parameter>ny</parameter></literal> + <literal><parameter>opt</parameter></literal> + <literal><parameter>clevel</parameter></literal> and + <literal><parameter>nlevel</parameter></literal> are the same as in + for example &plsurf3d;. + </para> + + <variablelist> + <varlistentry> + <term> + <parameter>x</parameter> + (<literal>PLFLT *</literal>, input) + </term> + <listitem> + <para> + Pointer to set of x coordinate values at which the function is + evaluated. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term> + <parameter>y</parameter> + (<literal>PLFLT *</literal>, input) + </term> + <listitem> + <para> + Pointer to set of y coordinate values at which the function is + evaluated. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term> + <parameter>zops</parameter> + (<literal>void (*) (?)</literal>, input) + </term> + <listitem> + <para> + Pointer to a function for processing the data contained in zp. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term> + <parameter>zp</parameter> + (<literal>PLFLT ** or PLfGrid2 *</literal>, input) + </term> + <listitem> + <para> + Pointer to the data to be plotted, either as a vectored + two-dimensional array with set of function values, or as + PLfGrid2 structure. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term> + <parameter>nx</parameter> + (<literal>PLINT</literal>, input) + </term> + <listitem> + <para> + Number of <literal><parameter>x</parameter></literal> values at + which function is evaluated. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term> + <parameter>ny</parameter> + (<literal>PLINT</literal>, input) + </term> + <listitem> + <para> + Number of <literal><parameter>y</parameter></literal> values at + which function is evaluated. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term> + <parameter>opt</parameter> + (<literal>PLINT</literal>, input) + </term> + <listitem> + <para> + Determines the way in which the surface is represented. To specify + more than one option just add the options, e.g. FACETED + SURF_CONT + <itemizedlist> + <listitem> + <para> + <literal><parameter>opt</parameter>=FACETED</literal>: Network + of lines is drawn connecting points at which function is + defined. + </para> + </listitem> + <listitem> + <para> + <literal><parameter>opt</parameter>=BASE_CONT</literal>: A contour + plot is drawn at the base XY plane using parameters + <parameter>nlevel</parameter> and <parameter>clevel</parameter>. + </para> + </listitem> + <listitem> + <para> + <literal><parameter>opt</parameter>=SURF_CONT</literal>: A contour + plot is drawn at the surface plane using parameters + <parameter>nlevel</parameter> and <parameter>clevel</parameter>. + </para> + </listitem> + <listitem> + <para> + <literal><parameter>opt</parameter>=DRAW_SIDES</literal>: draws a curtain + between the base XY plane and the borders of the plotted function. + </para> + </listitem> + <listitem> + <para> + <literal><parameter>opt</parameter>=MAG_COLOR</literal>: + the surface is colored according to the value of Z; if + <literal>MAG_COLOR</literal> is not used, then the default + the surface is colored according to the intensity of the + reflected light in the surface from a light source whose + position is set using &pllightsource;. + </para> + </listitem> + </itemizedlist> + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term> + <parameter>clevel</parameter> + (<literal>PLFLT *</literal>, input) + </term> + <listitem> + <para> + Pointer to the array that defines the contour level spacing. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term> + <parameter>nlevel</parameter> + (<literal>PLINT</literal>, input) + </term> + <listitem> + <para> + Number of elements in the <literal>clevel</literal> array. + </para> + </listitem> + </varlistentry> + </variablelist> + + <para> + Redacted form? <function>plfsurf3d(x, y, zops, zp, opt, clevel)</function> + </para> + + <para> This function is used in example 8. </para> This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site. |
From: <hba...@us...> - 2010-09-16 17:43:26
|
Revision: 11189 http://plplot.svn.sourceforge.net/plplot/?rev=11189&view=rev Author: hbabcock Date: 2010-09-16 17:43:20 +0000 (Thu, 16 Sep 2010) Log Message: ----------- Add documentation for plspal0 and plspal1. Modified Paths: -------------- trunk/doc/docbook/src/api.xml Modified: trunk/doc/docbook/src/api.xml =================================================================== --- trunk/doc/docbook/src/api.xml 2010-09-16 17:43:05 UTC (rev 11188) +++ trunk/doc/docbook/src/api.xml 2010-09-16 17:43:20 UTC (rev 11189) @@ -12759,6 +12759,98 @@ </sect1> + <sect1 id="plspal0" renderas="sect3"> + <title> + <function>plspal0</function>: Set the colors for color table 0 + from a cmap0 file + </title> + + <para> + <funcsynopsis> + <funcprototype> + <funcdef> + <function>plspal0</function> + </funcdef> + <paramdef><parameter>filename</parameter></paramdef> + </funcprototype> + </funcsynopsis> + </para> + + <para> + Set the colors for color table 0 from a cmap0 file + </para> + + <variablelist> + <varlistentry> + <term> + <parameter>filename</parameter> + (<literal>const char *</literal>, input) + </term> + <listitem> + <para> + The name of the cmap0 file, or a empty to string to + specify the default cmap0 file. + </para> + </listitem> + </varlistentry> + </variablelist> + + <para> + Redacted form: <function>plspal0(filename)</function> + </para> + + <para> + This function is in example 16. + </para> + + </sect1> + + <sect1 id="plspal1" renderas="sect3"> + <title> + <function>plspal1</function>: Set the colors for color table 1 + from a cmap1 file + </title> + + <para> + <funcsynopsis> + <funcprototype> + <funcdef> + <function>plspal1</function> + </funcdef> + <paramdef><parameter>filename</parameter></paramdef> + </funcprototype> + </funcsynopsis> + </para> + + <para> + Set the colors for color table 1 from a cmap1 file + </para> + + <variablelist> + <varlistentry> + <term> + <parameter>filename</parameter> + (<literal>const char *</literal>, input) + </term> + <listitem> + <para> + The name of the cmap1 file, or a empty to string to + specify the default cmap1 file. + </para> + </listitem> + </varlistentry> + </variablelist> + + <para> + Redacted form: <function>plspal1(filename)</function> + </para> + + <para> + This function is in example 16. + </para> + + </sect1> + <sect1 id="plspause" renderas="sect3"> <title> <function>plspause</function>: Set the pause (on end-of-page) status This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site. |
From: <hba...@us...> - 2010-09-22 15:05:35
|
Revision: 11199 http://plplot.svn.sourceforge.net/plplot/?rev=11199&view=rev Author: hbabcock Date: 2010-09-22 15:05:29 +0000 (Wed, 22 Sep 2010) Log Message: ----------- Add documentation for the plsmema() function. Tweak documentation for the plsmem() function. Modified Paths: -------------- trunk/doc/docbook/src/api.xml Modified: trunk/doc/docbook/src/api.xml =================================================================== --- trunk/doc/docbook/src/api.xml 2010-09-22 14:40:34 UTC (rev 11198) +++ trunk/doc/docbook/src/api.xml 2010-09-22 15:05:29 UTC (rev 11199) @@ -12463,7 +12463,7 @@ <sect1 id="plsmem" renderas="sect3"> <title> - <function>plsmem</function>: Set the memory area to be plotted + <function>plsmem</function>: Set the memory area to be plotted (RGB) </title> <para> @@ -12480,7 +12480,8 @@ </para> <para> - Set the memory area to be plotted (with the <quote>mem</quote> driver) + Set the memory area to be plotted (with the <quote>mem</quote> or + <quote>memcairo</quote> driver) as the <literal>dev</literal> member of the stream structure. Also set the number of pixels in the memory passed in <parameter>plotmem</parameter>, which is a block of memory @@ -12538,6 +12539,83 @@ </sect1> + <sect1 id="plsmema" renderas="sect3"> + <title> + <function>plsmema</function>: Set the memory area to be plotted (RGBA) + </title> + + <para> + <funcsynopsis> + <funcprototype> + <funcdef> + <function>plsmema</function> + </funcdef> + <paramdef><parameter>maxx</parameter></paramdef> + <paramdef><parameter>maxy</parameter></paramdef> + <paramdef><parameter>plotmem</parameter></paramdef> + </funcprototype> + </funcsynopsis> + </para> + + <para> + Set the memory area to be plotted (with the <quote>memcairo</quote> + driver) as the <literal>dev</literal> member of the stream structure. + Also set the number of pixels in the memory passed in + <parameter>plotmem</parameter>, which is a block of memory + <parameter>maxy</parameter> by <parameter>maxx</parameter> by 4 bytes + long, say: 480 x 640 x 4 (Y, X, RGBA) + </para> + + <para> + This memory will have to be freed by the user! + </para> + + <variablelist> + <varlistentry> + <term> + <parameter>maxx</parameter> + (<literal>PLINT</literal>, input) + </term> + <listitem> + <para> + Size of memory area in the X coordinate. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term> + <parameter>maxy</parameter> + (<literal>PLINT</literal>, input) + </term> + <listitem> + <para> + Size of memory area in the Y coordinate. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term> + <parameter>plotmem</parameter> + (<literal>void *</literal>, input) + </term> + <listitem> + <para> + Pointer to the beginning of the user-supplied memory area. + </para> + </listitem> + </varlistentry> + </variablelist> + + <para> + Redacted form: <function>plsmema(maxx, maxy, plotmem)</function> + </para> + + <para> + This function is not used in any examples. + </para> + + </sect1> + <sect1 id="plsmin" renderas="sect3"> <title> <function>plsmin</function>: Set length of minor ticks This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site. |
From: <ai...@us...> - 2010-10-02 22:11:12
|
Revision: 11239 http://plplot.svn.sourceforge.net/plplot/?rev=11239&view=rev Author: airwin Date: 2010-10-02 22:11:06 +0000 (Sat, 02 Oct 2010) Log Message: ----------- Add (DocBook) documentation of pllegend. Modified Paths: -------------- trunk/doc/docbook/src/api.xml Modified: trunk/doc/docbook/src/api.xml =================================================================== --- trunk/doc/docbook/src/api.xml 2010-10-01 21:12:14 UTC (rev 11238) +++ trunk/doc/docbook/src/api.xml 2010-10-02 22:11:06 UTC (rev 11239) @@ -3,7 +3,7 @@ api.xml: "The Common API for PLplot" chapter Copyright (C) 1994 Geoffrey Furnish and Maurice LeBrun -Copyright (C) 1999, 2000, 2001, 2002, 2003, 2004, 2008 Alan W. Irwin +Copyright (C) 1999-2010 Alan W. Irwin Copyright (C) 1999, 2000, 2001, 2002, 2003, 2004 Rafael Laboissiere Copyright (C) 2003 Joao Cardoso Copyright (C) 2004, 2007 Andrew Ross @@ -6298,6 +6298,380 @@ </sect1> + <sect1 id="pllegend" renderas="sect3"> + <title> + <function>pllegend</function>: Create a discrete annotated legend using + boxes, lines, and/or lines of symbols + </title> + + <para> + <funcsynopsis> + <funcprototype> + <funcdef> + <function>pllegend</function> + </funcdef> + <paramdef><parameter>opt</parameter></paramdef> + <paramdef><parameter>x</parameter></paramdef> + <paramdef><parameter>y</parameter></paramdef> + <paramdef><parameter>plot_width</parameter></paramdef> + <paramdef><parameter>bg_color</parameter></paramdef> + <paramdef><parameter>nlegend</parameter></paramdef> + <paramdef><parameter>opt_array</parameter></paramdef> + <paramdef><parameter>text_offset</parameter></paramdef> + <paramdef><parameter>text_scale</parameter></paramdef> + <paramdef><parameter>text_spacing</parameter></paramdef> + <paramdef><parameter>test_justification</parameter></paramdef> + <paramdef><parameter>text_colors</parameter></paramdef> + <paramdef><parameter>text</parameter></paramdef> + <paramdef><parameter>box_colors</parameter></paramdef> + <paramdef><parameter>box_patterns</parameter></paramdef> + <paramdef><parameter>box_scales</parameter></paramdef> + <paramdef><parameter>line_colors</parameter></paramdef> + <paramdef><parameter>line_styles</parameter></paramdef> + <paramdef><parameter>line_widths</parameter></paramdef> + <paramdef><parameter>symbol_colors</parameter></paramdef> + <paramdef><parameter>symbol_scales</parameter></paramdef> + <paramdef><parameter>symbol_numbers</parameter></paramdef> + <paramdef><parameter>symbols</parameter></paramdef> + </funcprototype> + </funcsynopsis> + </para> + + <para> + (N.B. This is an experimental API that may be subject to further + change as we gain more experience with it.) Routine for creating a + discrete plot legend with a plotted box, line, and/or line of symbols + for each annotated legend entry. The arguments of pllegend provide + control over the location and size of the legend within the current + subpage as well as the location and characteristics of the elements + (most of which are optional) within that legend. The resulting legend + is clipped at the boundaries of the current subpage + </para> + <variablelist> + <varlistentry> + <term> + <parameter>opt</parameter> + (<literal>PLINT</literal>, input) + </term> + <listitem> + <para> + <parameter>opt</parameter> contains bits controlling the + overall legend. If the <parameter>PL_LEGEND_BACKGROUND</parameter> + bit is set, plot a (semi-transparent) background for the legend. If + the <parameter>PL_LEGEND_TEXT_LEFT</parameter> bit is set, put the + text area on the left of the legend and the plotted area on the right. + Otherwise, put the text area on the right of the legend and the + plotted area on the left. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term> + <parameter>x</parameter> + (<literal>PLFLT</literal>, input) + </term> + <listitem> + <para> + Normalized sub-page X position of the upper-left corner of + the legend. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term> + <parameter>y</parameter> + (<literal>PLFLT</literal>, input) + </term> + <listitem> + <para> + Normalized sub-page Y position of the upper-left corner of + the legend. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term> + <parameter>plot_width</parameter> + (<literal>PLFLT</literal>, input) + </term> + <listitem> + <para> + Horizontal width in normalized subpage units of the plot + area (where the rectangular boxes, lines, and/or lines of symbols are + drawn) of the legend. N.B. The total horizontal width of the legend + in normalized subpage coordinates is calculated internally + from <parameter>plot_width</parameter>, + <parameter>text_offset</parameter> (see below), and length (calculated + internally) of the longest text string. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term> + <parameter>bg_color</parameter> + (<literal>PLINT</literal>, input) + </term> + <listitem> + <para> + The cmap0 index of the background color for the legend + (<parameter>PL_LEGEND_BACKGROUND</parameter>). + </para> + </listitem> + </varlistentry> + <varlistentry> + <term> + <parameter>nlegend</parameter> + (<literal>PLINT</literal>, input) + </term> + <listitem> + <para> + Number of legend entries. N.B. The total vertical height + of the legend in normalized subpage coordinates is + calculated internally from <parameter>nlegend</parameter>, + <parameter>text_scale</parameter> (see below), and + <parameter>text_spacing</parameter> (see below). + </para> + </listitem> + </varlistentry> + <varlistentry> + <term> + <parameter>opt_array</parameter> + (<literal>const PLINT *</literal>, input) + </term> + <listitem> + <para> + Array of nlegend values of options to control each + individual plotted area corresponding to a legend entry. If the + <parameter>PL_LEGEND_NONE</parameter> bit is set, then nothing is + plotted in the plotted area. If the + <parameter>PL_LEGEND_COLOR_BOX</parameter>, + <parameter>PL_LEGEND_LINE</parameter>, and/or + <parameter>PL_LEGEND_SYMBOL</parameter> bits are set, the area + corresponding to a legend entry is plotted with a colored box; a line; + and/or a line of symbols. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term> + <parameter>text_offset</parameter> + (<literal>PLFLT</literal>, input) + </term> + <listitem> + <para> + Offset of the text area from the plot area in units of + character width. N.B. The total horizontal width of the legend in + normalized subpage coordinates is calculated internally from + <parameter>plot_width</parameter> (see above), + <parameter>text_offset</parameter>, and length (calculated internally) + of the longest text string. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term> + <parameter>text_scale</parameter> + (<literal>PLFLT</literal>, input) + </term> + <listitem> + <para> + Character height scale for text annotations. N.B. The + total vertical height of the legend in normalized subpage coordinates + is calculated internally from <parameter>nlegend</parameter> (see + above), <parameter>text_scale</parameter>, and + <parameter>text_spacing</parameter> (see below). + </para> + </listitem> + </varlistentry> + <varlistentry> + <term> + <parameter>text_spacing</parameter> + (<literal>PLFLT</literal>, input) + </term> + <listitem> + <para> + Vertical spacing in units of the character height from one + legend entry to the next. N.B. The total vertical height of the + legend in normalized subpage coordinates is calculated internally from + <parameter>nlegend</parameter> (see above), + <parameter>text_scale</parameter> (see above), and + <parameter>text_spacing</parameter>. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term> + <parameter>text_justification</parameter> + (<literal>PLFLT</literal>, input) + </term> + <listitem> + <para> + Justification parameter used for text justification. The most common + values of text_justification are 0., 0.5, or 1. corresponding to a + text that is left justified, centred, or right justified within the + text area, but other values are allowed as well. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term> + <parameter>text_colors</parameter> + (<literal>const PLINT *</literal>, input) + </term> + <listitem> + <para> + Array of nlegend text colors (cmap0 indices). + </para> + </listitem> + </varlistentry> + <varlistentry> + <term> + <parameter>text</parameter> + (<literal>const char **</literal>, input) + </term> + <listitem> + <para> + Array of nlegend text string annotations. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term> + <parameter>box_colors</parameter> + (<literal>const PLINT *</literal>, input) + </term> + <listitem> + <para> + Array of nlegend colors (cmap0 indices) for the discrete colored boxes + (<parameter>PL_LEGEND_COLOR_BOX</parameter>). + </para> + </listitem> + </varlistentry> + <varlistentry> + <term> + <parameter>box_patterns</parameter> + (<literal>const PLINT *</literal>, input) + </term> + <listitem> + <para> + Array of nlegend patterns (plpsty indices) for the discrete colored + boxes (<parameter>PL_LEGEND_COLOR_BOX</parameter>). + </para> + </listitem> + </varlistentry> + <varlistentry> + <term> + <parameter>box_scales</parameter> + (<literal>const PLFLT *</literal>, input) + </term> + <listitem> + <para> + Array of nlegend scales (units of fraction of character height) for + the height of the discrete colored boxes + (<parameter>PL_LEGEND_COLOR_BOX</parameter>). + </para> + </listitem> + </varlistentry> + <varlistentry> + <term> + <parameter>line_colors</parameter> + (<literal>const PLINT *</literal>, input) + </term> + <listitem> + <para> + Array of nlegend line colors (cmap0 indices) + (<parameter>PL_LEGEND_LINE</parameter>). + </para> + </listitem> + </varlistentry> + <varlistentry> + <term> + <parameter>line_styles</parameter> + (<literal>const PLINT *</literal>, input) + </term> + <listitem> + <para> + Array of nlegend line styles (plsty indices) + (<parameter>PL_LEGEND_LINE</parameter>). + </para> + </listitem> + </varlistentry> + <varlistentry> + <term> + <parameter>line_widths</parameter> + (<literal>const PLINT *</literal>, input) + </term> + <listitem> + <para> + Array of nlegend line widths + (<parameter>PL_LEGEND_LINE</parameter>). + </para> + </listitem> + </varlistentry> + <varlistentry> + <term> + <parameter>symbol_colors</parameter> + (<literal>const PLINT *</literal>, input) + </term> + <listitem> + <para> + Array of nlegend symbol colors (cmap0 indices) + (<parameter>PL_LEGEND_SYMBOL</parameter>). + </para> + </listitem> + </varlistentry> + <varlistentry> + <term> + <parameter>symbol_scales</parameter> + (<literal>const PLFLT *</literal>, input) + </term> + <listitem> + <para> + Array of nlegend scale values for the symbol height + (<parameter>PL_LEGEND_SYMBOL</parameter>). + </para> + </listitem> + </varlistentry> + <varlistentry> + <term> + <parameter>symbol_numbers</parameter> + (<literal>const PLINT *</literal>, input) + </term> + <listitem> + <para> + Array of nlegend numbers of symbols to be drawn across the width of + the plotted area (<parameter>PL_LEGEND_SYMBOL</parameter>). + </para> + </listitem> + </varlistentry> + <varlistentry> + <term> + <parameter>symbols</parameter> + (<literal>const PLINT *</literal>, input) + </term> + <listitem> + <para> + Array of nlegend symbols (plpoin indices) + (<parameter>PL_LEGEND_SYMBOL</parameter>). + </para> + </listitem> + </varlistentry> + </variablelist> + + <para> + Redacted form: <function>pllegend(opt, x, y, plot_width, + bg_color, opt_array, text_offset, text_scale, text_spacing, + test_justification, text_colors, text, box_colors, box_patterns, + box_scales, line_colors, line_styles, line_widths, symbol_colors, + symbol_scales, symbol_numbers, symbols)</function> + </para> + + <para> + This function is used in examples 4 and 26. + </para> + + </sect1> + <sect1 id="pllightsource" renderas="sect3"> <title> <function>pllightsource</function>: Sets the 3D position of the light This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site. |
From: <ai...@us...> - 2011-03-11 00:09:08
|
Revision: 11615 http://plplot.svn.sourceforge.net/plplot/?rev=11615&view=rev Author: airwin Date: 2011-03-11 00:09:02 +0000 (Fri, 11 Mar 2011) Log Message: ----------- Interim update of pllegend documentation. Modified Paths: -------------- trunk/doc/docbook/src/api.xml Modified: trunk/doc/docbook/src/api.xml =================================================================== --- trunk/doc/docbook/src/api.xml 2011-03-10 18:46:33 UTC (rev 11614) +++ trunk/doc/docbook/src/api.xml 2011-03-11 00:09:02 UTC (rev 11615) @@ -6300,8 +6300,7 @@ <sect1 id="pllegend" renderas="sect3"> <title> - <function>pllegend</function>: Create a discrete annotated legend using - colored boxes, lines, and/or lines of symbols + <function>pllegend</function>: Plot legend using discretely annotated filled boxes, lines, and/or symbols </title> <para> @@ -6312,6 +6311,7 @@ </funcdef> <paramdef><parameter>p_legend_width</parameter></paramdef> <paramdef><parameter>p_legend_height</parameter></paramdef> + <paramdef><parameter>position</parameter></paramdef> <paramdef><parameter>opt</parameter></paramdef> <paramdef><parameter>x</parameter></paramdef> <paramdef><parameter>y</parameter></paramdef> @@ -6345,12 +6345,15 @@ </para> <para> - Routine for creating a discrete plot legend with a plotted + Routine for creating a discrete plot legend with a plotted filled box, line, and/or line of symbols for each annotated legend entry. The arguments of pllegend provide control over the location and size of the legend as well as the location and characteristics of the elements (most of which are optional) within that legend. The resulting legend is clipped at the boundaries of the current subpage. + (N.B. the adopted coordinate system used for some of the parameters is + defined in the documentation of the + <literal><parameter>position</parameter></literal> parameter.) </para> <variablelist> <varlistentry> @@ -6361,8 +6364,8 @@ <listitem> <para> Pointer to a location which contains (after the call) the - legend width in normalized viewport coordinates. This quantity is - calculated from <literal><parameter>plot_width</parameter></literal>. + legend width in adopted coordinates. This quantity is + calculated from <literal><parameter>plot_width</parameter></literal>, <literal><parameter>text_offset</parameter></literal>, <literal><parameter>ncolumn</parameter></literal> (possibly modified inside the routine depending on @@ -6380,7 +6383,7 @@ <listitem> <para> Pointer to a location which contains (after the call) the - legend height in normalized viewport coordinates. This quantity is + legend height in adopted coordinates. This quantity is calculated from <literal><parameter>text_scale</parameter></literal>, <literal><parameter>text_spacing</parameter></literal>, and <literal><parameter>nrow</parameter></literal> (possibly modified @@ -6392,6 +6395,43 @@ </varlistentry> <varlistentry> <term> + <parameter>position</parameter> + (<literal>PLINT</literal>, input) + </term> + <listitem> + <para> + <literal><parameter>position</parameter></literal> + contains bits controlling the overall position of the legend and the + definition of the adopted coordinates used for positions. The + combination of the <literal>PL_POSITION_LEFT</literal>, + <literal>PL_POSITION_RIGHT</literal>, + <literal>PL_POSITION_TOP</literal>, + <literal>PL_POSITION_BOTTOM</literal>, + <literal>PL_POSITION_INSIDE</literal>, and + <literal>PL_POSITION_OUTSIDE</literal> bits specifies one of the 16 + possible standard positions (the 4 corners and 4 side centers for both + the inside and outside cases) of the legend relative to the adopted + coordinate system. The adopted coordinates are normalized viewport + coordinates if the <literal>PL_POSITION_VIEWPORT</literal> bit is set + or normalized subpage coordinates if the + <literal>PL_POSITION_SUBPAGE</literal> bit is set. Default position + bits: If none of <literal>PL_POSITION_LEFT</literal>, + <literal>PL_POSITION_RIGHT</literal>, + <literal>PL_POSITION_TOP</literal>, or + <literal>PL_POSITION_BOTTOM</literal> are set, then use the + combination of <literal>PL_POSITION_RIGHT</literal> and + <literal>PL_POSITION_TOP</literal>. If neither of + <literal>PL_POSITION_INSIDE</literal> or + <literal>PL_POSITION_OUTSIDE</literal> is set, use + <literal>PL_POSITION_INSIDE</literal>. If neither of + <literal>PL_POSITION_VIEWPORT</literal> or + <literal>PL_POSITION_SUBPAGE</literal> is set, use + <literal>PL_POSITION_VIEWPORT</literal>. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term> <parameter>opt</parameter> (<literal>PLINT</literal>, input) </term> @@ -6407,19 +6447,10 @@ (semi-transparent) background for the legend. If the <literal>PL_LEGEND_BOUNDING_BOX</literal> bit is set, plot a bounding box for the legend. If the <literal>PL_LEGEND_ROW_MAJOR</literal> bit - is set and both of (possibly internally transformed) + is set and (both of the possibly internally transformed) <literal><parameter>nrow</parameter></literal> > 1 and <literal><parameter>ncolumn</parameter></literal> > 1, then plot - the resulting array of legend entries in row-major order. Finally, the - combination of the <literal>PL_LEGEND_LEFT</literal>, - <literal>PL_LEGEND_RIGHT</literal>, - <literal>PL_LEGEND_UPPER</literal>, - <literal>PL_LEGEND_LOWER</literal>, - <literal>PL_LEGEND_INSIDE</literal>, and - <literal>PL_LEGEND_OUTSIDE</literal> position bits specifies one of - the 16 possible standard positions (the 4 corners and 4 side centers - for both the inside and outside cases) of the legend relative to the - viewport. + the resulting array of legend entries in row-major order. </para> </listitem> </varlistentry> @@ -6430,14 +6461,15 @@ </term> <listitem> <para> - X offset of the legend position in normalized viewport - coordinates from the specified standard position of the legend. For - positive x, the direction of motion away from the standard position is - inward/outward from the standard corner positions or standard - center-left or center-right positions if the - <literal>PL_LEGEND_INSIDE</literal>/<literal>PL_LEGEND_OUTSIDE</literal> - bit is set in opt. For the center-upper or center-lower cases, the - direction of motion is toward positive X. + X offset of the legend position in adopted coordinates + from the specified standard position of the legend. For positive x, + the direction of motion away from the standard position is + inward/outward from the standard corner positions or standard left or + right positions if the + <literal>PL_POSITION_INSIDE</literal>/<literal>PL_POSITION_OUTSIDE</literal> + bit is set in <literal><parameter>position</parameter></literal>. For + the standard top or bottom positions, the direction of motion is toward + positive X. </para> </listitem> </varlistentry> @@ -6448,13 +6480,14 @@ </term> <listitem> <para> - Y offset of the legend position in normalized viewport - coordinates from the specified standard position of the legend. For - positive y, the direction of motion away from the standard position is + Y offset of the legend position in adopted coordinates + from the specified standard position of the legend. For positive y, + the direction of motion away from the standard position is inward/outward from the standard corner positions or standard - center-upper or center-lower positions if the - <literal>PL_LEGEND_INSIDE</literal>/<literal>PL_LEGEND_OUTSIDE</literal> - bit is set in opt. For the center-left or center-right cases, the + top or bottom positions if the + <literal>PL_POSITION_INSIDE</literal>/<literal>PL_POSITION_OUTSIDE</literal> + bit is set in <literal><parameter>position</parameter></literal>. + For the standard left or right positions, the direction of motion is toward positive Y. </para> </listitem> @@ -6466,9 +6499,9 @@ </term> <listitem> <para> - Horizontal width in normalized viewport units of the plot - area (where the colored boxes, lines, and/or lines of symbols are - drawn) of the legend. + Horizontal width in adopted coordinates of the plot area + (where the colored boxes, lines, and/or lines of symbols are drawn) of + the legend. </para> </listitem> </varlistentry> @@ -6491,7 +6524,7 @@ </term> <listitem> <para> - cmap0 index of the color of the bounding-box line for the legend + The cmap0 index of the color of the bounding-box line for the legend (<literal>PL_LEGEND_BOUNDING_BOX</literal>). </para> </listitem> @@ -6539,8 +6572,8 @@ </term> <listitem> <para> - Number of legend entries.N.B. The total vertical height - of the legend in normalized subpage coordinates is calculated + Number of legend entries. N.B. The total vertical height + of the legend in adopted coordinates is calculated internally from <literal><parameter>nlegend</parameter></literal>, <literal><parameter>text_scale</parameter></literal> (see below), and <literal><parameter>text_spacing</parameter></literal> (see below). @@ -6575,7 +6608,7 @@ <para> Offset of the text area from the plot area in units of character width. N.B. The total horizontal width of the legend in - normalized subpage coordinates is calculated internally from + adopted coordinates is calculated internally from <parameter>plot_width</parameter> (see above), <parameter>text_offset</parameter>, and length (calculated internally) of the longest text string. @@ -6590,7 +6623,7 @@ <listitem> <para> Character height scale for text annotations. N.B. The - total vertical height of the legend in normalized subpage coordinates + total vertical height of the legend in adopted coordinates is calculated internally from <parameter>nlegend</parameter> (see above), <parameter>text_scale</parameter>, and <parameter>text_spacing</parameter> (see below). @@ -6606,7 +6639,7 @@ <para> Vertical spacing in units of the character height from one legend entry to the next. N.B. The total vertical height of the - legend in normalized subpage coordinates is calculated internally from + legend in adopted coordinates is calculated internally from <parameter>nlegend</parameter> (see above), <parameter>text_scale</parameter> (see above), and <parameter>text_spacing</parameter>. This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site. |