paweld/lazarus
1
0
Fork 0
mirror of https://gitlab.com/freepascal.org/lazarus/lazarus.git synced 2025-05-21 16:22:48 +02:00
Code Issues Packages Projects Releases Wiki Activity

TAChart: Some more additions to the xml help files.

Browse Source 
git-svn-id: trunk@60414 -
This commit is contained in:
wp 2019-02-12 23:22:29 +00:00
parent dff24e8451
commit c2da4f6865
8 changed files with 277 additions and 40 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
.gitattributes vendored
View File

@ -5178,6 +5178,7 @@ components/tachart/editors/tatooleditors.pas svneol=native#text/pascal
components/tachart/fpdoc/descr.lst svneol=native#text/plain
components/tachart/fpdoc/input.lst svneol=native#text/plain
components/tachart/fpdoc/tachartaxis.xml svneol=native#text/plain
components/tachart/fpdoc/tachartaxisutils.xml svneol=native#text/xml
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

13
components/tachart/fpdoc/tachartaxis.xml
View File

@ -21,7 +21,7 @@ for vertical axises.</descr>
<short>Title is shown if <var>Visible</var> is true and <var>Caption</var> is not empty</short>
</element>
<element name="TChartAxis.Alignment">
<short>Determines the side of the chart whcih the axis is aligned to</short>
<short>Determines the side of the chart to which the axis is aligned</short>
<descr>Left- and right-aligned axises are vertical, top- and bottom-aligned axises are horizontal.
</descr>
</element>
@ -29,7 +29,8 @@ for vertical axises.</descr>
<short>Pen used for grid drawing</short>
<descr>Grid lines are drawn across the chart from each axis mark</descr>
</element>
<element name="TChartAxis.Inverted"/>
<element name="TChartAxis.Inverted"><short>Inverts the axis scale from increasing to decreasing.</short>
</element>
<element name="TChartAxis.Visible">
<short>If true, the axis is drawn on the chart</short>
<descr>Invisible axis might still be used for series transformation</descr>
@ -40,7 +41,13 @@ 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>
<p>Otherwise, marks are created automatically.</p>
</descr>
</element>
<element name="TChartAxis">
<short>Axis of a chart</short>
<descr><p>TAChart uses four coordinate systems:</p><ul><li><b>Axis coordinates</b> (known in some other applications as object coordinates) -- this is the "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 using axis transformations, such as logarithmic scale. Graph coordinates are common for all objects in the chart.</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>You can add or remove an arbitrary number of axes by editing the <link id="TAGraph.TChart.AxisList">AxisList</link> property of the chart. By default, a chart has two axes: one horizontal and one vertical. They are accessible via the <link id="TAGraph.TChart.BottomAxis">BottomAxis</link> and <link id="TAGraph.TChart.LeftAxis">LeftAxis</link> properties. Note that those properties are aliases to <var>AxisList[0]</var> and <var>AxisList[1]</var>, so if you remove those default axes, accessing <var>BottomAxis</var> and <var>LeftAxis</var> will return nil.</p><p>Visually, an axis consists of the axis line (drawn by <link id="TAxisPen">AxisPen</link>), grid lines (drawn by <link id="TGridPen">GridPen</link>), ticks, marks and an arrow.</p><p>Each axis is drawn inside its own rectangle, determined by the size of mark labels and ticks. By assigning several axes the same positive <var>Group</var> number, you can have them share the same rectangular area. Grouped axes can be used to achieve a "panes" look, when several series are drawn on different portions of the same graph.</p><p>Axes with the same alignment, but different groups, are stacked alongside each other. You can use the <var>Margin</var> property to control the spacing between such axes. </p>
</descr>
</element>
</module>

38
components/tachart/fpdoc/tachartaxisutils.xml Normal file
View File

@ -0,0 +1,38 @@
<?xml version="1.0" encoding="UTF-8"?>
<fpdoc-descriptions><package name="TAChartLazarusPkg"><module name="TAChartAxisUtils"><element name="TChartBasicAxis"><short><var>TChartBasicAxis</var> is the ancestor of the chart's axis class</short><descr><p>The basic axis consists of</p>
<ul><li>ticks (short line strokes perpendicular to the axis direction)</li><li><link id="TChartBasicAxis.Marks">marks</link>, i.e. labels placed at the tick positions</li><li><link id="TChartBasicAxis.Grid">grid lines</link> starting at the tick positions and running across the entire chart</li><li>an optional <link id="TChartBasicAxis.Arrow">arrow</link> at the end of the axis line</li>
</ul>
</descr><seealso><link id="TAChartAxis.TChartAxis"/>
</seealso>
</element><element name="TChartBasicAxis.Visible"><short>If switched to <var>false</var> the axis is hidden along with ticks and labels.</short>
</element><element name="TChartBasicAxis.TickLength"><short>Length of the (outer) axis ticks (in pixels)</short><seealso><link id="TChartBasicAxis.TickInnerLength">Inner length of the ticks</link>
</seealso>
</element><element name="TChartBasicAxis.TickInnerLength"><short>Length of the inner axis ticks (in pixels)</short><seealso><link id="TChartBasicAxis.TickLength">Length of the outer ticks</link>
</seealso>
</element><element name="TChartBasicAxis.TickColor"><short>Color of the axis ticks</short>
</element><element name="TChartBasicAxis.Grid"><short>Determines wether the axis has grid lines and how they are displayed</short><seealso><link id="TChartAxisGridPen"/><link id="TATypes.TChartPen"/>
</seealso>
</element><element name="TChartBasicAxis.Intervals"><short>Determines how the tick intervals of the axis are calculated.</short><seealso><link id="TACustomSource.TChartAxisIntervalParams"/>
</seealso>
</element><element name="TChartBasicAxis.Alignment"><short>Defines the side of the chart at which the axis is shown</short><seealso><link id="TChartAxisAlignment"/>
</seealso>
</element><element name="TChartBasicAxis.Arrow"><short>Determines whether and how an arrow is drawn at the end of the axis</short><seealso><link id="TATypes.TChartArrow"/>
</seealso>
</element><element name="TChartBasicAxis.Marks"><short>Provides parameters how labels ("marks") are to be drawn at the axis</short><seealso><link id="TCustomChartAxisMarks"/>
</seealso>
</element><element name="TChartBasicAxis.IsFlipped"><short>Returns <var>true</var> when the axis is drawn in the opposite direction (right-to-left, or top-to-bottom)</short><descr>In <var>TChartBasicAxis</var>, the function always returns <var>false</var>. It is
overridden by its descendant <var><link id="TAChartAxis.TChartAxis">TChartAxis</link>
</var> which
conisiders the state of the axis'
<link id="TAChartAxis.TChartAxis.Inverted">Inverted</link> and chart's
<link id="TAGraph.TChart.BiDiMode">BiDiMode</link> properties.
</descr>
</element><element name="TChartBasicAxis.Create"><short>Creates the axis as an element of the specified chart and as a member of the axislist given as <var>ACollection</var>
</short>
</element><element name="TChartBasicAxis.Destroy"><short>Destroys the axis and removes it from the collection to which it belongs.</short>
</element><element name="TChartAxisGridPen"><short>Defines the parameters used to draw the grid of the axis.</short><seealso><link id="TChartBasicAxis"/>
</seealso>
</element>
</module>
</package>
</fpdoc-descriptions>

45
components/tachart/fpdoc/tachartutils.xml
View File

@ -6,9 +6,50 @@
<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=""/>
<short>Data structure for a rectangle with floating point coordinates defined by opposite corner points a and b or by a 4-element array</short>
</element>
<element name="TOverrideColor"><short>Enumeration of elements deciding whether a color will override a brush or pen color.</short><seealso><link id="TSeriesPoint.OverrideColor"/>
</seealso>
</element><element name="TOverrideColors"><short>Set of elements deciding whether a color will override a brush or pen color.</short><seealso><link id="TSeriesPoint.OverrideColor"/>
</seealso>
</element><element name="TPointArray"><short>Dynamic array of <var><link id="TPoint"/>
</var> records (having integer coordinates)</short>
</element><element name="TDoublePointArray"><short>Dynamic array of <var><link id="TDoublePoint"/>
</var> records (having floating point coordinates)</short>
</element><element name="TPointBoolArr"><short>Helper type which allows to interpret a <var>TPoint</var> record as an integer array.</short><descr>For a <var>TPoint</var> variable <var>P</var>, the type-cast <var>TPointBoolArr(P)[b]</var> returns
<var>P.X</var> when the boolean variable <var>b</var> is <var>false</var>, and
<var>P.Y</var> when it is
<var>true</var>.
</descr>
</element><element name="TDoublePointBoolArr"><short>Helper type which allows to interpret a <var>TDoublePoint</var> record as a floating point array.</short><descr>For a
<var><link id="TDoublePoint"/>
</var> variable
<var>P</var>, the type-cast
<var>TDoublePointBoolArr(P)[b]</var> returns
<var>P.X</var> when the boolean variable
<var>b</var> is
<var>false</var>, and
<var>P.Y</var> when it is
<var>true</var>.
</descr>
</element><element name="TDoubleInterval"><short>Data type for an interval of floating point numbers.</short><descr><ul><li><var>FStart</var>: begin of the interval</li><li><var>FEnd</var>: end of the interval</li>
</ul>
</descr>
</element><element name="TSeriesMarksStyle"><short>Defines which information is displayed in the text of a series label</short><descr><ul><li><var>smsCustom</var>: user-defined</li><li><var>smsNone</var>: no labels</li><li><var>smsValue</var>: y value of the series, e.g. <var>'1234' </var>
</li><li><var>smsPercent</var>: percentage of the y value, e.g. <var>'12 %'</var>
</li><li><var>smsLabel</var>: text assigned to the data point, e.g. <var>'Cars'</var>
</li><li><var>smsLabelPercent</var>: text assigned to the data point, and percentage of the y value, e.g. <var>'Cars 12 %'</var>
</li><li><var>smsLabelValue</var>: text assigned to the data point, and y value, e.g. <var>'Cars 1234'</var>
</li><li><var>smsLegend</var>: ?</li><li><var>smsPercentTotal</var>: percentage and the total of the y values, e.g. <var>'12 % of 1234'</var>
</li><li><var>smsLabelPercentTotal</var>: text assigned to the data point, percentage and total of all y values, e.g.
<var>'Cars 12 % of 1234'</var>
</li><li><var>smsXValue</var>: x value of the data point</li>
</ul>
</descr>
</element><element name="TChartTextFormat"><short>Enumeration of two ways how text can be interpreted by TAChart: either directly or as being encoded in HTML.</short><descr><ul><li><var>tfNormal</var>: Text is taken literally.</li><li><var>tfHTML</var>: Text is assumed to contain simple HTML markup which is respected by the drawing routines.</li>
</ul>
</descr>
</element>
</module>
</package>

144
components/tachart/fpdoc/tagraph.xml
View File

@ -11,7 +11,18 @@
</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, 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>
<descr>
<p>The chart is composed of a list of <link id="TBasicChartSeries">series</link>, a list of <link id="TAChartAxis.TChartAxis">axes</link> and fixed <link id="TATypes.TChartElement">elements</link> like legend, title and footer.</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>
@ -68,7 +79,7 @@ use
</descr>
</element>
<element name="TChart.AxisList">
<short>List of graph <link id="TATypes.TChartAxis">axises</link>.</short>
<short>List of graph <link id="TATypes.TChartAxis">axes</link>.</short>
</element>
<element name="TChart.BottomAxis">
<short>Bottom axis of the chart.</short>
@ -87,7 +98,8 @@ use
<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>
<link id="TATypes.TChartAxisAlignment">calLeft</link>.
</descr>
<seealso>
<link id="TChart.AxisList">AxisList</link>
<link id="TATypes.TChartAxis.Alignment">TChartAxis.Alignment</link>
@ -197,7 +209,8 @@ For example, <link id="TASeries.TPieSeries">pie series</link> displays a separat
<short>Deletes the specified series from the chart.</short>
<descr>Note that the series is <b>not</b> destroyed.
</descr>
<seealso><link id=""/>
<seealso>
<link id="TChart.RemoveSeries"/>
</seealso>
</element>
<element name="TChart.PaintOnCanvas">
@ -212,7 +225,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>
<link id="TChart.GetFullExtent"/>
</seealso>
</element>
<element name="TChart.SaveToImage">
@ -242,30 +256,50 @@ For example, <link id="TASeries.TPieSeries">pie series</link> displays a separat
</element>
<element name="TChart.GraphToImage">
<short>Converts a point from graph coordinates to image coordinates.</short>
<seealso>
<link id="TChart.ImageToGraph"/>
<link id="TChart.XGraphToImage"/>
<link id="TChart.YGraphToImage"/>
</seealso>
</element>
<element name="TChart.ImageToGraph">
<short>Converts a point from image coordinates to graph coordinates.</short>
<seealso><link id=""/>
<seealso>
<link id="TChart.GraphToImage"/>
<link id="TChart.XImageToGraph"/>
<link id="TChart.YImageToGraph"/>
</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="TChart.XImageToGraph"/>
<link id="TChart.YGraphToImage"/>
<link id="TChart.GraphToImage"/>
</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="TChart.YImageToGraph"/>
<link id="TChart.XGraphToImage"/>
<link id="TChart.GraphToImage"/>
</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="TChart.XGraphToImage"/>
<link id="TChart.YImageToGraph"/>
<link id="TChart.ImageToGraph"/>
</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="TChart.YGraphToImage"/>
<link id="TChart.XImageToGraph"/>
<link id="TChart.ImageToGraph"/>
</seealso>
</element>
<element name="TChart.CurrentExtent">
@ -274,7 +308,8 @@ For example, <link id="TASeries.TPieSeries">pie series</link> displays a separat
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>
<link id="TChart.LogicalExtent">LogicalExtent</link>
</seealso>
</element>
<element name="TChart.XGraphMax">
@ -305,7 +340,7 @@ chart margin and the space reserved for series marks.
</element>
<element name="TChart.CopyToClipboardBitmap">
<short>Copies a bitmap screenshot of the chart to the clipboard.</short>
<seealso><link id=""/>
<seealso><link id="TChart.SaveToFile"/>
</seealso>
</element>
<element name="Register" skip="1"/>
@ -325,50 +360,99 @@ chart margin and the space reserved for series marks.
<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>
<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
<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.
</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
</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
</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,
</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.
</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.
</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>
</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
</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>
</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
</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>
<element name="TChart.AxisVisible">
<short>Can be used to hide all axes</short>
<seealso><link id="TAChartAxisUtils.TBasicChartAxis.Visible"/>TBasicChartAxis.Visible<link/>
</seealso>
</element>
</module>
</package>
</fpdoc-descriptions>

73
components/tachart/fpdoc/tatypes.xml
View File

@ -1,6 +1,75 @@
<?xml version="1.0"?>
<?xml version="1.0" encoding="UTF-8"?>
<fpdoc-descriptions>
<package name="TAChartLazarusPkg">
<module name="TATypes"/>
<module name="TATypes"><element name="TChartArrow"><short>Some elements of the chart, like an axis, can be decorated by an arrow</short>
</element>
<element name="TChartArrow.Visible"><short>Can be used to hide the arrow (if set to <var>false</var>).</short>
</element><element name="TChartArrow.Inverted"><short>Inverts the direction of the arrow</short><descr>The arrow at horizontal lines is normally drawn to point to the right, and the
arrow at vertical lines drawn to point upward. With <var>Inverted = true</var>
the arrow points to the left or downward, respectively.
</descr>
</element><element name="TChartArrow.Draw"><short>Draws the arrow at the specified position (in image coordinates) and using the specified pen.</short><descr>The direction of the line at which the arrow sits is given by the <var>AAngle</var> parameter (in radians).
</descr>
</element><element name="TChartArrow.BaseLength"><short>This is the length of the inner part of the arrow along the arrow direction</short><descr><ul><li>When the <var>BaseLength</var> is 0 the arrow shape is like a thin wedge.</li><li>When the <var>BaseLength</var> is equal to <var><link id="TChartArrow.Length">Length</link>
</var> the arrow shape is a triangle.</li><li>When <var>Length &gt; Baselength</var> the end of the arrow head is concave, otherwise convex (like a rhombus).</li>
</ul>
</descr>
</element><element name="TChartArrow.Width"><short>The width of the arrow is measured perpendicular to the arrow direction</short>
</element><element name="TChartArrow.Length"><short>Defines the length of the outer part of the arrow</short><descr><ul><li>When the <var><link id="TChartArrow.BaseLength">BaseLength</link>
</var> is 0 the arrow shape is like a thin wedge.</li><li>When the <var>BaseLength</var> is equal to <var>Length</var> the arrow shape is a triangle.</li><li>When <var>Length &gt; Baselength</var> the end of the arrow head is concave, otherwise convex (like a rhombus).</li>
</ul>
</descr>
</element><element name="TChartArrow.Create"><short>Creates the arrow as an element of the specified chart</short>
</element><element name="TChartArrow.Assign"><short>Copies all properties from the arrow specified as <var>ASource</var>
</short>
</element><element name="TChartElement"><short>Ancestor of the charrt elements (title, footer, axes, legend, etc.)</short>
</element><element name="TChartElement.Create"><short>Creates an instance of <var>TChartElement</var> as an element of the specified chart</short>
</element><element name="TChartElement.SetOwner"><short>Sets the owner of the element to the specified chart.</short><descr>The owner of the element receives the notification messages
(<var><link id="TChartElement.StyleChanged">StyleChanged</link>
</var>) when properties of
the element are changed.
</descr>
</element><element name="TChartElement.Visible"><short>Can be set to <var>false</var> if the element is to be hidden.</short>
</element><element name="TChartElement.Assign"><short>Copies all property values from the given source.</short><descr><var>ASource</var> must inherit from <var>TChartElement</var>, otherwise an
exception will be raised.
</descr>
</element><element name="TChartElement.GetOwner"><short>Returns the Owner of the element</short><descr>The owner of the element receives the notification messages
(<var><link id="TChartElement.StyleChanged">StyleChanged</link>
</var>) when properties of
the element are changed.
</descr>
</element><element name="TChartElement.StyleChanged"><short>Notifies the owner of the element whenever some property has been changed.</short>
</element><element name="TChartElement.SetVisible"><short>Setter procedure for the property <var><link id="TChartElement.Visible">Visible</link>
</var>.</short>
</element><element name="TChartElement.InitHelper"><short>Initializes a TFPCanvasHelper used by the ChartElement.</short><descr><var>Font</var>, <var>Pen</var> and <var>Brush</var> are the most prominent canvas
helpers. The <var>InitHelper</var> procedure assigns the <var>OnChanged</var> event to
the <var><link id="TChartElement.StyleChanged">StyleChanged</link>
</var> method which notifies the owner
of the ChartElement when helper properties are modified.
</descr>
</element><element name="TSeriesPointerStyle"><short>Enumeration of symbols allowed as <var><link id="TATypes.TSeriesPointer">series pointers</link>
</var>
</short>
</element><element name="TSeriesPointer.Visible"/><element name="TSeriesPointer.VertSize"><short>Defines the vertical size of the pointer symbol (in image units)</short><seealso><link id="TSeriesPointer.HorizSize"><var>HorizSize</var>
</link>
</seealso>
</element><element name="TSeriesPointer.HorizSize"><short>Defines the horizontal size of the pointer symbol (in image units)</short><seealso><link id="TSeriesPointer.VertSize"><var>VertSize</var>
</link>
</seealso>
</element><element name="TSeriesPointer.Brush"><short>Defines the <var>Brush</var> used to fill the inner area of the series pointer</short>
</element><element name="TSeriesPointer.Pen"><short>Defines the <var>Pen</var> used to draw the border of the series pointer symbol</short>
</element><element name="TSeriesPointer.Style"><short>Determines the symbol used to draw the series pointer</short><seealso><link id="TATypes.TSeriesPointer"/>
</seealso>
</element><element name="TSeriesPointer.OverrideColor"><short>Determines which colors will be used for drawing the SeriesPointer symbols</short><descr><ul><li>When the element <var>ocBrush</var> is not included in the set then the
symbol will be filled with the color of the series pointer's <var><link id="TSeriesPointer.Brush">Brush</link>
</var>,
not with the color assigned to the individual data points.</li><li>When the element <var>ocPen</var> is not included in the set then the
symbol border will be drawn with the color of the series pointer's
<var><link id="TSeriesPointer.Pen">Pen</link>
</var>, not with the color assigned to the individual data points.</li>
</ul>
</descr>
</element>
</module>
</package>
</fpdoc-descriptions>

1
components/tachart/tachartaxis.pas
View File

@ -169,7 +169,6 @@ type
property AtDataOnly: Boolean read FAtDataOnly write SetAtDataOnly default false;
property AxisPen: TChartAxisPen read FAxisPen write SetAxisPen;
property Group: Integer read FGroup write SetGroup default 0;
// Inverts the axis scale from increasing to decreasing.
property Inverted: boolean read FInverted write SetInverted default false;
property LabelSize: Integer read FLabelSize write SetLabelSize default 0;
property Margin: TChartDistance read FMargin write SetMargin default 0;

2
components/tachart/tatypes.pas
View File

@ -89,9 +89,7 @@ type
constructor Create(AOwner: TCustomChart);
public
procedure Assign(ASource: TPersistent); override;
procedure SetOwner(AOwner: TCustomChart);
property Visible: Boolean read FVisible write SetVisible;
end;