From 101727cfecfbf1f83fd8eb4d8ca2b46256905a04 Mon Sep 17 00:00:00 2001 From: wp Date: Tue, 22 Jun 2021 17:55:51 +0000 Subject: [PATCH] TAChart: Add xml documentation to the chart events. git-svn-id: trunk@65293 - --- components/tachart/fpdoc/tagraph.xml | 177 +++++++++++++++++++++++++-- 1 file changed, 167 insertions(+), 10 deletions(-) diff --git a/components/tachart/fpdoc/tagraph.xml b/components/tachart/fpdoc/tagraph.xml index 79ffbd3a53..9970c1193b 100644 --- a/components/tachart/fpdoc/tagraph.xml +++ b/components/tachart/fpdoc/tagraph.xml @@ -39,19 +39,14 @@ which is used to paint the background of the entire TChart, including - The list of chart series. - -

To add or remove series at run-time, + List of chart series. +

To add or remove series at run-time, use AddSeries and DeleteSeries methods. -

-

Use SeriesCount to determine the number of series contained in the chart.

+

Use SeriesCount to determine the number of series contained in the chart.

 - - - - + @@ -67,7 +62,7 @@ use - List of graph axes. + List of chart axes. Bottom axis of the chart. @@ -502,6 +497,168 @@ The chart responds by sending the result in the parameter does not "use" TACustomSeries.

+ The event OnAfterCustomDrawBackground fires after the background of the chart has been paintedAfter the background of the chart has been painted the event OnAfterCustomDrawBackground is + generated and gives the user the opportunity to paint on the background additional stationary information + such as a logo or similar. +

The event has the corresponding chart, the currently active drawer and the rectangle spanning the background as parameters. + Note that there is a similar event, OnAfterDrawBackground, + however, that works only with drawing backends supporting a canvas and thus has been marked as deprecated. +

+ + OnAfterDrawBackgroundOnBeforeCustomDrawBackgroundOnBeforeDrawBackgroundOnAfterCustomDrawBackWallOnAfterDrawBackWallOnBeforeCustomDrawBackWallOnBeforeDrawBackWall + + + + +The event OnAfterDrawBackground fires after the background of the chart has been painted +When the background of the chart (i.e. the entire area covered by the chart) +has been painted the event OnAfterDrawBackground is generated and +gives to user the opportunity to paint on the background additional stationary information such as a logo or similar. +

The event has the corresponding chart, the canvas to be drawn, and the rectangle spanning +the background as parameters.

Note that this event is deprecated and will be removed because painting works only on +drawing backends which support a TCanvas. Use the more general +OnAfterCustomDrawBackground as a replacement. +

+ +OnBeforeDrawBackgroundOnAfterCustomDrawBackgroundOnBeforeCustomDrawBackgroundOnAfterDrawBackWallOnAfterCustomDrawBackWallOnBeforeDrawBackWallOnBeforeCustomDrawBackWall + + + + + The event OnBeforeDrawBackground fires before the background of the chart will be painted +Before the background of the chart will be painted the event OnBeforeDrawBackground +is generated and gives the user the opportunity to replace the built-in drawing +routine by user-defined drawing code, e.g. for painting a gradient or providing an image background. +Note that this custom drawing is executed only when the parameter ADoDefaultDrawing is false. +

This event is deprecated and will be removed because painting works only on drawing backends supporting a TCanvas. Use the more general +OnBeforeCustomDrawBackground as a replacement. +

+ +OnAfterDrawBackgroundOnBeforeCustomDrawBackgroundOnAfterCustomDrawBackgroundOnBeforeDrawBackWallOnAfterDrawBackWallOnBeforeCustomDrawBackWallOnAfterCustomDrawBackWall + + + + +The event OnBeforeCustomDrawBackground fires before the background of the chart will be painted +Before the background of the chart will be painted the event +OnBeforeCustomDrawBackground is generated to allow custom painting of +the entire background by user code. This way the background can be drawn with a +gradient or with a background image. Note that built-in drawing is skipped only if the event +parameter ADoDefaultDrawing is set to false in the event handler. +

Besides the ADoDefaultDrawing parameter, the event has the corresponding chart, the currently active drawer and the rectangle spanning the background as parameters. +

Note that there is a similar event, OnBeforeDrawBackground, +however, that works only with drawing backends supporting a canvas and thus has been marked as deprecated. +

+ +OnAfterCustomDrawBackgroundOnBeforeDrawBackgroundOnBeforeCustomDrawBackgroundOnBeforeDrawBackWallOnAfterDrawBackWallOnBeforeCustomDrawBackWallOnAfterCustomDrawBackWall + + + + +The event OnAfterCustomDrawBackWall fires after the back-wall of the chart has been painted +The back-wall of a chart is the inner chart rectangle spanned by the axes. +After this rectangle has been painted the event OnAfterCustomDrawBackWall +is generated to give the user the opportunity to draw something over this +default back-wall, e.g. a logo or similar. +

The event has the corresponding chart, the currently active drawer and the rectangle spanning the back-wall as parameters. +

Note that there is a similar event, OnAfterDrawBackWall, +however, that works only with drawing backends supporting a canvas and thus has been marked as deprecated. +

+ +OnAfterDrawBackWallOnBeforeCustomDrawBackWallOnBeforeDrawBackWallOnAfterDrawBackgroundOnBeforeDrawBackgroundOnAfterCustomDrawBackgroundOnBeforeCustomDrawBackground + + + + +The event OnAfterDrawBackWall fires after the back-wall of the chart has been painted +The back-wall of a chart is the inner chart rectangle spanned by the axes. +After this rectangle has been painted the event OnAfterDrawBackWall +is generated and gives the user the opportunity to draw something over this +default back-wall, e.g. a logo or similar. +

The event has the corresponding chart, the canvas to be drawn, and the rectangle spanning the backwall as parameters. +

Note that this event is deprecated and will be removed because painting works only +on drawing backends which support a TCanvas. Use the more general +OnAfterCustomDrawBackWall as a replacement. +

+ +OnAfterCustomDrawBackWallOnBeforeDrawBackWallOnBeforeCustomDrawBackWallOnAfterDrawBackgroundOnAfterCustomDrawBackgroundOnBeforeDrawBackgroundOnBeforeCustomDrawBackground + + + + +The event OnBeforeCustomDrawBackWall fires before the back-wall +of the chart will be painted +The back-wall of a chart is the inner chart rectangle spanned by the axes. +Before this rectangle is painted the event OnBeforeCustomDrawBackWall +is generated with the boolean parameter ADoDefaultDrawing which, if set to false, +allows to replace the built-in painting routine by user code, e.g. for filling +the back-wall with a gradient or with a background image. +

Besides the ADoDefaultDrawing parameter, the event has the corresponding +chart, the currently active drawer and the rectangle spanning the background as parameters. +

+

Note that there is a similar event, OnBeforeDrawBackWall. +That works, however, only with drawing backends supporting a canvas and thus has been marked as deprecated. +

+ + +OnAfterDrawBackWall +OnAfterCustomDrawBackWall +OnBeforeDrawBackWall +OnAfterDrawBackground +OnAfterCustomDrawBackground +OnBeforeDrawBackground +OnBeforeCustomDrawBackground + + + + +The event OnBeforeDrawBackWall fires before the back-wall of the chart will be painted +The back-wall of a chart is the inner chart rectangle spanned by the axes. +Before this rectangle is painted the event OnBeforeDrawBackWall is generated +with the boolean parameter ADoDefaultDrawing which, if set to false, +allows to replace the built-in painting routine by user code, e.g. for filling +with a gradient or with a background image. +

Besides the ADoDefaultDrawing parameter, the event has the +corresponding chart, the canvas on which painting occurs, as well as the +rectangle spanning the background as parameters. +

+

This event is deprecated and will be removed because painting works only on +drawing backends supporting a TCanvas. Use the more general +OnBeforeCustomDrawBackWall +as a replacement. +

+ + +OnBeforeCustomDrawBackWall +OnAfterDrawBackWall +OnAfterCustomDrawBackWall +OnAfterDrawBackground +OnAfterCustomDrawBackground +OnBeforeDrawBackground +OnBeforeCustomDrawBackground + + + The event OnAfterPaint is fired at the very end of the painting cycle of a chartWhen painting of a chart is complete, i.e. when all subitems such as axes, series, legend, titles have been drawn and immediately before the chart's Paint method is exited, the event OnAfterPaint is generated. It can be used for logging or time measurement purposes. Do not call anything which itself triggers a new drawing cycle because the event will fire again and again and make the application hang. +OnAfterDraw + + The event OnDrawLegend can be used to custom-draw the chart legend.When a handler has been assigned to the OnDrawlegend event painting of the chart legend is done by this user code rather than the built-in default drawing code. +

The rectangle passed as the LegendRect parameter is the rectangle that would be covered by the built-in legend. +

+ + The event OnAfterDraw is the last event of the drawing cycle of the chartOnAfterPaint + Before the chart's drawing cycle ends the event OnAfterDraw is generated. Here, the user has the last opportunity to paint something over the finished chart by using the currently active drawer given as a parameter. + + A change in the chart's full extent triggers the event OnFullExtentChanged + When data are added to a series such that the range of values is extended, or when the user manually sets the chart's Extent property, the event OnFullExtentChanged is generated. This way, for example, gui elements displaying the axis range can be updated. +OnExtentChanged + + The event OnExtentChanged fires when the chart's visible viewport changed, for example by zooming or panning.When the user zooms or pans a chart the visible viewport changes. To notify the application of this change the event OnExtentChanged is generated. +OnFullExtentChanged + + The event OnExtentValidate checks whether a change of the chart's extent is allowed or notZooming or panning outside the chart's FullExtent can lead to a loss of the visible viewport. To prevent this a handler for the OnExtentValidate event can be provided in which the boolean variable AllowChange should signal that the extent given in the argument ALogicalExtent is possible. If not, the ALogicalExtent can be set to the valid extent to be used instead. + + Proportional, when set to true, applies the same scaling factor to the x and y axis. +