lazarus/components/tachart/fpdoc/tacustomseries.xml

<?xml version="1.0"?>
<fpdoc-descriptions>
  <package name="TAChartLazarusPkg">
    <module name="TACustomSeries">
      <element name="TCustomChartSeries">
        <short>Basic chart series. Inherit this if you want to create a new series type.</short>
      </element>
      <element name="TChartGetMarkEvent"/>
      <element name="TChartSeries.Count">
        <short>Return number of points in the series.</short>
      </element>
      <element name="TChartSeries.Add">
        <short>Add new point to the right of the series.</short>
        <descr>
          <p>The X coordinate of the new point is calculated as the rightmost existing X coordinate plus 1.</p>
          <p>Requires <link id="TChartSeries.ListSource">editable data source</link>.</p>
        </descr>
        <seealso>
          <link id="TChartSeries.AddXY">AddXY</link>
        </seealso>
        <errors>
          <link id="TASources.EEditableSourceRequired">EEditableSourceRequired</link>
        </errors>
      </element>
      <element name="TChartSeries.AddXY">
        <short>Add a new point to the series.</short>
        <descr>
          <p>Requires <link id="TChartSeries.ListSource">editable data source</link>.</p>
        </descr>
        <errors>
          <link id="TASources.EEditableSourceRequired">EEditableSourceRequired</link>
        </errors>
      </element>
      <element name="TChartSeries.ListSource">
        <errors>
          <link id="TASources.EEditableSourceRequired">EEditableSourceRequired</link>
        </errors>
        <short>Verify that the data source is editable and return it.</short>
      </element>
      <element name="TChartSeries.Clear">
        <short>Remove all points from the series.</short>
        <descr>
          <p>Requires <link id="TChartSeries.ListSource">editable data source</link>.</p>
        </descr>
      </element>
      <element name="TChartSeries.Delete">
        <errors>
          <link id="TASources.EEditableSourceRequired">EEditableSourceRequired</link>
        </errors>
        <short>Remove point by index.</short>
        <descr>
          <p>Requires <link id="TChartSeries.ListSource">editable data source</link>.</p>
        </descr>
      </element>
      <element name="TChartSeries.SetXValue"/>
      <element name="TChartSeries.SetYValue"/>
      <element name="TChartSeries.Source">
        <short>Series data source.</short>
      </element>
      <element name="TChartSeries.Marks">
        <short>Mark parameters.</short>
      </element>
      <element name="TChartSeries.OnGetMark">
        <short>Called before the drawing of each mark.</short>
        <seealso>
          <link id="TChartSeries.Marks">Marks</link>
        </seealso>
      </element>
      <element name="TChartSeries">
        <short>Series with the data source.</short>
      </element>
      <element name="TChartSeries.Title" link="#TAChartLazarusPkg.TAGraph.TBasicChartSeries.Title"/>
      <element name="TChartSeries.GetColor">
        <short>Return the color of the point number <var>AIndex</var>
        </short>
      </element>
      <element name="TChartSeries.SetColor">
        <short>Set the color of the point number <var>AIndex</var> to <var>AColor</var>
        </short>
      </element>
      <element name="TChartSeries.DefaultFormattedMark">
        <short>Return the label for the point number <var>AIndex</var> formatted as per <var>Marks</var> property</short>
      </element>
      <element name="TChartSeries.Extent">
        <short>Return the bounding rectangle for all points in the serie.</short>
        <seealso>
          <link id="TASources.TCustomChartSource.Extent">TCustomChartSource.Extent</link>
        </seealso>
      </element>
      <element name="TChartSeries.FormattedMark">
        <short>Return the label for the point number <var>AIndex</var> obtained by <var>OnGetMark</var> event, or <var>DefaultFormattedMark</var>.</short>
      </element>
    </module>
  </package>
</fpdoc-descriptions>