RiverSoftAVG Products Help

Zoom Window Out
Larger Text | Smaller Text
Hide Page Header
Show Expanding Text
Printable Version
Send Mail Feedback
Save Permalink URL

Navigation: Code Documentation > RSCharting > RSCharts > Classes > TRSGuideChartValues > Methods

TRSGuideChartValues.Add(TRSChartValueType,String,TCanvasColor,TLineOrientations) Method

Creates a new RSCharts.TRSGuideChartValue instance and adds it to the Items array. The new instance is initialized with the X, Caption, Color, and Orientation parameters. Call Add to create a guide in the collection. The new value is placed at the end of the Items array, or, if the collection is Sorted, placed at the sorted point in the collection (based on a default value (0)).

Add returns the new guide.

Namespace: RSCharts

Parameters

Type: TRSChartValueType

Caption

Type: String

Color

Type: TCanvasColor

Orientation

Type: TLineOrientations

Return Value

Type: TRSGuideChartValue

The following example creates values in the collection:

Delphi

var
   Value: TRSGuideChartValue;  // note, this type should be the same that the chart uses (e.g., TRS2DChartValue, TRSArrowChartValue, etc)
begin
   Value := MyChart.Values.Add;
   Value.Caption := 'One';
   Value.Color := clRed;
   Value.X := 10.0;
   Value.Y := 20.0;
   Value.Orientation := loVertical;
   // this code adds the same point but much more quickly
   Value := MyChart.Values.Add( 10.0, 20.0, 'One', clRed, loVertical );
end;

RiverSoftAVG Products Help

Return Value

Reference