1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295
|
<?xml version="1.0"?>
<fpdoc-descriptions>
<package name="TAChartLazarusPkg">
<module name="TAGraph">
<element name="TChart.Title">
<short>Chart title.</short>
</element>
<element name="TReticuleMode">
<short>The mode of reticule drawing.</short>
<seealso>
<link id="TChart.ReticuleMode">TChart.ReticuleMode</link>
</seealso>
</element>
<element name="TReticuleMode.rmNone">
<short>Do not draw reticule.</short>
</element>
<element name="TReticuleMode.rmVertical">
<short>Draw reticule as a vertical line. Find nearest point by X coordinate.</short>
</element>
<element name="TReticuleMode.rmHorizontal">
<short>Draw reticule as a horizontal line. Find nearest point by Y coordinate.</short>
</element>
<element name="TReticuleMode.rmCross">
<short>Draw reticule as both vertical and horizontal line. Find nearest point by distanse.</short>
</element>
<element name="TChart.ReticuleMode">
<short>Reticule drawing mode.</short>
<descr>
<p>Reticule is a line highlighting graph point nearest to the mouse cursor.</p>
<p>For reticule to be visible, the chart needs to:</p>
<p>1. Have ReticuleMode to value other that rmNone;</p>
<p>2. Have at least one series implementing GetNearestPoint interface
(by default it is implemented by line, bar and area series);</p>
<p>3. Have <link id="TASeries.TBasicPointSeries.UseReticule">UseReticule</link>
property of that series set to <var>true</var>.</p>
</descr>
</element>
<element name="TChart.AllowZoom">
<short>If <var>true</var>, user can zoom chart with the mouse.</short>
<descr>Allow user to zoom chart by drawing new zoom rectangle with the mouse while holding left mouse button.</descr>
</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>
<descr>Note that <var>BackColor</var> is different form the <link id="TChart.Color">Color</link> property
which is used to paint the background of all <var>TChart</var>, including legend, axises and title.</descr>
<seealso>
<link id="TChart.Color">Color</link>
</seealso>
</element>
<element name="TChart.Depth">
<short>The length of Z axis in 3D mode, in pixels. Zero value means 2D mode.</short>
</element>
<element name="TChart.ExpandPercentage">
<short>Default extent size is increased by this percent. May be negative.</short>
<descr>
<p>To ensure full visualization of the extreme points of the chart, it is usually a good idea
to set the default zoom value so that the default extent is slightly greater
than the extent of chart data.</p>
<p>This can be done by either setting <var>ExpandPercentage</var> property,
which increases the extent value relatively, setting the <link id="TChart.Extent">extent</link>
manually, or setting absolute <link id="TChart.Margins">margins</link>.</p>
</descr>
<seealso>
<link id="TChart.Extent">Extent</link>
<link id="TChart.Margins">Margins</link>
</seealso>
</element>
<element name="TChart.Series">
<short>The list of chart series.</short>
<descr>To add or remove series at run-time,
use <link id="TChart.AddSeries">AddSeries</link> and <link id="TChart.DeleteSeries">DeleteSeries</link> methods.</descr>
<seealso>
<link id="TChart.AddSeries">AddSeries</link>
<link id="TChart.ClearSeries">ClearSeries</link>
<link id="TChart.DeleteSeries">DeleteSeries</link>
</seealso>
</element>
<element name="TChart.SeriesCount">
<short>The number of chart series, including inactive ones.</short>
</element>
<element name="TChart.Foot">
<short>Chart footer.</short>
</element>
<element name="TChart.Frame">
<short>The pen to draw frame around the chart.</short>
<descr>Set <var>Frame.Visible</var> to <var>false</var> to turn off frame drawing.</descr>
</element>
<element name="TChart.AxisList">
<short>List of graph <link id="TATypes.TChartAxis">axises</link>.</short>
</element>
<element name="TChart.BottomAxis">
<short>Bottom axis of the chart.</short>
<descr>Retrieves first axis from the <link id="TChart.AxisList">AxisList</link> with
<link id="TATypes.TChartAxis.Alignment">Alignment</link> set to
<link id="TATypes.TChartAxisAlignment">calBottom</link>.</descr>
<seealso>
<link id="TChart.AxisList">AxisList</link>
<link id="TATypes.TChartAxis.Alignment">TChartAxis.Alignment</link>
</seealso>
</element>
<element name="TChart.LeftAxis">
<short>Left axis of the chart.</short>
<descr>Retrieves first axis from the <link id="TChart.AxisList">AxisList</link> with
<link id="TATypes.TChartAxis.Alignment">Alignment</link> set to
<link id="TATypes.TChartAxisAlignment">calLeft</link>.</descr>
<seealso>
<link id="TChart.AxisList">AxisList</link>
<link id="TATypes.TChartAxis.Alignment">TChartAxis.Alignment</link>
</seealso>
</element>
<element name="TChart.Legend">
<short>Chart legend.</short>
</element>
<element name="TChart.OnDrawReticule">
<short>Called each time the <link id="TChart.ReticuleMode">reticule</link> is updated.</short>
</element>
<element name="TChart.Margins">
<short>Margins around the chart sides in default extent, in pixels.</short>
<seealso>
<link id="TChart.BorderSpacing">BorderSpacing</link>
<link id="TChart.ExpandPercentage">ExpandPercentage</link>
<link id="TChart.Extent">Extent</link>
</seealso>
<descr>Note that the margins set by this property have effect only on the default extent.
Use <link id="TChart.BorderSpacing">BorderSpacing</link> property to set margins
independently of zoom level.</descr>
</element>
<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 of 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>
<element name="Register" skip="1"/>
<element name="RegisterSeriesClass" skip="1"/>
<element name="TChart.EraseBackground" skip="1"/>
<element name="TChart.GetChildren" skip="1"/>
<element name="TChart.Paint" skip="1"/>
<element name="TChart.SetChildOrder" skip="1"/>
</module>
</package>
</fpdoc-descriptions>
|