paweld/lazarus
1
0
Fork 0
mirror of https://gitlab.com/freepascal.org/lazarus/lazarus.git synced 2025-08-27 00:40:18 +02:00
Code Issues Packages Projects Releases Wiki Activity

TAChart: Start documenting TACustomSeries unit.

Browse Source 
git-svn-id: trunk@22143 -
This commit is contained in:
ask 2009-10-13 14:20:05 +00:00
parent e3b340c74c
commit 76769b2c6b
1 changed files with 70 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

71
components/tachart/fpdoc/tacustomseries.xml
View File

@ -1,6 +1,75 @@
<?xml version="1.0"?>
<fpdoc-descriptions>
<package name="TAChartLazarusPkg">
<module name="TACustomSeries"/>
<module name="TACustomSeries">
<element name="TCustomChartSeries">
<short>Basic chart series. Inherit this if you want to create a new series type.</short>
</element>
<element name="TChartGetMarkEvent"/>
<element name="TChartSeries.Count">
<short>Return number of points in the series.</short>
</element>
<element name="TChartSeries.Add">
<short>Add new point to the right of the serie</short>
<descr>
<p>The X coordinate of the new point is calculated as the rightmost existing X coordinate plus 1.</p>
<p>Requires <link id="TChartSeries.ListSource">editable data source</link>.</p>
</descr>
<seealso>
<link id="TChartSeries.AddXY">AddXY</link>
</seealso>
<errors>
<link id="TASources.EEditableSourceRequired">EEditableSourceRequired</link>
</errors>
</element>
<element name="TChartSeries.AddXY">
<short>Add a new point to the series.</short>
<descr>
<p>Requires <link id="TChartSeries.ListSource">editable data source</link>.</p>
</descr>
<errors>
<link id="TASources.EEditableSourceRequired">EEditableSourceRequired</link>
</errors>
</element>
<element name="TChartSeries.ListSource">
<errors>
<link id="TASources.EEditableSourceRequired">EEditableSourceRequired</link>
</errors>
<short>Verify that the data source is editable and return it.</short>
</element>
<element name="TChartSeries.Clear">
<short>Remove all points from the series.</short>
<descr>
<p>Requires <link id="TChartSeries.ListSource">editable data source</link>.</p>
</descr>
</element>
<element name="TChartSeries.Delete">
<errors>
<link id="TASources.EEditableSourceRequired">EEditableSourceRequired</link>
</errors>
<short>Remove point by index.</short>
<descr>
<p>Requires <link id="TChartSeries.ListSource">editable data source</link>.</p>
</descr>
</element>
<element name="TChartSeries.SetXValue"/>
<element name="TChartSeries.SetYValue"/>
<element name="TChartSeries.Source">
<short>Series data source.</short>
</element>
<element name="TChartSeries.Marks">
<short>Mark paramaters.</short>
</element>
<element name="TChartSeries.OnGetMark">
<short>Called before the drawing of each mark.</short>
<seealso>
<link id="TChartSeries.Marks">Marks</link>
</seealso>
</element>
<element name="TChartSeries">
<short>Series with the data source.</short>
</element>
<element name="TChartSeries.Title" link="#TAChartLazarusPkg.TAGraph.TBasicChartSeries.Title"/>
</module>
</package>
</fpdoc-descriptions>