Hide Comments
Hide Comments

Comments (0)

expandingMethods

 

Name

Description

public method

Add

Overloaded.  Creates a new RSCharts.TRSArrowChartValue instance and adds it to the Items array. Call Add to create an arrow 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.

Add returns the new arrow value.

Note that because every time you change a value an event is called, it is faster to add and initialize a value using the overloaded Add method.
 

public method

Add(TRSChartValueType,String,TCanvasColor)

Overloaded.  Creates a new RSCharts.TRSArrowChartValue instance and adds it to the Items array. The new instance is initialized with the X (default StartY and EndX and EndY), Caption, and Color parameters. Call Add to create an arrow 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.

Add returns the new arrow value.

public method

Add(TRSChartValueType,TRSChartValueType,String,TCanvasColor)

Overloaded.  Creates a new RSCharts.TRSArrowChartValue instance and adds it to the Items array. The new instance is initialized with the StartX, StartY (start point with default end point), Caption, and Color parameters. Call Add to create an arrow 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.

Add returns the new arrow value.

public method

Add(TRSChartValueType,TRSChartValueType,TRSChartValueType,TRSChartValueType,String,TCanvasColor)

Overloaded.  Creates a new RSCharts.TRSArrowChartValue instance and adds it to the Items array. The new instance is initialized with the dimensions (StartX, StartY, EndX and EndY which specify the 2 end points), Caption, and Color parameters. Call Add to create an arrow 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.

Add returns the new arrow value.

public method

FindItemID(Integer)

Returns the Item with the specified ID. The FindItemID method returns the item in the collection whose ID property is passed to it as a parameter. If no item has the specified ID, FindItemID returns nil.

public method

GetEnumerator

Returns the enumerator for the collection, which is used when you write a "for Item in Chart.Values" loop.

protected method

GetValueDimMaximum(TRSChartValue,Integer)

Returns the maximum value for the dimension. This may be modified by other values. For example, the shape value modifies the X value by adding the width value. This method is called by the   CalculateMetaData method.

alert_noteNotes to Inheritors

Override this method if you need to return a maximum value for a dimension that is depends on other factors than just the value in TRSChartValue.Values[Dimension]. For example, the TRSCandleStickChartValues class overrides this method for the Y dimension because the Y dimension is bounded by the High Dimension and Low Dimension, not the Close value.

You will probably also need to override the       SetMetaData method to set the new maximum.

protected method

GetValueDimMinimum(TRSChartValue,Integer)

Returns the minimum value for the dimension. This may be modified by other values. For example, the shape value modifies the X value by adding the width value. This method is called by the   CalculateMetaData method.

alert_noteNotes to Inheritors

Override this method if you need to return a minimum value for a dimension that is depends on other factors than just the value in TRSChartValue.Values[Dimension]. For example, the TRSCandleStickChartValues class overrides this method for the Y dimension because the Y dimension is bounded by the High Dimension and Low Dimension, not the Close value.

You will probably also need to override the       SetMetaData method to set the new minimum.

public method

Insert(Integer)

Creates a new instance and adds it to the Items array. Call Insert to add a new value at a specified position in the collection. Existing items (starting from the specified position) are moved up in the Items array. Note that Insert only works as expected if the collection is not     Sorted.

Insert returns the new collection value.
 

protected method

SetMetaData(TValueMetaData,TRSChartValue,Integer)

Sets the metadata (min, max, sum, etc) by using the TRSChartValue.Values property. The Dimension parameter specifies the dimension to use in the Values property. This method is called by the   CalculateMetaData method when it finds a value "better" than the current metadata value (e.g., less than current minimum)

alert_noteNotes to Inheritors

This method is often overridden when you need to override the     GetValueDimMinimum and     GetValueDimMaximum methods.

Top

Comments (0)

RiverSoftAVG Charting Component Suite (RCCS) © 2005-2015, Thomas G. Grubb