|
Name
|
Description
|
|
Add
|
Overloaded. Creates a new TRSChartValue instance and adds it to the Items array. Call Add to create a value 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 value.
 Note
|
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.
|
|
|
Add(TRSChartValueType,String,TCanvasColor)
|
Overloaded. Creates a new TRSChartValue instance and adds it to the Items array. The new instance is initialized with the Value, Caption, and Color parameters. Call Add to create a value 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 value.
Note
|
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.
|
|
|
Add(TRSChartValueType[],String,TCanvasColor)
|
Overloaded. Creates a new TRSChartValue instance and adds it to the Items array. The new instance is initialized with the Values, Caption, and Color parameters. Call Add to create a value 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 value.
|
|
Append(TRSChartValues)
|
Appends the Source values to the current collection
|
|
Assign(TPersistent)
|
Represents method Assign(TPersistent).
|
|
AssignTo(TPersistent)
|
Represents method AssignTo(TPersistent).
|
|
CalculateMetaData
|
Calculates the metadata (e.g., minimums, maximums, summations, and absolute summations) for the entire values collection, for all dimensions.
The metadata is recalculated when values change and the NeedMetaData property is set to true.
|
|
Clone
|
Creates a copy of the values collection. This is a "deep" copy, e.g., all items and their properties are copied. The new collection is returned. The Owner of the collection is the same as the current collection's Owner . Note, you are responsible for freeing the clone.
|
|
CustomSort(TValuesSortCompare)
|
Sorts the current values collection using the supplied comparison function. Use CustomSort when you want to perform a special type of sorting on the values collection. You need to define a function based on the RSChartPanel.TValuesSortCompare signature.
If you want to do normal sorting, just call the Sort method.
|
|
FindClosest(TRSChartValueType)
|
Returns the Index of the Item that is closest to the Value parameter. FindClosest uses the Values in the sorted dimension ( SortByDimension) to determine the nearest value. If the collection is not sorted, this function returns -1.
|
|
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.
|
|
GetAbsSum(Integer)
|
Represents method GetAbsSum(Integer).
|
|
GetAxisMaximum(Integer)
|
Returns the maximum value in the collection for the specified dimension.
|
|
GetAxisMinimum(Integer)
|
Returns the minimum value in the collection for the specified dimension.
|
|
GetEnumerator
|
Returns the enumerator for the collection, which is used when you write a "for Item in Chart.Values" loop.
|
|
GetIsDateTime
|
Represents method GetIsDateTime.
|
|
GetMaxValue(Integer)
|
Represents method GetMaxValue(Integer).
|
|
GetMinValue(Integer)
|
Represents method GetMinValue(Integer).
|
|
GetSortByDimension
|
Represents method GetSortByDimension.
|
|
GetSum(Integer)
|
Represents method GetSum(Integer).
|
|
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.
 Notes 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.
|
|
|
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.
Notes 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.
|
|
|
IndexOf(TRSChartValueType,Integer)
|
Returns the Index of the Item that contains the Value parameter (or close to the Value parameter) for the specifed Dimension. If the Collection is sorted by the specified Dimension, IndexOf calls the FindClosest method. However, if the collection is not sorted or not sorted by the specified Dimension, the method iterates through the collection looking for a value that is approximately equal to the specified Value.
|
|
Insert(Integer)
|
Creates a new RSChartPanel.TRSChartValue 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.
|
|
Loaded
|
Represents method Loaded.
|
|
Notify(Classes,Classes)
|
Represents method Notify(Classes,Classes).
|
|
Owner
|
Returns the chart that is the owner of the collection, or nil if there is not one.
|
|
QuickSort(Integer,Integer,TValuesSortCompare)
|
Represents method QuickSort(Integer,Integer,TValuesSortCompare).
|
|
SelectAll
|
Selects all values in the collection (TRSChartValue.Selected is set to true)
|
|
SelectionChanged(TRSChartValue)
|
Represents method SelectionChanged(TRSChartValue).
|
|
SelectNone
|
Deselects all values in the collection (TRSChartValue.Selected is set to false)
|
|
SetCount(Integer)
|
Represents method SetCount(Integer).
|
|
SetIsDateTime(Boolean)
|
Represents method SetIsDateTime(Boolean).
|
|
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)
|
|
Sort
|
Sorts the current values collection based on the SortByDimension. You can do custom sorts by using the CustomSort method.
|
|
Update(TCollectionItem)
|
Represents method Update(TCollectionItem).
|
|
ValueChanged(TRSChartValue,Integer)
|
Represents method ValueChanged(TRSChartValue,Integer).
|
|
VisibleChanged(TRSChartValue)
|
Represents method VisibleChanged(TRSChartValue).
|
