mirror of
https://gitlab.com/freepascal.org/lazarus/lazarus.git
synced 2025-04-06 08:18:13 +02:00
TAChart: Beginning to update the xml help files.
git-svn-id: trunk@60405 -
This commit is contained in:
wp
parent
4bb5c5ff41
commit
8375daf906
2
.gitattributes
vendored
2
.gitattributes
vendored
@ -5181,8 +5181,10 @@ components/tachart/fpdoc/tachartaxis.xml svneol=native#text/plain
|
||||
components/tachart/fpdoc/tachartutils.xml svneol=native#text/plain
|
||||
components/tachart/fpdoc/tacustomseries.xml svneol=native#text/plain
|
||||
components/tachart/fpdoc/tadbsource.xml svneol=native#text/plain
|
||||
components/tachart/fpdoc/tageometry.xml svneol=native#text/xml
|
||||
components/tachart/fpdoc/tagraph.xml svneol=native#text/plain
|
||||
components/tachart/fpdoc/talegend.xml svneol=native#text/plain
|
||||
components/tachart/fpdoc/tamath.xml svneol=native#text/xml
|
||||
components/tachart/fpdoc/taseries.xml svneol=native#text/plain
|
||||
components/tachart/fpdoc/tasources.xml svneol=native#text/plain
|
||||
components/tachart/fpdoc/tatypes.xml svneol=native#text/plain
|
||||
|
||||
@ -1,8 +1,10 @@
|
||||
tachartutils.xml
|
||||
tacustomseries.xml
|
||||
tadbsource.xml
|
||||
tageometry.xml
|
||||
tagraph.xml
|
||||
talegend.xml
|
||||
tamath.xml
|
||||
taseries.xml
|
||||
tasources.xml
|
||||
tatypes.xml
|
||||
|
||||
@ -1,8 +1,10 @@
|
||||
..\tachartutils.pas
|
||||
..\tacustomseries.pas
|
||||
..\tadbsource.pas
|
||||
..\tageometry.pas
|
||||
..\tagraph.pas
|
||||
..\talegend.pas
|
||||
..\tamath.pas
|
||||
..\taseries.pas
|
||||
..\tasources.pas
|
||||
-dfpdoc ..\tatypes.pas
|
||||
|
||||
@ -1,4 +1,4 @@
|
||||
<?xml version="1.0"?>
|
||||
<?xml version="1.0" encoding="UTF-8"?>
|
||||
<fpdoc-descriptions>
|
||||
<package name="TAChartLazarusPkg">
|
||||
<module name="TAChartAxis">
|
||||
@ -22,7 +22,8 @@ for vertical axises.</descr>
|
||||
</element>
|
||||
<element name="TChartAxis.Alignment">
|
||||
<short>Determines the side of the chart whcih the axis is aligned to</short>
|
||||
<descr>Left- and right-aligned axises are vertical, top- and bottom-aligned axises are horizontal.</descr>
|
||||
<descr>Left- and right-aligned axises are vertical, top- and bottom-aligned axises are horizontal.
|
||||
</descr>
|
||||
</element>
|
||||
<element name="TChartAxis.Grid">
|
||||
<short>Pen used for grid drawing</short>
|
||||
@ -39,7 +40,8 @@ for vertical axises.</descr>
|
||||
<p>If the source is set, marks are determined by <var>X</var> or <var>Y</var> coordinates
|
||||
of <var>Source</var> items for horizontal and vertical axises correspondingly.
|
||||
</p>
|
||||
<p>Otherwise, marks are created automatically.</p></descr>
|
||||
<p>Otherwise, marks are created automatically.</p>
|
||||
</descr>
|
||||
</element>
|
||||
</module>
|
||||
</package>
|
||||
|
||||
@ -1,6 +1,15 @@
|
||||
<?xml version="1.0"?>
|
||||
<?xml version="1.0" encoding="UTF-8"?>
|
||||
<fpdoc-descriptions>
|
||||
<package name="TAChartLazarusPkg">
|
||||
<module name="TAChartUtils"/>
|
||||
<module name="TAChartUtils">
|
||||
<element name="TDoublePoint">
|
||||
<short>Data type for a point with floating point coordinates X and Y</short>
|
||||
</element>
|
||||
<element name="TDoubleRect">
|
||||
<short>Data structure for a rectangle with floating point coordinates defined by opposite corner points a and b</short>
|
||||
<seealso><link id=""/>
|
||||
</seealso>
|
||||
</element>
|
||||
</module>
|
||||
</package>
|
||||
</fpdoc-descriptions>
|
||||
|
||||
96
components/tachart/fpdoc/tageometry.xml
Normal file
96
components/tachart/fpdoc/tageometry.xml
Normal file
@ -0,0 +1,96 @@
|
||||
<?xml version="1.0" encoding="UTF-8"?>
|
||||
<fpdoc-descriptions>
|
||||
<package name="TAChartLazarusPkg">
|
||||
<module name="TAGeometry">
|
||||
<element name="IsPointInRect">
|
||||
<short>Returns <var>true</var> when the point <var>AP</var> is inside a rectangle or on its borders.</short>
|
||||
<descr>The rectangle can be specified as a <var>TRect</var> structure or by its top/left and bottom/right corner points (<var>TPoint</var>).
|
||||
</descr>
|
||||
</element>
|
||||
<element name="IsRectInRect">
|
||||
<short>Returns <var>true</var> when a rectangle is contained within another rectangle</short>
|
||||
<descr>Note: The rectangle is still considered to be contained within the outer
|
||||
rectangle even when their corners collide.
|
||||
</descr>
|
||||
</element>
|
||||
<element name="CopyPoints">
|
||||
<short>Copies the points from a TPoint array to the result array</short>
|
||||
</element>
|
||||
<element name="DotProduct">
|
||||
<short>Calculates the dot product of the two 2D vectors A and B</short>
|
||||
<descr>The dot product of two vectors A and B is calculated as
|
||||
<var>Result := A.X * B.X + A.Y * B.Y</var>
|
||||
</descr>
|
||||
</element>
|
||||
<element name="DoublePoint">
|
||||
<short>Creates a <var>TDoublePoint</var> record from two floating point values AX and AY, or from a <var>TPoint</var> having integer coordinates</short>
|
||||
<seealso>
|
||||
<link id="TAChartUtils.TDoublePoint">TDoublePoint</link>
|
||||
</seealso>
|
||||
</element>
|
||||
<element name="DoubleRect">
|
||||
<short>Creates a <var>TDoubleRect</var> data structure from four floating point values</short>
|
||||
<seealso>
|
||||
<link id="TAChartUtils.TDoubleRect">TDoubleRect</link>
|
||||
</seealso>
|
||||
</element>
|
||||
<element name="ExpandRect">
|
||||
<short>Expands the given rectangle by the X and Y values of the specified point</short>
|
||||
</element>
|
||||
<element name="IsPointOnLine">
|
||||
<short>Returns <var>true</var> when the point <var>AP</var> is on the line between the points <var>A1</var> and <var>A2</var>
|
||||
</short>
|
||||
</element>
|
||||
<element name="IsPointInPolygon">
|
||||
<short>Returns <var>true</var> when the point <var>AP</var> is inside or on the border of the polygon define by the points in the array <var>APolygon</var>
|
||||
</short>
|
||||
</element>
|
||||
<element name="IsLineIntersectsLine">
|
||||
<short>Returns <var>true</var> when the line defined by the points <var>AA</var> and <var>AB</var> intersects the line given by the points <var>AC</var> and <var>AD</var>
|
||||
</short>
|
||||
</element>
|
||||
<element name="IsPolygonIntersectsPolygon">
|
||||
<short>Returns <var>true</var> when the two polygons given by the point arrays <var>AP1</var> and <var>AP2</var>, respectively, intersect</short>
|
||||
</element>
|
||||
<element name="LineIntersectsRect">
|
||||
<short>Returns <var>true</var> when the line given by the points <var>AA</var> and <var>AB</var> intersects the given rectangle <var>ARect</var>
|
||||
</short>
|
||||
</element>
|
||||
<element name="MakeSquare">
|
||||
<short>Creates a square rectangle from the input rectangle <var>ARect</var>
|
||||
</short>
|
||||
<descr>The length of the longer side is shortened to become equal to the shorter side.
|
||||
</descr>
|
||||
</element>
|
||||
<element name="MaxPoint">
|
||||
<short>Creates a <var>TPoint</var> from the maximum x and y coordinates of two other points, <var>A</var> and <var>B</var>
|
||||
</short>
|
||||
</element>
|
||||
<element name="MeasureRotatedRect"/>
|
||||
<element name="NormalizeRect">
|
||||
<short>Ensures that the corner coordinates of the given rectangle are in the correct order</short>
|
||||
<descr>
|
||||
<ul>
|
||||
<li>for <b>integer </b>coordinates: <var>Left <= Right</var> and <var>Top <= Bottom</var>
|
||||
</li>
|
||||
<li>for <b>floating point</b> coordinates:<var>a.X <= b.X</var> and <var>a.Y <= b.Y</var>
|
||||
</li>
|
||||
</ul>
|
||||
</descr>
|
||||
</element>
|
||||
<element name="PointDist"><short>Returns a parameter characterizing the distance between the points <var>A</var> and <var>B</var>
|
||||
</short><descr>The "distance" is calculated as the square of the sum of the coordinate differences:
|
||||
<p><var>Result := sqr(A.X - B.X) + sqr(A.Y - B.Y)</var>
|
||||
</p><p>The standard Euclidian distance would be obtained by calculating the square root of the result.</p>
|
||||
</descr>
|
||||
</element><element name="PointDistX"><short>Returns the difference of the X coordinates of the two points <var>A</var> and <var>B</var>
|
||||
</short>
|
||||
</element><element name="PointDistY"><short>Returns the difference of the Y coordinates of the two points <var>A</var> and <var>B</var>
|
||||
</short>
|
||||
</element><element name="PointLineDist"><short>Returns a parameter for the distance between point <var>P</var> and the line given by the points <var>A</var> and <var>B</var>
|
||||
</short><descr>Note that this parameter corresponds to the squared Euclidian distance.
|
||||
</descr>
|
||||
</element>
|
||||
</module>
|
||||
</package>
|
||||
</fpdoc-descriptions>
|
||||
@ -1,49 +1,30 @@
|
||||
<?xml version="1.0"?>
|
||||
<?xml version="1.0" encoding="utf-8"?>
|
||||
<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>
|
||||
<short>If <var>true</var>, the user can zoom chart with the mouse.</short>
|
||||
<descr>Allow the user to zoom the chart by drawing a 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>
|
||||
<p>Chart methods work with four coordinate systems:
|
||||
<ul>
|
||||
<li>
|
||||
<b>Axis coordinates</b> (known in some other applications as object coordinates) -- they are "raw" coordinate values obtained from the data. As the name implies, axis coordinates are interpreted in terms of specific axis -- the same coordinate value may have different meaning depending on the axis it is applied to.</li>
|
||||
<li>
|
||||
<b>Graph coordinates</b> are converted from the axis coordinates by means of axis transformations, such as logarithmic scale. Graph coordinates are common to all objects in the chart. Consider the graph coordinates as an invisible graphing paper behind the chart; its x axis is horizontal running from left to right, and its y axis is vertical running from bottom to top even if a series is rotated.</li>
|
||||
<li>
|
||||
<b>Image coordinates</b> (aka screen coordinates) are converted from graph coordinates based on the chart viewport. This transformation is always linear and can be influenced by chart tools such as zooming and panning.</li>
|
||||
<li>
|
||||
<b>Device coordinates</b> are usually equal to screen coordinates, but may be adjusted to the drawing back-end to accommodate different physical resolutions (DPI values). See, for example, printer drawer.</li>
|
||||
</ul>
|
||||
</p>
|
||||
</descr>
|
||||
</element>
|
||||
<element name="TChart.BackColor">
|
||||
@ -60,49 +41,58 @@ which is used to paint the background of all <var>TChart</var>, including legend
|
||||
<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>
|
||||
<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 the <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>
|
||||
<link id=""/>
|
||||
<link id=""/>
|
||||
</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>
|
||||
<descr>
|
||||
<p>To add or remove series at run-time,
|
||||
use
|
||||
<link id="TChart.AddSeries">AddSeries</link> and
|
||||
<link id="TChart.DeleteSeries">DeleteSeries</link> methods.
|
||||
</p>
|
||||
<p>Use <link id="TChartSeriesCount">SeriesCount</link> to determine the number of series contained in the chart.</p>
|
||||
</descr>
|
||||
<seealso>
|
||||
<link id="TChart.AddSeries">AddSeries</link>
|
||||
<link id="TChart.ClearSeries">ClearSeries</link>
|
||||
<link id="TChart.DeleteSeries">DeleteSeries</link>
|
||||
<link id=""/>
|
||||
<link id=""/>
|
||||
<link id=""/>
|
||||
</seealso>
|
||||
</element>
|
||||
<element name="TChart.SeriesCount">
|
||||
<short>The number of chart series, including inactive ones.</short>
|
||||
<short>Returns 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>
|
||||
<short>The pen to draw a frame around the chart's viewport.</short>
|
||||
<descr>
|
||||
<p>The position of the frame is coincient with the default axis position. </p>
|
||||
<p>Set <var>Frame.Visible</var> to <var>false</var> to turn off frame drawing.
|
||||
</p>
|
||||
</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
|
||||
<descr>Retrieves the 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>
|
||||
<link id=""/>
|
||||
<link id=""/>
|
||||
</seealso>
|
||||
</element>
|
||||
<element name="TChart.LeftAxis">
|
||||
@ -118,9 +108,6 @@ use <link id="TChart.AddSeries">AddSeries</link> and <link id="TChart.DeleteSeri
|
||||
<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>
|
||||
@ -134,12 +121,16 @@ independently of zoom level.</descr>
|
||||
</element>
|
||||
<element name="TChart.Extent">
|
||||
<short>Manual overrides for the chart extent borders.</short>
|
||||
<descr>
|
||||
<p>The <var>Extent</var> defines the unzoomed viewport of the chart.</p>
|
||||
<p>Values entered here override any other automatic extent calculation.</p>
|
||||
</descr>
|
||||
</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>
|
||||
<short>Draw the series using the specified drawer</short>
|
||||
</element>
|
||||
<element name="TBasicChartSeries.IsEmpty">
|
||||
<short>Return <var>true</var> if the series contains no data.</short>
|
||||
@ -209,29 +200,41 @@ For example, <link id="TASeries.TPieSeries">pie series</link> displays a separat
|
||||
<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>
|
||||
<short>Removes all series from this chart.</short>
|
||||
<descr>Note that the series are <b>not </b>destroyed.</descr>
|
||||
</element>
|
||||
<element name="TChart.DeleteSeries">
|
||||
<short>Delete given series from the chart.</short>
|
||||
<short>Deletes a given series from the chart.</short>
|
||||
<descr>Note that the series is <b>not</b> destroyed.</descr>
|
||||
<seealso>
|
||||
<link id=""/>
|
||||
</seealso>
|
||||
</element>
|
||||
<element name="TChart.PaintOnCanvas">
|
||||
<short>Draw the chart on a given canvas. May be used to print the chart.</short>
|
||||
<short>Draw the chart on a given canvas.</short>
|
||||
<descr>
|
||||
<p>The canvas passed to this method not necessarily is that of the screen. It can be the canvas provided by some other drawing device, such as a bitmap or the printer.</p>
|
||||
<p>Note, however, that this method is out-dated; the recommended method of drawing is by calling the method <var>Draw</var> which allows painting also on devices which do not have a canvas.</p>
|
||||
</descr>
|
||||
<seealso>
|
||||
<link id=""/>
|
||||
</seealso>
|
||||
</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>
|
||||
<short>Returns a raster image of the given type with the screenshot of the chart.</short>
|
||||
<descr>The image must be freed by calling code.</descr>
|
||||
<seealso>
|
||||
<link id=""/>
|
||||
</seealso>
|
||||
</element>
|
||||
<element name="TChart.SaveToFile">
|
||||
<short>Save chart screenshot to a file as a raster image of the given type.</short>
|
||||
<short>Saves 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>
|
||||
<link id=""/>
|
||||
<link id=""/>
|
||||
</seealso>
|
||||
</element>
|
||||
<element name="TChart.SaveToBitmapFile">
|
||||
@ -246,42 +249,74 @@ For example, <link id="TASeries.TPieSeries">pie series</link> displays a separat
|
||||
<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>
|
||||
<short>Converts a point from graph coordinates to image coordinates.</short>
|
||||
</element>
|
||||
<element name="TChart.ImageToGraph">
|
||||
<short>Convert a point from image coordinates to graph coordinates.</short>
|
||||
<short>Converts a point from image coordinates to graph coordinates.</short>
|
||||
<seealso>
|
||||
<link id=""/>
|
||||
</seealso>
|
||||
</element>
|
||||
<element name="TChart.XGraphToImage">
|
||||
<short>Convert X graph coordinate to image coordinate.</short>
|
||||
<short>Converts the X coordinate of a point from graph coordinates to image coordinates.</short>
|
||||
<seealso>
|
||||
<link id=""/>
|
||||
</seealso>
|
||||
</element>
|
||||
<element name="TChart.YGraphToImage">
|
||||
<short>Convert Y graph coordinate to image coordinate.</short>
|
||||
<short>Converts the Y coordinate of a point from graph units to image units.</short>
|
||||
<seealso>
|
||||
<link id=""/>
|
||||
</seealso>
|
||||
</element>
|
||||
<element name="TChart.XImageToGraph">
|
||||
<short>Convert X image coordinate to graph coordinate.</short>
|
||||
<short>Converts the X coordinate of a point from image coordinates to graph coordinates.</short>
|
||||
<seealso>
|
||||
<link id=""/>
|
||||
</seealso>
|
||||
</element>
|
||||
<element name="TChart.YImageToGraph">
|
||||
<short>Convert Y image coordinate to graph coordinate.</short>
|
||||
<short>Converts the Y coordinate of a point from image units to graph units.</short>
|
||||
<seealso>
|
||||
<link id=""/>
|
||||
</seealso>
|
||||
</element>
|
||||
<element name="TChart.CurrentExtent">
|
||||
<short>Return the chart extent at the current zoom level.</short>
|
||||
<short>Returns the chart extent at the current zoom level.</short>
|
||||
<descr>The extent is the visible viewport of the chart. It is given in graph coordinates.</descr>
|
||||
<seealso>
|
||||
<link id=""/>
|
||||
</seealso>
|
||||
</element>
|
||||
<element name="TChart.XGraphMax">
|
||||
<short>Deprecated, use <link id="TChart.CurrentExtent">CurrentExtent</link> instead.</short>
|
||||
<short>Returns the maximum x value of the chart in graph units</short>
|
||||
<descr>Deprecated, use
|
||||
<link id="TChart.CurrentExtent">CurrentExtent</link> instead.</descr>
|
||||
</element>
|
||||
<element name="TChart.XGraphMin">
|
||||
<short>Deprecated, use <link id="TChart.CurrentExtent">CurrentExtent</link> instead.</short>
|
||||
<short>Returns the minimum x value of the chart in graph coordinates</short>
|
||||
<descr>Deprecated, use
|
||||
|
||||
<link id="TChart.CurrentExtent">CurrentExtent</link> instead.</descr>
|
||||
</element>
|
||||
<element name="TChart.YGraphMax">
|
||||
<short>Deprecated, use <link id="TChart.CurrentExtent">CurrentExtent</link> instead.</short>
|
||||
<short>Returns the maximum y value of the chart, in graph coordinates</short>
|
||||
<descr>Deprecated, use <link id="TChart.CurrentExtent">CurrentExtent</link> instead.</descr>
|
||||
<seealso>
|
||||
<link id=""/>
|
||||
</seealso>
|
||||
</element>
|
||||
<element name="TChart.YGraphMin">
|
||||
<short>Deprecated, use <link id="TChart.CurrentExtent">CurrentExtent</link> instead.</short>
|
||||
<short>Returns the minimum y value of the chart in graph coordinates</short>
|
||||
<descr>Deprecated, use <link id="TChart.CurrentExtent">CurrentExtent</link> instead.</descr>
|
||||
<seealso>
|
||||
<link id=""/>
|
||||
</seealso>
|
||||
</element>
|
||||
<element name="TChart.CopyToClipboardBitmap">
|
||||
<short>Save chart screenshot to the clipboard.</short>
|
||||
<short>Copies a bitmap screenshot of the chart to the clipboard.</short>
|
||||
<seealso>
|
||||
<link id="TChart.SaveToImage">SaveToImage</link>
|
||||
<link id=""/>
|
||||
</seealso>
|
||||
</element>
|
||||
<element name="Register" skip="1"/>
|
||||
@ -290,6 +325,20 @@ For example, <link id="TASeries.TPieSeries">pie series</link> displays a separat
|
||||
<element name="TChart.GetChildren" skip="1"/>
|
||||
<element name="TChart.Paint" skip="1"/>
|
||||
<element name="TChart.SetChildOrder" skip="1"/>
|
||||
<element name="TChart.AllowPanning">
|
||||
<short>If <var>true</var>, the user can drag the visible viewport of the chart with the mouse.</short>
|
||||
<descr>Allows the user to pan the chart by dragging the visible vieport with the right mouse button.</descr>
|
||||
</element>
|
||||
<element name="TChart.PaintOnCanvas.Draw"/>
|
||||
<element name="TChart.Draw">
|
||||
<short>Draws the chart usung the given drawing back-end</short>
|
||||
<descr>This method draw the chart by means of the given drawing back-end,
|
||||
<var>Drawer</var>. Unlike
|
||||
<var>PaintOnCanvas</var> the chart can be drawn on non-canvas devices, such as a svg file.</descr>
|
||||
<seealso>
|
||||
<link id=""/>
|
||||
</seealso>
|
||||
</element>
|
||||
</module>
|
||||
</package>
|
||||
</fpdoc-descriptions>
|
||||
|
||||
31
components/tachart/fpdoc/tamath.xml
Normal file
31
components/tachart/fpdoc/tamath.xml
Normal file
@ -0,0 +1,31 @@
|
||||
<?xml version="1.0" encoding="UTF-8"?>
|
||||
<fpdoc-descriptions>
|
||||
<package name="TAChartLazarusPkg">
|
||||
<module name="TAMath"><element name="EnsureOrder"><short>If <var>A</var> is greater than <var>B</var> then both numbers are exchanged to make sure that <var>A</var> is never greater than <var>B</var>.</short>
|
||||
</element><element name="ExpandRange"><short>Expands the interval between <var>ALo</var> and <var>AHi</var> by subtracting <var>ACoeff</var> from <var>ALo</var> and adding it to <var>AHi</var>
|
||||
</short>
|
||||
</element><element name="SafeEqual"><short>Checks whether <var>A</var> is equal to <var>B</var> in a way which does not crash when one of the arguments is <var>NaN</var> ("not a number").</short>
|
||||
</element>
|
||||
<element name="SafeMin"><short>Returns the minimum of the numbers <var>A</var> and <var>B</var>. Does not crash when one of the values is <var>NaN</var> (Not a Number).</short>
|
||||
</element><element name="SafeInRange"><short>Returns <var>true</var> when <var>AValue</var> is within or at the bounds of the interval between <var>ABound1</var> and <var>ABound2</var>
|
||||
</short>
|
||||
</element><element name="SafeInRangeWithBounds"><short>Returns <var>true</var> when <var>AValue</var> is within or at the bounds of the interval between <var>ABound1</var> and <var>ABound2</var>
|
||||
</short><descr>Whether <var>AValue</var> is at the bounds of the interval is allowed within the specified tolerance <var>AEpsilon</var> where the default <var>AEpsilon=0</var> is interpreted as a <var>1E-12</var> fraction of the interval length.
|
||||
</descr>
|
||||
</element><element name="SafeNan"><short>Returns a value of <var>NaN</var> ("not a number") with range checking and overflow checking turned off.</short>
|
||||
</element><element name="Ulps"><short>Converts the double-precision value <var>AX</var> to an integer 2's complement representation.</short><descr>The difference between resulting integers can be interpreted as distance in ulps.
|
||||
</descr>
|
||||
</element><element name="SafeInfinity"><short>Returns a value of the special number <var>Infinity</var> with range checking and overflow checking turned off.</short>
|
||||
</element>
|
||||
<element name="InRangeUlps"><short>Returns <var>true</var> when <var>AX</var> is within or at the bounds of the interval between <var>ALo</var> and <var>AHi</var>
|
||||
</short><descr>The double-precision parameters are converted to an integer 2's complement representation.
|
||||
The comparison is made with a tolerance of <var>AMaxUlps</var>.
|
||||
</descr>
|
||||
</element><element name="CumulNormDistr"><short>Calculates the value of the <b>cumulative normal distribution</b> for the argument <var>AX</var>
|
||||
</short>
|
||||
</element><element name="InvCumulNormDistr"><short>Calculates the value of the <b>inverse cumulative normal distribution</b> for the argument <var>AX</var>
|
||||
</short>
|
||||
</element>
|
||||
</module>
|
||||
</package>
|
||||
</fpdoc-descriptions>
|
||||
@ -206,6 +206,7 @@ end;
|
||||
|
||||
// Convert double value to integer 2's complement representation.
|
||||
// Difference between resulting integers can be interpreted as distance in ulps.
|
||||
|
||||
function Ulps(AX: Double): Int64; inline;
|
||||
begin
|
||||
Result := Int64(AX);
|
||||
|
||||
Loading…
Reference in New Issue
Block a user