mirror of
https://gitlab.com/freepascal.org/lazarus/lazarus.git
synced 2025-08-14 11:19:24 +02:00
TAChart: Document TAGraph unit.
git-svn-id: trunk@22084 -
This commit is contained in:
ask
parent
35d3ebf0e8
commit
d11ae66a06
@ -41,6 +41,10 @@ property of that series set to <var>true</var>.</p>
|
||||
</element>
|
||||
<element name="TChart">
|
||||
<short>Main charting component.</short>
|
||||
<descr>
|
||||
<p>The chart is composed of list of <link id="TBasicChartSeries">series</link> and fixed <link id="TATypes.TChartElement">elements</link> like legend, axises and footers.</p>
|
||||
<p>Chart methods work with two coordinate systems: floating-point coordinates supplied by series (often called <i>graph coordinates)</i> and on-screen coordinates (often called <i>image coordinates</i>)</p>
|
||||
</descr>
|
||||
</element>
|
||||
<element name="TChart.BackColor">
|
||||
<short>Color of back plane of the chart.</short>
|
||||
@ -131,6 +135,156 @@ independently of zoom level.</descr>
|
||||
<element name="TChart.Extent">
|
||||
<short>Manual overrides for the chart extent borders.</short>
|
||||
</element>
|
||||
<element name="TBasicChartSeries">
|
||||
<short>The basic chart series class. Do not inherit or instantiate directly.</short>
|
||||
</element>
|
||||
<element name="TBasicChartSeries.Draw">
|
||||
<short>Draw the series on a given canvas.</short>
|
||||
</element>
|
||||
<element name="TBasicChartSeries.IsEmpty">
|
||||
<short>Return <var>true</var> if the series contains no data.</short>
|
||||
</element>
|
||||
<element name="TBasicChartSeries.Active">
|
||||
<short>If <var>true</var>, this series is visible and taken into account in extent calculation.</short>
|
||||
</element>
|
||||
<element name="TBasicChartSeries.Depth">
|
||||
<short>The extent of the series along Z axis, in pixels. Zero for 2D series.</short>
|
||||
<seealso>
|
||||
<link id="TBasicChartSeries.ZPosition">ZPosition</link>
|
||||
<link id="TChart.Depth">TChart.Depth</link>
|
||||
</seealso>
|
||||
</element>
|
||||
<element name="TBasicChartSeries.ParentChart">
|
||||
<short>The chart owning this series</short>
|
||||
</element>
|
||||
<element name="TBasicChartSeries.ShowInLegend">
|
||||
<short>If <var>true</var>, this series is displayed in the legend.</short>
|
||||
</element>
|
||||
<element name="TBasicChartSeries.Title">
|
||||
<short>Series title to show in legend.</short>
|
||||
</element>
|
||||
<element name="TBasicChartSeries.ZPosition">
|
||||
<short>Offset of the series along Z-axis, in pixels. Also determines series drawing order.</short>
|
||||
<descr>
|
||||
<p>The series are drawn in order of decreasing <var>ZPosition</var> value.</p>
|
||||
<p>So to bring series on 2D chart to front, set it's <var>ZPosition</var> to 0.</p>
|
||||
</descr>
|
||||
<seealso>
|
||||
<link id="TBasicChartSeries.Depth">Depth</link>
|
||||
<link id="TChart.Depth">TChart.Depth</link>
|
||||
</seealso>
|
||||
</element>
|
||||
<element name="TChartSeriesList">
|
||||
<short>The list of chart series.</short>
|
||||
</element>
|
||||
<element name="TChartSeriesList.Items">
|
||||
<short>Retrieve char series by index.</short>
|
||||
</element>
|
||||
<element name="TBasicChartSeries.AfterAdd">
|
||||
<short>Called after the series was added to a chart.</short>
|
||||
<seealso>
|
||||
<link id="TChart.AddSeries">TChart.AddSeries</link>
|
||||
</seealso>
|
||||
</element>
|
||||
<element name="TBasicChartSeries.AfterDraw">
|
||||
<short>Called after the series is drawn.</short>
|
||||
</element>
|
||||
<element name="TBasicChartSeries.BeforeDraw">
|
||||
<short>Called before the series is drawn.</short>
|
||||
</element>
|
||||
<element name="TBasicChartSeries.GetLegendItems">
|
||||
<short>Get the list if legend items for this series.</short>
|
||||
<descr>Note that the series may return several items.
|
||||
|
||||
For example, <link id="TASeries.TPieSeries">pie series</link> displays a separate legend item for each pie slice.</descr>
|
||||
</element>
|
||||
<element name="TBasicChartSeries.UpdateBounds">
|
||||
<short>Update the default chart extent according to this series data.</short>
|
||||
</element>
|
||||
<element name="TBasicChartSeries.UpdateMargins">
|
||||
<short>Update chart margins according to this series data.</short>
|
||||
<descr>In particular, margins are used to make room for labels.</descr>
|
||||
</element>
|
||||
<element name="TChart.AddSeries">
|
||||
<short>Add given series to this chart.</short>
|
||||
<descr>Note that the series can only belong to a single chart.</descr>
|
||||
</element>
|
||||
<element name="TChart.ClearSeries">
|
||||
<short>Remove all series from this chart.</short>
|
||||
</element>
|
||||
<element name="TChart.DeleteSeries">
|
||||
<short>Delete given series from the chart.</short>
|
||||
</element>
|
||||
<element name="TChart.PaintOnCanvas">
|
||||
<short>Draw the chart on a given canvas. May be used to print the chart.</short>
|
||||
</element>
|
||||
<element name="TChart.ZoomFull">
|
||||
<short>Restore the default zoom level.</short>
|
||||
</element>
|
||||
<element name="TChart.SaveToImage">
|
||||
<short>Return a raster image of the given type with the screenshot of the chart.</short>
|
||||
<seealso>
|
||||
<link id="TChart.SaveToFile">SaveToFile</link>
|
||||
</seealso>
|
||||
<descr>The image must be freed by calling code.</descr>
|
||||
</element>
|
||||
<element name="TChart.SaveToFile">
|
||||
<short>Save chart screenshot to a file as a raster image of the given type.</short>
|
||||
<seealso>
|
||||
<link id="TChart.SaveToImage">SaveToImage</link>
|
||||
<link id="#LCL.Graphics.TGraphic.SaveToFile">TGraphic.SaveToFile</link>
|
||||
</seealso>
|
||||
</element>
|
||||
<element name="TChart.SaveToBitmapFile">
|
||||
<short>Save chart screenshot to a file as a bitmap image.</short>
|
||||
<descr>Deprecated. Use SaveToFile(TBitmap, fileName) instead.</descr>
|
||||
<seealso>
|
||||
<link id="TChart.SaveToFile">SaveToFile</link>
|
||||
</seealso>
|
||||
</element>
|
||||
<element name="TBasicChartSeries.GetNearestPoint">
|
||||
<short>Get the series point nearest to <var>APoint</var> as measured by <var>ADistFunc</var>.</short>
|
||||
<descr>Return <var>true</var> if such a point exists.</descr>
|
||||
</element>
|
||||
<element name="TChart.GraphToImage">
|
||||
<short>Convert ф point from graph coordinates to image coordinates.</short>
|
||||
</element>
|
||||
<element name="TChart.ImageToGraph">
|
||||
<short>Convert a point from image coordinates to graph coordinates.</short>
|
||||
</element>
|
||||
<element name="TChart.XGraphToImage">
|
||||
<short>Convert X graph coordinate to image coordinate.</short>
|
||||
</element>
|
||||
<element name="TChart.YGraphToImage">
|
||||
<short>Convert Y graph coordinate to image coordinate.</short>
|
||||
</element>
|
||||
<element name="TChart.XImageToGraph">
|
||||
<short>Convert X image coordinate to graph coordinate.</short>
|
||||
</element>
|
||||
<element name="TChart.YImageToGraph">
|
||||
<short>Convert Y image coordinate to graph coordinate.</short>
|
||||
</element>
|
||||
<element name="TChart.CurrentExtent">
|
||||
<short>Return the chart extent at the current zoom level.</short>
|
||||
</element>
|
||||
<element name="TChart.XGraphMax">
|
||||
<short>Deprecated, use <link id="TChart.CurrentExtent">CurrentExtent</link> instead.</short>
|
||||
</element>
|
||||
<element name="TChart.XGraphMin">
|
||||
<short>Deprecated, use <link id="TChart.CurrentExtent">CurrentExtent</link> instead.</short>
|
||||
</element>
|
||||
<element name="TChart.YGraphMax">
|
||||
<short>Deprecated, use <link id="TChart.CurrentExtent">CurrentExtent</link> instead.</short>
|
||||
</element>
|
||||
<element name="TChart.YGraphMin">
|
||||
<short>Deprecated, use <link id="TChart.CurrentExtent">CurrentExtent</link> instead.</short>
|
||||
</element>
|
||||
<element name="TChart.CopyToClipboardBitmap">
|
||||
<short>Save chart screenshot to the clipboard.</short>
|
||||
<seealso>
|
||||
<link id="TChart.SaveToImage">SaveToImage</link>
|
||||
</seealso>
|
||||
</element>
|
||||
</module>
|
||||
</package>
|
||||
</fpdoc-descriptions>
|
||||
|
||||
Loading…
Reference in New Issue
Block a user