File: tatypes.xml

package info (click to toggle)
lazarus 2.2.6%2Bdfsg2-2
  • links: PTS, VCS
  • area: main
  • in suites: bookworm
  • size: 219,980 kB
  • sloc: pascal: 1,944,919; xml: 357,634; makefile: 270,608; cpp: 57,115; sh: 3,249; java: 609; perl: 297; sql: 222; ansic: 137
file content (109 lines) | stat: -rw-r--r-- 9,375 bytes parent folder | download | duplicates (4)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
<?xml version="1.0" encoding="UTF-8"?>
<fpdoc-descriptions>
  <package name="TAChartLazarusPkg">
    <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 chart 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>
    <element name="TChartShadow"><short>Some elements of the chart can be decorated by means of a drop shadow</short><descr>When a series "throws" a shows it is redrawn at some offset from its
original location in some specified color and with some degree of transparency.
</descr>
      </element><element name="TChartShadow.Color"><short>Defines the color with which the series is redrawn for the shadow</short>
      </element><element name="TChartShadow.OffsetX"><short>Defines the horizontal distance at which the original series is redrawn for the shadow</short>
      </element><element name="TChartShadow.OffsetY"><short>Defines the vertical distance at which the original series is redrawn for the shadow</short>
      </element><element name="TChartShadow.Transparency"><short>Transparency of the shadow series, ranging between 0 (opaque) and 255 (fully transparent = invisible)</short>
      </element><element name="TChartShadow.Visible"><short>Using the property <var>Visible</var> the shadow can be turned on and off.</short>
      </element><element name="TChartPen"><short>Pen used to draw many of the chart elements</short><descr>In addition to the standard TCanvas pen a <var>TChartPen</var> has a property
<link id="TChartPen.Visible"/><var>Visible</var> by which the pen can be turned off.
</descr>
      </element><element name="TChartPen.EffVisible"><short>Returns <var>true</var> when the pen is "effectively" visible.</short><descr>The pen is visible when the property
<link id="TChartPen.Visible"><var>Visible</var>
          </link> is <var>true</var> and when its
<link id="TPen.Style"><var>Style</var>
          </link> is not <var>psClear</var>.
</descr>
      </element><element name="TCustomChart"><short>Ancestor of <var>TChart</var>
        </short><descr>The <var>TCustomChart</var> prepares the most basic notification mechanism in
order to be able to communicate with
<link id="TChartElement"><var>TChartElement</var>
          </link> instances.
</descr><seealso><var><link id="TAGraph.TChart"/>
          </var>
        </seealso>
      </element><element name="TCustomChart.ZoomFull"><short>Restores the default (unzoomed) viewport.</short>
      </element><element name="TCustomChart.StyleChanged"/><element name="CMD_QUERY_SERIESEXTENT"><short>Identifier of a command with which an axis queries from the chart the extent of all series attached to this axis.</short><seealso><var><link id="TAGraph.TChart.Notify"/>
          </var>
        </seealso>
      </element><element name="TSeriesPointer"><short>Defines the data point symbols</short><descr>The series pointer is a symbol of adjustable size and shape which is drawn by some
series at the position of the data points. This symbol is also displayed in the
<link id="TALegend.TChartLegend">legend</link> to identify the series.
</descr>
      </element>
    </module>
  </package>
</fpdoc-descriptions>