User: nrichards
Date: 07/07/24 17:27:58
Modified: doc/reference/en/modules itext.xml
Log:
update charting docs
Revision Changes Path
1.14 +312 -112 jboss-seam/doc/reference/en/modules/itext.xml
(In the diff below, changes in quantity of whitespace are not shown.)
Index: itext.xml
===================================================================
RCS file: /cvsroot/jboss/jboss-seam/doc/reference/en/modules/itext.xml,v
retrieving revision 1.13
retrieving revision 1.14
diff -u -b -r1.13 -r1.14
--- itext.xml 24 Jul 2007 00:59:50 -0000 1.13
+++ itext.xml 24 Jul 2007 21:27:58 -0000 1.14
@@ -319,7 +319,8 @@
<itemizedlist>
<listitem>
- <para><literal>name</literal> — The font name, for example: <literal>COURIER</literal>, <literal>HELVETICA</literal>,
+ <para><literal>name</literal> — The font name, for example:
+ <literal>COURIER</literal>, <literal>HELVETICA</literal>,
<literal>TIMES-ROMAN</literal>, <literal>SYMBOL</literal> or
<literal>ZAPFDINGBATS</literal>.</para>
</listitem>
@@ -1016,20 +1017,6 @@
every 3 cells will automatically form a row. Header and footer rows can be declared, and the headers and
footers will be repeated in the event a table structure spans multiple pages.</para>
- <programlisting><p:document xmlns:p="http://jboss.com/products/seam/pdf"
- xmlns:ui="http://java.sun.com/jsf/facelets"
- title="Hello">
- <p:table columns="3" headerRows="1">
- <p:cell>name</p:cell>
- <p:cell>owner</p:cell>
- <p:cell>size</p:cell>
- <ui:repeat value="#{documents}" var="doc">
- <p:cell>#{doc.name}</p:cell>
- <p:cell>#{doc.user.name}</p:cell>
- <p:cell>#{doc.size}</p:cell>
- </ui:repeat>
- </p:table>
-</p:document> </programlisting>
@@ -1175,7 +1162,17 @@
<para>
<emphasis>Usage</emphasis>
</para>
- <programlisting>...</programlisting>
+ <programlisting><p:table columns="3" headerRows="1">
+ <p:cell>name</p:cell>
+ <p:cell>owner</p:cell>
+ <p:cell>size</p:cell>
+ <ui:repeat value="#{documents}" var="doc">
+ <p:cell>#{doc.name}</p:cell>
+ <p:cell>#{doc.user.name}</p:cell>
+ <p:cell>#{doc.size}</p:cell>
+ </ui:repeat>
+</p:table></programlisting>
+
</entry>
</row>
@@ -1360,7 +1357,7 @@
<para>
<emphasis>Usage</emphasis>
</para>
- <programlisting>...</programlisting>
+ <programlisting><p:cell>...</p:cell></programlisting>
</entry>
</row>
@@ -1473,84 +1470,188 @@
</para>
<itemizedlist>
- <!--- UICategoryChartBase -->
<listitem>
<para>
- <literal>domainGridlinesVisible</literal>
- </para>
+ <literal>borderVisible</literal> — Controls whether or not a border is
+ displayed around the entire chart. </para>
</listitem>
+
<listitem>
<para>
- <literal>domainGridlinePaint</literal>
+ <literal>borderPaint</literal> — The color of the border, if visible;
</para>
</listitem>
<listitem>
<para>
- <literal>domainGridlineStroke</literal>
- </para>
+ <literal>borderBackgroundPaint</literal> — The default background
+ color of the chart. </para>
</listitem>
<listitem>
<para>
- <literal>rangeGridlinesVisible</literal>
- </para>
+ <literal>borderStroke</literal> — </para>
</listitem>
+
+
<listitem>
<para>
- <literal>rangeGridlinesVisible</literal>
- </para>
+ <literal>domainAxisLabel</literal> — The text label for the domain
+ axis. </para>
</listitem>
<listitem>
<para>
- <literal>rangeGridlinePaint</literal>
- </para>
+ <literal>domainAxisPaint</literal> — The color of the domain axis
+ label. </para>
</listitem>
<listitem>
<para>
- <literal>rangeGridlinePaint</literal>
- </para>
+ <literal>domainGridlinesVisible</literal>— Controls whether or not
+ gridlines for the domain axis are shown on the chart. </para>
+ </listitem>
+ <listitem>
+ <para>
+ <literal>domainGridlinePaint</literal>— The color of the domain
+ gridlines, if visible. </para>
+ </listitem>
+ <listitem>
+ <para>
+ <literal>domainGridlineStroke</literal> — The stroke style of the
+ domain gridleines, if visible. </para>
</listitem>
- <!--- UIBarChart -->
+ <listitem>
+ <para>
+ <literal>height</literal> — The height of the chart. </para>
+ </listitem>
+ <listitem>
+ <para>
+ <literal>width</literal> — The width of the chart. </para>
+ </listitem>
<listitem>
<para>
- <literal>title</literal>
- </para>
+ <literal>is3D</literal> — A boolean value indicating that the chart
+ should be rendered in 3D instead of 2D. </para>
</listitem>
+
<listitem>
<para>
- <literal>categoryAxisLabel</literal>
- </para>
+ <literal>legend</literal> — A boolean value indicating whether or not
+ the chart should include a legend. </para>
</listitem>
+
<listitem>
<para>
- <literal>valueAxisLabel</literal>
- </para>
+ <literal>legendItemPaint</literal>— The default color of the text
+ labels in the legend. </para>
</listitem>
+
<listitem>
<para>
- <literal>orientation</literal>
- </para>
+ <literal>legendItemBackgoundPaint</literal>— The background color for
+ the legend, if different from the chart background color.</para>
</listitem>
+
<listitem>
<para>
- <literal>legend</literal>
+ <literal>orientation</literal> — The orientation of the plot, either
+ <code>vertical</code> (the default) or <code>horizontal</code>. </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ <literal>plotBackgroundPaint</literal>— The color of the plot
+ background.</para>
+ </listitem>
+
+ <listitem>
+ <para>
+ <literal>plotBackgroundAlpha</literal>— The alpha (transparency) level
+ of the plot background. It should be a number between 0 (completely transparent)
+ and 1 (completely opaque). </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ <literal>plotForegroundAlpha</literal>— The alpha (transparency) level
+ of the plot. It should be a number between 0 (completely transparent) and 1
+ (completely opaque). </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ <literal>plotOutlinePaint</literal>— The color of the range gridlines,
+ if visible. </para>
+ </listitem>
+ <listitem>
+ <para>
+ <literal>plotOutlineStroke</literal> — The stroke style of the range
+ gridleines, if visible. </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ <literal>rangeAxisLabel</literal> — The text label for the range axis.
</para>
</listitem>
<listitem>
<para>
- <literal>is3D</literal>
+ <literal>rangeAxisPaint</literal> — The color of the range axis label.
</para>
</listitem>
+ <listitem>
+ <para>
+ <literal>rangeGridlinesVisible</literal>— Controls whether or not
+ gridlines for the range axis are shown on the chart. </para>
+ </listitem>
+ <listitem>
+ <para>
+ <literal>rangeGridlinePaint</literal>— The color of the range
+ gridlines, if visible. </para>
+ </listitem>
+ <listitem>
+ <para>
+ <literal>rangeGridlineStroke</literal> — The stroke style of the range
+ gridleines, if visible. </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ <literal>title</literal> — The chart title text. </para>
+ </listitem>
+ <listitem>
+ <para>
+ <literal>titlePaint</literal>— The color of the chart title text.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ <literal>titleBackgroundPaint</literal>— The background color around
+ the chart title.</para>
+ </listitem>
+ <listitem>
+ <para>
+ <literal>width</literal> — The width of the chart. </para>
+ </listitem>
</itemizedlist>
<para>
<emphasis>Usage</emphasis>
</para>
- <programlisting/>
+ <programlisting>
+<p:barchart title="Bar Chart" legend="true"
+ width="500" height="500">
+ <p:series key="Last Year">
+ <p:data columnKey="Joe" value="100" />
+ <p:data columnKey="Bob" value="120" />
+ </p:series> <p:series key="This Year">
+ <p:data columnKey="Joe" value="125" />
+ <p:data columnKey="Bob" value="115" />
+ </p:series>
+</p:barchart>
+ </programlisting>
</entry>
</row>
@@ -1581,83 +1682,186 @@
</para>
<itemizedlist>
+ <listitem>
+ <para>
+ <literal>borderVisible</literal> — Controls whether or not a border is
+ displayed around the entire chart. </para>
+ </listitem>
- <!--- UICategoryChartBase -->
<listitem>
<para>
- <literal>domainGridlinesVisible</literal>
+ <literal>borderPaint</literal> — The color of the border, if visible;
</para>
</listitem>
<listitem>
<para>
- <literal>domainGridlinePaint</literal>
- </para>
+ <literal>borderBackgroundPaint</literal> — The default background
+ color of the chart. </para>
</listitem>
<listitem>
<para>
- <literal>domainGridlineStroke</literal>
- </para>
+ <literal>borderStroke</literal> — </para>
</listitem>
+
+
<listitem>
<para>
- <literal>rangeGridlinesVisible</literal>
- </para>
+ <literal>domainAxisLabel</literal> — The text label for the domain
+ axis. </para>
</listitem>
<listitem>
<para>
- <literal>rangeGridlinesVisible</literal>
- </para>
+ <literal>domainAxisPaint</literal> — The color of the domain axis
+ label. </para>
</listitem>
+
<listitem>
<para>
- <literal>rangeGridlinePaint</literal>
- </para>
+ <literal>domainGridlinesVisible</literal>— Controls whether or not
+ gridlines for the domain axis are shown on the chart. </para>
+ </listitem>
+ <listitem>
+ <para>
+ <literal>domainGridlinePaint</literal>— The color of the domain
+ gridlines, if visible. </para>
+ </listitem>
+ <listitem>
+ <para>
+ <literal>domainGridlineStroke</literal> — The stroke style of the
+ domain gridleines, if visible. </para>
</listitem>
<listitem>
<para>
- <literal>rangeGridlinePaint</literal>
- </para>
+ <literal>height</literal> — The height of the chart. </para>
</listitem>
- <!--- UILineChart -->
<listitem>
<para>
- <literal>title</literal>
- </para>
+ <literal>width</literal> — The width of the chart. </para>
</listitem>
+
<listitem>
<para>
- <literal>domainAxisLabel</literal>
- </para>
+ <literal>is3D</literal> — A boolean value indicating that the chart
+ should be rendered in 3D instead of 2D. </para>
</listitem>
+
<listitem>
<para>
- <literal>rangeAxisLabel</literal>
- </para>
+ <literal>legend</literal> — A boolean value indicating whether or not
+ the chart should include a legend. </para>
</listitem>
+
<listitem>
<para>
- <literal>orientation</literal>
- </para>
+ <literal>legendItemPaint</literal>— The default color of the text
+ labels in the legend. </para>
</listitem>
+
<listitem>
<para>
- <literal>legend</literal>
+ <literal>legendItemBackgoundPaint</literal>— The background color for
+ the legend, if different from the chart background color.</para>
+ </listitem>
+
+ <listitem>
+ <para>
+ <literal>orientation</literal> — The orientation of the plot, either
+ <code>vertical</code> (the default) or <code>horizontal</code>. </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ <literal>plotBackgroundPaint</literal>— The color of the plot
+ background.</para>
+ </listitem>
+
+ <listitem>
+ <para>
+ <literal>plotBackgroundAlpha</literal>— The alpha (transparency) level
+ of the plot background. It should be a number between 0 (completely transparent)
+ and 1 (completely opaque). </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ <literal>plotForegroundAlpha</literal>— The alpha (transparency) level
+ of the plot. It should be a number between 0 (completely transparent) and 1
+ (completely opaque). </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ <literal>plotOutlinePaint</literal>— The color of the range gridlines,
+ if visible. </para>
+ </listitem>
+ <listitem>
+ <para>
+ <literal>plotOutlineStroke</literal> — The stroke style of the range
+ gridleines, if visible. </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ <literal>rangeAxisLabel</literal> — The text label for the range axis.
</para>
</listitem>
<listitem>
<para>
- <literal>is3D</literal>
+ <literal>rangeAxisPaint</literal> — The color of the range axis label.
</para>
</listitem>
+ <listitem>
+ <para>
+ <literal>rangeGridlinesVisible</literal>— Controls whether or not
+ gridlines for the range axis are shown on the chart. </para>
+ </listitem>
+ <listitem>
+ <para>
+ <literal>rangeGridlinePaint</literal>— The color of the range
+ gridlines, if visible. </para>
+ </listitem>
+ <listitem>
+ <para>
+ <literal>rangeGridlineStroke</literal> — The stroke style of the range
+ gridleines, if visible. </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ <literal>title</literal> — The chart title text. </para>
+ </listitem>
+ <listitem>
+ <para>
+ <literal>titlePaint</literal>— The color of the chart title text.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ <literal>titleBackgroundPaint</literal>— The background color around
+ the chart title.</para>
+ </listitem>
+ <listitem>
+ <para>
+ <literal>width</literal> — The width of the chart. </para>
+ </listitem>
</itemizedlist>
<para>
<emphasis>Usage</emphasis>
</para>
- <programlisting/>
+ <programlisting><p:linechart title="Line Chart"
+ width="500" height="500">
+ <p:series key="Prices">
+ <p:data columnKey="2003" value="7.36" />
+ <p:data columnKey="2004" value="11.50" />
+ <p:data columnKey="2005" value="34.625" />
+ <p:data columnKey="2006" value="76.30" />
+ <p:data columnKey="2007" value="85.05" />
+ </p:series>
+</p:linechart></programlisting>
</entry>
</row>
@@ -1846,58 +2050,56 @@
<para>
<literal>key</literal> — The series name. </para>
</listitem>
+ <!--
<listitem>
<para>
- <literal>seriesPaint</literal>
+ <literal>seriesFillPaint</literal> —
</para>
</listitem>
+ -->
<listitem>
<para>
- <literal>seriesFillPaint</literal>
+ <literal>seriesPaint</literal> — The color of each item in the series
</para>
</listitem>
+
<listitem>
<para>
- <literal>seriesOutlinePaint</literal>
- </para>
+ <literal>seriesOutlinePaint</literal> — The outline color for each
+ item in the series. </para>
</listitem>
<listitem>
<para>
- <literal>seriesOutlineStroke</literal>
- </para>
+ <literal>seriesOutlineStroke</literal> — The stroke used to draw each
+ item in the series. </para>
</listitem>
+ <!--
<listitem>
<para>
<literal>seriesStroke</literal>
</para>
</listitem>
+ -->
<listitem>
<para>
- <literal>seriesVisible</literal>
- </para>
+ <literal>seriesVisible</literal> — A boolean indicating if the series
+ should be displayed. </para>
</listitem>
<listitem>
<para>
- <literal>seriesVisibleInLegend</literal>
- </para>
+ <literal>seriesVisibleInLegend</literal> — A boolean indiciating if
+ the series should be listed in the legend. </para>
</listitem>
</itemizedlist>
<para>
<emphasis>Usage</emphasis>
</para>
- <programlisting><p:barchart title="Bar Chart3D">
- <p:series key="data1">
+ <programlisting><p:series key="data1">
<ui:repeat value="#{data.pieData1}" var="item">
<p:data columnKey="#{item.name}" value="#{item.value}" />
</ui:repeat>
- </p:series>
- <p:series key="data2" seriesPaint="green" seriesStroke="dot2">
- <ui:repeat value="#{data.pieData2}" var="item">
- <p:data columnKey="#{item.name}" value="#{item.value}" />
- </ui:repeat>
- </p:series>
-</p:barchart></programlisting>
+</p:series></programlisting>
</entry>
</row>
@@ -1929,49 +2131,47 @@
<itemizedlist>
<listitem>
<para>
- <literal>key</literal>
- </para>
- </listitem>
- <listitem>
- <para>
- <literal>columnKey</literal>
- </para>
+ <literal>key</literal> — The name of the data item. </para>
</listitem>
<listitem>
<para>
- <literal>rowKey</literal>
- </para>
+ <literal>series</literal> — The series name, when not embedded inside
+ a <code><p:series></code>. </para>
</listitem>
<listitem>
<para>
- <literal>value</literal>
- </para>
+ <literal>value</literal> — The numeric data value. </para>
</listitem>
<listitem>
<para>
- <literal>explodedPercent</literal>
- </para>
+ <literal>explodedPercent</literal> — For pie charts, indicates how
+ exploded a from the pie a piece is. </para>
</listitem>
+
<listitem>
<para>
- <literal>sectionPaint</literal>
- </para>
+ <literal>sectionOutlinePaint</literal> — For bar charts, the color of the section outline.</para>
</listitem>
<listitem>
<para>
- <literal>sectionOutlinePaint</literal>
- </para>
+ <literal>sectionOutlineStroke</literal> — For bar charts, the stroke type for the section outline.</para>
</listitem>
<listitem>
<para>
- <literal>sectionOutlineStroke</literal>
- </para>
+ <literal>sectionPaint</literal> — For bar charts, the color of the section.</para>
</listitem>
</itemizedlist>
<para>
<emphasis>Usage</emphasis>
</para>
- <programlisting/>
+
+
+
+ <programlisting><p:data key="foo" value="20" sectionPaint="#111111"
+ explodedPercent=".2" />
+<p:data key="bar" value="30" sectionPaint="#333333" />
+<p:data key="baz" value="40" sectionPaint="#555555"
+ sectionOutlineStroke="my-dot-style" /></programlisting>
</entry>
</row>