cvs: peardoc /en/package/images image-graph.xml
| From: | Martin Jansen | Date: | Sat, 17 Sep 2005 14:35:11 +0000 |
| Subject: | cvs: peardoc /en/package/images image-graph.xml | ||
| Groups: | php.pear.doc | ||
| Request: | Send a blank email to pear-doc+get-6835@lists.php.net to get a copy of this message | ||
mj Sat Sep 17 10:35:11 2005 EDT
Modified files:
/peardoc/en/package/images image-graph.xml
Log:
* Removed the outdated Image_Graph documentation from the manual.
# I'm leaving the subdirectory in CVS for now until we've decided how and
# if this thing will continue.
http://cvs.php.net/diff.php/peardoc/en/package/images/image-graph.xml?r1=1.5&r2=1.6&ty=u Index: peardoc/en/package/images/image-graph.xml diff -u peardoc/en/package/images/image-graph.xml:1.5 peardoc/en/package/images/image-graph.xml:1.6 --- peardoc/en/package/images/image-graph.xml:1.5 Fri Sep 9 15:57:27 2005 +++ peardoc/en/package/images/image-graph.xml Sat Sep 17 10:35:10 2005 @@ -1,1216 +1,18 @@ -<!-- $Revision: 1.5 $ --> -<sect1 id="package.images.image-graph"> -<title>Image_Graph</title> -<refentry id="package.images.image-graph.image-graph-summary"> - <refnamediv> - <refname>Class Summary <classname>Image_Graph</classname></refname> - <refpurpose>Main class for Graph generation</refpurpose> - </refnamediv> -<refsect1> - <title>Main class for Graph generation</title> - <para>This class is the starting-point if you want to generate graphs. It handles the various objects involved (e.g. axes, title, list of data-elements). It also provides the basic functions to add data-elements (using addData()), for automatic determination of min/max values for the axes, for data-handling and for the final generation of the graph. An instance of Image_Graph is the root for a tree of class-instances that will store data and settings, will provide methods for customizing the appearance of your graph and will finally create the output (graph on a canvas).</para> - -</refsect1> -<refsect1> -<title>Class Trees for <classname>Image_Graph</classname></title> - <para> - <itemizedlist> - <listitem><para> - Image_Graph - </para></listitem> - </itemizedlist> - </para> -</refsect1> -</refentry> -&package.images.image-graph.image-graph.image-graph; -&package.images.image-graph.image-graph.getgdimage; -&package.images.image-graph.image-graph.setaxescolor; -&package.images.image-graph.image-graph.setbackgroundcolor; -&package.images.image-graph.image-graph.setdatadefaultcolor; -&package.images.image-graph.image-graph.setdefaultfontoptions; -&package.images.image-graph.image-graph.setspacefromborder; -&package.images.image-graph.image-graph.stackdata; -<refentry id="package.images.image-graph.image-graph-axis-summary"> - <refnamediv> - <refname>Class Summary <classname>Image_Graph_Axis</classname></refname> - <refpurpose>Class for storing axis settings</refpurpose> - </refnamediv> -<refsect1> - <title>Class for storing axis settings</title> - <para>All axes used in the Graph (1 x-axis and 2 y-axes) have common functionality. This class is used for storage of various settings like the axis-type ("linear" or "text"), the axis-title, "ticks" (minor and major lines) and their layout on the axis, the axis-bounds (min/max-values), a representation for numerical values (string in sprintf-format) and colors. The functionality for actually drawing an axis is (currently) implemented in the main class Image_Graph. All specialized features like mapping of values to relative/absolute pixel-values are done in the derived classes for Axis_X and Axis_Y.</para> - -</refsect1> -<refsect1> -<title>Class Trees for <classname>Image_Graph_Axis</classname></title> - <para> - <itemizedlist> - <listitem><para> - <link linkend="package.images.image-graph.image-graph-base-summary"><classname>Image_Graph_Base</classname></link> - <itemizedlist> - <listitem><para> - Image_Graph_Axis - </para></listitem> - </itemizedlist> - </para></listitem> - </itemizedlist> - </para> - <para> - <table> - <title>Classes that extend <classname>Image_Graph_Axis</classname></title> - <tgroup cols="2"> - <thead> - <row> - <entry>Class</entry> - <entry>Summary</entry> - </row> - </thead> - <tbody> - <row> - <entry><link linkend="package.images.image-graph.image-graph-axis-x-summary">Image_Graph_Axis_X</link></entry> - <entry>Class for storing x-axis settings</entry> - </row> - <row> - <entry><link linkend="package.images.image-graph.image-graph-axis-y-summary">Image_Graph_Axis_Y</link></entry> - <entry>Class for storing x-axis settings</entry> - </row> - </tbody> - </tgroup> - </table> - </para> - <para> - <classname>Image_Graph_Axis</classname> Inherited Methods - </para> - <para> - <table> - <title>Inherited from <link linkend="package.images.image-graph.image-graph-base-summary"><classname>Image_Graph_Base</classname></link></title> - <tgroup cols="2"> - <thead> - <row> - <entry>Method Name</entry> - <entry>Summary</entry> - </row> - </thead> - <tbody> - <row> - <entry> <link linkend="package.images.image-graph.image-graph-base.setcolor"><function>Image_Graph_Base::setColor</function></link></entry> - <entry>Set color</entry> - </row> - <row> - <entry> <link linkend="package.images.image-graph.image-graph-base.setfontoptions"><function>Image_Graph_Base::setFontOptions</function></link></entry> - <entry>Set options for fonts</entry> - </row> - <row> - <entry> <link linkend="package.images.image-graph.image-graph-base.setspacer"><function>Image_Graph_Base::setSpacer</function></link></entry> - <entry>Set spacer</entry> - </row> - <row> - <entry> <link linkend="package.images.image-graph.image-graph-base.settext"><function>Image_Graph_Base::setText</function></link></entry> - <entry>Set text</entry> - </row> - </tbody> - </tgroup> - </table> - </para> -</refsect1> -</refentry> -&package.images.image-graph.image-graph-axis.image-graph-axis; -&package.images.image-graph.image-graph-axis.setbounds; -&package.images.image-graph.image-graph-axis.setnumbercolor; -&package.images.image-graph.image-graph-axis.setnumberformat; -&package.images.image-graph.image-graph-axis.setticksautosteps; -&package.images.image-graph.image-graph-axis.setticksize; -&package.images.image-graph.image-graph-axis.setticksmajor; -&package.images.image-graph.image-graph-axis.setticksminor; -&package.images.image-graph.image-graph-axis.settickstyle; -<refentry id="package.images.image-graph.image-graph-axis-values-summary"> - <refnamediv> - <refname>Class Summary <classname>Image_Graph_Axis_Values</classname></refname> - <refpurpose>Class for handling textual and numerical values on the axes</refpurpose> - </refnamediv> -<refsect1> - <title>Class for handling textual and numerical values on the axes</title> - <para>This class provied methods and attributes for customization of an axis. You can use it to set the options like the font, it's size or the color in which values (both numerical and textual, depending on the axis) will be drawn. For a numerical axis this class also offers you functionality to set the format in which numbers will be drawn. You can use this to set the number of decimal digits, prepend or append text etc. For a textual axis (actually: for the x-axis) this class allows you to set the text-labels which will be drawn.</para> - -</refsect1> -<refsect1> -<title>Class Trees for <classname>Image_Graph_Axis_Values</classname></title> - <para> - <itemizedlist> - <listitem><para> - <link linkend="package.images.image-graph.image-graph-base-summary"><classname>Image_Graph_Base</classname></link> - <itemizedlist> - <listitem><para> - <link linkend="package.images.image-graph.image-graph-title-summary"><classname>Image_Graph_Title</classname></link> - <itemizedlist> - <listitem><para> - Image_Graph_Axis_Values - </para></listitem> - </itemizedlist> - </para></listitem> - </itemizedlist> - </para></listitem> - </itemizedlist> - </para> - <para> - <classname>Image_Graph_Axis_Values</classname> Inherited Methods - </para> - <para> - <table> - <title>Inherited from <link linkend="package.images.image-graph.image-graph-title-summary"><classname>Image_Graph_Title</classname></link></title> - <tgroup cols="2"> - <thead> - <row> - <entry>Method Name</entry> - <entry>Summary</entry> - </row> - </thead> - <tbody> - <row> - <entry> Constructor <link linkend="package.images.image-graph.image-graph-title.image-graph-title"><function>Image_Graph_Title::Image_Graph_Title</function></link></entry> - <entry>Constructor</entry> - </row> - <row> - <entry> <link linkend="package.images.image-graph.image-graph-title.setcolor"><function>Image_Graph_Title::setColor</function></link></entry> - <entry>Set color</entry> - </row> - </tbody> - </tgroup> - </table> - <table> - <title>Inherited from <link linkend="package.images.image-graph.image-graph-base-summary"><classname>Image_Graph_Base</classname></link></title> - <tgroup cols="2"> - <thead> - <row> - <entry>Method Name</entry> - <entry>Summary</entry> - </row> - </thead> - <tbody> - <row> - <entry> <link linkend="package.images.image-graph.image-graph-base.setcolor"><function>Image_Graph_Base::setColor</function></link></entry> - <entry>Set color</entry> - </row> - <row> - <entry> <link linkend="package.images.image-graph.image-graph-base.setfontoptions"><function>Image_Graph_Base::setFontOptions</function></link></entry> - <entry>Set options for fonts</entry> - </row> - <row> - <entry> <link linkend="package.images.image-graph.image-graph-base.setspacer"><function>Image_Graph_Base::setSpacer</function></link></entry> - <entry>Set spacer</entry> - </row> - <row> - <entry> <link linkend="package.images.image-graph.image-graph-base.settext"><function>Image_Graph_Base::setText</function></link></entry> - <entry>Set text</entry> - </row> - </tbody> - </tgroup> - </table> - </para> -</refsect1> -</refentry> -&package.images.image-graph.image-graph-axis-values.image-graph-axis-values; -&package.images.image-graph.image-graph-axis-values.setnumberformat; -&package.images.image-graph.image-graph-axis-values.settext; -<refentry id="package.images.image-graph.image-graph-axis-x-summary"> - <refnamediv> - <refname>Class Summary <classname>Image_Graph_Axis_X</classname></refname> - <refpurpose>Class for storing x-axis settings</refpurpose> - </refnamediv> -<refsect1> - <title>Class for storing x-axis settings</title> - <para>Based upon the the common attributes/methods provided by the Image_Graph_Axis-class this one addresses all features which are needed for the x-axis.</para> - -</refsect1> -<refsect1> -<title>Class Trees for <classname>Image_Graph_Axis_X</classname></title> - <para> - <itemizedlist> - <listitem><para> - <link linkend="package.images.image-graph.image-graph-base-summary"><classname>Image_Graph_Base</classname></link> - <itemizedlist> - <listitem><para> - <link linkend="package.images.image-graph.image-graph-axis-summary"><classname>Image_Graph_Axis</classname></link> - <itemizedlist> - <listitem><para> - Image_Graph_Axis_X - </para></listitem> - </itemizedlist> - </para></listitem> - </itemizedlist> - </para></listitem> - </itemizedlist> - </para> - <para> - <classname>Image_Graph_Axis_X</classname> Inherited Methods - </para> - <para> - <table> - <title>Inherited from <link linkend="package.images.image-graph.image-graph-axis-summary"><classname>Image_Graph_Axis</classname></link></title> - <tgroup cols="2"> - <thead> - <row> - <entry>Method Name</entry> - <entry>Summary</entry> - </row> - </thead> - <tbody> - <row> - <entry> Constructor <link linkend="package.images.image-graph.image-graph-axis.image-graph-axis"><function>Image_Graph_Axis::Image_Graph_Axis</function></link></entry> - <entry>Constructor</entry> - </row> - <row> - <entry> <link linkend="package.images.image-graph.image-graph-axis.setbounds"><function>Image_Graph_Axis::setBounds</function></link></entry> - <entry>Set bounds</entry> - </row> - <row> - <entry> <link linkend="package.images.image-graph.image-graph-axis.setnumbercolor"><function>Image_Graph_Axis::setNumbercolor</function></link></entry> - <entry>Set color for numbers on the axis</entry> - </row> - <row> - <entry> <link linkend="package.images.image-graph.image-graph-axis.setnumberformat"><function>Image_Graph_Axis::setNumberformat</function></link></entry> - <entry>Set numberformat for axis</entry> - </row> - <row> - <entry> <link linkend="package.images.image-graph.image-graph-axis.setticksautosteps"><function>Image_Graph_Axis::setTicksAutoSteps</function></link></entry> - <entry>Set maximum steps for automatic creation of ticksMajor/ticksMinor</entry> - </row> - <row> - <entry> <link linkend="package.images.image-graph.image-graph-axis.setticksize"><function>Image_Graph_Axis::setTickSize</function></link></entry> - <entry>Set size for (major) ticks on axis</entry> - </row> - <row> - <entry> <link linkend="package.images.image-graph.image-graph-axis.setticksmajor"><function>Image_Graph_Axis::setTicksMajor</function></link></entry> - <entry>Set major ticks on axis</entry> - </row> - <row> - <entry> <link linkend="package.images.image-graph.image-graph-axis.setticksminor"><function>Image_Graph_Axis::setTicksMinor</function></link></entry> - <entry>Set minor ticks on axis</entry> - </row> - <row> - <entry> <link linkend="package.images.image-graph.image-graph-axis.settickstyle"><function>Image_Graph_Axis::setTickStyle</function></link></entry> - <entry>Set tick-style for ticks on a axis</entry> - </row> - </tbody> - </tgroup> - </table> - <table> - <title>Inherited from <link linkend="package.images.image-graph.image-graph-base-summary"><classname>Image_Graph_Base</classname></link></title> - <tgroup cols="2"> - <thead> - <row> - <entry>Method Name</entry> - <entry>Summary</entry> - </row> - </thead> - <tbody> - <row> - <entry> <link linkend="package.images.image-graph.image-graph-base.setcolor"><function>Image_Graph_Base::setColor</function></link></entry> - <entry>Set color</entry> - </row> - <row> - <entry> <link linkend="package.images.image-graph.image-graph-base.setfontoptions"><function>Image_Graph_Base::setFontOptions</function></link></entry> - <entry>Set options for fonts</entry> - </row> - <row> - <entry> <link linkend="package.images.image-graph.image-graph-base.setspacer"><function>Image_Graph_Base::setSpacer</function></link></entry> - <entry>Set spacer</entry> - </row> - <row> - <entry> <link linkend="package.images.image-graph.image-graph-base.settext"><function>Image_Graph_Base::setText</function></link></entry> - <entry>Set text</entry> - </row> - </tbody> - </tgroup> - </table> - </para> -</refsect1> -</refentry> -&package.images.image-graph.image-graph-axis-x.image-graph-axis-x; -&package.images.image-graph.image-graph-axis-x.setaxistype; -&package.images.image-graph.image-graph-axis-x.setlabels; -&package.images.image-graph.image-graph-axis-x.valuetopixelabsolute; -&package.images.image-graph.image-graph-axis-x.valuetopixelrelative; -<refentry id="package.images.image-graph.image-graph-axis-y-summary"> - <refnamediv> - <refname>Class Summary <classname>Image_Graph_Axis_Y</classname></refname> - <refpurpose>Class for storing x-axis settings</refpurpose> - </refnamediv> -<refsect1> - <title>Class for storing x-axis settings</title> - <para>Based upon the the common attributes/methods provided by the Image_Graph_Axis-class this one addresses all features which are needed for the y-axis.</para> - -</refsect1> -<refsect1> -<title>Class Trees for <classname>Image_Graph_Axis_Y</classname></title> - <para> - <itemizedlist> - <listitem><para> - <link linkend="package.images.image-graph.image-graph-base-summary"><classname>Image_Graph_Base</classname></link> - <itemizedlist> - <listitem><para> - <link linkend="package.images.image-graph.image-graph-axis-summary"><classname>Image_Graph_Axis</classname></link> - <itemizedlist> - <listitem><para> - Image_Graph_Axis_Y - </para></listitem> - </itemizedlist> - </para></listitem> - </itemizedlist> - </para></listitem> - </itemizedlist> - </para> - <para> - <classname>Image_Graph_Axis_Y</classname> Inherited Methods - </para> - <para> - <table> - <title>Inherited from <link linkend="package.images.image-graph.image-graph-axis-summary"><classname>Image_Graph_Axis</classname></link></title> - <tgroup cols="2"> - <thead> - <row> - <entry>Method Name</entry> - <entry>Summary</entry> - </row> - </thead> - <tbody> - <row> - <entry> Constructor <link linkend="package.images.image-graph.image-graph-axis.image-graph-axis"><function>Image_Graph_Axis::Image_Graph_Axis</function></link></entry> - <entry>Constructor</entry> - </row> - <row> - <entry> <link linkend="package.images.image-graph.image-graph-axis.setbounds"><function>Image_Graph_Axis::setBounds</function></link></entry> - <entry>Set bounds</entry> - </row> - <row> - <entry> <link linkend="package.images.image-graph.image-graph-axis.setnumbercolor"><function>Image_Graph_Axis::setNumbercolor</function></link></entry> - <entry>Set color for numbers on the axis</entry> - </row> - <row> - <entry> <link linkend="package.images.image-graph.image-graph-axis.setnumberformat"><function>Image_Graph_Axis::setNumberformat</function></link></entry> - <entry>Set numberformat for axis</entry> - </row> - <row> - <entry> <link linkend="package.images.image-graph.image-graph-axis.setticksautosteps"><function>Image_Graph_Axis::setTicksAutoSteps</function></link></entry> - <entry>Set maximum steps for automatic creation of ticksMajor/ticksMinor</entry> - </row> - <row> - <entry> <link linkend="package.images.image-graph.image-graph-axis.setticksize"><function>Image_Graph_Axis::setTickSize</function></link></entry> - <entry>Set size for (major) ticks on axis</entry> - </row> - <row> - <entry> <link linkend="package.images.image-graph.image-graph-axis.setticksmajor"><function>Image_Graph_Axis::setTicksMajor</function></link></entry> - <entry>Set major ticks on axis</entry> - </row> - <row> - <entry> <link linkend="package.images.image-graph.image-graph-axis.setticksminor"><function>Image_Graph_Axis::setTicksMinor</function></link></entry> - <entry>Set minor ticks on axis</entry> - </row> - <row> - <entry> <link linkend="package.images.image-graph.image-graph-axis.settickstyle"><function>Image_Graph_Axis::setTickStyle</function></link></entry> - <entry>Set tick-style for ticks on a axis</entry> - </row> - </tbody> - </tgroup> - </table> - <table> - <title>Inherited from <link linkend="package.images.image-graph.image-graph-base-summary"><classname>Image_Graph_Base</classname></link></title> - <tgroup cols="2"> - <thead> - <row> - <entry>Method Name</entry> - <entry>Summary</entry> - </row> - </thead> - <tbody> - <row> - <entry> <link linkend="package.images.image-graph.image-graph-base.setcolor"><function>Image_Graph_Base::setColor</function></link></entry> - <entry>Set color</entry> - </row> - <row> - <entry> <link linkend="package.images.image-graph.image-graph-base.setfontoptions"><function>Image_Graph_Base::setFontOptions</function></link></entry> - <entry>Set options for fonts</entry> - </row> - <row> - <entry> <link linkend="package.images.image-graph.image-graph-base.setspacer"><function>Image_Graph_Base::setSpacer</function></link></entry> - <entry>Set spacer</entry> - </row> - <row> - <entry> <link linkend="package.images.image-graph.image-graph-base.settext"><function>Image_Graph_Base::setText</function></link></entry> - <entry>Set text</entry> - </row> - </tbody> - </tgroup> - </table> - </para> -</refsect1> -</refentry> -&package.images.image-graph.image-graph-axis-y.image-graph-axis-y; -&package.images.image-graph.image-graph-axis-y.setaxistype; -&package.images.image-graph.image-graph-axis-y.valuetopixelabsolute; -&package.images.image-graph.image-graph-axis-y.valuetopixelrelative; -<refentry id="package.images.image-graph.image-graph-base-summary"> - <refnamediv> - <refname>Class Summary <classname>Image_Graph_Base</classname></refname> - <refpurpose>Base class for data-storage in common objects</refpurpose> - </refnamediv> -<refsect1> - <title>Base class for data-storage in common objects</title> - <para>Some attributes and methods to manipulate them are used in almost any object for the graph. This class provides the base-functionality for the classes derived from it.</para> - -</refsect1> -<refsect1> -<title>Class Trees for <classname>Image_Graph_Base</classname></title> - <para> - <itemizedlist> - <listitem><para> - Image_Graph_Base - </para></listitem> - </itemizedlist> - </para> - <para> - <table> - <title>Classes that extend <classname>Image_Graph_Base</classname></title> - <tgroup cols="2"> - <thead> - <row> - <entry>Class</entry> - <entry>Summary</entry> - </row> - </thead> - <tbody> - <row> - <entry><link linkend="package.images.image-graph.image-graph-title-summary">Image_Graph_Title</link></entry> - <entry>Class for storing a title</entry> - </row> - <row> - <entry><link linkend="package.images.image-graph.image-graph-axis-summary">Image_Graph_Axis</link></entry> - <entry>Class for storing axis settings</entry> - </row> - <row> - <entry><link linkend="package.images.image-graph.image-graph-grid-summary">Image_Graph_Grid</link></entry> - <entry>Class for storing grid-element settings</entry> - </row> - </tbody> - </tgroup> - </table> - </para> -</refsect1> -</refentry> -&package.images.image-graph.image-graph-base.setcolor; -&package.images.image-graph.image-graph-base.setfontoptions; -&package.images.image-graph.image-graph-base.setspacer; -&package.images.image-graph.image-graph-base.settext; -<refentry id="package.images.image-graph.image-graph-color-summary"> - <refnamediv> - <refname>Class Summary <classname>Image_Graph_Color</classname></refname> - <refpurpose>Class for color-handling</refpurpose> - </refnamediv> -<refsect1> - <title>Class for color-handling</title> - <para>This is used to extend the functionality of the current PEAR::Image_Color v0.4. I hope to be allowed to incorporate some of the improvements in a new Image_Color release.</para> - -</refsect1> -<refsect1> -<title>Class Trees for <classname>Image_Graph_Color</classname></title> - <para> - <itemizedlist> - <listitem><para> - Image_Color - <itemizedlist> - <listitem><para> - Image_Graph_Color - </para></listitem> - </itemizedlist> - </para></listitem> - </itemizedlist> - </para> -</refsect1> -</refentry> -&package.images.image-graph.image-graph-color.allocatecolor; -&package.images.image-graph.image-graph-color.color2rgb; -&package.images.image-graph.image-graph-color.getrange; -<refentry id="package.images.image-graph.image-graph-datamarker-common-summary"> - <refnamediv> - <refname>Class Summary <classname>Image_Graph_DataMarker_Common</classname></refname> - <refpurpose>Base class for a datamarker-element (e.g. "diamond", -"square" or "triangle")</refpurpose> - </refnamediv> -<refsect1> - <title>Base class for a datamarker-element (e.g. "diamond", -"square" or "triangle")</title> - <para>This class provides a basic implementation that is used and extended in all derived datamarker-elements.</para> - -</refsect1> -<refsect1> -<title>Class Trees for <classname>Image_Graph_DataMarker_Common</classname></title> - <para> - <itemizedlist> - <listitem><para> - Image_Graph_DataMarker_Common - </para></listitem> - </itemizedlist> - </para> - <para> - <table> - <title>Classes that extend <classname>Image_Graph_DataMarker_Common</classname></title> - <tgroup cols="2"> - <thead> - <row> - <entry>Class</entry> - <entry>Summary</entry> - </row> - </thead> - <tbody> - <row> - <entry><link linkend="package.images.image-graph.image-graph-datamarker-diamond-summary">Image_Graph_DataMarker_Diamond</link></entry> - <entry>Diamond datamarker-element</entry> - </row> - <row> - <entry><link linkend="package.images.image-graph.image-graph-datamarker-square-summary">Image_Graph_DataMarker_Square</link></entry> - <entry>Square datamarker-element</entry> - </row> - </tbody> - </tgroup> - </table> - </para> -</refsect1> -</refentry> -&package.images.image-graph.image-graph-datamarker-common.image-graph-datamarker-common; -&package.images.image-graph.image-graph-datamarker-common.setcolor; -&package.images.image-graph.image-graph-datamarker-common.setsize; -<refentry id="package.images.image-graph.image-graph-datamarker-diamond-summary"> - <refnamediv> - <refname>Class Summary <classname>Image_Graph_DataMarker_Diamond</classname></refname> - <refpurpose>Diamond datamarker-element</refpurpose> - </refnamediv> -<refsect1> - <title>Diamond datamarker-element</title> - <para>The shape of this datamarker is a diamond (or rhomb). The size set by setSize() is the width/height.</para> - -</refsect1> -<refsect1> -<title>Class Trees for <classname>Image_Graph_DataMarker_Diamond</classname></title> - <para> - <itemizedlist> - <listitem><para> - <link linkend="package.images.image-graph.image-graph-datamarker-common-summary"><classname>Image_Graph_DataMarker_Common</classname></link> - <itemizedlist> - <listitem><para> - Image_Graph_DataMarker_Diamond - </para></listitem> - </itemizedlist> - </para></listitem> - </itemizedlist> - </para> - <para> - <classname>Image_Graph_DataMarker_Diamond</classname> Inherited Methods - </para> - <para> - <table> - <title>Inherited from <link linkend="package.images.image-graph.image-graph-datamarker-common-summary"><classname>Image_Graph_DataMarker_Common</classname></link></title> - <tgroup cols="2"> - <thead> - <row> - <entry>Method Name</entry> - <entry>Summary</entry> - </row> - </thead> - <tbody> - <row> - <entry> Constructor <link linkend="package.images.image-graph.image-graph-datamarker-common.image-graph-datamarker-common"><function>Image_Graph_DataMarker_Common::Image_Graph_DataMarker_Common</function></link></entry> - <entry>Constructor</entry> - </row> - <row> - <entry> <link linkend="package.images.image-graph.image-graph-datamarker-common.setcolor"><function>Image_Graph_DataMarker_Common::setColor</function></link></entry> - <entry>Set color</entry> - </row> - <row> - <entry> <link linkend="package.images.image-graph.image-graph-datamarker-common.setsize"><function>Image_Graph_DataMarker_Common::setSize</function></link></entry> - <entry>Set size</entry> - </row> - </tbody> - </tgroup> - </table> - </para> -</refsect1> -</refentry> -&package.images.image-graph.image-graph-datamarker-diamond.image-graph-datamarker-diamond; -&package.images.image-graph.image-graph-datamarker-diamond.drawgd; -<refentry id="package.images.image-graph.image-graph-datamarker-square-summary"> - <refnamediv> - <refname>Class Summary <classname>Image_Graph_DataMarker_Square</classname></refname> - <refpurpose>Square datamarker-element</refpurpose> - </refnamediv> -<refsect1> - <title>Square datamarker-element</title> - <para>The shape of this datamarker is a square. The size set by setSize() is the width/height.</para> - -</refsect1> -<refsect1> -<title>Class Trees for <classname>Image_Graph_DataMarker_Square</classname></title> - <para> - <itemizedlist> - <listitem><para> - <link linkend="package.images.image-graph.image-graph-datamarker-common-summary"><classname>Image_Graph_DataMarker_Common</classname></link> - <itemizedlist> - <listitem><para> - Image_Graph_DataMarker_Square - </para></listitem> - </itemizedlist> - </para></listitem> - </itemizedlist> - </para> - <para> - <classname>Image_Graph_DataMarker_Square</classname> Inherited Methods - </para> - <para> - <table> - <title>Inherited from <link linkend="package.images.image-graph.image-graph-datamarker-common-summary"><classname>Image_Graph_DataMarker_Common</classname></link></title> - <tgroup cols="2"> - <thead> - <row> - <entry>Method Name</entry> - <entry>Summary</entry> - </row> - </thead> - <tbody> - <row> - <entry> Constructor <link linkend="package.images.image-graph.image-graph-datamarker-common.image-graph-datamarker-common"><function>Image_Graph_DataMarker_Common::Image_Graph_DataMarker_Common</function></link></entry> - <entry>Constructor</entry> - </row> - <row> - <entry> <link linkend="package.images.image-graph.image-graph-datamarker-common.setcolor"><function>Image_Graph_DataMarker_Common::setColor</function></link></entry> - <entry>Set color</entry> - </row> - <row> - <entry> <link linkend="package.images.image-graph.image-graph-datamarker-common.setsize"><function>Image_Graph_DataMarker_Common::setSize</function></link></entry> - <entry>Set size</entry> - </row> - </tbody> - </tgroup> - </table> - </para> -</refsect1> -</refentry> -&package.images.image-graph.image-graph-datamarker-square.image-graph-datamarker-square; -&package.images.image-graph.image-graph-datamarker-square.drawgd; -<refentry id="package.images.image-graph.image-graph-data-bar-summary"> - <refnamediv> - <refname>Class Summary <classname>Image_Graph_Data_Bar</classname></refname> - <refpurpose>Bar data-element</refpurpose> - </refnamediv> -<refsect1> - <title>Bar data-element</title> - <para>This class is used to draw a bar in the diagram. Support for stacking is implemented in this element.</para> - -</refsect1> -<refsect1> -<title>Class Trees for <classname>Image_Graph_Data_Bar</classname></title> - <para> - <itemizedlist> - <listitem><para> - <link linkend="package.images.image-graph.image-graph-data-common-summary"><classname>Image_Graph_Data_Common</classname></link> - <itemizedlist> - <listitem><para> - Image_Graph_Data_Bar - </para></listitem> - </itemizedlist> - </para></listitem> - </itemizedlist> - </para> - <para> - <classname>Image_Graph_Data_Bar</classname> Inherited Methods - </para> - <para> - <table> - <title>Inherited from <link linkend="package.images.image-graph.image-graph-data-common-summary"><classname>Image_Graph_Data_Common</classname></link></title> - <tgroup cols="2"> - <thead> - <row> - <entry>Method Name</entry> - <entry>Summary</entry> - </row> - </thead> - <tbody> - <row> - <entry> Constructor <link linkend="package.images.image-graph.image-graph-data-common.image-graph-data-common"><function>Image_Graph_Data_Common::Image_Graph_Data_Common</function></link></entry> - <entry>Constructor</entry> - </row> - <row> - <entry> <link linkend="package.images.image-graph.image-graph-data-common.drawgd"><function>Image_Graph_Data_Common::drawGD</function></link></entry> - <entry>Draws diagram element</entry> - </row> - <row> - <entry> <link linkend="package.images.image-graph.image-graph-data-common.setcolor"><function>Image_Graph_Data_Common::setColor</function></link></entry> - <entry>Set color</entry> - </row> - <row> - <entry> <link linkend="package.images.image-graph.image-graph-data-common.setdatamarker"><function>Image_Graph_Data_Common::setDataMarker</function></link></entry> - <entry>Set a data marker to be used</entry> - </row> - <row> - <entry> <link linkend="package.images.image-graph.image-graph-data-common.setfill"><function>Image_Graph_Data_Common::setFill</function></link></entry> - <entry>Set a fill element to be used</entry> - </row> - <row> - <entry> <link linkend="package.images.image-graph.image-graph-data-common.stackingdrawgd"><function>Image_Graph_Data_Common::stackingDrawGD</function></link></entry> - <entry>Draw all diagram elements in this stacking-group</entry> - </row> - </tbody> - </tgroup> - </table> - </para> -</refsect1> -</refentry> -&package.images.image-graph.image-graph-data-bar.image-graph-data-bar; -&package.images.image-graph.image-graph-data-bar.drawgd; -&package.images.image-graph.image-graph-data-bar.stackingprepare; -<refentry id="package.images.image-graph.image-graph-data-common-summary"> - <refnamediv> - <refname>Class Summary <classname>Image_Graph_Data_Common</classname></refname> - <refpurpose>Base class for a data-element (e.g. "line" or "bar")</refpurpose> - </refnamediv> -<refsect1> - <title>Base class for a data-element (e.g. "line" or "bar")</title> - <para>This class provides a basic implementation that is used and extended in all derived data elements. An instance of this class can be used as a "null output" (not actually drawing anything). This is usually *not* needed, however it might be useful in special cases.</para> - -</refsect1> -<refsect1> -<title>Class Trees for <classname>Image_Graph_Data_Common</classname></title> - <para> - <itemizedlist> - <listitem><para> - Image_Graph_Data_Common - </para></listitem> - </itemizedlist> - </para> - <para> - <table> - <title>Classes that extend <classname>Image_Graph_Data_Common</classname></title> - <tgroup cols="2"> - <thead> - <row> - <entry>Class</entry> - <entry>Summary</entry> - </row> - </thead> - <tbody> - <row> - <entry><link linkend="package.images.image-graph.image-graph-data-line-summary">Image_Graph_Data_Line</link></entry> - <entry>Line data-element</entry> - </row> - <row> - <entry><link linkend="package.images.image-graph.image-graph-data-bar-summary">Image_Graph_Data_Bar</link></entry> - <entry>Bar data-element</entry> - </row> - </tbody> - </tgroup> - </table> - </para> -</refsect1> -</refentry> -&package.images.image-graph.image-graph-data-common.image-graph-data-common; -&package.images.image-graph.image-graph-data-common.drawgd; -&package.images.image-graph.image-graph-data-common.setcolor; -&package.images.image-graph.image-graph-data-common.setdatamarker; -&package.images.image-graph.image-graph-data-common.setfill; -&package.images.image-graph.image-graph-data-common.stackingdrawgd; -<refentry id="package.images.image-graph.image-graph-data-line-summary"> - <refnamediv> - <refname>Class Summary <classname>Image_Graph_Data_Line</classname></refname> - <refpurpose>Line data-element</refpurpose> - </refnamediv> -<refsect1> - <title>Line data-element</title> - <para>This class is used to draw a line in the diagram. Support for stacking is implemented in this element.</para> - -</refsect1> -<refsect1> -<title>Class Trees for <classname>Image_Graph_Data_Line</classname></title> - <para> - <itemizedlist> - <listitem><para> - <link linkend="package.images.image-graph.image-graph-data-common-summary"><classname>Image_Graph_Data_Common</classname></link> - <itemizedlist> - <listitem><para> - Image_Graph_Data_Line - </para></listitem> - </itemizedlist> - </para></listitem> - </itemizedlist> - </para> - <para> - <classname>Image_Graph_Data_Line</classname> Inherited Methods - </para> - <para> - <table> - <title>Inherited from <link linkend="package.images.image-graph.image-graph-data-common-summary"><classname>Image_Graph_Data_Common</classname></link></title> - <tgroup cols="2"> - <thead> - <row> - <entry>Method Name</entry> - <entry>Summary</entry> - </row> - </thead> - <tbody> - <row> - <entry> Constructor <link linkend="package.images.image-graph.image-graph-data-common.image-graph-data-common"><function>Image_Graph_Data_Common::Image_Graph_Data_Common</function></link></entry> - <entry>Constructor</entry> - </row> - <row> - <entry> <link linkend="package.images.image-graph.image-graph-data-common.drawgd"><function>Image_Graph_Data_Common::drawGD</function></link></entry> - <entry>Draws diagram element</entry> - </row> - <row> - <entry> <link linkend="package.images.image-graph.image-graph-data-common.setcolor"><function>Image_Graph_Data_Common::setColor</function></link></entry> - <entry>Set color</entry> - </row> - <row> - <entry> <link linkend="package.images.image-graph.image-graph-data-common.setdatamarker"><function>Image_Graph_Data_Common::setDataMarker</function></link></entry> - <entry>Set a data marker to be used</entry> - </row> - <row> - <entry> <link linkend="package.images.image-graph.image-graph-data-common.setfill"><function>Image_Graph_Data_Common::setFill</function></link></entry> - <entry>Set a fill element to be used</entry> - </row> - <row> - <entry> <link linkend="package.images.image-graph.image-graph-data-common.stackingdrawgd"><function>Image_Graph_Data_Common::stackingDrawGD</function></link></entry> - <entry>Draw all diagram elements in this stacking-group</entry> - </row> - </tbody> - </tgroup> - </table> - </para> -</refsect1> -</refentry> -&package.images.image-graph.image-graph-data-line.image-graph-data-line; -&package.images.image-graph.image-graph-data-line.drawgd; -&package.images.image-graph.image-graph-data-line.stackingdrawgd; -&package.images.image-graph.image-graph-data-line.stackingprepare; -<refentry id="package.images.image-graph.image-graph-fill-common-summary"> - <refnamediv> - <refname>Class Summary <classname>Image_Graph_Fill_Common</classname></refname> - <refpurpose>Base class for a fill-element (e.g. a "solid" fill or a -"gradient" fill)</refpurpose> - </refnamediv> -<refsect1> - <title>Base class for a fill-element (e.g. a "solid" fill or a -"gradient" fill)</title> - <para>This class provides a basic implementation that is used and extended in all derived fill-elements. Fill-elements can be used at various places in Image_Graph. E.g. you can use it for filling a data-element (Image_Graph_Data_Common and derived classes) or a grid-element (Image_Graph_Grid).</para> - -</refsect1> -<refsect1> -<title>Class Trees for <classname>Image_Graph_Fill_Common</classname></title> - <para> - <itemizedlist> - <listitem><para> - Image_Graph_Fill_Common - </para></listitem> - </itemizedlist> - </para> - <para> - <table> - <title>Classes that extend <classname>Image_Graph_Fill_Common</classname></title> - <tgroup cols="2"> - <thead> - <row> - <entry>Class</entry> - <entry>Summary</entry> - </row> - </thead> - <tbody> - <row> - <entry><link linkend="package.images.image-graph.image-graph-fill-solid-summary">Image_Graph_Fill_Solid</link></entry> - <entry>Solid fill-element</entry> - </row> - <row> - <entry><link linkend="package.images.image-graph.image-graph-fill-gradient-summary">Image_Graph_Fill_Gradient</link></entry> - <entry>Gradient fill-element</entry> - </row> - </tbody> - </tgroup> - </table> - </para> -</refsect1> -</refentry> -&package.images.image-graph.image-graph-fill-common.image-graph-fill-common; -&package.images.image-graph.image-graph-fill-common.drawgdbox; -&package.images.image-graph.image-graph-fill-common.drawgdpolygon; -&package.images.image-graph.image-graph-fill-common.setcolor; -<refentry id="package.images.image-graph.image-graph-fill-gradient-summary"> - <refnamediv> - <refname>Class Summary <classname>Image_Graph_Fill_Gradient</classname></refname> - <refpurpose>Gradient fill-element</refpurpose> - </refnamediv> -<refsect1> - <title>Gradient fill-element</title> - <para>This class is used throughout Image_Graph to perform gradient fills. It is mainly used for diagram-data-elements (like a bar or a line) and the diagram-grid. Note that also more than 2 colors can be provided which will result in a gradient-fill from one color to the next [...] to the last one (multiple gradients).</para> - -</refsect1> -<refsect1> -<title>Class Trees for <classname>Image_Graph_Fill_Gradient</classname></title> - <para> - <itemizedlist> - <listitem><para> - <link linkend="package.images.image-graph.image-graph-fill-common-summary"><classname>Image_Graph_Fill_Common</classname></link> - <itemizedlist> - <listitem><para> - Image_Graph_Fill_Gradient - </para></listitem> - </itemizedlist> - </para></listitem> - </itemizedlist> - </para> - <para> - <classname>Image_Graph_Fill_Gradient</classname> Inherited Methods - </para> - <para> - <table> - <title>Inherited from <link linkend="package.images.image-graph.image-graph-fill-common-summary"><classname>Image_Graph_Fill_Common</classname></link></title> - <tgroup cols="2"> - <thead> - <row> - <entry>Method Name</entry> - <entry>Summary</entry> - </row> - </thead> - <tbody> - <row> - <entry> Constructor <link linkend="package.images.image-graph.image-graph-fill-common.image-graph-fill-common"><function>Image_Graph_Fill_Common::Image_Graph_Fill_Common</function></link></entry> - <entry>Constructor</entry> - </row> - <row> - <entry> <link linkend="package.images.image-graph.image-graph-fill-common.drawgdbox"><function>Image_Graph_Fill_Common::drawGDBox</function></link></entry> - <entry>Draws fill element, shape: box</entry> - </row> - <row> - <entry> <link linkend="package.images.image-graph.image-graph-fill-common.drawgdpolygon"><function>Image_Graph_Fill_Common::drawGDPolygon</function></link></entry> - <entry>Draws fill element, shape: polygon</entry> - </row> - <row> - <entry> <link linkend="package.images.image-graph.image-graph-fill-common.setcolor"><function>Image_Graph_Fill_Common::setColor</function></link></entry> - <entry>Set color</entry> - </row> - </tbody> - </tgroup> - </table> - </para> -</refsect1> -</refentry> -&package.images.image-graph.image-graph-fill-gradient.image-graph-fill-gradient; -&package.images.image-graph.image-graph-fill-gradient.drawgdbox; -&package.images.image-graph.image-graph-fill-gradient.drawgdpolygon; -&package.images.image-graph.image-graph-fill-gradient.setcolor; -<refentry id="package.images.image-graph.image-graph-fill-solid-summary"> - <refnamediv> - <refname>Class Summary <classname>Image_Graph_Fill_Solid</classname></refname> - <refpurpose>Solid fill-element</refpurpose> - </refnamediv> -<refsect1> - <title>Solid fill-element</title> - <para>This class is used throughout Image_Graph to perform solid fills. It is mainly used for diagram-data-elements (like a bar or a line) and the diagram-grid.</para> - -</refsect1> -<refsect1> -<title>Class Trees for <classname>Image_Graph_Fill_Solid</classname></title> - <para> - <itemizedlist> - <listitem><para> - <link linkend="package.images.image-graph.image-graph-fill-common-summary"><classname>Image_Graph_Fill_Common</classname></link> - <itemizedlist> - <listitem><para> - Image_Graph_Fill_Solid - </para></listitem> - </itemizedlist> - </para></listitem> - </itemizedlist> - </para> - <para> - <classname>Image_Graph_Fill_Solid</classname> Inherited Methods - </para> - <para> - <table> - <title>Inherited from <link linkend="package.images.image-graph.image-graph-fill-common-summary"><classname>Image_Graph_Fill_Common</classname></link></title> - <tgroup cols="2"> - <thead> - <row> - <entry>Method Name</entry> - <entry>Summary</entry> - </row> - </thead> - <tbody> - <row> - <entry> Constructor <link linkend="package.images.image-graph.image-graph-fill-common.image-graph-fill-common"><function>Image_Graph_Fill_Common::Image_Graph_Fill_Common</function></link></entry> - <entry>Constructor</entry> - </row> - <row> - <entry> <link linkend="package.images.image-graph.image-graph-fill-common.drawgdbox"><function>Image_Graph_Fill_Common::drawGDBox</function></link></entry> - <entry>Draws fill element, shape: box</entry> - </row> - <row> - <entry> <link linkend="package.images.image-graph.image-graph-fill-common.drawgdpolygon"><function>Image_Graph_Fill_Common::drawGDPolygon</function></link></entry> - <entry>Draws fill element, shape: polygon</entry> - </row> - <row> - <entry> <link linkend="package.images.image-graph.image-graph-fill-common.setcolor"><function>Image_Graph_Fill_Common::setColor</function></link></entry> - <entry>Set color</entry> - </row> - </tbody> - </tgroup> - </table> - </para> -</refsect1> -</refentry> -&package.images.image-graph.image-graph-fill-solid.image-graph-fill-solid; -&package.images.image-graph.image-graph-fill-solid.drawgdbox; -<refentry id="package.images.image-graph.image-graph-grid-summary"> - <refnamediv> - <refname>Class Summary <classname>Image_Graph_Grid</classname></refname> - <refpurpose>Class for storing grid-element settings</refpurpose> - </refnamediv> -<refsect1> - <title>Class for storing grid-element settings</title> - <para>The "grid" is used to make values (positions) inside the graph easier to read by using horizontal/vertical lines and/or filled areas as the graph background. It's possible to draw the grid at the major or minor ticks. Using two or more alternating colors/fills for the grid is an "impressive" and useful feature for the generated graphs. All fill-elements (derived from Image_Graph_Fill_Common) can be used. In most cases you will want to choose a solid fills with a certain color. However it might be useful to e.g. use some pattern fills (stripes, dots, ...) which will make reading possible even if you print it out in black/white. Since the normal fill-elements are used, you can also use alpha-values for the colors. This way it's still possible to see the graph background through the fill. Note that you shouldn't use too many different colors/fills since this can have a negative and disturbing effect on the readability of the graph.</para> - -</refsect1> -<refsect1> -<title>Class Trees for <classname>Image_Graph_Grid</classname></title> - <para> - <itemizedlist> - <listitem><para> - <link linkend="package.images.image-graph.image-graph-base-summary"><classname>Image_Graph_Base</classname></link> - <itemizedlist> - <listitem><para> - Image_Graph_Grid - </para></listitem> - </itemizedlist> - </para></listitem> - </itemizedlist> - </para> - <para> - <classname>Image_Graph_Grid</classname> Inherited Methods - </para> - <para> - <table> - <title>Inherited from <link linkend="package.images.image-graph.image-graph-base-summary"><classname>Image_Graph_Base</classname></link></title> - <tgroup cols="2"> - <thead> - <row> - <entry>Method Name</entry> - <entry>Summary</entry> - </row> - </thead> - <tbody> - <row> - <entry> <link linkend="package.images.image-graph.image-graph-base.setcolor"><function>Image_Graph_Base::setColor</function></link></entry> - <entry>Set color</entry> - </row> - <row> - <entry> <link linkend="package.images.image-graph.image-graph-base.setfontoptions"><function>Image_Graph_Base::setFontOptions</function></link></entry> - <entry>Set options for fonts</entry> - </row> - <row> - <entry> <link linkend="package.images.image-graph.image-graph-base.setspacer"><function>Image_Graph_Base::setSpacer</function></link></entry> - <entry>Set spacer</entry> - </row> - <row> - <entry> <link linkend="package.images.image-graph.image-graph-base.settext"><function>Image_Graph_Base::setText</function></link></entry> - <entry>Set text</entry> - </row> - </tbody> - </tgroup> - </table> - </para> -</refsect1> -</refentry> -&package.images.image-graph.image-graph-grid.image-graph-grid; -&package.images.image-graph.image-graph-grid.setfill; -&package.images.image-graph.image-graph-grid.setfilltype; -&package.images.image-graph.image-graph-grid.setlinetype; -<refentry id="package.images.image-graph.image-graph-title-summary"> - <refnamediv> - <refname>Class Summary <classname>Image_Graph_Title</classname></refname> - <refpurpose>Class for storing a title</refpurpose> - </refnamediv> -<refsect1> - <title>Class for storing a title</title> - <para>Titles are needed in various places: diagram title, axis titles, ... This function provides a common API for all titles</para> - -</refsect1> -<refsect1> -<title>Class Trees for <classname>Image_Graph_Title</classname></title> - <para> - <itemizedlist> - <listitem><para> - <link linkend="package.images.image-graph.image-graph-base-summary"><classname>Image_Graph_Base</classname></link> - <itemizedlist> - <listitem><para> - Image_Graph_Title - </para></listitem> - </itemizedlist> - </para></listitem> - </itemizedlist> - </para> - <para> - <table> - <title>Classes that extend <classname>Image_Graph_Title</classname></title> - <tgroup cols="2"> - <thead> - <row> - <entry>Class</entry> - <entry>Summary</entry> - </row> - </thead> - <tbody> - <row> - <entry><link linkend="package.images.image-graph.image-graph-axis-values-summary">Image_Graph_Axis_Values</link></entry> - <entry>Class for handling textual and numerical values on the axes</entry> - </row> - </tbody> - </tgroup> - </table> - </para> - <para> - <classname>Image_Graph_Title</classname> Inherited Methods - </para> - <para> - <table> - <title>Inherited from <link linkend="package.images.image-graph.image-graph-base-summary"><classname>Image_Graph_Base</classname></link></title> - <tgroup cols="2"> - <thead> - <row> - <entry>Method Name</entry> - <entry>Summary</entry> - </row> - </thead> - <tbody> - <row> - <entry> <link linkend="package.images.image-graph.image-graph-base.setcolor"><function>Image_Graph_Base::setColor</function></link></entry> - <entry>Set color</entry> - </row> - <row> - <entry> <link linkend="package.images.image-graph.image-graph-base.setfontoptions"><function>Image_Graph_Base::setFontOptions</function></link></entry> - <entry>Set options for fonts</entry> - </row> - <row> - <entry> <link linkend="package.images.image-graph.image-graph-base.setspacer"><function>Image_Graph_Base::setSpacer</function></link></entry> - <entry>Set spacer</entry> - </row> - <row> - <entry> <link linkend="package.images.image-graph.image-graph-base.settext"><function>Image_Graph_Base::setText</function></link></entry> - <entry>Set text</entry> - </row> - </tbody> - </tgroup> - </table> - </para> -</refsect1> -</refentry> -&package.images.image-graph.image-graph-title.image-graph-title; -&package.images.image-graph.image-graph-title.setcolor; -&package.images.image-graph.constants; -</sect1> -<!-- Generated by phpDocumentor v 1.3.0RC2 http://www.phpdoc.org --> +<!-- $Revision: 1.6 $ --> +<sect1 id="package.images.image-graph"> + <title>Image_Graph</title> + + <simpara> + Due to the fact that the <classname>Image_Graph</classname> is + currently in development phase, there is no documentation available + in the manual. + </simpara> + <simpara> + Extensive example code is available on an <ulink + url="http://pear.veggerby.dk/samples/">external site</ulink>. + </simpara> +</sect1> + <!-- Keep this comment at the end of the file Local variables: mode: sgml
http://cvs.php.net/diff.php/peardoc/en/package/images/image-graph.xml?r1=1.5&r2=1.6&ty=u Index: peardoc/en/package/images/image-graph.xml diff -u peardoc/en/package/images/image-graph.xml:1.5 peardoc/en/package/images/image-graph.xml:1.6 --- peardoc/en/package/images/image-graph.xml:1.5 Fri Sep 9 15:57:27 2005 +++ peardoc/en/package/images/image-graph.xml Sat Sep 17 10:35:10 2005 @@ -1,1216 +1,18 @@ -<!-- $Revision: 1.5 $ --> -<sect1 id="package.images.image-graph"> -<title>Image_Graph</title> -<refentry id="package.images.image-graph.image-graph-summary"> - <refnamediv> - <refname>Class Summary <classname>Image_Graph</classname></refname> - <refpurpose>Main class for Graph generation</refpurpose> - </refnamediv> -<refsect1> - <title>Main class for Graph generation</title> - <para>This class is the starting-point if you want to generate graphs. It handles the various objects involved (e.g. axes, title, list of data-elements). It also provides the basic functions to add data-elements (using addData()), for automatic determination of min/max values for the axes, for data-handling and for the final generation of the graph. An instance of Image_Graph is the root for a tree of class-instances that will store data and settings, will provide methods for customizing the appearance of your graph and will finally create the output (graph on a canvas).</para> - -</refsect1> -<refsect1> -<title>Class Trees for <classname>Image_Graph</classname></title> - <para> - <itemizedlist> - <listitem><para> - Image_Graph - </para></listitem> - </itemizedlist> - </para> -</refsect1> -</refentry> -&package.images.image-graph.image-graph.image-graph; -&package.images.image-graph.image-graph.getgdimage; -&package.images.image-graph.image-graph.setaxescolor; -&package.images.image-graph.image-graph.setbackgroundcolor; -&package.images.image-graph.image-graph.setdatadefaultcolor; -&package.images.image-graph.image-graph.setdefaultfontoptions; -&package.images.image-graph.image-graph.setspacefromborder; -&package.images.image-graph.image-graph.stackdata; -<refentry id="package.images.image-graph.image-graph-axis-summary"> - <refnamediv> - <refname>Class Summary <classname>Image_Graph_Axis</classname></refname> - <refpurpose>Class for storing axis settings</refpurpose> - </refnamediv> -<refsect1> - <title>Class for storing axis settings</title> - <para>All axes used in the Graph (1 x-axis and 2 y-axes) have common functionality. This class is used for storage of various settings like the axis-type ("linear" or "text"), the axis-title, "ticks" (minor and major lines) and their layout on the axis, the axis-bounds (min/max-values), a representation for numerical values (string in sprintf-format) and colors. The functionality for actually drawing an axis is (currently) implemented in the main class Image_Graph. All specialized features like mapping of values to relative/absolute pixel-values are done in the derived classes for Axis_X and Axis_Y.</para> - -</refsect1> -<refsect1> -<title>Class Trees for <classname>Image_Graph_Axis</classname></title> - <para> - <itemizedlist> - <listitem><para> - <link linkend="package.images.image-graph.image-graph-base-summary"><classname>Image_Graph_Base</classname></link> - <itemizedlist> - <listitem><para> - Image_Graph_Axis - </para></listitem> - </itemizedlist> - </para></listitem> - </itemizedlist> - </para> - <para> - <table> - <title>Classes that extend <classname>Image_Graph_Axis</classname></title> - <tgroup cols="2"> - <thead> - <row> - <entry>Class</entry> - <entry>Summary</entry> - </row> - </thead> - <tbody> - <row> - <entry><link linkend="package.images.image-graph.image-graph-axis-x-summary">Image_Graph_Axis_X</link></entry> - <entry>Class for storing x-axis settings</entry> - </row> - <row> - <entry><link linkend="package.images.image-graph.image-graph-axis-y-summary">Image_Graph_Axis_Y</link></entry> - <entry>Class for storing x-axis settings</entry> - </row> - </tbody> - </tgroup> - </table> - </para> - <para> - <classname>Image_Graph_Axis</classname> Inherited Methods - </para> - <para> - <table> - <title>Inherited from <link linkend="package.images.image-graph.image-graph-base-summary"><classname>Image_Graph_Base</classname></link></title> - <tgroup cols="2"> - <thead> - <row> - <entry>Method Name</entry> - <entry>Summary</entry> - </row> - </thead> - <tbody> - <row> - <entry> <link linkend="package.images.image-graph.image-graph-base.setcolor"><function>Image_Graph_Base::setColor</function></link></entry> - <entry>Set color</entry> - </row> - <row> - <entry> <link linkend="package.images.image-graph.image-graph-base.setfontoptions"><function>Image_Graph_Base::setFontOptions</function></link></entry> - <entry>Set options for fonts</entry> - </row> - <row> - <entry> <link linkend="package.images.image-graph.image-graph-base.setspacer"><function>Image_Graph_Base::setSpacer</function></link></entry> - <entry>Set spacer</entry> - </row> - <row> - <entry> <link linkend="package.images.image-graph.image-graph-base.settext"><function>Image_Graph_Base::setText</function></link></entry> - <entry>Set text</entry> - </row> - </tbody> - </tgroup> - </table> - </para> -</refsect1> -</refentry> -&package.images.image-graph.image-graph-axis.image-graph-axis; -&package.images.image-graph.image-graph-axis.setbounds; -&package.images.image-graph.image-graph-axis.setnumbercolor; -&package.images.image-graph.image-graph-axis.setnumberformat; -&package.images.image-graph.image-graph-axis.setticksautosteps; -&package.images.image-graph.image-graph-axis.setticksize; -&package.images.image-graph.image-graph-axis.setticksmajor; -&package.images.image-graph.image-graph-axis.setticksminor; -&package.images.image-graph.image-graph-axis.settickstyle; -<refentry id="package.images.image-graph.image-graph-axis-values-summary"> - <refnamediv> - <refname>Class Summary <classname>Image_Graph_Axis_Values</classname></refname> - <refpurpose>Class for handling textual and numerical values on the axes</refpurpose> - </refnamediv> -<refsect1> - <title>Class for handling textual and numerical values on the axes</title> - <para>This class provied methods and attributes for customization of an axis. You can use it to set the options like the font, it's size or the color in which values (both numerical and textual, depending on the axis) will be drawn. For a numerical axis this class also offers you functionality to set the format in which numbers will be drawn. You can use this to set the number of decimal digits, prepend or append text etc. For a textual axis (actually: for the x-axis) this class allows you to set the text-labels which will be drawn.</para> - -</refsect1> -<refsect1> -<title>Class Trees for <classname>Image_Graph_Axis_Values</classname></title> - <para> - <itemizedlist> - <listitem><para> - <link linkend="package.images.image-graph.image-graph-base-summary"><classname>Image_Graph_Base</classname></link> - <itemizedlist> - <listitem><para> - <link linkend="package.images.image-graph.image-graph-title-summary"><classname>Image_Graph_Title</classname></link> - <itemizedlist> - <listitem><para> - Image_Graph_Axis_Values - </para></listitem> - </itemizedlist> - </para></listitem> - </itemizedlist> - </para></listitem> - </itemizedlist> - </para> - <para> - <classname>Image_Graph_Axis_Values</classname> Inherited Methods - </para> - <para> - <table> - <title>Inherited from <link linkend="package.images.image-graph.image-graph-title-summary"><classname>Image_Graph_Title</classname></link></title> - <tgroup cols="2"> - <thead> - <row> - <entry>Method Name</entry> - <entry>Summary</entry> - </row> - </thead> - <tbody> - <row> - <entry> Constructor <link linkend="package.images.image-graph.image-graph-title.image-graph-title"><function>Image_Graph_Title::Image_Graph_Title</function></link></entry> - <entry>Constructor</entry> - </row> - <row> - <entry> <link linkend="package.images.image-graph.image-graph-title.setcolor"><function>Image_Graph_Title::setColor</function></link></entry> - <entry>Set color</entry> - </row> - </tbody> - </tgroup> - </table> - <table> - <title>Inherited from <link linkend="package.images.image-graph.image-graph-base-summary"><classname>Image_Graph_Base</classname></link></title> - <tgroup cols="2"> - <thead> - <row> - <entry>Method Name</entry> - <entry>Summary</entry> - </row> - </thead> - <tbody> - <row> - <entry> <link linkend="package.images.image-graph.image-graph-base.setcolor"><function>Image_Graph_Base::setColor</function></link></entry> - <entry>Set color</entry> - </row> - <row> - <entry> <link linkend="package.images.image-graph.image-graph-base.setfontoptions"><function>Image_Graph_Base::setFontOptions</function></link></entry> - <entry>Set options for fonts</entry> - </row> - <row> - <entry> <link linkend="package.images.image-graph.image-graph-base.setspacer"><function>Image_Graph_Base::setSpacer</function></link></entry> - <entry>Set spacer</entry> - </row> - <row> - <entry> <link linkend="package.images.image-graph.image-graph-base.settext"><function>Image_Graph_Base::setText</function></link></entry> - <entry>Set text</entry> - </row> - </tbody> - </tgroup> - </table> - </para> -</refsect1> -</refentry> -&package.images.image-graph.image-graph-axis-values.image-graph-axis-values; -&package.images.image-graph.image-graph-axis-values.setnumberformat; -&package.images.image-graph.image-graph-axis-values.settext; -<refentry id="package.images.image-graph.image-graph-axis-x-summary"> - <refnamediv> - <refname>Class Summary <classname>Image_Graph_Axis_X</classname></refname> - <refpurpose>Class for storing x-axis settings</refpurpose> - </refnamediv> -<refsect1> - <title>Class for storing x-axis settings</title> - <para>Based upon the the common attributes/methods provided by the Image_Graph_Axis-class this one addresses all features which are needed for the x-axis.</para> - -</refsect1> -<refsect1> -<title>Class Trees for <classname>Image_Graph_Axis_X</classname></title> - <para> - <itemizedlist> - <listitem><para> - <link linkend="package.images.image-graph.image-graph-base-summary"><classname>Image_Graph_Base</classname></link> - <itemizedlist> - <listitem><para> - <link linkend="package.images.image-graph.image-graph-axis-summary"><classname>Image_Graph_Axis</classname></link> - <itemizedlist> - <listitem><para> - Image_Graph_Axis_X - </para></listitem> - </itemizedlist> - </para></listitem> - </itemizedlist> - </para></listitem> - </itemizedlist> - </para> - <para> - <classname>Image_Graph_Axis_X</classname> Inherited Methods - </para> - <para> - <table> - <title>Inherited from <link linkend="package.images.image-graph.image-graph-axis-summary"><classname>Image_Graph_Axis</classname></link></title> - <tgroup cols="2"> - <thead> - <row> - <entry>Method Name</entry> - <entry>Summary</entry> - </row> - </thead> - <tbody> - <row> - <entry> Constructor <link linkend="package.images.image-graph.image-graph-axis.image-graph-axis"><function>Image_Graph_Axis::Image_Graph_Axis</function></link></entry> - <entry>Constructor</entry> - </row> - <row> - <entry> <link linkend="package.images.image-graph.image-graph-axis.setbounds"><function>Image_Graph_Axis::setBounds</function></link></entry> - <entry>Set bounds</entry> - </row> - <row> - <entry> <link linkend="package.images.image-graph.image-graph-axis.setnumbercolor"><function>Image_Graph_Axis::setNumbercolor</function></link></entry> - <entry>Set color for numbers on the axis</entry> - </row> - <row> - <entry> <link linkend="package.images.image-graph.image-graph-axis.setnumberformat"><function>Image_Graph_Axis::setNumberformat</function></link></entry> - <entry>Set numberformat for axis</entry> - </row> - <row> - <entry> <link linkend="package.images.image-graph.image-graph-axis.setticksautosteps"><function>Image_Graph_Axis::setTicksAutoSteps</function></link></entry> - <entry>Set maximum steps for automatic creation of ticksMajor/ticksMinor</entry> - </row> - <row> - <entry> <link linkend="package.images.image-graph.image-graph-axis.setticksize"><function>Image_Graph_Axis::setTickSize</function></link></entry> - <entry>Set size for (major) ticks on axis</entry> - </row> - <row> - <entry> <link linkend="package.images.image-graph.image-graph-axis.setticksmajor"><function>Image_Graph_Axis::setTicksMajor</function></link></entry> - <entry>Set major ticks on axis</entry> - </row> - <row> - <entry> <link linkend="package.images.image-graph.image-graph-axis.setticksminor"><function>Image_Graph_Axis::setTicksMinor</function></link></entry> - <entry>Set minor ticks on axis</entry> - </row> - <row> - <entry> <link linkend="package.images.image-graph.image-graph-axis.settickstyle"><function>Image_Graph_Axis::setTickStyle</function></link></entry> - <entry>Set tick-style for ticks on a axis</entry> - </row> - </tbody> - </tgroup> - </table> - <table> - <title>Inherited from <link linkend="package.images.image-graph.image-graph-base-summary"><classname>Image_Graph_Base</classname></link></title> - <tgroup cols="2"> - <thead> - <row> - <entry>Method Name</entry> - <entry>Summary</entry> - </row> - </thead> - <tbody> - <row> - <entry> <link linkend="package.images.image-graph.image-graph-base.setcolor"><function>Image_Graph_Base::setColor</function></link></entry> - <entry>Set color</entry> - </row> - <row> - <entry> <link linkend="package.images.image-graph.image-graph-base.setfontoptions"><function>Image_Graph_Base::setFontOptions</function></link></entry> - <entry>Set options for fonts</entry> - </row> - <row> - <entry> <link linkend="package.images.image-graph.image-graph-base.setspacer"><function>Image_Graph_Base::setSpacer</function></link></entry> - <entry>Set spacer</entry> - </row> - <row> - <entry> <link linkend="package.images.image-graph.image-graph-base.settext"><function>Image_Graph_Base::setText</function></link></entry> - <entry>Set text</entry> - </row> - </tbody> - </tgroup> - </table> - </para> -</refsect1> -</refentry> -&package.images.image-graph.image-graph-axis-x.image-graph-axis-x; -&package.images.image-graph.image-graph-axis-x.setaxistype; -&package.images.image-graph.image-graph-axis-x.setlabels; -&package.images.image-graph.image-graph-axis-x.valuetopixelabsolute; -&package.images.image-graph.image-graph-axis-x.valuetopixelrelative; -<refentry id="package.images.image-graph.image-graph-axis-y-summary"> - <refnamediv> - <refname>Class Summary <classname>Image_Graph_Axis_Y</classname></refname> - <refpurpose>Class for storing x-axis settings</refpurpose> - </refnamediv> -<refsect1> - <title>Class for storing x-axis settings</title> - <para>Based upon the the common attributes/methods provided by the Image_Graph_Axis-class this one addresses all features which are needed for the y-axis.</para> - -</refsect1> -<refsect1> -<title>Class Trees for <classname>Image_Graph_Axis_Y</classname></title> - <para> - <itemizedlist> - <listitem><para> - <link linkend="package.images.image-graph.image-graph-base-summary"><classname>Image_Graph_Base</classname></link> - <itemizedlist> - <listitem><para> - <link linkend="package.images.image-graph.image-graph-axis-summary"><classname>Image_Graph_Axis</classname></link> - <itemizedlist> - <listitem><para> - Image_Graph_Axis_Y - </para></listitem> - </itemizedlist> - </para></listitem> - </itemizedlist> - </para></listitem> - </itemizedlist> - </para> - <para> - <classname>Image_Graph_Axis_Y</classname> Inherited Methods - </para> - <para> - <table> - <title>Inherited from <link linkend="package.images.image-graph.image-graph-axis-summary"><classname>Image_Graph_Axis</classname></link></title> - <tgroup cols="2"> - <thead> - <row> - <entry>Method Name</entry> - <entry>Summary</entry> - </row> - </thead> - <tbody> - <row> - <entry> Constructor <link linkend="package.images.image-graph.image-graph-axis.image-graph-axis"><function>Image_Graph_Axis::Image_Graph_Axis</function></link></entry> - <entry>Constructor</entry> - </row> - <row> - <entry> <link linkend="package.images.image-graph.image-graph-axis.setbounds"><function>Image_Graph_Axis::setBounds</function></link></entry> - <entry>Set bounds</entry> - </row> - <row> - <entry> <link linkend="package.images.image-graph.image-graph-axis.setnumbercolor"><function>Image_Graph_Axis::setNumbercolor</function></link></entry> - <entry>Set color for numbers on the axis</entry> - </row> - <row> - <entry> <link linkend="package.images.image-graph.image-graph-axis.setnumberformat"><function>Image_Graph_Axis::setNumberformat</function></link></entry> - <entry>Set numberformat for axis</entry> - </row> - <row> - <entry> <link linkend="package.images.image-graph.image-graph-axis.setticksautosteps"><function>Image_Graph_Axis::setTicksAutoSteps</function></link></entry> - <entry>Set maximum steps for automatic creation of ticksMajor/ticksMinor</entry> - </row> - <row> - <entry> <link linkend="package.images.image-graph.image-graph-axis.setticksize"><function>Image_Graph_Axis::setTickSize</function></link></entry> - <entry>Set size for (major) ticks on axis</entry> - </row> - <row> - <entry> <link linkend="package.images.image-graph.image-graph-axis.setticksmajor"><function>Image_Graph_Axis::setTicksMajor</function></link></entry> - <entry>Set major ticks on axis</entry> - </row> - <row> - <entry> <link linkend="package.images.image-graph.image-graph-axis.setticksminor"><function>Image_Graph_Axis::setTicksMinor</function></link></entry> - <entry>Set minor ticks on axis</entry> - </row> - <row> - <entry> <link linkend="package.images.image-graph.image-graph-axis.settickstyle"><function>Image_Graph_Axis::setTickStyle</function></link></entry> - <entry>Set tick-style for ticks on a axis</entry> - </row> - </tbody> - </tgroup> - </table> - <table> - <title>Inherited from <link linkend="package.images.image-graph.image-graph-base-summary"><classname>Image_Graph_Base</classname></link></title> - <tgroup cols="2"> - <thead> - <row> - <entry>Method Name</entry> - <entry>Summary</entry> - </row> - </thead> - <tbody> - <row> - <entry> <link linkend="package.images.image-graph.image-graph-base.setcolor"><function>Image_Graph_Base::setColor</function></link></entry> - <entry>Set color</entry> - </row> - <row> - <entry> <link linkend="package.images.image-graph.image-graph-base.setfontoptions"><function>Image_Graph_Base::setFontOptions</function></link></entry> - <entry>Set options for fonts</entry> - </row> - <row> - <entry> <link linkend="package.images.image-graph.image-graph-base.setspacer"><function>Image_Graph_Base::setSpacer</function></link></entry> - <entry>Set spacer</entry> - </row> - <row> - <entry> <link linkend="package.images.image-graph.image-graph-base.settext"><function>Image_Graph_Base::setText</function></link></entry> - <entry>Set text</entry> - </row> - </tbody> - </tgroup> - </table> - </para> -</refsect1> -</refentry> -&package.images.image-graph.image-graph-axis-y.image-graph-axis-y; -&package.images.image-graph.image-graph-axis-y.setaxistype; -&package.images.image-graph.image-graph-axis-y.valuetopixelabsolute; -&package.images.image-graph.image-graph-axis-y.valuetopixelrelative; -<refentry id="package.images.image-graph.image-graph-base-summary"> - <refnamediv> - <refname>Class Summary <classname>Image_Graph_Base</classname></refname> - <refpurpose>Base class for data-storage in common objects</refpurpose> - </refnamediv> -<refsect1> - <title>Base class for data-storage in common objects</title> - <para>Some attributes and methods to manipulate them are used in almost any object for the graph. This class provides the base-functionality for the classes derived from it.</para> - -</refsect1> -<refsect1> -<title>Class Trees for <classname>Image_Graph_Base</classname></title> - <para> - <itemizedlist> - <listitem><para> - Image_Graph_Base - </para></listitem> - </itemizedlist> - </para> - <para> - <table> - <title>Classes that extend <classname>Image_Graph_Base</classname></title> - <tgroup cols="2"> - <thead> - <row> - <entry>Class</entry> - <entry>Summary</entry> - </row> - </thead> - <tbody> - <row> - <entry><link linkend="package.images.image-graph.image-graph-title-summary">Image_Graph_Title</link></entry> - <entry>Class for storing a title</entry> - </row> - <row> - <entry><link linkend="package.images.image-graph.image-graph-axis-summary">Image_Graph_Axis</link></entry> - <entry>Class for storing axis settings</entry> - </row> - <row> - <entry><link linkend="package.images.image-graph.image-graph-grid-summary">Image_Graph_Grid</link></entry> - <entry>Class for storing grid-element settings</entry> - </row> - </tbody> - </tgroup> - </table> - </para> -</refsect1> -</refentry> -&package.images.image-graph.image-graph-base.setcolor; -&package.images.image-graph.image-graph-base.setfontoptions; -&package.images.image-graph.image-graph-base.setspacer; -&package.images.image-graph.image-graph-base.settext; -<refentry id="package.images.image-graph.image-graph-color-summary"> - <refnamediv> - <refname>Class Summary <classname>Image_Graph_Color</classname></refname> - <refpurpose>Class for color-handling</refpurpose> - </refnamediv> -<refsect1> - <title>Class for color-handling</title> - <para>This is used to extend the functionality of the current PEAR::Image_Color v0.4. I hope to be allowed to incorporate some of the improvements in a new Image_Color release.</para> - -</refsect1> -<refsect1> -<title>Class Trees for <classname>Image_Graph_Color</classname></title> - <para> - <itemizedlist> - <listitem><para> - Image_Color - <itemizedlist> - <listitem><para> - Image_Graph_Color - </para></listitem> - </itemizedlist> - </para></listitem> - </itemizedlist> - </para> -</refsect1> -</refentry> -&package.images.image-graph.image-graph-color.allocatecolor; -&package.images.image-graph.image-graph-color.color2rgb; -&package.images.image-graph.image-graph-color.getrange; -<refentry id="package.images.image-graph.image-graph-datamarker-common-summary"> - <refnamediv> - <refname>Class Summary <classname>Image_Graph_DataMarker_Common</classname></refname> - <refpurpose>Base class for a datamarker-element (e.g. "diamond", -"square" or "triangle")</refpurpose> - </refnamediv> -<refsect1> - <title>Base class for a datamarker-element (e.g. "diamond", -"square" or "triangle")</title> - <para>This class provides a basic implementation that is used and extended in all derived datamarker-elements.</para> - -</refsect1> -<refsect1> -<title>Class Trees for <classname>Image_Graph_DataMarker_Common</classname></title> - <para> - <itemizedlist> - <listitem><para> - Image_Graph_DataMarker_Common - </para></listitem> - </itemizedlist> - </para> - <para> - <table> - <title>Classes that extend <classname>Image_Graph_DataMarker_Common</classname></title> - <tgroup cols="2"> - <thead> - <row> - <entry>Class</entry> - <entry>Summary</entry> - </row> - </thead> - <tbody> - <row> - <entry><link linkend="package.images.image-graph.image-graph-datamarker-diamond-summary">Image_Graph_DataMarker_Diamond</link></entry> - <entry>Diamond datamarker-element</entry> - </row> - <row> - <entry><link linkend="package.images.image-graph.image-graph-datamarker-square-summary">Image_Graph_DataMarker_Square</link></entry> - <entry>Square datamarker-element</entry> - </row> - </tbody> - </tgroup> - </table> - </para> -</refsect1> -</refentry> -&package.images.image-graph.image-graph-datamarker-common.image-graph-datamarker-common; -&package.images.image-graph.image-graph-datamarker-common.setcolor; -&package.images.image-graph.image-graph-datamarker-common.setsize; -<refentry id="package.images.image-graph.image-graph-datamarker-diamond-summary"> - <refnamediv> - <refname>Class Summary <classname>Image_Graph_DataMarker_Diamond</classname></refname> - <refpurpose>Diamond datamarker-element</refpurpose> - </refnamediv> -<refsect1> - <title>Diamond datamarker-element</title> - <para>The shape of this datamarker is a diamond (or rhomb). The size set by setSize() is the width/height.</para> - -</refsect1> -<refsect1> -<title>Class Trees for <classname>Image_Graph_DataMarker_Diamond</classname></title> - <para> - <itemizedlist> - <listitem><para> - <link linkend="package.images.image-graph.image-graph-datamarker-common-summary"><classname>Image_Graph_DataMarker_Common</classname></link> - <itemizedlist> - <listitem><para> - Image_Graph_DataMarker_Diamond - </para></listitem> - </itemizedlist> - </para></listitem> - </itemizedlist> - </para> - <para> - <classname>Image_Graph_DataMarker_Diamond</classname> Inherited Methods - </para> - <para> - <table> - <title>Inherited from <link linkend="package.images.image-graph.image-graph-datamarker-common-summary"><classname>Image_Graph_DataMarker_Common</classname></link></title> - <tgroup cols="2"> - <thead> - <row> - <entry>Method Name</entry> - <entry>Summary</entry> - </row> - </thead> - <tbody> - <row> - <entry> Constructor <link linkend="package.images.image-graph.image-graph-datamarker-common.image-graph-datamarker-common"><function>Image_Graph_DataMarker_Common::Image_Graph_DataMarker_Common</function></link></entry> - <entry>Constructor</entry> - </row> - <row> - <entry> <link linkend="package.images.image-graph.image-graph-datamarker-common.setcolor"><function>Image_Graph_DataMarker_Common::setColor</function></link></entry> - <entry>Set color</entry> - </row> - <row> - <entry> <link linkend="package.images.image-graph.image-graph-datamarker-common.setsize"><function>Image_Graph_DataMarker_Common::setSize</function></link></entry> - <entry>Set size</entry> - </row> - </tbody> - </tgroup> - </table> - </para> -</refsect1> -</refentry> -&package.images.image-graph.image-graph-datamarker-diamond.image-graph-datamarker-diamond; -&package.images.image-graph.image-graph-datamarker-diamond.drawgd; -<refentry id="package.images.image-graph.image-graph-datamarker-square-summary"> - <refnamediv> - <refname>Class Summary <classname>Image_Graph_DataMarker_Square</classname></refname> - <refpurpose>Square datamarker-element</refpurpose> - </refnamediv> -<refsect1> - <title>Square datamarker-element</title> - <para>The shape of this datamarker is a square. The size set by setSize() is the width/height.</para> - -</refsect1> -<refsect1> -<title>Class Trees for <classname>Image_Graph_DataMarker_Square</classname></title> - <para> - <itemizedlist> - <listitem><para> - <link linkend="package.images.image-graph.image-graph-datamarker-common-summary"><classname>Image_Graph_DataMarker_Common</classname></link> - <itemizedlist> - <listitem><para> - Image_Graph_DataMarker_Square - </para></listitem> - </itemizedlist> - </para></listitem> - </itemizedlist> - </para> - <para> - <classname>Image_Graph_DataMarker_Square</classname> Inherited Methods - </para> - <para> - <table> - <title>Inherited from <link linkend="package.images.image-graph.image-graph-datamarker-common-summary"><classname>Image_Graph_DataMarker_Common</classname></link></title> - <tgroup cols="2"> - <thead> - <row> - <entry>Method Name</entry> - <entry>Summary</entry> - </row> - </thead> - <tbody> - <row> - <entry> Constructor <link linkend="package.images.image-graph.image-graph-datamarker-common.image-graph-datamarker-common"><function>Image_Graph_DataMarker_Common::Image_Graph_DataMarker_Common</function></link></entry> - <entry>Constructor</entry> - </row> - <row> - <entry> <link linkend="package.images.image-graph.image-graph-datamarker-common.setcolor"><function>Image_Graph_DataMarker_Common::setColor</function></link></entry> - <entry>Set color</entry> - </row> - <row> - <entry> <link linkend="package.images.image-graph.image-graph-datamarker-common.setsize"><function>Image_Graph_DataMarker_Common::setSize</function></link></entry> - <entry>Set size</entry> - </row> - </tbody> - </tgroup> - </table> - </para> -</refsect1> -</refentry> -&package.images.image-graph.image-graph-datamarker-square.image-graph-datamarker-square; -&package.images.image-graph.image-graph-datamarker-square.drawgd; -<refentry id="package.images.image-graph.image-graph-data-bar-summary"> - <refnamediv> - <refname>Class Summary <classname>Image_Graph_Data_Bar</classname></refname> - <refpurpose>Bar data-element</refpurpose> - </refnamediv> -<refsect1> - <title>Bar data-element</title> - <para>This class is used to draw a bar in the diagram. Support for stacking is implemented in this element.</para> - -</refsect1> -<refsect1> -<title>Class Trees for <classname>Image_Graph_Data_Bar</classname></title> - <para> - <itemizedlist> - <listitem><para> - <link linkend="package.images.image-graph.image-graph-data-common-summary"><classname>Image_Graph_Data_Common</classname></link> - <itemizedlist> - <listitem><para> - Image_Graph_Data_Bar - </para></listitem> - </itemizedlist> - </para></listitem> - </itemizedlist> - </para> - <para> - <classname>Image_Graph_Data_Bar</classname> Inherited Methods - </para> - <para> - <table> - <title>Inherited from <link linkend="package.images.image-graph.image-graph-data-common-summary"><classname>Image_Graph_Data_Common</classname></link></title> - <tgroup cols="2"> - <thead> - <row> - <entry>Method Name</entry> - <entry>Summary</entry> - </row> - </thead> - <tbody> - <row> - <entry> Constructor <link linkend="package.images.image-graph.image-graph-data-common.image-graph-data-common"><function>Image_Graph_Data_Common::Image_Graph_Data_Common</function></link></entry> - <entry>Constructor</entry> - </row> - <row> - <entry> <link linkend="package.images.image-graph.image-graph-data-common.drawgd"><function>Image_Graph_Data_Common::drawGD</function></link></entry> - <entry>Draws diagram element</entry> - </row> - <row> - <entry> <link linkend="package.images.image-graph.image-graph-data-common.setcolor"><function>Image_Graph_Data_Common::setColor</function></link></entry> - <entry>Set color</entry> - </row> - <row> - <entry> <link linkend="package.images.image-graph.image-graph-data-common.setdatamarker"><function>Image_Graph_Data_Common::setDataMarker</function></link></entry> - <entry>Set a data marker to be used</entry> - </row> - <row> - <entry> <link linkend="package.images.image-graph.image-graph-data-common.setfill"><function>Image_Graph_Data_Common::setFill</function></link></entry> - <entry>Set a fill element to be used</entry> - </row> - <row> - <entry> <link linkend="package.images.image-graph.image-graph-data-common.stackingdrawgd"><function>Image_Graph_Data_Common::stackingDrawGD</function></link></entry> - <entry>Draw all diagram elements in this stacking-group</entry> - </row> - </tbody> - </tgroup> - </table> - </para> -</refsect1> -</refentry> -&package.images.image-graph.image-graph-data-bar.image-graph-data-bar; -&package.images.image-graph.image-graph-data-bar.drawgd; -&package.images.image-graph.image-graph-data-bar.stackingprepare; -<refentry id="package.images.image-graph.image-graph-data-common-summary"> - <refnamediv> - <refname>Class Summary <classname>Image_Graph_Data_Common</classname></refname> - <refpurpose>Base class for a data-element (e.g. "line" or "bar")</refpurpose> - </refnamediv> -<refsect1> - <title>Base class for a data-element (e.g. "line" or "bar")</title> - <para>This class provides a basic implementation that is used and extended in all derived data elements. An instance of this class can be used as a "null output" (not actually drawing anything). This is usually *not* needed, however it might be useful in special cases.</para> - -</refsect1> -<refsect1> -<title>Class Trees for <classname>Image_Graph_Data_Common</classname></title> - <para> - <itemizedlist> - <listitem><para> - Image_Graph_Data_Common - </para></listitem> - </itemizedlist> - </para> - <para> - <table> - <title>Classes that extend <classname>Image_Graph_Data_Common</classname></title> - <tgroup cols="2"> - <thead> - <row> - <entry>Class</entry> - <entry>Summary</entry> - </row> - </thead> - <tbody> - <row> - <entry><link linkend="package.images.image-graph.image-graph-data-line-summary">Image_Graph_Data_Line</link></entry> - <entry>Line data-element</entry> - </row> - <row> - <entry><link linkend="package.images.image-graph.image-graph-data-bar-summary">Image_Graph_Data_Bar</link></entry> - <entry>Bar data-element</entry> - </row> - </tbody> - </tgroup> - </table> - </para> -</refsect1> -</refentry> -&package.images.image-graph.image-graph-data-common.image-graph-data-common; -&package.images.image-graph.image-graph-data-common.drawgd; -&package.images.image-graph.image-graph-data-common.setcolor; -&package.images.image-graph.image-graph-data-common.setdatamarker; -&package.images.image-graph.image-graph-data-common.setfill; -&package.images.image-graph.image-graph-data-common.stackingdrawgd; -<refentry id="package.images.image-graph.image-graph-data-line-summary"> - <refnamediv> - <refname>Class Summary <classname>Image_Graph_Data_Line</classname></refname> - <refpurpose>Line data-element</refpurpose> - </refnamediv> -<refsect1> - <title>Line data-element</title> - <para>This class is used to draw a line in the diagram. Support for stacking is implemented in this element.</para> - -</refsect1> -<refsect1> -<title>Class Trees for <classname>Image_Graph_Data_Line</classname></title> - <para> - <itemizedlist> - <listitem><para> - <link linkend="package.images.image-graph.image-graph-data-common-summary"><classname>Image_Graph_Data_Common</classname></link> - <itemizedlist> - <listitem><para> - Image_Graph_Data_Line - </para></listitem> - </itemizedlist> - </para></listitem> - </itemizedlist> - </para> - <para> - <classname>Image_Graph_Data_Line</classname> Inherited Methods - </para> - <para> - <table> - <title>Inherited from <link linkend="package.images.image-graph.image-graph-data-common-summary"><classname>Image_Graph_Data_Common</classname></link></title> - <tgroup cols="2"> - <thead> - <row> - <entry>Method Name</entry> - <entry>Summary</entry> - </row> - </thead> - <tbody> - <row> - <entry> Constructor <link linkend="package.images.image-graph.image-graph-data-common.image-graph-data-common"><function>Image_Graph_Data_Common::Image_Graph_Data_Common</function></link></entry> - <entry>Constructor</entry> - </row> - <row> - <entry> <link linkend="package.images.image-graph.image-graph-data-common.drawgd"><function>Image_Graph_Data_Common::drawGD</function></link></entry> - <entry>Draws diagram element</entry> - </row> - <row> - <entry> <link linkend="package.images.image-graph.image-graph-data-common.setcolor"><function>Image_Graph_Data_Common::setColor</function></link></entry> - <entry>Set color</entry> - </row> - <row> - <entry> <link linkend="package.images.image-graph.image-graph-data-common.setdatamarker"><function>Image_Graph_Data_Common::setDataMarker</function></link></entry> - <entry>Set a data marker to be used</entry> - </row> - <row> - <entry> <link linkend="package.images.image-graph.image-graph-data-common.setfill"><function>Image_Graph_Data_Common::setFill</function></link></entry> - <entry>Set a fill element to be used</entry> - </row> - <row> - <entry> <link linkend="package.images.image-graph.image-graph-data-common.stackingdrawgd"><function>Image_Graph_Data_Common::stackingDrawGD</function></link></entry> - <entry>Draw all diagram elements in this stacking-group</entry> - </row> - </tbody> - </tgroup> - </table> - </para> -</refsect1> -</refentry> -&package.images.image-graph.image-graph-data-line.image-graph-data-line; -&package.images.image-graph.image-graph-data-line.drawgd; -&package.images.image-graph.image-graph-data-line.stackingdrawgd; -&package.images.image-graph.image-graph-data-line.stackingprepare; -<refentry id="package.images.image-graph.image-graph-fill-common-summary"> - <refnamediv> - <refname>Class Summary <classname>Image_Graph_Fill_Common</classname></refname> - <refpurpose>Base class for a fill-element (e.g. a "solid" fill or a -"gradient" fill)</refpurpose> - </refnamediv> -<refsect1> - <title>Base class for a fill-element (e.g. a "solid" fill or a -"gradient" fill)</title> - <para>This class provides a basic implementation that is used and extended in all derived fill-elements. Fill-elements can be used at various places in Image_Graph. E.g. you can use it for filling a data-element (Image_Graph_Data_Common and derived classes) or a grid-element (Image_Graph_Grid).</para> - -</refsect1> -<refsect1> -<title>Class Trees for <classname>Image_Graph_Fill_Common</classname></title> - <para> - <itemizedlist> - <listitem><para> - Image_Graph_Fill_Common - </para></listitem> - </itemizedlist> - </para> - <para> - <table> - <title>Classes that extend <classname>Image_Graph_Fill_Common</classname></title> - <tgroup cols="2"> - <thead> - <row> - <entry>Class</entry> - <entry>Summary</entry> - </row> - </thead> - <tbody> - <row> - <entry><link linkend="package.images.image-graph.image-graph-fill-solid-summary">Image_Graph_Fill_Solid</link></entry> - <entry>Solid fill-element</entry> - </row> - <row> - <entry><link linkend="package.images.image-graph.image-graph-fill-gradient-summary">Image_Graph_Fill_Gradient</link></entry> - <entry>Gradient fill-element</entry> - </row> - </tbody> - </tgroup> - </table> - </para> -</refsect1> -</refentry> -&package.images.image-graph.image-graph-fill-common.image-graph-fill-common; -&package.images.image-graph.image-graph-fill-common.drawgdbox; -&package.images.image-graph.image-graph-fill-common.drawgdpolygon; -&package.images.image-graph.image-graph-fill-common.setcolor; -<refentry id="package.images.image-graph.image-graph-fill-gradient-summary"> - <refnamediv> - <refname>Class Summary <classname>Image_Graph_Fill_Gradient</classname></refname> - <refpurpose>Gradient fill-element</refpurpose> - </refnamediv> -<refsect1> - <title>Gradient fill-element</title> - <para>This class is used throughout Image_Graph to perform gradient fills. It is mainly used for diagram-data-elements (like a bar or a line) and the diagram-grid. Note that also more than 2 colors can be provided which will result in a gradient-fill from one color to the next [...] to the last one (multiple gradients).</para> - -</refsect1> -<refsect1> -<title>Class Trees for <classname>Image_Graph_Fill_Gradient</classname></title> - <para> - <itemizedlist> - <listitem><para> - <link linkend="package.images.image-graph.image-graph-fill-common-summary"><classname>Image_Graph_Fill_Common</classname></link> - <itemizedlist> - <listitem><para> - Image_Graph_Fill_Gradient - </para></listitem> - </itemizedlist> - </para></listitem> - </itemizedlist> - </para> - <para> - <classname>Image_Graph_Fill_Gradient</classname> Inherited Methods - </para> - <para> - <table> - <title>Inherited from <link linkend="package.images.image-graph.image-graph-fill-common-summary"><classname>Image_Graph_Fill_Common</classname></link></title> - <tgroup cols="2"> - <thead> - <row> - <entry>Method Name</entry> - <entry>Summary</entry> - </row> - </thead> - <tbody> - <row> - <entry> Constructor <link linkend="package.images.image-graph.image-graph-fill-common.image-graph-fill-common"><function>Image_Graph_Fill_Common::Image_Graph_Fill_Common</function></link></entry> - <entry>Constructor</entry> - </row> - <row> - <entry> <link linkend="package.images.image-graph.image-graph-fill-common.drawgdbox"><function>Image_Graph_Fill_Common::drawGDBox</function></link></entry> - <entry>Draws fill element, shape: box</entry> - </row> - <row> - <entry> <link linkend="package.images.image-graph.image-graph-fill-common.drawgdpolygon"><function>Image_Graph_Fill_Common::drawGDPolygon</function></link></entry> - <entry>Draws fill element, shape: polygon</entry> - </row> - <row> - <entry> <link linkend="package.images.image-graph.image-graph-fill-common.setcolor"><function>Image_Graph_Fill_Common::setColor</function></link></entry> - <entry>Set color</entry> - </row> - </tbody> - </tgroup> - </table> - </para> -</refsect1> -</refentry> -&package.images.image-graph.image-graph-fill-gradient.image-graph-fill-gradient; -&package.images.image-graph.image-graph-fill-gradient.drawgdbox; -&package.images.image-graph.image-graph-fill-gradient.drawgdpolygon; -&package.images.image-graph.image-graph-fill-gradient.setcolor; -<refentry id="package.images.image-graph.image-graph-fill-solid-summary"> - <refnamediv> - <refname>Class Summary <classname>Image_Graph_Fill_Solid</classname></refname> - <refpurpose>Solid fill-element</refpurpose> - </refnamediv> -<refsect1> - <title>Solid fill-element</title> - <para>This class is used throughout Image_Graph to perform solid fills. It is mainly used for diagram-data-elements (like a bar or a line) and the diagram-grid.</para> - -</refsect1> -<refsect1> -<title>Class Trees for <classname>Image_Graph_Fill_Solid</classname></title> - <para> - <itemizedlist> - <listitem><para> - <link linkend="package.images.image-graph.image-graph-fill-common-summary"><classname>Image_Graph_Fill_Common</classname></link> - <itemizedlist> - <listitem><para> - Image_Graph_Fill_Solid - </para></listitem> - </itemizedlist> - </para></listitem> - </itemizedlist> - </para> - <para> - <classname>Image_Graph_Fill_Solid</classname> Inherited Methods - </para> - <para> - <table> - <title>Inherited from <link linkend="package.images.image-graph.image-graph-fill-common-summary"><classname>Image_Graph_Fill_Common</classname></link></title> - <tgroup cols="2"> - <thead> - <row> - <entry>Method Name</entry> - <entry>Summary</entry> - </row> - </thead> - <tbody> - <row> - <entry> Constructor <link linkend="package.images.image-graph.image-graph-fill-common.image-graph-fill-common"><function>Image_Graph_Fill_Common::Image_Graph_Fill_Common</function></link></entry> - <entry>Constructor</entry> - </row> - <row> - <entry> <link linkend="package.images.image-graph.image-graph-fill-common.drawgdbox"><function>Image_Graph_Fill_Common::drawGDBox</function></link></entry> - <entry>Draws fill element, shape: box</entry> - </row> - <row> - <entry> <link linkend="package.images.image-graph.image-graph-fill-common.drawgdpolygon"><function>Image_Graph_Fill_Common::drawGDPolygon</function></link></entry> - <entry>Draws fill element, shape: polygon</entry> - </row> - <row> - <entry> <link linkend="package.images.image-graph.image-graph-fill-common.setcolor"><function>Image_Graph_Fill_Common::setColor</function></link></entry> - <entry>Set color</entry> - </row> - </tbody> - </tgroup> - </table> - </para> -</refsect1> -</refentry> -&package.images.image-graph.image-graph-fill-solid.image-graph-fill-solid; -&package.images.image-graph.image-graph-fill-solid.drawgdbox; -<refentry id="package.images.image-graph.image-graph-grid-summary"> - <refnamediv> - <refname>Class Summary <classname>Image_Graph_Grid</classname></refname> - <refpurpose>Class for storing grid-element settings</refpurpose> - </refnamediv> -<refsect1> - <title>Class for storing grid-element settings</title> - <para>The "grid" is used to make values (positions) inside the graph easier to read by using horizontal/vertical lines and/or filled areas as the graph background. It's possible to draw the grid at the major or minor ticks. Using two or more alternating colors/fills for the grid is an "impressive" and useful feature for the generated graphs. All fill-elements (derived from Image_Graph_Fill_Common) can be used. In most cases you will want to choose a solid fills with a certain color. However it might be useful to e.g. use some pattern fills (stripes, dots, ...) which will make reading possible even if you print it out in black/white. Since the normal fill-elements are used, you can also use alpha-values for the colors. This way it's still possible to see the graph background through the fill. Note that you shouldn't use too many different colors/fills since this can have a negative and disturbing effect on the readability of the graph.</para> - -</refsect1> -<refsect1> -<title>Class Trees for <classname>Image_Graph_Grid</classname></title> - <para> - <itemizedlist> - <listitem><para> - <link linkend="package.images.image-graph.image-graph-base-summary"><classname>Image_Graph_Base</classname></link> - <itemizedlist> - <listitem><para> - Image_Graph_Grid - </para></listitem> - </itemizedlist> - </para></listitem> - </itemizedlist> - </para> - <para> - <classname>Image_Graph_Grid</classname> Inherited Methods - </para> - <para> - <table> - <title>Inherited from <link linkend="package.images.image-graph.image-graph-base-summary"><classname>Image_Graph_Base</classname></link></title> - <tgroup cols="2"> - <thead> - <row> - <entry>Method Name</entry> - <entry>Summary</entry> - </row> - </thead> - <tbody> - <row> - <entry> <link linkend="package.images.image-graph.image-graph-base.setcolor"><function>Image_Graph_Base::setColor</function></link></entry> - <entry>Set color</entry> - </row> - <row> - <entry> <link linkend="package.images.image-graph.image-graph-base.setfontoptions"><function>Image_Graph_Base::setFontOptions</function></link></entry> - <entry>Set options for fonts</entry> - </row> - <row> - <entry> <link linkend="package.images.image-graph.image-graph-base.setspacer"><function>Image_Graph_Base::setSpacer</function></link></entry> - <entry>Set spacer</entry> - </row> - <row> - <entry> <link linkend="package.images.image-graph.image-graph-base.settext"><function>Image_Graph_Base::setText</function></link></entry> - <entry>Set text</entry> - </row> - </tbody> - </tgroup> - </table> - </para> -</refsect1> -</refentry> -&package.images.image-graph.image-graph-grid.image-graph-grid; -&package.images.image-graph.image-graph-grid.setfill; -&package.images.image-graph.image-graph-grid.setfilltype; -&package.images.image-graph.image-graph-grid.setlinetype; -<refentry id="package.images.image-graph.image-graph-title-summary"> - <refnamediv> - <refname>Class Summary <classname>Image_Graph_Title</classname></refname> - <refpurpose>Class for storing a title</refpurpose> - </refnamediv> -<refsect1> - <title>Class for storing a title</title> - <para>Titles are needed in various places: diagram title, axis titles, ... This function provides a common API for all titles</para> - -</refsect1> -<refsect1> -<title>Class Trees for <classname>Image_Graph_Title</classname></title> - <para> - <itemizedlist> - <listitem><para> - <link linkend="package.images.image-graph.image-graph-base-summary"><classname>Image_Graph_Base</classname></link> - <itemizedlist> - <listitem><para> - Image_Graph_Title - </para></listitem> - </itemizedlist> - </para></listitem> - </itemizedlist> - </para> - <para> - <table> - <title>Classes that extend <classname>Image_Graph_Title</classname></title> - <tgroup cols="2"> - <thead> - <row> - <entry>Class</entry> - <entry>Summary</entry> - </row> - </thead> - <tbody> - <row> - <entry><link linkend="package.images.image-graph.image-graph-axis-values-summary">Image_Graph_Axis_Values</link></entry> - <entry>Class for handling textual and numerical values on the axes</entry> - </row> - </tbody> - </tgroup> - </table> - </para> - <para> - <classname>Image_Graph_Title</classname> Inherited Methods - </para> - <para> - <table> - <title>Inherited from <link linkend="package.images.image-graph.image-graph-base-summary"><classname>Image_Graph_Base</classname></link></title> - <tgroup cols="2"> - <thead> - <row> - <entry>Method Name</entry> - <entry>Summary</entry> - </row> - </thead> - <tbody> - <row> - <entry> <link linkend="package.images.image-graph.image-graph-base.setcolor"><function>Image_Graph_Base::setColor</function></link></entry> - <entry>Set color</entry> - </row> - <row> - <entry> <link linkend="package.images.image-graph.image-graph-base.setfontoptions"><function>Image_Graph_Base::setFontOptions</function></link></entry> - <entry>Set options for fonts</entry> - </row> - <row> - <entry> <link linkend="package.images.image-graph.image-graph-base.setspacer"><function>Image_Graph_Base::setSpacer</function></link></entry> - <entry>Set spacer</entry> - </row> - <row> - <entry> <link linkend="package.images.image-graph.image-graph-base.settext"><function>Image_Graph_Base::setText</function></link></entry> - <entry>Set text</entry> - </row> - </tbody> - </tgroup> - </table> - </para> -</refsect1> -</refentry> -&package.images.image-graph.image-graph-title.image-graph-title; -&package.images.image-graph.image-graph-title.setcolor; -&package.images.image-graph.constants; -</sect1> -<!-- Generated by phpDocumentor v 1.3.0RC2 http://www.phpdoc.org --> +<!-- $Revision: 1.6 $ --> +<sect1 id="package.images.image-graph"> + <title>Image_Graph</title> + + <simpara> + Due to the fact that the <classname>Image_Graph</classname> is + currently in development phase, there is no documentation available + in the manual. + </simpara> + <simpara> + Extensive example code is available on an <ulink + url="http://pear.veggerby.dk/samples/">external site</ulink>. + </simpara> +</sect1> + <!-- Keep this comment at the end of the file Local variables: mode: sgml