diff --git a/components/tachart/fpdoc/tageometry.xml b/components/tachart/fpdoc/tageometry.xml index 9ae1bf64f3..e30db935e9 100644 --- a/components/tachart/fpdoc/tageometry.xml +++ b/components/tachart/fpdoc/tageometry.xml @@ -78,11 +78,12 @@ rectangle even when their corners collide. - Returns a parameter characterizing the distance between the points A and B - The "distance" is calculated as the square of the sum of the coordinate differences: -

Result := sqr(A.X - B.X) + sqr(A.Y - B.Y) -

The standard Euclidian distance would be obtained by calculating the square root of the result.

- + + Returns a parameter characterizing the distance between the points A and B +

The "distance" is calculated as the square of the sum of the coordinate differences:

+

Result := sqr(A.X - B.X) + sqr(A.Y - B.Y)

+

The standard Euclidian distance would be obtained by calculating the square root of the result.

+ Returns the difference of the X coordinates of the two points A and B Returns the difference of the Y coordinates of the two points A and B diff --git a/components/tachart/fpdoc/tagraph.xml b/components/tachart/fpdoc/tagraph.xml index d223a941fe..6e858d9066 100644 --- a/components/tachart/fpdoc/tagraph.xml +++ b/components/tachart/fpdoc/tagraph.xml @@ -1,4 +1,4 @@ - + @@ -11,20 +11,8 @@ Main charting component. - -

The chart is composed of list of series and fixed elements like legend, axises and footers.

-

Chart methods work with four coordinate systems: -

    -
  • - Axis coordinates (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.
    • -
  • - Graph coordinates 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.
    • -
  • - Image coordinates (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.
    • -
  • - Device coordinates 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.
    • -
-

+

The chart is composed of list of series and fixed elements like legend, axes and footers.

Chart methods work with four coordinate systems:

  • Axis coordinates (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.
  • Graph coordinates 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.
  • Image coordinates (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.
  • Device coordinates 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.
    • +
@@ -196,18 +184,20 @@ For example, pie series displays a separat In particular, margins are used to make room for labels. - Add given series to this chart. - Note that the series can only belong to a single chart. + Adds the specified series to the chart. + Note that the series can only belong to a single chart. + - Removes all series from this chart. - Note that the series are not destroyed. + Removes all series from the chart. + Note that the series are not destroyed. + - Deletes a given series from the chart. - Note that the series is not destroyed. - - + Deletes the specified series from the chart. + Note that the series is not destroyed. + + @@ -222,6 +212,8 @@ For example, pie series displays a separat Restore the default zoom level. + GetFullExtent + Returns a raster image of the given type with the screenshot of the chart. @@ -253,45 +245,43 @@ For example, pie series displays a separat Converts a point from image coordinates to graph coordinates. - - + Converts the X coordinate of a point from graph coordinates to image coordinates. - - + Converts the Y coordinate of a point from graph units to image units. - - + Converts the X coordinate of a point from image coordinates to graph coordinates. - - + Converts the Y coordinate of a point from image units to graph units. - - + Returns the chart extent at the current zoom level. - The extent is the visible viewport of the chart. It is given in graph coordinates. - - + 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. + + LogicalExtent Returns the maximum x value of the chart in graph units Deprecated, use -CurrentExtent instead. +CurrentExtent instead. + Returns the minimum x value of the chart in graph coordinates @@ -315,8 +305,7 @@ For example, pie series displays a separat Copies a bitmap screenshot of the chart to the clipboard. - - + @@ -332,13 +321,54 @@ For example, pie series displays a separat Draws the chart usung the given drawing back-end - This method draw the chart by means of the given drawing back-end, + This method draws the chart by means of the given drawing back-end, Drawer. Unlike -PaintOnCanvas the chart can be drawn on non-canvas devices, such as a svg file. - - +PaintOnCanvas the chart can be drawn on non-canvas devices, such as a svg file. + + + Creates the chart + Destroys the chart + Returns true when the given point (in graph coordinates) is inside or at the boundaries of the chart's viewport (area spanned by the axes) + Creates a new chart and copies all properties of the current chart to it. + Disables redrawing of the chart

Useful when many data points are added.

Must be accompanied by EnableRedrawing, otherwise the chart will +not be updated any more.

+ + Draws the legend on the specified canvas in the given rectangleUseful to paint the legend outside the chart control. + + Enables redrawing of the chartMust be called after redrawing of the chart has been deactivated by calling +DisableRedrawing. Otherwise the chart will not be updated any more. + + Returns the full extent of the chartThe 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. + + Initializes extents and transformations before the chart is drawn.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. + + Removes the specified series from the chartNote that the series is not destroyed. + + Returns true when the built-in toolset is active.The built-in toolset is responsible for the default zooming and panning capabilities of the chart. +When a separate TChartToolset 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 false. + + Part of the notification chainWhen any property of any chart element is changed the method StyleChanged +is called. It typically requests a repaint of the chart and notifies other elements +of the changes. + + Returns true when the chart is zoomed. + Returns the extent of the viewport requested by the userThe LogicalExtent does not contain the the inner margins and the +space reserved for the series labels. It is given in graph coordinates. +CurrentExtent + + Defines the minimum height of the LogicalExtent + When series labels are displayed and AutoMarks is true then space is reserved +for the labels and is no longer available for plotting. The MinDataSpace avoids +that the series can completely disappear when very long or very high labels are +displayed. + +