mirror of
https://gitlab.com/freepascal.org/lazarus/lazarus.git
synced 2025-08-11 18:36:10 +02:00
TAChart: Some more additions to xml help files.
git-svn-id: trunk@60408 -
This commit is contained in:
wp
parent
8f58e27315
commit
5ed9b1096b
@ -78,11 +78,12 @@ rectangle even when their corners collide.
|
||||
</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 name="PointDist">
|
||||
<short>Returns a parameter characterizing the distance between the points <var>A</var> and <var>B</var></short>
|
||||
<descr><p>The "distance" is calculated as the square of the sum of the coordinate differences:</p>
|
||||
<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>
|
||||
|
||||
@ -1,4 +1,4 @@
|
||||
<?xml version="1.0" encoding="utf-8"?>
|
||||
<?xml version="1.0" encoding="UTF-8"?>
|
||||
<fpdoc-descriptions>
|
||||
<package name="TAChartLazarusPkg">
|
||||
<module name="TAGraph">
|
||||
@ -11,20 +11,8 @@
|
||||
</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 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><p>The chart is composed of list of <link id="TBasicChartSeries">series</link> and fixed <link id="TATypes.TChartElement">elements</link> like legend, axes and footers.</p><p>Chart methods work with four coordinate systems:</p><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>
|
||||
</descr>
|
||||
</element>
|
||||
<element name="TChart.BackColor">
|
||||
@ -196,18 +184,20 @@ For example, <link id="TASeries.TPieSeries">pie series</link> displays a separat
|
||||
<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>
|
||||
<short>Adds the specified series to the chart.</short>
|
||||
<descr>Note that the series can only belong to a single chart.
|
||||
</descr>
|
||||
</element>
|
||||
<element name="TChart.ClearSeries">
|
||||
<short>Removes all series from this chart.</short>
|
||||
<descr>Note that the series are <b>not </b>destroyed.</descr>
|
||||
<short>Removes all series from the chart.</short>
|
||||
<descr>Note that the series are <b>not </b>destroyed.
|
||||
</descr>
|
||||
</element>
|
||||
<element name="TChart.DeleteSeries">
|
||||
<short>Deletes a given series from the chart.</short>
|
||||
<descr>Note that the series is <b>not</b> destroyed.</descr>
|
||||
<seealso>
|
||||
<link id=""/>
|
||||
<short>Deletes the specified 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">
|
||||
@ -222,6 +212,8 @@ For example, <link id="TASeries.TPieSeries">pie series</link> displays a separat
|
||||
</element>
|
||||
<element name="TChart.ZoomFull">
|
||||
<short>Restore the default zoom level.</short>
|
||||
<seealso><link id="#TAChartLazarusPkg.tagraph">GetFullExtent</link>
|
||||
</seealso>
|
||||
</element>
|
||||
<element name="TChart.SaveToImage">
|
||||
<short>Returns a raster image of the given type with the screenshot of the chart.</short>
|
||||
@ -253,45 +245,43 @@ For example, <link id="TASeries.TPieSeries">pie series</link> displays a separat
|
||||
</element>
|
||||
<element name="TChart.ImageToGraph">
|
||||
<short>Converts a point from image coordinates to graph coordinates.</short>
|
||||
<seealso>
|
||||
<link id=""/>
|
||||
<seealso><link id=""/>
|
||||
</seealso>
|
||||
</element>
|
||||
<element name="TChart.XGraphToImage">
|
||||
<short>Converts the X coordinate of a point from graph coordinates to image coordinates.</short>
|
||||
<seealso>
|
||||
<link id=""/>
|
||||
<seealso><link id=""/>
|
||||
</seealso>
|
||||
</element>
|
||||
<element name="TChart.YGraphToImage">
|
||||
<short>Converts the Y coordinate of a point from graph units to image units.</short>
|
||||
<seealso>
|
||||
<link id=""/>
|
||||
<seealso><link id=""/>
|
||||
</seealso>
|
||||
</element>
|
||||
<element name="TChart.XImageToGraph">
|
||||
<short>Converts the X coordinate of a point from image coordinates to graph coordinates.</short>
|
||||
<seealso>
|
||||
<link id=""/>
|
||||
<seealso><link id=""/>
|
||||
</seealso>
|
||||
</element>
|
||||
<element name="TChart.YImageToGraph">
|
||||
<short>Converts the Y coordinate of a point from image units to graph units.</short>
|
||||
<seealso>
|
||||
<link id=""/>
|
||||
<seealso><link id=""/>
|
||||
</seealso>
|
||||
</element>
|
||||
<element name="TChart.CurrentExtent">
|
||||
<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=""/>
|
||||
<descr>The extent is the visible viewport of the chart. It is given in graph coordinates.
|
||||
In addition to the viewport requested for zooming it also contains the inner
|
||||
chart margin and the space reserved for series marks.
|
||||
</descr>
|
||||
<seealso><link id="TChart.LogicalExtent">LogicalExtent</link>
|
||||
</seealso>
|
||||
</element>
|
||||
<element name="TChart.XGraphMax">
|
||||
<short>Returns the maximum x value of the chart in graph units</short>
|
||||
<descr>Deprecated, use
|
||||
<link id="TChart.CurrentExtent">CurrentExtent</link> instead.</descr>
|
||||
<link id="TChart.CurrentExtent">CurrentExtent</link> instead.
|
||||
</descr>
|
||||
</element>
|
||||
<element name="TChart.XGraphMin">
|
||||
<short>Returns the minimum x value of the chart in graph coordinates</short>
|
||||
@ -315,8 +305,7 @@ For example, <link id="TASeries.TPieSeries">pie series</link> displays a separat
|
||||
</element>
|
||||
<element name="TChart.CopyToClipboardBitmap">
|
||||
<short>Copies a bitmap screenshot of the chart to the clipboard.</short>
|
||||
<seealso>
|
||||
<link id=""/>
|
||||
<seealso><link id=""/>
|
||||
</seealso>
|
||||
</element>
|
||||
<element name="Register" skip="1"/>
|
||||
@ -332,13 +321,54 @@ For example, <link id="TASeries.TPieSeries">pie series</link> displays a separat
|
||||
<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,
|
||||
<descr>This method draws 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=""/>
|
||||
<var>PaintOnCanvas</var> the chart can be drawn on non-canvas devices, such as a svg file.
|
||||
</descr>
|
||||
<seealso><link id=""/>
|
||||
</seealso>
|
||||
</element>
|
||||
<element name="TChart.Create"><short>Creates the chart</short>
|
||||
</element><element name="TChart.Destroy"><short>Destroys the chart</short>
|
||||
</element><element name="TChart.IsPointInViewPort"><short>Returns <var>true</var> when the given point (in graph coordinates) is inside or at the boundaries of the chart's viewport (area spanned by the axes)</short>
|
||||
</element><element name="TChart.Clone"><short>Creates a new chart and copies all properties of the current chart to it.</short>
|
||||
</element><element name="TChart.DisableRedrawing"><short>Disables redrawing of the chart</short><descr><p>Useful when many data points are added.</p><p>Must be accompanied by <var>EnableRedrawing</var>, otherwise the chart will
|
||||
not be updated any more.</p>
|
||||
</descr>
|
||||
</element><element name="TChart.DrawLegendOn"><short>Draws the legend on the specified canvas in the given rectangle</short><descr>Useful to paint the legend outside the chart control.
|
||||
</descr>
|
||||
</element><element name="TChart.EnableRedrawing"><short>Enables redrawing of the chart</short><descr>Must be called after redrawing of the chart has been deactivated by calling
|
||||
DisableRedrawing. Otherwise the chart will not be updated any more.
|
||||
</descr>
|
||||
</element><element name="TChart.GetFullExtent"><short>Returns the full extent of the chart</short><descr>The full extent is the unzoomed viewport of the chart. This is usually determined
|
||||
automatically as the area encompassing all the data from series and axis ranges.
|
||||
</descr>
|
||||
</element><element name="TChart.Prepare"><short>Initializes extents and transformations before the chart is drawn.</short><descr>This method normally is executed automatically. It must be called explicitly, however,
|
||||
when the chart's extent is needed before the chart has been painted, e.g. in the
|
||||
form's OnCreate event.
|
||||
</descr>
|
||||
</element><element name="TChart.RemoveSeries"><short>Removes the specified series from the chart</short><descr>Note that the series is <b>not</b> destroyed.
|
||||
</descr>
|
||||
</element><element name="TChart.UsesBuiltinToolset"><short>Returns <var>true</var> when the built-in toolset is active.</short><descr>The built-in toolset is responsible for the default zooming and panning capabilities of the chart.
|
||||
When a separate <var>TChartToolset</var> is added in order to get more control over these
|
||||
processed or to use other tools the built-in toolset is de-activated and this function returns <var>false</var>.
|
||||
</descr>
|
||||
</element><element name="TChart.StyleChanged"><short>Part of the notification chain</short><descr>When any property of any chart element is changed the method <var>StyleChanged</var>
|
||||
is called. It typically requests a repaint of the chart and notifies other elements
|
||||
of the changes.
|
||||
</descr>
|
||||
</element><element name="TChart.IsZoomed"><short>Returns <var>true</var> when the chart is zoomed.</short>
|
||||
</element><element name="TChart.LogicalExtent"><short>Returns the extent of the viewport requested by the user</short><descr>The <var>LogicalExtent</var> does not contain the the inner margins and the
|
||||
space reserved for the series labels. It is given in graph coordinates.
|
||||
</descr><seealso><link id="TChart.CurrentExtent">CurrentExtent</link>
|
||||
</seealso>
|
||||
</element><element name="TChart.MinDataSpace"><short>Defines the minimum height of the <var>LogicalExtent</var>
|
||||
</short><descr>When series labels are displayed and <var>AutoMarks</var> is <var>true</var> then space is reserved
|
||||
for the labels and is no longer available for plotting. The <var>MinDataSpace</var> avoids
|
||||
that the series can completely disappear when very long or very high labels are
|
||||
displayed.
|
||||
</descr>
|
||||
</element>
|
||||
</module>
|
||||
</package>
|
||||
</fpdoc-descriptions>
|
||||
|
||||
Loading…
Reference in New Issue
Block a user