Difference between revisions of "TAChart documentation"

From Lazarus wiki
(Axis transformations)
Line 27: Line 27:
 
Axis transformations are grouped in <code>TChartAxisTransformations</code> component.
 
Axis transformations are grouped in <code>TChartAxisTransformations</code> component.
 
It contains a list of transformations which are applied in the order given.
 
It contains a list of transformations which are applied in the order given.
 +
(For example, performing scale before and after logarithm will yield different results).
 +
 
For transformations to have an effect, you should:
 
For transformations to have an effect, you should:
 
* Make sure <code>Enabled</code> property is true for all transformations.
 
* Make sure <code>Enabled</code> property is true for all transformations.
Line 35: Line 37:
 
You can rotate the series by assigning ''both'' <code>AxisIndexX</code> to vertical axis and <code>AxisIndexY</code>
 
You can rotate the series by assigning ''both'' <code>AxisIndexX</code> to vertical axis and <code>AxisIndexY</code>
 
to the horizontal axis.
 
to the horizontal axis.
 +
 +
==== Linear and logarithmic transformation ====
 +
 +
Those are simple arithmetic transformations.
  
 
==== Auto-scaling transformation ====
 
==== Auto-scaling transformation ====
Line 46: Line 52:
 
to a range from 1 to 2, you will confine all the series using the first transformation to the upper half of the chart,
 
to a range from 1 to 2, you will confine all the series using the first transformation to the upper half of the chart,
 
and all the series using the second transformation to the lower half (assuming there are no unassigned series left).
 
and all the series using the second transformation to the lower half (assuming there are no unassigned series left).
 +
 +
==== User-defined transformation ====
 +
 +
You can create you own transformation either by inheriting from <code>TAxisTransform</code>,
 +
or, if you prefer "visual" programming, by using <code>TUserDefinedAxisTransform</code>.
 +
In either case there are two basic requirements:
 +
* <code>AxisToGraph</code> and <code>GraphToAxis</code> functions should be defined everywhere in data range and inverse of each other (for example, avoid now only dividing, but also multiplying by zero).
 +
* functions should be monotonic.

Revision as of 06:03, 29 July 2011

English (en) русский (ru) українська (uk) 中文(中国大陆)‎ (zh_CN)

Overview

TAChart is a package for drawing graphs, charts and other diagrams. It is comparable in features, but not specifically compatible, with Delphi TeeChart package. One substantial difference is that some features (e.g. data sources and axis transformations) are implemented via separate components instead of just properties. This leads to increased flexibility and opportunity for code re-use, but at the cost of some additional API complexity.

Coordinates and axises

TAChart uses three coordinate systems:

  • Axis coordinates (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 therms of specific axis -- the same coordinate value may have different meaning depending on the axis it is applied to.
  • Graph coordinates (aka world coordinates) are converted from the axis coordinates using axis transformation, such as logarithmic scale. Graph coordinates are common for all objects in the chart.
  • 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.

You can add or remove arbitrary number of axises by editing AxisList property. By default, chart have two axises: one horizontal and one vertical. They are accessible via BottomAxis and LeftAxis properties. Note that those properties are aliases to AxisList[0] and AxisList[1], so if you remove those default axises, accessing BottomAxis and LeftAxis will return nil.

Axis transformations

Axis transformations are grouped in TChartAxisTransformations component. It contains a list of transformations which are applied in the order given. (For example, performing scale before and after logarithm will yield different results).

For transformations to have an effect, you should:

  • Make sure Enabled property is true for all transformations.
  • Assign transformations component to Transformations property of at least one axis.
  • Assign AxisIndexX and/or AxisIndexY properties of the series to the appropriate axis index.

Note that by default, AxisIndexX and AxisIndexY have a special value of -1, which means "ignore axis transformations". Also note that if you add or remove axises, the indexes may change. You can rotate the series by assigning both AxisIndexX to vertical axis and AxisIndexY to the horizontal axis.

Linear and logarithmic transformation

Those are simple arithmetic transformations.

Auto-scaling transformation

To display several independently scaled series, assign them to two or more axises and apply TAutoScaleAxisTransform to each axis. See "axistransf" demo, page "Linear", checkbox "Auto scale".

By using MinValue and MaxValue properties you can control the in graph coordinates of the auto-scaled series. For example, by setting one transformation to a range from 0 to 1, and another to a range from 1 to 2, you will confine all the series using the first transformation to the upper half of the chart, and all the series using the second transformation to the lower half (assuming there are no unassigned series left).

User-defined transformation

You can create you own transformation either by inheriting from TAxisTransform, or, if you prefer "visual" programming, by using TUserDefinedAxisTransform. In either case there are two basic requirements:

  • AxisToGraph and GraphToAxis functions should be defined everywhere in data range and inverse of each other (for example, avoid now only dividing, but also multiplying by zero).
  • functions should be monotonic.