Boost-Commit :

Date view	Thread view	Subject view	Author view

From: pbristow_at_[hidden]
Date: 2008-01-23 16:45:51

Next message: ahd6974-boostorg_at_[hidden]: "[Boost-commit] svn:boost r42934 - trunk/libs/statechart/example/Performance"
Previous message: pbristow_at_[hidden]: "[Boost-commit] svn:boost r42932 - in sandbox/SOC/2007/visualization/boost/svg_plot: . detail"

Author: pbristow
Date: 2008-01-23 16:45:50 EST (Wed, 23 Jan 2008)
New Revision: 42933
URL: http://svn.boost.org/trac/boost/changeset/42933

Log:
Added some style descriptions. Text_ style and others TODO
Text files modified:
   sandbox/SOC/2007/visualization/libs/svg_plot/doc/html/index.html | 2
   sandbox/SOC/2007/visualization/libs/svg_plot/doc/html/svg_plot/interface/svg_1d_plot_interface.html | 18
   sandbox/SOC/2007/visualization/libs/svg_plot/doc/html/svg_plot/interface/svg_2d_plot_interface.html | 27
   sandbox/SOC/2007/visualization/libs/svg_plot/doc/html/svg_plot/interface/svg_boxplot_interface.html | 1688 +++++++++++++++++++++++++++++++++++++++
   sandbox/SOC/2007/visualization/libs/svg_plot/doc/html/svg_plot/interface/svg_interface.html | 456 ++++++++--
   sandbox/SOC/2007/visualization/libs/svg_plot/doc/interface.qbk | 257 +++++
   6 files changed, 2298 insertions(+), 150 deletions(-)

Modified: sandbox/SOC/2007/visualization/libs/svg_plot/doc/html/index.html
==============================================================================
--- sandbox/SOC/2007/visualization/libs/svg_plot/doc/html/index.html (original)
+++ sandbox/SOC/2007/visualization/libs/svg_plot/doc/html/index.html 2008-01-23 16:45:50 EST (Wed, 23 Jan 2008)
@@ -96,7 +96,7 @@
</div>
</div>
<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
-<td align="left">Last revised: January 18, 2008 at 09:53:10 GMT</td>
+<td align="left">Last revised: January 23, 2008 at 19:43:00 GMT</td>
<td align="right"><div class="copyright-footer"></div></td>
</tr></table>
<hr>

Modified: sandbox/SOC/2007/visualization/libs/svg_plot/doc/html/svg_plot/interface/svg_1d_plot_interface.html
==============================================================================
--- sandbox/SOC/2007/visualization/libs/svg_plot/doc/html/svg_plot/interface/svg_1d_plot_interface.html (original)
+++ sandbox/SOC/2007/visualization/libs/svg_plot/doc/html/svg_plot/interface/svg_1d_plot_interface.html 2008-01-23 16:45:50 EST (Wed, 23 Jan 2008)
@@ -28,7 +28,7 @@
<a name="svg_plot.interface.svg_1d_plot_interface"></a> svg_1d_plot Public Interface
</h3></div></div></div>
<div class="table">
-<a name="id696024"></a>Table 7. 1D_plot Miscellaneous Functions
+<a name="id697440"></a>Table 8. 1D_plot Miscellaneous Functions
<div class="table-contents"><table class="table" summary="1D_plot Miscellaneous Functions">
<colgroup>
<col>
@@ -211,7 +211,7 @@
</table></div>
</div>
 <div class="table">
-<a name="id696862"></a>Table 8. 1D_plot Commands
+<a name="id698278"></a>Table 9. 1D_plot Commands
<div class="table-contents"><table class="table" summary="1D_plot Commands">
<colgroup>
<col>
@@ -379,7 +379,7 @@
</table></div>
</div>
 <div class="table">
-<a name="id697550"></a>Table 9. 1D_plot Colors
+<a name="id698966"></a>Table 10. 1D_plot Colors
<div class="table-contents"><table class="table" summary="1D_plot Colors">
<colgroup>
<col>
@@ -587,7 +587,7 @@
</table></div>
</div>
 <div class="table">
-<a name="id698612"></a>Table 10. 1D_plot X-Axis Definition
+<a name="id700028"></a>Table 11. 1D_plot X-Axis Definition
<div class="table-contents"><table class="table" summary="1D_plot X-Axis Definition">
<colgroup>
<col>
@@ -729,7 +729,7 @@
</table></div>
</div>
 <a name="svg_plot.interface.svg_1d_plot_interface.the_1d_plot__code__phrase_role__identifier__plot__phrase__phrase_role__special______phrase___code__method"></a><h5>
-<a name="id699275"></a>
+<a name="id700691"></a>
 <a href="svg_1d_plot_interface.html#svg_plot.interface.svg_1d_plot_interface.the_1d_plot__code__phrase_role__identifier__plot__phrase__phrase_role__special______phrase___code__method">The
 1D_plot <code class="computeroutput">plot()</code>
 Method</a>
@@ -740,7 +740,7 @@
 named parameters, as well as a deduced parameter.
 
<div class="table">
-<a name="id699334"></a>Table 11. 1D_plot Required parameter
+<a name="id700750"></a>Table 12. 1D_plot Required parameter
<div class="table-contents"><table class="table" summary="1D_plot Required parameter">
<colgroup>
<col>
@@ -803,7 +803,7 @@
</table></div>
</div>
 <div class="table">
-<a name="id699455"></a>Table 12. 1D_plot Deduced parameter
+<a name="id700871"></a>Table 13. 1D_plot Deduced parameter
<div class="table-contents"><table class="table" summary="1D_plot Deduced parameter">
<colgroup>
<col>
@@ -859,7 +859,7 @@
</table></div>
</div>
 <div class="table">
-<a name="id699562"></a>Table 13. 1D_plot Optional Parameters
+<a name="id700978"></a>Table 14. 1D_plot Optional Parameters
<div class="table-contents"><table class="table" summary="1D_plot Optional Parameters">
<colgroup>
<col>
@@ -1010,7 +1010,7 @@
 method:
 
<a name="svg_plot.interface.svg_1d_plot_interface.using_1d_plot_fill_and_stroke_colors"></a><h5>
-<a name="id700114"></a>
+<a name="id701530"></a>
 <a href="svg_1d_plot_interface.html#svg_plot.interface.svg_1d_plot_interface.using_1d_plot_fill_and_stroke_colors">Using
 1D_plot fill and stroke colors</a>
 </h5>

Modified: sandbox/SOC/2007/visualization/libs/svg_plot/doc/html/svg_plot/interface/svg_2d_plot_interface.html
==============================================================================
--- sandbox/SOC/2007/visualization/libs/svg_plot/doc/html/svg_plot/interface/svg_2d_plot_interface.html (original)
+++ sandbox/SOC/2007/visualization/libs/svg_plot/doc/html/svg_plot/interface/svg_2d_plot_interface.html 2008-01-23 16:45:50 EST (Wed, 23 Jan 2008)
@@ -27,7 +27,7 @@
<a name="svg_plot.interface.svg_2d_plot_interface"></a> svg_2d_plot Public Interface
</h3></div></div></div>
<div class="table">
-<a name="id700268"></a>Table 14. 2D_plot Miscellaneous
+<a name="id701684"></a>Table 15. 2D_plot Miscellaneous
<div class="table-contents"><table class="table" summary="2D_plot Miscellaneous">
<colgroup>
<col>
@@ -115,7 +115,7 @@
</table></div>
</div>
 <div class="table">
-<a name="id700626"></a>Table 15. 2D_plot Commands
+<a name="id702042"></a>Table 16. 2D_plot Commands
<div class="table-contents"><table class="table" summary="2D_plot Commands">
<colgroup>
<col>
@@ -432,7 +432,7 @@
</table></div>
</div>
 <div class="table">
-<a name="id701902"></a>Table 16. 2D_plot Colors
+<a name="id703322"></a>Table 17. 2D_plot Colors
<div class="table-contents"><table class="table" summary="2D_plot Colors">
<colgroup>
<col>
@@ -683,7 +683,7 @@
</table></div>
</div>
 <div class="table">
-<a name="id703191"></a>Table 17. 2D_plot Axis Information
+<a name="id704611"></a>Table 18. 2D_plot Axis Information
<div class="table-contents"><table class="table" summary="2D_plot Axis Information">
<colgroup>
<col>
@@ -973,7 +973,7 @@
 preceeding code).
 
<a name="svg_plot.interface.svg_2d_plot_interface.the__code__phrase_role__identifier__plot__phrase__phrase_role__special______phrase___code__method"></a><h5>
-<a name="id704593"></a>
+<a name="id706014"></a>
 <a href="svg_2d_plot_interface.html#svg_plot.interface.svg_2d_plot_interface.the__code__phrase_role__identifier__plot__phrase__phrase_role__special______phrase___code__method">The
 <code class="computeroutput">plot()</code>
 Method</a>
@@ -984,7 +984,7 @@
 named parameters, as well as a deduced parameter.
 
<div class="table">
-<a name="id704653"></a>Table 18. 2D_plot Required parameter
+<a name="id706074"></a>Table 19. 2D_plot Required parameter
<div class="table-contents"><table class="table" summary="2D_plot Required parameter">
<colgroup>
<col>
@@ -1022,7 +1022,7 @@
 </td>
<td>
 
- Any object that can return an iterator with begin() and end()
+ Any object that can return an iterator with begin() and end().
 
 </td>
</tr>
@@ -1039,7 +1039,7 @@
 </td>
<td>
 
- The name of this series
+ The name of this series.
 
 </td>
</tr>
@@ -1047,7 +1047,7 @@
</table></div>
</div>
 <div class="table">
-<a name="id704775"></a>Table 19. 2D_plot Deduced parameter
+<a name="id706195"></a>Table 20. 2D_plot Deduced parameter
<div class="table-contents"><table class="table" summary="2D_plot Deduced parameter">
<colgroup>
<col>
@@ -1080,7 +1080,7 @@
<tbody><tr>
<td>
 
- _fill_color
+ fill_color
 
 </td>
<td>
@@ -1090,8 +1090,7 @@
 </td>
<td>
 
- This is the color that shows up inside of the circle that is being
- drawn
+ This is the color that shows inside of the circle that is being drawn.
 
 </td>
<td>
@@ -1103,7 +1102,7 @@
</table></div>
</div>
 <div class="table">
-<a name="id704875"></a>Table 20. 2D_plot Optional Parameters
+<a name="id706295"></a>Table 21. 2D_plot Optional Parameters
<div class="table-contents"><table class="table" summary="2D_plot Optional Parameters">
<colgroup>
<col>
@@ -1338,7 +1337,7 @@
 Here are some examples of correct uses:
 
<a name="svg_plot.interface.svg_2d_plot_interface.using_fill_and_stroke_colors"></a><h4>
-<a name="id705680"></a>
+<a name="id707100"></a>
 <a href="svg_2d_plot_interface.html#svg_plot.interface.svg_2d_plot_interface.using_fill_and_stroke_colors">Using
 fill and stroke colors</a>
 </h4>

Modified: sandbox/SOC/2007/visualization/libs/svg_plot/doc/html/svg_plot/interface/svg_boxplot_interface.html
==============================================================================
--- sandbox/SOC/2007/visualization/libs/svg_plot/doc/html/svg_plot/interface/svg_boxplot_interface.html (original)
+++ sandbox/SOC/2007/visualization/libs/svg_plot/doc/html/svg_plot/interface/svg_boxplot_interface.html 2008-01-23 16:45:50 EST (Wed, 23 Jan 2008)
@@ -27,7 +27,7 @@
<a name="svg_plot.interface.svg_boxplot_interface"></a> svg_boxplot Public Interface
</h3></div></div></div>
<div class="table">
-<a name="id705824"></a>Table 21. Boxplot Miscellaneous
+<a name="id707244"></a>Table 22. Boxplot Miscellaneous
<div class="table-contents"><table class="table" summary="Boxplot Miscellaneous">
<colgroup>
<col>
@@ -102,7 +102,7 @@
</table></div>
</div>
 <div class="table">
-<a name="id706118"></a>Table 22. Boxplot Commands
+<a name="id707538"></a>Table 23. Boxplot Commands
<div class="table-contents"><table class="table" summary="Boxplot Commands">
<colgroup>
<col>
@@ -190,7 +190,7 @@
</table></div>
</div>
 <div class="table">
-<a name="id706447"></a>Table 23. Boxplot Colors
+<a name="id707868"></a>Table 24. Boxplot Colors
<div class="table-contents"><table class="table" summary="Boxplot Colors">
<colgroup>
<col>
@@ -341,7 +341,7 @@
</table></div>
</div>
 <div class="table">
-<a name="id707180"></a>Table 24. Boxplot Axis Information
+<a name="id708600"></a>Table 25. Boxplot Axis Information
<div class="table-contents"><table class="table" summary="Boxplot Axis Information">
<colgroup>
<col>
@@ -527,19 +527,19 @@
 These allow one to check the current value (default if not changed by the
 preceeding code).
 
-<a name="svg_plot.interface.svg_boxplot_interface.the__code__phrase_role__identifier__plot__phrase__phrase_role__special______phrase___code__method"></a><h5>
-<a name="id708084"></a>
- <a href="svg_boxplot_interface.html#svg_plot.interface.svg_boxplot_interface.the__code__phrase_role__identifier__plot__phrase__phrase_role__special______phrase___code__method">The
+<a name="svg_plot.interface.svg_boxplot_interface.the__code__phrase_role__identifier__plot__phrase__phrase_role__special______phrase___code__function"></a><h5>
+<a name="id709504"></a>
+ <a href="svg_boxplot_interface.html#svg_plot.interface.svg_boxplot_interface.the__code__phrase_role__identifier__plot__phrase__phrase_role__special______phrase___code__function">The
 <code class="computeroutput">plot()</code>
- Method</a>
+ Function</a>
 </h5>

 The <code class="computeroutput">plot()</code>
- method allows data series parameters and further chained functions to control
- their display.
+ function allows data series parameters, and further chained functions to
+ control their display.
 
<div class="table">
-<a name="id708144"></a>Table 25. Required parameters
+<a name="id709564"></a>Table 26. Required parameters
<div class="table-contents"><table class="table" summary="Required parameters">
<colgroup>
<col>
@@ -602,7 +602,7 @@
</table></div>
</div>
 <div class="table">
-<a name="id708265"></a>Table 26. Optional Functions
+<a name="id709685"></a>Table 27. Optional Functions
<div class="table-contents"><table class="table" summary="Optional Functions">
<colgroup>
<col>
@@ -894,6 +894,1670 @@
</tbody>
</table></div>
</div>
+ <a name="svg_plot.interface.svg_boxplot_interface.styles_providing_addition_control"></a><h5>
+<a name="id710830"></a>
+ <a href="svg_boxplot_interface.html#svg_plot.interface.svg_boxplot_interface.styles_providing_addition_control">Styles
+ providing addition control</a>
+ </h5>
+
+ Several style classes are used internally but are available for external
+ use too. For most applications the functions listed above will provide enough
+ control, but styles are documented here:
+ 
+<pre class="programlisting">
+class svg_style;
+class text_style; // Font, size, etc parameters of text like title, legend, labels ...
+class plot_point_style; // Parameters of points maarking data series values.
+class plot_line_style; // Parameters of lines joining data series values.
+class axis_line_style; // Parameters of the axes.
+class ticks_labels_style; // Parameters of the axis, grids, & ticks and their value labels.
+</pre>
+<a name="svg_plot.interface.svg_boxplot_interface.box_style_defines_a_rectangular_box_"></a><h4>
+<a name="id711011"></a>
+ <a href="svg_boxplot_interface.html#svg_plot.interface.svg_boxplot_interface.box_style_defines_a_rectangular_box_">Box
+ Style defines a rectangular box.</a>
+ </h4>
+
+ A box has a border and may be filled with the same or different colors.
+ 
+<pre class="programlisting">
+class box_style
+{ // Style of a rectangular box.
+ // Use for image and plot window.
+public:
+ svg_color stroke_; // Box line stroke color.
+ svg_color fill_; // Box fill color.
+ double width_; // plot border rectangle width.
+ double margin_; // Marginal (svg units) space around the box (inside or out).
+ bool border_on_; // Display the border.
+ bool fill_on_; // Color fill the box.
+
+ box_style(const svg_color& scolor = black,
+ const svg_color& fcolor = antiquewhite,
+ double width = 1, // of border
+ double margin = 2., //
+ bool border_on = true, // Draw a border of width.
+ bool fill_on = false) // Apply fill color.
+ :
+ stroke_(scolor), fill_(fcolor), width_(width),
+ margin_(margin),
+ border_on_(border_on),
+ fill_on_(fill_on)
+ { // Initializes all private data with defaults.
+ }
+}; // class box_style
+</pre>
+<div class="table">
+<a name="id711647"></a>Table 28. Box Style Constructor
+<div class="table-contents"><table class="table" summary="Box Style Constructor">
+<colgroup>
+<col>
+<col>
+<col>
+<col>
+</colgroup>
+<thead><tr>
+<th>
+ 
+ parameter #
+ 
+ </th>
+<th>
+ 
+ name
+ 
+ </th>
+<th>
+ 
+ Default
+ 
+ </th>
+<th>
+ 
+ Description
+ 
+ </th>
+</tr></thead>
+<tbody>
+<tr>
+<td>
+ 
+ 1
+ 
+ </td>
+<td>
+ 
+ scolor
+ 
+ </td>
+<td>
+ 
+ black
+ 
+ </td>
+<td>
+ 
+ stroke color of the border of the rectangle.
+ 
+ </td>
+</tr>
+<tr>
+<td>
+ 
+ 2
+ 
+ </td>
+<td>
+ 
+ fcolor
+ 
+ </td>
+<td>
+ 
+ white
+ 
+ </td>
+<td>
+ 
+ Fill color of the rectangle.
+ 
+ </td>
+</tr>
+<tr>
+<td>
+ 
+ 3
+ 
+ </td>
+<td>
+ 
+ width
+ 
+ </td>
+<td>
+ 
+ 1
+ 
+ </td>
+<td>
+ 
+ Width the svg units of border
+ 
+ </td>
+</tr>
+<tr>
+<td>
+ 
+ 4
+ 
+ </td>
+<td>
+ 
+ margin
+ 
+ </td>
+<td>
+ 
+ 2
+ 
+ </td>
+<td>
+ 
+ Margin provided to avoid text etc being too close to the border, or
+ the border colliding with other rectangles.
+ 
+ </td>
+</tr>
+<tr>
+<td>
+ 
+ 4
+ 
+ </td>
+<td>
+ 
+ border_on
+ 
+ </td>
+<td>
+ 
+ true (border drawn)
+ 
+ </td>
+<td>
+ 
+ if true, the a border is drawn.
+ 
+ </td>
+</tr>
+<tr>
+<td>
+ 
+ 5
+ 
+ </td>
+<td>
+ 
+ fill_on
+ 
+ </td>
+<td>
+ 
+ false (not filled)
+ 
+ </td>
+<td>
+ 
+ if true, fill color drawn inside border, if any.
+ 
+ </td>
+</tr>
+</tbody>
+</table></div>
+</div>
+ <div class="table">
+<a name="id711898"></a>Table 29. Box Style Accessor functions (all are chainable).
+<div class="table-contents"><table class="table" summary="Box Style Accessor functions (all are chainable).">
+<colgroup>
+<col>
+<col>
+<col>
+<col>
+<col>
+</colgroup>
+<thead><tr>
+<th>
+ 
+ name
+ 
+ </th>
+<th>
+ 
+ parameter type
+ 
+ </th>
+<th>
+ 
+ Default value
+ 
+ </th>
+<th>
+ 
+ Description
+ 
+ </th>
+<th>
+ 
+ Examples
+ 
+ </th>
+</tr></thead>
+<tbody>
+<tr>
+<td>
+ 
+ scolor
+ 
+ </td>
+<td>
+ 
+ svg_color
+ 
+ </td>
+<td>
+ 
+ black
+ 
+ </td>
+<td>
+ 
+ Sets color of border of box
+ 
+ </td>
+<td>
+ 
+ my_box.scolor(red); my_box.scolor();
+ 
+ </td>
+</tr>
+<tr>
+<td>
+ 
+ fcolor
+ 
+ </td>
+<td>
+ 
+ svg_color
+ 
+ </td>
+<td>
+ 
+ white
+ 
+ </td>
+<td>
+ 
+ Sets fill color of box
+ 
+ </td>
+<td>
+ 
+ my_box.fcolor(red); my_box.fcolor();
+ 
+ </td>
+</tr>
+<tr>
+<td>
+ 
+ width
+ 
+ </td>
+<td>
+ 
+ real_type
+ 
+ </td>
+<td>
+ 
+ 1 svg unit
+ 
+ </td>
+<td>
+ 
+ Sets width of border.
+ 
+ </td>
+<td>
+ 
+ my_box.width(2); my_box.width()
+ 
+ </td>
+</tr>
+<tr>
+<td>
+ 
+ margin
+ 
+ </td>
+<td>
+ 
+ real_type
+ 
+ </td>
+<td>
+ 
+ 1 svg unit
+ 
+ </td>
+<td>
+ 
+ Sets margin around border (inside and out).
+ 
+ </td>
+<td>
+ 
+ my_box.width(2); my_box.width()
+ 
+ </td>
+</tr>
+<tr>
+<td>
+ 
+ border_on
+ 
+ </td>
+<td>
+ 
+ bool
+ 
+ </td>
+<td>
+ 
+ true
+ 
+ </td>
+<td>
+ 
+ If true, draws a border of box.
+ 
+ </td>
+<td>
+ 
+ my_box.border_on(true); my_box.border();
+ 
+ </td>
+</tr>
+<tr>
+<td>
+ 
+ fill_on
+ 
+ </td>
+<td>
+ 
+ bool
+ 
+ </td>
+<td>
+ 
+ false
+ 
+ </td>
+<td>
+ 
+ If true, color fills the box.
+ 
+ </td>
+<td>
+ 
+ my_box.fill_on(true); my_box.fill();
+ 
+ </td>
+</tr>
+</tbody>
+</table></div>
+</div>
+ <a name="svg_plot.interface.svg_boxplot_interface.text_style_defines_text_font__size_etc_"></a><h4>
+<a name="id712213"></a>
+ <a href="svg_boxplot_interface.html#svg_plot.interface.svg_boxplot_interface.text_style_defines_text_font__size_etc_">Text
+ Style defines text Font, Size etc.</a>
+ </h4>
+
+ Text style constructor.
+ 
+<pre class="programlisting">
+text_style(int size = 20,
+const std::string& font = "", // Default is sans with Firefox & IE, but serif with Opera.
+const std::string& style = "",
+const std::string& weight = "",
+const std::string& stretch = "",
+const std::string& decoration = "")
+: // Constructor.
+font_size_(size),
+ font_family_(font),
+ style_(style),
+ weight_(weight),
+ stretch_(stretch),
+ decoration_(decoration)
+{ // text_style default constructor, defines defaults for all private members.
+}
+</pre>
+<div class="table">
+<a name="id712711"></a>Table 30. Text Style Constructor
+<div class="table-contents"><table class="table" summary="Text Style Constructor">
+<colgroup>
+<col>
+<col>
+<col>
+<col>
+</colgroup>
+<thead><tr>
+<th>
+ 
+ parameter #
+ 
+ </th>
+<th>
+ 
+ name
+ 
+ </th>
+<th>
+ 
+ Default
+ 
+ </th>
+<th>
+ 
+ Description
+ 
+ </th>
+</tr></thead>
+<tbody>
+<tr>
+<td>
+ 
+ 1
+ 
+ </td>
+<td>
+ 
+ font_size
+ 
+ </td>
+<td>
+ 
+ 20
+ 
+ </td>
+<td>
+ 
+ text font size (svg units).
+ 
+ </td>
+</tr>
+<tr>
+<td>
+ 
+ 2
+ 
+ </td>
+<td>
+ 
+ font_family
+ 
+ </td>
+<td>
+ 
+ ""
+ 
+ </td>
+<td>
+ 
+ Font family ( Default is sans with Firefox & IE but serif with
+ Opera).
+ 
+ </td>
+</tr>
+<tr>
+<td>
+ 
+ 3
+ 
+ </td>
+<td>
+ 
+ font_style
+ 
+ </td>
+<td>
+ 
+ ""
+ 
+ </td>
+<td>
+ 
+ Allows italic or bold.
+ 
+ </td>
+</tr>
+<tr>
+<td>
+ 
+ Functions that are not yet implemented by browsers:
+ 
+ </td>
+<td class="auto-generated"> </td>
+<td class="auto-generated"> </td>
+<td class="auto-generated"> </td>
+</tr>
+<tr>
+<td>
+ 
+ 4
+ 
+ </td>
+<td>
+ 
+ font_weight
+ 
+ </td>
+<td>
+ 
+ ""
+ 
+ </td>
+<td>
+ 
+ Font weight: normal | bold | bolder | lighter | 100 | 200 .. 900.
+ 
+ </td>
+</tr>
+<tr>
+<td>
+ 
+ 5
+ 
+ </td>
+<td>
+ 
+ font_stretch
+ 
+ </td>
+<td>
+ 
+ ""
+ 
+ </td>
+<td>
+ 
+ normal | wider | narrower ....
+ 
+ </td>
+</tr>
+<tr>
+<td>
+ 
+ 6
+ 
+ </td>
+<td>
+ 
+ font_decoration
+ 
+ </td>
+<td>
+ 
+ ""
+ 
+ </td>
+<td>
+ 
+ "underline" | "overline" | "line-through".
+ 
+ </td>
+</tr>
+</tbody>
+</table></div>
+</div>
+ 
+ Examples: text_style my_style;
+ 
+
+ produces a normal default font of size 20 svg units (usually pixels).
+ 
+<pre class="programlisting">
+text_style my_style(14, "Lucida Sans Unicode", "italic");
+</pre>
+
+ produces a Lucida Sans Unicode font of size of 14 svg units (usually pixels).
+ 
+<div class="table">
+<a name="id713047"></a>Table 31. Text Style Accessor functions
+<div class="table-contents"><table class="table" summary="Text Style Accessor functions">
+<colgroup>
+<col>
+<col>
+<col>
+<col>
+<col>
+</colgroup>
+<thead><tr>
+<th>
+ 
+ name
+ 
+ </th>
+<th>
+ 
+ parameter type
+ 
+ </th>
+<th>
+ 
+ Default value
+ 
+ </th>
+<th>
+ 
+ Description
+ 
+ </th>
+<th>
+ 
+ Examples
+ 
+ </th>
+</tr></thead>
+<tbody>
+<tr>
+<td>
+ 
+ font_size
+ 
+ </td>
+<td>
+ 
+ int
+ 
+ </td>
+<td>
+ 
+ black
+ 
+ </td>
+<td>
+ 
+ Sets size of font in svg units
+ 
+ </td>
+<td>
+ 
+ my_text.font_size(10); my_text.font_size();
+ 
+ </td>
+</tr>
+<tr>
+<td>
+ 
+ font_family
+ 
+ </td>
+<td>
+ 
+ std::string
+ 
+ </td>
+<td>
+ 
+ ""
+ 
+ </td>
+<td>
+ 
+ Sets font family
+ 
+ </td>
+<td>
+ 
+ my_text.font_family("Arial"); my_text.font_family();
+ 
+ </td>
+</tr>
+<tr>
+<td>
+ 
+ font_style
+ 
+ </td>
+<td>
+ 
+ std::string
+ 
+ </td>
+<td>
+ 
+ ""
+ 
+ </td>
+<td>
+ 
+ Sets font style (normal | bold | italic).
+ 
+ </td>
+<td>
+ 
+ my_text.font_style("italic"); my_text.font_style()
+ 
+ </td>
+</tr>
+<tr>
+<td>
+ 
+ Functions that are not yet implemented by browsers:
+ 
+ </td>
+<td class="auto-generated"> </td>
+<td class="auto-generated"> </td>
+<td class="auto-generated"> </td>
+<td class="auto-generated"> </td>
+</tr>
+<tr>
+<td>
+ 
+ font_weight
+ 
+ </td>
+<td>
+ 
+ std::string
+ 
+ </td>
+<td>
+ 
+ ""
+ 
+ </td>
+<td>
+ 
+ Sets font weight.
+ 
+ </td>
+<td>
+ 
+ my_text.font_weight("bold"); my_text.font_weight()
+ 
+ </td>
+</tr>
+<tr>
+<td>
+ 
+ font_stretch
+ 
+ </td>
+<td>
+ 
+ std::string
+ 
+ </td>
+<td>
+ 
+ ""
+ 
+ </td>
+<td>
+ 
+ Sets font stretch (wider | narrower).
+ 
+ </td>
+<td>
+ 
+ my_text.font_stretch(true); my_text.font_stretch();
+ 
+ </td>
+</tr>
+<tr>
+<td>
+ 
+ font_decoration
+ 
+ </td>
+<td>
+ 
+ std::string
+ 
+ </td>
+<td>
+ 
+ ""
+ 
+ </td>
+<td>
+ 
+ Set decoration (underline | overline | strike thru).
+ 
+ </td>
+<td>
+ 
+ my_text.font_decoration("underline"); my_text.font_decoration();
+ 
+ </td>
+</tr>
+</tbody>
+</table></div>
+</div>
+ <a name="svg_plot.interface.svg_boxplot_interface.plot_point_style_defines_how_data_points_are_marked_"></a><h4>
+<a name="id713373"></a>
+ <a href="svg_boxplot_interface.html#svg_plot.interface.svg_boxplot_interface.plot_point_style_defines_how_data_points_are_marked_">plot_point_style
+ defines how data points are marked.</a>
+ </h4>
+<pre class="programlisting">
+class plot_point_style
+{
+public:
+ svg_color fill_color_; // Color of the centre of the shape.
+ svg_color stroke_color_; // Color of circumference of shape.
+ int size_; // diameter of circle, height of square, font_size ...
+ point_shape shape_; // round, square, point...
+ std::string symbols_; // Unicode symbol (letters, digits, squiggles etc)
+ // Caution: not all Unicode symbols are output by all browsers!
+ // Set symbol(s) font using .style().font_family("arial");
+ text_style symbols_style_;
+
+ plot_point_style(const svg_color& fill = blank, const svg_color& stroke = blank,
+ int size = 10, point_shape shape = round, const std::string& symbols = "X")
+ :
+ fill_color_(fill), stroke_color_(stroke), size_(size), shape_(shape), symbols_(symbols)
+ { // TODO Should there be default colors? or "none" == blank?
+ symbols_style_.font_size(size);
+ symbols_style_.font_family("Lucida Sans Unicode");
+ }
+</pre>
+<div class="table">
+<a name="id714005"></a>Table 32. Plot Point Style Constructor
+<div class="table-contents"><table class="table" summary="Plot Point Style Constructor">
+<colgroup>
+<col>
+<col>
+<col>
+<col>
+<col>
+<col>
+<col>
+<col>
+</colgroup>
+<thead><tr>
+<th>
+ 
+ parameter #
+ 
+ </th>
+<th>
+ 
+ name
+ 
+ </th>
+<th>
+ 
+ Default
+ 
+ </th>
+<th>
+ 
+ Description
+ 
+ </th>
+<td class="auto-generated"> </td>
+<td class="auto-generated"> </td>
+<td class="auto-generated"> </td>
+<td class="auto-generated"> </td>
+</tr></thead>
+<tbody>
+<tr>
+<td>
+ 
+ 1
+ 
+ </td>
+<td>
+ 
+ fill
+ 
+ </td>
+<td>
+ 
+ blank
+ 
+ </td>
+<td>
+ 
+ SVG fill color.
+ 
+ </td>
+<td class="auto-generated"> </td>
+<td class="auto-generated"> </td>
+<td class="auto-generated"> </td>
+<td class="auto-generated"> </td>
+</tr>
+<tr>
+<td>
+ 
+ 2
+ 
+ </td>
+<td>
+ 
+ stroke
+ 
+ </td>
+<td>
+ 
+ blank
+ 
+ </td>
+<td>
+ 
+ SVG stroke color.
+ 
+ </td>
+<td class="auto-generated"> </td>
+<td class="auto-generated"> </td>
+<td class="auto-generated"> </td>
+<td class="auto-generated"> </td>
+</tr>
+<tr>
+<td>
+ 
+ 3
+ 
+ </td>
+<td>
+ 
+ size
+ 
+ </td>
+<td>
+ 
+ 10
+ 
+ </td>
+<td>
+ 
+ size of marker (svg units).
+ 
+ </td>
+<td class="auto-generated"> </td>
+<td class="auto-generated"> </td>
+<td class="auto-generated"> </td>
+<td class="auto-generated"> </td>
+</tr>
+<tr>
+<td>
+ 
+ 4
+ 
+ </td>
+<td>
+ 
+ shape
+ 
+ </td>
+<td>
+ 
+ round
+ 
+ </td>
+<td>
+ 
+ shape in enum point_shape
+ 
+ </td>
+<td>
+ 
+ [5
+ 
+ </td>
+<td>
+ 
+ symbol(s)
+ 
+ </td>
+<td>
+ 
+ "X"
+ 
+ </td>
+<td>
+ 
+ Unicode symbol(s) (letters, digits, squiggles etc)
+ 
+ </td>
+</tr>
+</tbody>
+</table></div>
+</div>
+ 
+ Examples:
+ 
+<pre class="programlisting">
+point_style_(black, blank, 10, round), // Default point style, black 10 point unfilled circle.
+point_style_(red, yellow, 5, square), // Point style, red 5 square filled yellow.
+</pre>
+
+ It is usually convenient to override point styles onto calls of plot function
+ by chaining thus:
+ 
+<pre class="programlisting">
+my_plot.plot(data2, "-2 + x^2").fill_color(orange).size(5).shape(square);
+</pre>
+
+ Shapes available are:
+ 
+<pre class="programlisting">
+enum point_shape
+{ // Marking a data point.
+ // Used in draw_plot_point in axis_plot_frame.hpp
+ none = 0,
+ round, square, point, egg, // ellipse
+ vertical_line, // line up & down from axis.
+ horizontal_line, // line left & right from axis.
+ vertical_tick, // tick up from axis.
+ horizontal_tick, // line left & right from axis.
+ // Note horizontal will not be useful for 1D plot - will be on the axis.
+ cone, // pointing up - 'rightwayup'.
+ triangle, // pointing down 'upsidedown'.
+ star, // using polygon.
+ lozenge, // Using Unicode symbols.
+ diamond,
+ heart,
+ club,
+ spade,
+ asterisk, // *
+ x, // x
+ cross,
+ symbol // Unicode symbol including letters, digits, greek & 'squiggles'.
+ // For example: &#x3A9; = greek omega
+ // Other shapes may be added.
+};
+</pre>
+<div class="table">
+<a name="id714878"></a>Table 33. Plot Point Style Accessor functions
+<div class="table-contents"><table class="table" summary="Plot Point Style Accessor functions">
+<colgroup>
+<col>
+<col>
+<col>
+<col>
+<col>
+</colgroup>
+<thead><tr>
+<th>
+ 
+ name
+ 
+ </th>
+<th>
+ 
+ parameter type
+ 
+ </th>
+<th>
+ 
+ Default value
+ 
+ </th>
+<th>
+ 
+ Description
+ 
+ </th>
+<th>
+ 
+ Examples
+ 
+ </th>
+</tr></thead>
+<tbody>
+<tr>
+<td>
+ 
+ size
+ 
+ </td>
+<td>
+ 
+ int
+ 
+ </td>
+<td>
+ 
+ 10
+ 
+ </td>
+<td>
+ 
+ Sets size of point marker or font in svg units
+ 
+ </td>
+<td>
+ 
+ my_mark.size(10); my_mark.font_size();
+ 
+ </td>
+</tr>
+<tr>
+<td>
+ 
+ fill_color
+ 
+ </td>
+<td>
+ 
+ svg_color
+ 
+ </td>
+<td>
+ 
+ none
+ 
+ </td>
+<td>
+ 
+ Sets fill color
+ 
+ </td>
+<td>
+ 
+ my_mark.fill_color(red); my_mark.fill_color();
+ 
+ </td>
+</tr>
+<tr>
+<td>
+ 
+ stroke_color
+ 
+ </td>
+<td>
+ 
+ black
+ 
+ </td>
+<td>
+ 
+ ""
+ 
+ </td>
+<td>
+ 
+ Sets stroke color for mark.
+ 
+ </td>
+<td>
+ 
+ my_mark.stroke_color(green); my_mark.stroke_color()
+ 
+ </td>
+</tr>
+<tr>
+<td>
+ 
+ shape
+ 
+ </td>
+<td>
+ 
+ point_shape
+ 
+ </td>
+<td>
+ 
+ none
+ 
+ </td>
+<td>
+ 
+ Sets plot point marker
+ 
+ </td>
+<td>
+ 
+ my_mark.shape(egg); my_mark.shape()
+ 
+ </td>
+</tr>
+<tr>
+<td>
+ 
+ symbols
+ 
+ </td>
+<td>
+ 
+ std::string
+ 
+ </td>
+<td>
+ 
+ "X"
+ 
+ </td>
+<td>
+ 
+ Sets symbol as plot point marker.
+ 
+ </td>
+<td>
+ 
+ my_mark.symbols("&#x3A9;"); (greek omega) my_mark.symbols();
+ 
+ </td>
+</tr>
+<tr>
+<td>
+ 
+ style
+ 
+ </td>
+<td>
+ 
+ svg::text_style
+ 
+ </td>
+<td>
+ 
+ "Lucida Sans Unicode" with plot_point size.
+ 
+ </td>
+<td>
+ 
+ Set font and size for a symbol marking points.
+ 
+ </td>
+<td>
+ 
+ my_mark.style(my_symbol_style); my_mark.style();
+ 
+ </td>
+</tr>
+</tbody>
+</table></div>
+</div>
+ <a name="svg_plot.interface.svg_boxplot_interface.plot_line_style_defines_how_data_points_are_joined_"></a><h4>
+<a name="id715195"></a>
+ <a href="svg_boxplot_interface.html#svg_plot.interface.svg_boxplot_interface.plot_line_style_defines_how_data_points_are_joined_">plot_line_style
+ defines how data points are joined.</a>
+ </h4>
+<pre class="programlisting">
+class plot_line_style
+{ // Style of line joining data series values.
+public:
+ svg_color color_; // Line stroke color. (No fill color for lines).
+ svg_color area_fill_; // Fill color from line to axis. == true means color.blank = true.
+ double width_; // Width of line.
+ bool line_on_; // If straight line is to be drawn between points.
+ bool bezier_on_; // If a smooth bezier line is to be drawn between points.
+
+ plot_line_style(const svg_color& col = black, const svg_color& acol = true, double width = 2, bool line_on = true, bool bezier_on = false)
+ :
+ color_(col), area_fill_(acol), width_(width), line_on_(line_on), bezier_on_(bezier_on)
+ { // Defaults for all private data.
+ }
+</pre>
+<div class="table">
+<a name="id715705"></a>Table 34. Plot line Style Constructor
+<div class="table-contents"><table class="table" summary="Plot line Style Constructor">
+<colgroup>
+<col>
+<col>
+<col>
+<col>
+<col>
+<col>
+<col>
+<col>
+</colgroup>
+<thead><tr>
+<th>
+ 
+ parameter #
+ 
+ </th>
+<th>
+ 
+ name
+ 
+ </th>
+<th>
+ 
+ Default
+ 
+ </th>
+<th>
+ 
+ Description
+ 
+ </th>
+<td class="auto-generated"> </td>
+<td class="auto-generated"> </td>
+<td class="auto-generated"> </td>
+<td class="auto-generated"> </td>
+</tr></thead>
+<tbody>
+<tr>
+<td>
+ 
+ 1
+ 
+ </td>
+<td>
+ 
+ color
+ 
+ </td>
+<td>
+ 
+ black
+ 
+ </td>
+<td>
+ 
+ line color (SVG stroke color).
+ 
+ </td>
+<td class="auto-generated"> </td>
+<td class="auto-generated"> </td>
+<td class="auto-generated"> </td>
+<td class="auto-generated"> </td>
+</tr>
+<tr>
+<td>
+ 
+ 2
+ 
+ </td>
+<td>
+ 
+ area_fill
+ 
+ </td>
+<td>
+ 
+ blank
+ 
+ </td>
+<td>
+ 
+ area_fill color (if required).
+ 
+ </td>
+<td class="auto-generated"> </td>
+<td class="auto-generated"> </td>
+<td class="auto-generated"> </td>
+<td class="auto-generated"> </td>
+</tr>
+<tr>
+<td>
+ 
+ 3
+ 
+ </td>
+<td>
+ 
+ width
+ 
+ </td>
+<td>
+ 
+ 2
+ 
+ </td>
+<td>
+ 
+ width of line (svg units).
+ 
+ </td>
+<td class="auto-generated"> </td>
+<td class="auto-generated"> </td>
+<td class="auto-generated"> </td>
+<td class="auto-generated"> </td>
+</tr>
+<tr>
+<td>
+ 
+ 4
+ 
+ </td>
+<td>
+ 
+ line_on
+ 
+ </td>
+<td>
+ 
+ true
+ 
+ </td>
+<td>
+ 
+ true if straight line required.
+ 
+ </td>
+<td>
+ 
+ [5
+ 
+ </td>
+<td>
+ 
+ bezier_on
+ 
+ </td>
+<td>
+ 
+ false
+ 
+ </td>
+<td>
+ 
+ true if bezier smoothed line required.
+ 
+ </td>
+</tr>
+</tbody>
+</table></div>
+</div>
+ 
+ Examples:
+ 
+<pre class="programlisting">
+my_line_style line_style_(black, true, 2, true, false);
+// Black straight line joining points (without area fill).
+</pre>
+
+ In practice it is often convenient to chain function calls onto plot function
+ calls thus:
+ 
+<pre class="programlisting">
+my_plot.plot(data3, "-1 + 2x").bezier_on(true).line_color(blue);
+</pre>
+<div class="table">
+<a name="id716109"></a>Table 35. Plot Line Style Accessor functions
+<div class="table-contents"><table class="table" summary="Plot Line Style Accessor functions">
+<colgroup>
+<col>
+<col>
+<col>
+<col>
+<col>
+</colgroup>
+<thead><tr>
+<th>
+ 
+ name
+ 
+ </th>
+<th>
+ 
+ parameter type
+ 
+ </th>
+<th>
+ 
+ Default value
+ 
+ </th>
+<th>
+ 
+ Description
+ 
+ </th>
+<th>
+ 
+ Examples
+ 
+ </th>
+</tr></thead>
+<tbody>
+<tr>
+<td>
+ 
+ width
+ 
+ </td>
+<td>
+ 
+ int
+ 
+ </td>
+<td>
+ 
+ 10
+ 
+ </td>
+<td>
+ 
+ Sets width of line in svg units
+ 
+ </td>
+<td>
+ 
+ my_mark.width(1); my_mark.width();
+ 
+ </td>
+</tr>
+<tr>
+<td>
+ 
+ color
+ 
+ </td>
+<td>
+ 
+ svg_color
+ 
+ </td>
+<td>
+ 
+ black
+ 
+ </td>
+<td>
+ 
+ Sets line color
+ 
+ </td>
+<td>
+ 
+ my_mark.color(red); my_mark.fill_color();
+ 
+ </td>
+</tr>
+<tr>
+<td>
+ 
+ area_fill
+ 
+ </td>
+<td>
+ 
+ svg_color
+ 
+ </td>
+<td>
+ 
+ black
+ 
+ </td>
+<td>
+ 
+ Sets area_fill color.
+ 
+ </td>
+<td>
+ 
+ my_mark.area_fill(green); my_mark.area_fill()
+ 
+ </td>
+</tr>
+<tr>
+<td>
+ 
+ line_on
+ 
+ </td>
+<td>
+ 
+ bool
+ 
+ </td>
+<td>
+ 
+ true
+ 
+ </td>
+<td>
+ 
+ If true draws a line.
+ 
+ </td>
+<td>
+ 
+ my_mark.line_on(true); my_mark.line_on()
+ 
+ </td>
+</tr>
+<tr>
+<td>
+ 
+ bezier_on
+ 
+ </td>
+<td>
+ 
+ bool
+ 
+ </td>
+<td>
+ 
+ false
+ 
+ </td>
+<td>
+ 
+ If true draws a curve.
+ 
+ </td>
+<td>
+ 
+ my_mark.bezier_on(true); my_mark.bezier_on()
+ 
+ </td>
+</tr>
+</tbody>
+</table></div>
+</div>
 
</div>
<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>

Modified: sandbox/SOC/2007/visualization/libs/svg_plot/doc/html/svg_plot/interface/svg_interface.html
==============================================================================
--- sandbox/SOC/2007/visualization/libs/svg_plot/doc/html/svg_plot/interface/svg_interface.html (original)
+++ sandbox/SOC/2007/visualization/libs/svg_plot/doc/html/svg_plot/interface/svg_interface.html 2008-01-23 16:45:50 EST (Wed, 23 Jan 2008)
@@ -104,7 +104,107 @@
<tr>
<td>
 
- <code class="computeroutput">svg&
+ <code class="computeroutput">g_element&
+ add_g_element()</code>
+ 
+ </td>
+<td>
+ 
+ Adds a g_element at the root of the document tree. Acts as a <code class="computeroutput">push_back()</code>
+ 
+ </td>
+<td>
+ 
+ Returns the <code class="computeroutput">g_element</code>
+ that is pushed back. This allows you to do something like the following:
+ <code class="computeroutput">image.add_g_element().line(/**/).line(/**/).rect(/**/);
+ </code> which adds two lines and a rectangle to the g_element that
+ was just created.
+ 
+ </td>
+</tr>
+<tr>
+<td>
+ 
+ <code class="computeroutput">circle_element&
+ circle(double x, double y, unsigned int
+ radius =
+ 5)</code>
+ 
+ </td>
+<td>
+ 
+ Adds a point at (x,y) in the root level of the document
+ 
+ </td>
+<td>
+ 
+ If the user is calling the circle method, odds are they would prefer
+ a real circle instead of a degenerate circle (a point). 5 is as good
+ a default as any other, and the user is unlikely want a point if they
+ are making this call.
+ 
+ </td>
+</tr>
+<tr>
+<td>
+ 
+ <code class="computeroutput">ellipse_element&
+ ellipse(double rx, double ry, double cx, double cy)</code>
+ 
+ </td>
+<td>
+ 
+ Adds an ellipse at the root level of the doucment
+ 
+ </td>
+<td>
+ 
+ The widths of the ellipse are required
+ 
+ </td>
+</tr>
+<tr>
+<td>
+ 
+ <code class="computeroutput">g_element&
+ get_g_element(int)</code>
+ 
+ </td>
+<td>
+ 
+ Gets the g_element at the index specified.
+ 
+ </td>
+<td>
+ 
+ Gives a runtime error if you specify an index that does not contain
+ a <code class="computeroutput">g_element</code>. An iterator
+ interface to access these elements might be useful.
+ 
+ </td>
+</tr>
+<tr>
+<td>
+ 
+ <code class="computeroutput">get_g_element</code>
+ 
+ </td>
+<td>
+ 
+ Class derived from svg_element.
+ 
+ </td>
+<td>
+ 
+ Graph element: line, circle, rect... Node element of document tree.
+ 
+ </td>
+</tr>
+<tr>
+<td>
+ 
+ <code class="computeroutput">line_element&
 line(double x1, double y1, double x2, double y2)</code>
 
 </td>
@@ -144,89 +244,100 @@
<tr>
<td>
 
- <code class="computeroutput">get_g_element</code>
+ <code class="computeroutput">polygon_element&
+ polygon(double x, double y, bool f)</code>
 
 </td>
<td>
 
- Class derived from svg_element.
+ Begins a polygon at point (x, y). Fill is determined by <code class="computeroutput">f</code>
 
 </td>
<td>
 
- Graph element: line, circle, rect... Node element of document tree.
 
 </td>
</tr>
<tr>
<td>
 
- <code class="computeroutput">g_element&
- add_g_element()</code>
+ <code class="computeroutput">polygon_element&
+ polygon(std::vector<poly_path_point>&
+ v,
+ bool f)</code>
 
 </td>
<td>
 
- Adds a g_element at the root of the document tree. Acts as a <code class="computeroutput">push_back()</code>
+ Generates a polygon from the vector input using Cartesian coordinates.
 
 </td>
<td>
 
- Returns the <code class="computeroutput">g_element</code>
- that is pushed back. This allows you to do something like the following:
- <code class="computeroutput">image.add_g_element().line(/**/).line(/**/).rect(/**/);
- </code> which adds two lines and a rectangle to the g_element that
- was just created.
+ Fill is determined by <code class="computeroutput">f</code>.
 
 </td>
</tr>
<tr>
<td>
 
- <code class="computeroutput">svg&
- circle(double x, double y, unsigned int
- radius =
- 5)</code>
+ <code class="computeroutput">polyline_element&
+ polyline(double x, double y)</code>
 
 </td>
<td>
 
- Adds a point at (x,y) in the root level of the document
+ Places a polyline at coordinate (x, y)
 
 </td>
<td>
 
- If the user is calling the circle method, odds are they would prefer
- a real circle instead of a degenerate circle (a point). 5 is as good
- a default as any other, and the user is unlikely want a point if they
- are making this call.
 
 </td>
</tr>
<tr>
<td>
 
- <code class="computeroutput">g_element&
- get_g_element(int)</code>
+ <code class="computeroutput">polyline_element&
+ polyline(double x1, double y1, double x2, double y2)</code>
 
 </td>
<td>
 
- Gets the g_element at the index specified.
+ Adds a polyline to the root of the SVG document from (x1, y1) to (x2,
+ y2)
 
 </td>
<td>
 
- Gives a runtime error if you specify an index that does not contain
- a <code class="computeroutput">g_element</code>. An iterator
- interface to access these elements might be useful.
 
 </td>
</tr>
<tr>
<td>
 
- <code class="computeroutput">svg&
+ <code class="computeroutput">polyline_element&
+ polyline(std::vector<poly_path_point>&
+ v,
+ bool f=true)</code>
+ 
+ </td>
+<td>
+ 
+ Adds a polyline to the root of the SVG document with
+ 
+ </td>
+<td>
+ 
+ <code class="computeroutput">f</code> denotes the option
+ to provide a fill for the polyline.
+ 
+ </td>
+</tr>
+<tr>
+<td>
+ 
+ <code class="computeroutput">rect_element&
 rect(double x1, double y1, double width, double height)</code>
 
 </td>
@@ -244,7 +355,26 @@
<tr>
<td>
 
- <code class="computeroutput">svg&
+ <code class="computeroutput">polygon_element&
+ rhombus(double x1, double y1, double x2, double y2, double x3, double y3, double x4, double y4, bool f
+ = true</code>
+ 
+ </td>
+<td>
+ 
+ Generates a rhombus at the four coordinates provided
+ 
+ </td>
+<td>
+ 
+ Fill is determined by <code class="computeroutput">f</code>.
+ 
+ </td>
+</tr>
+<tr>
+<td>
+ 
+ <code class="computeroutput">text_element&
 text(double x, double y, std::string text)</code>
 
 </td>
@@ -259,12 +389,31 @@
 
 </td>
</tr>
+<tr>
+<td>
+ 
+ <code class="computeroutput">polygon_element&
+ triangle(double x1, double y1, double x2, double y2, double x3, double y3, bool f
+ = true</code>
+ 
+ </td>
+<td>
+ 
+ Generates a triangle at the three Cartesian coordinates specified
+ 
+ </td>
+<td>
+ 
+ Fill is determined by <code class="computeroutput">f</code>
+ 
+ </td>
+</tr>
</tbody>
</table></div>
</div>
 <div class="table">
-<a name="id693843"></a>Table 5. `svg` Copyright
-<div class="table-contents"><table class="table" summary="`svg` Copyright">
+<a name="id694987"></a>Table 5. Special methods
+<div class="table-contents"><table class="table" summary="Special methods">
<colgroup>
<col>
<col>
@@ -291,51 +440,78 @@
<tr>
<td>
 
- <code class="computeroutput">svg&
- copyright_holder(const std::string)</code>
+ <code class="computeroutput">clip_path_element&
+ clip_path(const rect_element& rect, const std::string&
+ id)</code>
 
 </td>
<td>
 
- Set copyright holder for the SVG XML document, as comment and XML.
+ Allows a rectangle to be defined as a clipping element. The clip elements
+ are referenced by name, so you must provide the ID
 
 </td>
<td>
 
-  <meta name<code class="literal">"copyright"
- content</code>"Paul A. Bristow" />
 
 </td>
</tr>
<tr>
<td>
 
- <code class="computeroutput">svg&
- license(const std::string, const std::string,
- const std::string, const std::string)</code>
+ <code class="computeroutput">void load_stylesheet(const std::string&
+ input)</code>
 
 </td>
<td>
 
- Set license terms (if any): reproduction, distribution, attribution,
- commercialuse
+ Allows you to define the filename of a stylesheet. The stylesheet is
+ validated as being a strict subset of the CSS syntax.
 
 </td>
<td>
 
- "permits" (default), "requires", or "prohibits".
 
 </td>
</tr>
+</tbody>
+</table></div>
+</div>
+ <div class="table">
+<a name="id695246"></a>Table 6. `svg` Copyright
+<div class="table-contents"><table class="table" summary="`svg` Copyright">
+<colgroup>
+<col>
+<col>
+<col>
+</colgroup>
+<thead><tr>
+<th>
+ 
+ Signature
+ 
+ </th>
+<th>
+ 
+ Description
+ 
+ </th>
+<th>
+ 
+ Notes & Examples
+ 
+ </th>
+</tr></thead>
+<tbody>
<tr>
<td>
 
- <code class="computeroutput">const std::string& reproduction()</code>
+ <code class="computeroutput">const std::string& attribution()</code>
 
 </td>
<td>
 
- Returns the Reproduction segment of the license
+ Returns the Attribution segment of the license
 
 </td>
<td>
@@ -347,34 +523,34 @@
<tr>
<td>
 
- <code class="computeroutput">const std::string& distribution()</code>
+ <code class="computeroutput">const std::string& author()</code>
 
 </td>
<td>
 
- Returns the Distribution segment of the license
+ Returns the author of the document.
 
 </td>
<td>
 
- The default is <code class="computeroutput">""</code>
+ The default is the copyright_holder.
 
 </td>
</tr>
<tr>
<td>
 
- <code class="computeroutput">const std::string& attribution()</code>
+ <code class="computeroutput">void author(const std::string)</code>
 
 </td>
<td>
 
- Returns the Attribution segment of the license
+ Sets the author of the document
 
 </td>
<td>
 
- The default is <code class="computeroutput">""</code>
+ The copyright_holder is the default author
 
 </td>
</tr>
@@ -398,6 +574,41 @@
<tr>
<td>
 
+ <code class="computeroutput">const std::string& copyright_date()</code>
+ 
+ </td>
+<td>
+ 
+ Returns the copyright date for the SVG XML document
+ 
+ </td>
+<td>
+ 
+ Returns the date string, not the associated XML.
+ 
+ </td>
+</tr>
+<tr>
+<td>
+ 
+ <code class="computeroutput">void copyright_date(const std::string)</code>
+ 
+ </td>
+<td>
+ 
+ Set copyright date for the SVG XML document, as comment and XML.
+ 
+ </td>
+<td>
+ 
+  <meta name<code class="literal">"date"
+ content</code>"2007" />
+ 
+ </td>
+</tr>
+<tr>
+<td>
+ 
 <code class="computeroutput">const std::string& copyright_holder</code>
 
 </td>
@@ -415,142 +626,161 @@
<tr>
<td>
 
- <code class="computeroutput">svg&
- license(bool)</code>
+ <code class="computeroutput">void copyright_holder(const std::string)</code>
 
 </td>
<td>
 
- Sets whether or not the license information should be added to the
- written document
+ Set copyright holder for the SVG XML document, as comment and XML.
 
 </td>
<td>
 
- <code class="computeroutput">false</code>
+  <meta name<code class="literal">"copyright"
+ content</code>"Paul A. Bristow" />
 
 </td>
</tr>
<tr>
<td>
 
- <code class="computeroutput">bool is_license()</code>
+ <code class="computeroutput">const std::string& description()</code>
 
 </td>
<td>
 
- Returns whether or not a license will be output with a written document.
+ Returns the description of the document.
 
 </td>
<td>
 
- Permits reproduction & distribution but requires atribution.
+ Returns the description string, not the associated XML
 
 </td>
</tr>
<tr>
<td>
 
- <code class="computeroutput">svg&
- author(const std::string)</code>
+ <code class="computeroutput">void description(const std::string)</code>
 
 </td>
<td>
 
- Sets the author of the document
+ Sets description for the SVG XML document, as comment and XML.
 
 </td>
<td>
 
- The copyright_holder is the default author
+  <desc>My Document description</desc>
 
 </td>
</tr>
<tr>
<td>
 
- <code class="computeroutput">svg&
- copyright_date(const std::string)</code>
+ <code class="computeroutput">const std::string& distribution()</code>
 
 </td>
<td>
 
- Set copyright date for the SVG XML document, as comment and XML.
+ Returns the Distribution segment of the license
 
 </td>
<td>
 
-  <meta name<code class="literal">"date"
- content</code>"2007" />
+ The default is <code class="computeroutput">""</code>
 
 </td>
</tr>
<tr>
<td>
 
- <code class="computeroutput">const std::string& copyright_date()</code>
+ `void image_filename(const std::string)
 
 </td>
<td>
 
- Returns the copyright date for the SVG XML document
+ Writes the image filename for the document as a title element in the
+ SVG document
 
 </td>
<td>
 
- Returns the date string, not the associated XML.
+ If the wrong filename is provided, the right one will be set upon a
+ call to write(). You should not have to set this, as it will be overridden
+ upon write.
 
 </td>
</tr>
<tr>
<td>
 
- <code class="computeroutput">svg&
- description(const std::string)</code>
+ <code class="computeroutput">bool is_license()</code>
 
 </td>
<td>
 
- Sets description for the SVG XML document, as comment and XML.
+ Returns whether or not a license will be output with a written document.
 
 </td>
<td>
 
-  <desc>My Document description</desc>
+ Permits reproduction & distribution but requires atribution.
 
 </td>
</tr>
<tr>
<td>
 
- <code class="computeroutput">const std::string& description()</code>
+ <code class="computeroutput">void license(bool)</code>
 
 </td>
<td>
 
- Returns the description of the document.
+ Sets whether or not the license information should be added to the
+ written document
 
 </td>
<td>
 
- Returns the description string, not the associated XML
+ <code class="computeroutput">false</code>
 
 </td>
</tr>
<tr>
<td>
 
- <code class="computeroutput">const std::string& author()</code>
+ <code class="computeroutput">void license(const std::string,
+ const std::string, const std::string,
+ const std::string)</code>
 
 </td>
<td>
 
- Returns the author of the document.
+ Set license terms (if any): reproduction, distribution, attribution,
+ commercialuse
 
 </td>
<td>
 
- The default is the copyright_holder.
+ "permits" (default), "requires", or "prohibits".
+ 
+ </td>
+</tr>
+<tr>
+<td>
+ 
+ <code class="computeroutput">const std::string& reproduction()</code>
+ 
+ </td>
+<td>
+ 
+ Returns the Reproduction segment of the license
+ 
+ </td>
+<td>
+ 
+ The default is <code class="computeroutput">""</code>
 
 </td>
</tr>
@@ -558,7 +788,7 @@
</table></div>
</div>
 <div class="table">
-<a name="id695136"></a>Table 6. `svg` document settings and writing
+<a name="id696540"></a>Table 7. `svg` document settings and writing
<div class="table-contents"><table class="table" summary="`svg` document settings and writing">
<colgroup>
<col>
@@ -586,8 +816,24 @@
<tr>
<td>
 
- <code class="computeroutput">svg&
- coord_precision(int)</code>
+ <code class="computeroutput">int coord_precision()</code>
+ 
+ </td>
+<td>
+ 
+ Returns the current precision of doubles in the document
+ 
+ </td>
+<td>
+ 
+ The default is 3
+ 
+ </td>
+</tr>
+<tr>
+<td>
+ 
+ <code class="computeroutput">void coord_precision(int)</code>
 
 </td>
<td>
@@ -604,19 +850,17 @@
<tr>
<td>
 
- <code class="computeroutput">svg&
- document_title(const std::string)</code>
+ <code class="computeroutput">const std::string
+ document_title()</code>
 
 </td>
<td>
 
- Sets title for the SVG XML document (not the
- plot)
+ Returns the title of the SVG XML document
 
 </td>
<td>
 
- <title>My Document title</title>
 
 </td>
</tr>
@@ -639,30 +883,31 @@
<tr>
<td>
 
- <code class="computeroutput">int coord_precision(int)</code>
+ <code class="computeroutput">void document_title(const std::string)</code>
 
 </td>
<td>
 
- Returns the current precision of doubles in the document
+ Sets title for the SVG XML document (not the plot)
 
 </td>
<td>
 
- The default is 3
+ <title>My Document title</title>
 
 </td>
</tr>
<tr>
<td>
 
- <code class="computeroutput">svg&
- x_size(unsigned int)</code>
+ <code class="computeroutput">void image_size(unsigned
+ int,
+ unsigned int)</code>
 
 </td>
<td>
 
- Sets the width of the image (pixels).
+ Sets the size of the image produced, (pixels).
 
 </td>
<td>
@@ -673,13 +918,13 @@
<tr>
<td>
 
- <code class="computeroutput">svg&
- y_size(unsigned int)</code>
+ <code class="computeroutput">unsigned int
+ x_size()</code>
 
 </td>
<td>
 
- Sets the height of the image (pixels).
+ Returns the width of the image (pixels).
 
 </td>
<td>
@@ -690,13 +935,13 @@
<tr>
<td>
 
- <code class="computeroutput">unsigned int
- x_size()</code>
+ <code class="computeroutput">void x_size(unsigned
+ int)</code>
 
 </td>
<td>
 
- Returns the width of the image (pixels).
+ Sets the width of the image (pixels).
 
 </td>
<td>
@@ -724,14 +969,13 @@
<tr>
<td>
 
- <code class="computeroutput">svg&
- image_size(unsigned int, unsigned
+ <code class="computeroutput">void y_size(unsigned
 int)</code>
 
 </td>
<td>
 
- Sets the size of the image produced, (pixels).
+ Sets the height of the image (pixels).
 
 </td>
<td>
@@ -742,8 +986,7 @@
<tr>
<td>
 
- <code class="computeroutput">svg&
- write(const std::string&)</code>
+ <code class="computeroutput">void write(const std::string&)</code>
 
 </td>
<td>
@@ -761,8 +1004,7 @@
<tr>
<td>
 
- <code class="computeroutput">svg&
- write(std::ostream&)</code>
+ <code class="computeroutput">void write(std::ostream&)</code>
 
 </td>
<td>

Modified: sandbox/SOC/2007/visualization/libs/svg_plot/doc/interface.qbk
==============================================================================
--- sandbox/SOC/2007/visualization/libs/svg_plot/doc/interface.qbk (original)
+++ sandbox/SOC/2007/visualization/libs/svg_plot/doc/interface.qbk 2008-01-23 16:45:50 EST (Wed, 23 Jan 2008)
@@ -210,7 +210,9 @@
[[`svg_2d_plot& y_scale(double y1, double y2)`] [Sets the scale of the Y axis from y1 to y2. Throws an exception if y2 <= y1.] ]
]

-Accessor get functions are also provided for all the above set functions. These allow one to check the current value (default if not changed by the preceeding code).
+Accessor get functions are also provided for all the above set functions.
+These allow one to check the current value
+(default if not changed by the preceeding code).

[heading The `plot()` Method]
The `plot()` method is defined using Boost.Parameter. As such, it supports a
@@ -218,14 +220,14 @@

[table 2D_plot Required parameter
[[ID] [Type (* is a wildcard)] [Description]]
-[[_container] [*] [Any object that can return an iterator with begin() and end()]]
-[[_title] [`std::string`] [The name of this series]]
+[[_container] [*] [Any object that can return an iterator with begin() and end().]]
+[[_title] [`std::string`] [The name of this series.]]
] [/ table 2D_plot Required parameter]

[table 2D_plot Deduced parameter
[[ID] [Type] [Description] [Default]]
-[[_fill_color] [`svg_color`] [This is the color that shows up inside of the circle that is
-being drawn] [white]]
+[[fill_color] [`svg_color`] [This is the color that shows inside of the circle that is
+being drawn.] [white]]
] [/ table 2D_plot Deduced parameter]

[table 2D_plot Optional Parameters
@@ -316,9 +318,10 @@

Accessor get functions are also provided for all the above set functions. These allow one to check the current value (default if not changed by the preceeding code).

-[heading The `plot()` Method]
+[heading The `plot()` Function]

-The `plot()` method allows data series parameters and further chained functions to control their display.
+The `plot()` function allows data series parameters,
+and further chained functions to control their display.

[table Required parameters
[[ID] [Type (* is a wildcard)] [Description]]
@@ -356,6 +359,246 @@
``]
[`boost_default_convert` (default) is sufficient in all cases where the data stored in the container can be directly cast to a double.]]
] [/ table Optional Functions]
+
+[h4 Styles providing addition control]
+
+Several style classes are used internally but are available for external use too.
+For most applications the functions listed above will provide enough control,
+but styles are documented here:
+
+ class svg_style;
+ class text_style; // Font, size, etc parameters of text like title, legend, labels ...
+ class plot_point_style; // Parameters of points maarking data series values.
+ class plot_line_style; // Parameters of lines joining data series values.
+ class axis_line_style; // Parameters of the axes.
+ class ticks_labels_style; // Parameters of the axis, grids, & ticks and their value labels.
+
+[h6 Box Style defines a rectangular box.]
+A box has a border and may be filled with the same or different colors.
+
+ class box_style
+ { // Style of a rectangular box.
+ // Use for image and plot window.
+ public:
+ svg_color stroke_; // Box line stroke color.
+ svg_color fill_; // Box fill color.
+ double width_; // plot border rectangle width.
+ double margin_; // Marginal (svg units) space around the box (inside or out).
+ bool border_on_; // Display the border.
+ bool fill_on_; // Color fill the box.
+
+ box_style(const svg_color& scolor = black,
+ const svg_color& fcolor = antiquewhite,
+ double width = 1, // of border
+ double margin = 2., //
+ bool border_on = true, // Draw a border of width.
+ bool fill_on = false) // Apply fill color.
+ :
+ stroke_(scolor), fill_(fcolor), width_(width),
+ margin_(margin),
+ border_on_(border_on),
+ fill_on_(fill_on)
+ { // Initializes all private data with defaults.
+ }
+ }; // class box_style
+
+[table Box Style Constructor
+[[parameter #] [name] [Default] [Description]]
+[[1] [scolor] [black] [stroke color of the border of the rectangle.]]
+[[2] [fcolor] [white] [Fill color of the rectangle.]]
+[[3] [width] [1] [Width the svg units of border]]
+[[4] [margin] [2] [Margin provided to avoid text etc being too close to the border, or the border colliding with other rectangles.]]
+[[4] [border_on] [true (border drawn)] [if true, the a border is drawn.]]
+[[5] [fill_on] [false (not filled)] [if true, fill color drawn inside border, if any.]]
+] [/ table Box Style]
+
+[table Box Style Accessor functions (all are chainable).
+[[name] [parameter type] [Default value] [Description] [Examples]]
+[[scolor] [svg_color] [black] [Sets color of border of box] [my_box.scolor(red); my_box.scolor();]]
+[[fcolor] [svg_color] [white] [Sets fill color of box] [my_box.fcolor(red); my_box.fcolor();]]
+[[width] [real_type] [1 svg unit] [Sets width of border.] [my_box.width(2); my_box.width()]]
+[[margin] [real_type] [1 svg unit] [Sets margin around border (inside and out).] [my_box.width(2); my_box.width()]]
+[[border_on] [bool] [true] [If true, draws a border of box.] [my_box.border_on(true); my_box.border();]]
+[[fill_on] [bool] [false] [If true, color fills the box.] [my_box.fill_on(true); my_box.fill();]]
+] [/table Box style Accessor functions]
+
+[h6 Text Style defines text Font, Size etc.]
+
+Text style constructor.
+
+ text_style(int size = 20,
+ const std::string& font = "", // Default is sans with Firefox & IE, but serif with Opera.
+ const std::string& style = "",
+ const std::string& weight = "",
+ const std::string& stretch = "",
+ const std::string& decoration = "")
+ : // Constructor.
+ font_size_(size),
+ font_family_(font),
+ style_(style),
+ weight_(weight),
+ stretch_(stretch),
+ decoration_(decoration)
+ { // text_style default constructor, defines defaults for all private members.
+ }
+
+[table Text Style Constructor
+[[parameter #] [name] [Default] [Description]]
+[[1] [font_size] [20] [text font size (svg units).]]
+[[2] [font_family] [""] [Font family ( Default is sans with Firefox & IE but serif with Opera).]]
+[[3] [font_style] [""] [Allows italic or bold.]]
+[[Functions that are not yet implemented by browsers:]]
+[[4] [font_weight] [""] [Font weight: normal | bold | bolder | lighter | 100 | 200 .. 900.]]
+[[5] [font_stretch] [""] [normal | wider | narrower ....]]
+[[6] [font_decoration] [""] ["underline" | "overline" | "line-through".]]
+] [/ table Box Style]
+
+Examples:
+ text_style my_style;
+
+produces a normal default font of size 20 svg units (usually pixels).
+
+ text_style my_style(14, "Lucida Sans Unicode", "italic");
+
+produces a Lucida Sans Unicode font of size of 14 svg units (usually pixels).
+
+[table Text Style Accessor functions
+[[name] [parameter type] [Default value] [Description] [Examples]]
+[[font_size] [int] [black] [Sets size of font in svg units] [my_text.font_size(10); my_text.font_size();]]
+[[font_family] [std::string] [""] [Sets font family] [my_text.font_family("Arial"); my_text.font_family();]]
+[[font_style] [std::string] [""] [Sets font style (normal | bold | italic).] [my_text.font_style("italic"); my_text.font_style()]]
+[[Functions that are not yet implemented by browsers:]]
+[[font_weight] [std::string] [""] [Sets font weight.] [my_text.font_weight("bold"); my_text.font_weight()]]
+[[font_stretch] [std::string] [""] [Sets font stretch (wider | narrower).] [my_text.font_stretch(true); my_text.font_stretch();]]
+[[font_decoration] [std::string] [""] [Set decoration (underline | overline | strike thru).] [my_text.font_decoration("underline"); my_text.font_decoration();]]
+] [/table text style Accessor functions]
+
+[h6 plot_point_style defines how data points are marked.]
+
+ class plot_point_style
+ {
+ public:
+ svg_color fill_color_; // Color of the centre of the shape.
+ svg_color stroke_color_; // Color of circumference of shape.
+ int size_; // diameter of circle, height of square, font_size ...
+ point_shape shape_; // round, square, point...
+ std::string symbols_; // Unicode symbol (letters, digits, squiggles etc)
+ // Caution: not all Unicode symbols are output by all browsers!
+ // Set symbol(s) font using .style().font_family("arial");
+ text_style symbols_style_;
+
+ plot_point_style(const svg_color& fill = blank, const svg_color& stroke = blank,
+ int size = 10, point_shape shape = round, const std::string& symbols = "X")
+ :
+ fill_color_(fill), stroke_color_(stroke), size_(size), shape_(shape), symbols_(symbols)
+ { // TODO Should there be default colors? or "none" == blank?
+ symbols_style_.font_size(size);
+ symbols_style_.font_family("Lucida Sans Unicode");
+ }
+
+[table Plot Point Style Constructor
+[[parameter #] [name] [Default] [Description]]
+[[1] [fill] [blank] [SVG fill color.]]
+[[2] [stroke] [blank] [SVG stroke color.]]
+[[3] [size] [10] [size of marker (svg units).]]
+[[4] [shape] [round] [shape in enum point_shape]
+[[5] [symbol(s)] ["X"] [Unicode symbol(s) (letters, digits, squiggles etc)]]
+] [/ table Plot point Style]
+
+Examples:
+
+ point_style_(black, blank, 10, round), // Default point style, black 10 point unfilled circle.
+ point_style_(red, yellow, 5, square), // Point style, red 5 square filled yellow.
+
+It is usually convenient to override point styles onto calls of plot function by chaining thus:
+
+ my_plot.plot(data2, "-2 + x^2").fill_color(orange).size(5).shape(square);
+
+Shapes available are:
+
+ enum point_shape
+ { // Marking a data point.
+ // Used in draw_plot_point in axis_plot_frame.hpp
+ none = 0,
+ round, square, point, egg, // ellipse
+ vertical_line, // line up & down from axis.
+ horizontal_line, // line left & right from axis.
+ vertical_tick, // tick up from axis.
+ horizontal_tick, // line left & right from axis.
+ // Note horizontal will not be useful for 1D plot - will be on the axis.
+ cone, // pointing up - 'rightwayup'.
+ triangle, // pointing down 'upsidedown'.
+ star, // using polygon.
+ lozenge, // Using Unicode symbols.
+ diamond,
+ heart,
+ club,
+ spade,
+ asterisk, // *
+ x, // x
+ cross,
+ symbol // Unicode symbol including letters, digits, greek & 'squiggles'.
+ // For example: Ω = greek omega
+ // Other shapes may be added.
+ };
+
+[table Plot Point Style Accessor functions
+[[name] [parameter type] [Default value] [Description] [Examples]]
+[[size] [int] [10] [Sets size of point marker or font in svg units] [my_mark.size(10); my_mark.font_size();]]
+[[fill_color] [svg_color] [none] [Sets fill color] [my_mark.fill_color(red); my_mark.fill_color();]]
+[[stroke_color] [black] [""] [Sets stroke color for mark.] [my_mark.stroke_color(green); my_mark.stroke_color()]]
+[[shape] [point_shape] [none] [Sets plot point marker] [my_mark.shape(egg); my_mark.shape()]]
+[[symbols] [std::string] ["X"] [Sets symbol as plot point marker.] [my_mark.symbols("Ω"); (greek omega) my_mark.symbols();]]
+[[style] [svg::text_style] ["Lucida Sans Unicode" with plot_point size.] [Set font and size for a symbol marking points.] [my_mark.style(my_symbol_style); my_mark.style();]]
+] [/table Plot Point style Accessor functions]
+
+[h6 plot_line_style defines how data points are joined.]
+
+ class plot_line_style
+ { // Style of line joining data series values.
+ public:
+ svg_color color_; // Line stroke color. (No fill color for lines).
+ svg_color area_fill_; // Fill color from line to axis. == true means color.blank = true.
+ double width_; // Width of line.
+ bool line_on_; // If straight line is to be drawn between points.
+ bool bezier_on_; // If a smooth bezier line is to be drawn between points.
+
+ plot_line_style(const svg_color& col = black, const svg_color& acol = true, double width = 2, bool line_on = true, bool bezier_on = false)
+ :
+ color_(col), area_fill_(acol), width_(width), line_on_(line_on), bezier_on_(bezier_on)
+ { // Defaults for all private data.
+ }
+
+
+[table Plot line Style Constructor
+[[parameter #] [name] [Default] [Description]]
+[[1] [color] [black] [line color (SVG stroke color).]]
+[[2] [area_fill] [blank] [area_fill color (if required).]]
+[[3] [width] [2] [width of line (svg units).]]
+[[4] [line_on] [true] [true if straight line required.]
+[[5] [bezier_on] [false] [true if bezier smoothed line required.]]
+] [/ table Plot Line Style]
+
+Examples:
+
+ my_line_style line_style_(black, true, 2, true, false);
+ // Black straight line joining points (without area fill).
+
+In practice it is often convenient to chain function calls onto plot function calls thus:
+
+ my_plot.plot(data3, "-1 + 2x").bezier_on(true).line_color(blue);
+
+
+[table Plot Line Style Accessor functions
+[[name] [parameter type] [Default value] [Description] [Examples]]
+[[width] [int] [10] [Sets width of line in svg units] [my_mark.width(1); my_mark.width();]]
+[[color] [svg_color] [black] [Sets line color] [my_mark.color(red); my_mark.fill_color();]]
+[[area_fill] [svg_color] [black] [Sets area_fill color.] [my_mark.area_fill(green); my_mark.area_fill()]]
+[[line_on] [bool] [true] [If true draws a line.] [my_mark.line_on(true); my_mark.line_on()]]
+[[bezier_on] [bool] [false] [If true draws a curve.] [my_mark.bezier_on(true); my_mark.bezier_on()]]
+] [/table Plot Line style Accessor functions]
+
+
[endsect] [/section:svg_2d_plot_interface]

[include settings.qbk]

Next message: ahd6974-boostorg_at_[hidden]: "[Boost-commit] svn:boost r42934 - trunk/libs/statechart/example/Performance"
Previous message: pbristow_at_[hidden]: "[Boost-commit] svn:boost r42932 - in sandbox/SOC/2007/visualization/boost/svg_plot: . detail"

Date view	Thread view	Subject view	Author view

Boost-Commit list run by bdawes at acm.org, david.abrahams at rcn.com, gregod at cs.rpi.edu, cpdaniel at pacbell.net, john at johnmaddock.co.uk