RiverSoftAVG Products Help

Create(TRSCustomChart,TRSChartValueClass)

Initializes a new instance of the TRSPathChartValues class. (Overrides RSCharts.TRS2DChartValues.Create(TRSCustomChart,TRSChartValueClass).)

AbsSum

Returns the sum of the absolute values of the first dimension of the values in the chart. The   AbsSums property returns the absolute sum for any dimension in the chart (see   DimensionCount for more details).
 (Inherited from RSChartPanel.TRSChartValues.)

AbsSums[Integer]

Returns the summation of the absolute values for every dimension of the TRSChartValues in the chart. Use the     DimensionCount property to determine the number of dimensions in the chart value collection. This property is part of the metadata that the collection tracks about the chart values.

A chart value, depending on the chart type, can contain 1 or more dimensional values that define the chart value. For example, each chart value in a bar chart contains 1 value (defining the height of the bar), line chart values contains 2 dimensions: X and Y, and shape chart values contain 4 dimensions: X, Y, Width, and Height. See the Values and ValueCount properties of the TRSChartValue item for more information.
 
 

DateTimeAxes

Specifies the axes that should be considered datetime values. The property controls which dimensions should be labeled as a date time or a regular floating point number. When this property includes an axis, all the labels for the chart will be drawn as a Date + Time (controlled by the DateTimeFormat of the axis). (Inherited from RSCharts.TRS2DChartValues.)

DefaultDimension

Returns the     Values dimension that contains the default dimension or key dimension, i.e., the dimension that is most important to a chart. For 1D charts, like a pie chart, this value is 0. For 2D charts, this dimension is usually 1.

Use the     TimeDimension and the     DefaultDimension to find out the "important" dimensions of the TRSChartValue descendant.

DimensionCount

Returns the number of dimensions each Value ( RSChartPanel.TRSChartValue ) will have in the chart.

A chart value, depending on the chart type, can contain 1 or more dimensional values that define the chart value. For example, each chart value in a bar chart contains 1 value (defining the height of the bar), line chart values contains 2 dimensions: X and Y, and shape chart values contain 4 dimensions: X, Y, Width, and Height. The number of dimensions in a chart is defined when the TRSChartValues collection is created. Every time a TRSChartValue item is created, its Values property will be initialized to the size of DimensionCount.
 

DoNotNotify

Represents property DoNotNotify. (Inherited from RSChartPanel.TRSChartValues.)

HasCaptions

Specifies that at least one TRSChartValue in the collection has had a Caption assigned to it. (Inherited from RSChartPanel.TRSChartValues.)

HeightDim

Returns the dimension of the Height property of the TRSPathChartValue. Use this property to always access the correct dimension for the Height property.
 

IsDateTime

Controls whether the first (or only) dimension should be labeled as a date time or a regular floating point number. When this property is set to True, all the labels for this chart will be drawn as a Date + Time (controlled by the   DateTimeFormat of the axis).
 (Inherited from RSChartPanel.TRSChartValues.)

Items[Integer]

Lists the values in the chart. Use Items to access individual value in the collection. The value of the Index parameter corresponds to the Index property of RSChartPanel.TRSChartValue . It represents the position of the value in the collection.

The Items property is the default property for the class. You can access this property with the abbreviation Values[index], which is equivalent to Values.Items[index].
 
 

Limit

Limits the number of values (or RSChartPanel.TRSChartValue items) in the collection. It provides the chart the ability to limit its size automatically as values are added.

Once the Count property equals the Limit property, every time you Add another value, the 0-th value is deleted. This property makes it easy to ensure your chart values do not grow unbounded and creates an automatic sliding window display ofthe Limit number of points. Note that this is not necessarily the last Limit number of points added, as sorting the values (Sorted) can make which value is deleted unpredictable.

If you want an unlimited number of chart values, set Limit to RSChartConsts|NoLimit .
 

MaxValue

Returns the maximum value of the first dimension of the values in the chart. The   MaxValues property returns the maximum value for any dimension in the chart (see   DimensionCount for more details).
 (Inherited from RSChartPanel.TRSChartValues.)

MaxValues[Integer]

Returns the maximum value for every dimension of the TRSChartValues in the chart. Use the     DimensionCount property to determine the number of dimensions in the chart value collection. This property is part of the metadata that the collection tracks about the chart values.

A chart value, depending on the chart type, can contain 1 or more dimensional values that define the chart value. For example, each chart value in a bar chart contains 1 value (defining the height of the bar), line chart values contains 2 dimensions: X and Y, and shape chart values contain 4 dimensions: X, Y, Width, and Height. See the Values and ValueCount properties of the TRSChartValue item for more information.
 
 

MinValue

Returns the minimum value of the first dimension of the values in the chart. The   MinValues property returns the maximum value for any dimension in the chart (see   DimensionCount for more details).
 (Inherited from RSChartPanel.TRSChartValues.)

MinValues[Integer]

Returns the minimum value for every dimension of the TRSChartValues in the chart. Use the     DimensionCount property to determine the number of dimensions in the chart value collection. This property is part of the metadata that the collection tracks about the chart values.

A chart value, depending on the chart type, can contain 1 or more dimensional values that define the chart value. For example, each chart value in a bar chart contains 1 value (defining the height of the bar), line chart values contains 2 dimensions: X and Y, and shape chart values contain 4 dimensions: X, Y, Width, and Height. See the Values and ValueCount properties of the TRSChartValue item for more information.
 
 

NeedMetaUpdate

Signals that metadata is out of date and needs to be recalculated by calling the CalculateMetaData method (Inherited from RSChartPanel.TRSChartValues.)

NumDimensions

Specifies the number of dimensions the TRSChartValue's have. The number of dimensions specify the size of the   TRSChartValue.Values property and corresponds to all the floating point properties of a value (e.g., X, Y, Z, Width, Height, Size, etc). (Inherited from RSChartPanel.TRSChartValues.)

SelCount

Returns the number of   selected values in the collection (Inherited from RSChartPanel.TRSChartValues.)

SortByDimension

Represents property SortByDimension. (Inherited from RSCharts.TRS2DChartValues.)

Sorted

Controls whether the values of the chart are sorted or not.

Set the Sorted property to True to force all values to be sorted in the collection based on the     SortByDimension and     SortOrder properties. When this property is False, the values are in the order that they were added or inserted into the collection (see Add or Insert methods).

SortOrder

Controls whether the items are sorted in ascending or descending order. The RSChartPanel.TRSChartValues.SortByDimension property controls which values are used to do the sorting. The RSChartPanel.TRSChartValues.Sorted property controls whether the items will be sorted at all. (Inherited from RSChartPanel.TRSChartValues.)

Sum

Returns the summation of the first dimension of the values in the chart. The   Sums property returns the summation for any dimension in the chart (see   DimensionCount for more details).
 (Inherited from RSChartPanel.TRSChartValues.)

Sums[Integer]

Returns the summation of the values for every dimension of the TRSChartValues in the chart. Use the     DimensionCount property to determine the number of dimensions in the chart value collection. This property is part of the metadata that the collection tracks about the chart values.

A chart value, depending on the chart type, can contain 1 or more dimensional values that define the chart value. For example, each chart value in a bar chart contains 1 value (defining the height of the bar), line chart values contains 2 dimensions: X and Y, and shape chart values contain 4 dimensions: X, Y, Width, and Height. See the Values and ValueCount properties of the TRSChartValue item for more information.
 
 

TimeDimension

Returns the     Values dimension that contains the time/x/horizontal dimension. For 1D charts, like a pie chart, this value is unassigned (DIMENSION_UNASSIGNED). For 2D charts, this dimension is usually 0.

Use the     TimeDimension and the     DefaultDimension to find out the "important" dimensions of the TRSChartValue descendant.

VisibleCount

Returns the number of visible values in the collection (   Visible = True) (Inherited from RSChartPanel.TRSChartValues.)

WidthDim

Returns the dimension of the Width property of the TRSPathChartValue. Use this property to always access the correct dimension for the Width property.
 

XDim

Returns the dimension of the X property of the TRS2DChartValue. Use this property to always access the correct dimension for the X property.
 (Inherited from RSCharts.TRS2DChartValues.)

YDim

Returns the dimension of the Y property of the TRS2DChartValue. Use this property to always access the correct dimension for the Y property.
 (Inherited from RSCharts.TRS2DChartValues.)

Add

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

Add(String,String,TCanvasColor)

Overloaded.  Creates a new RSCharts.TRSPathChartValue instance and adds it to the Items array. The new instance is initialized with the Path Data, Caption, and Color parameters. Call Add to create a path shape 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 path shape value.
 

Add(TRSChartValueType,String,TCanvasColor)

Overloaded.  Creates a new RSCharts.TRS2DChartValue instance and adds it to the Items array. The new instance is initialized with the Value, Caption, and Color parameters. The Value parameter is assigned to the first dimension of the TRS2DChartValues.Values property. 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.

Add returns the new 2D value.
 
 

Add(TRSChartValueType,TRSChartValueType,String,TCanvasColor)

Overloaded.  Creates a new RSCharts.TRS2DChartValue instance and adds it to the Items array. The new instance is initialized with the X, Y, 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.

Add returns the new 2D value.
 
 

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.
 

Add(TRSRect,String,String,TCanvasColor)

Overloaded.  Creates a new RSCharts.TRSPathChartValue instance and adds it to the Items array. The new instance is initialized with the dimensions (Top, Left, Width, and Height), Path Data, Caption, and Color parameters. Call Add to create a path shape 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 path shape value.
 

Append(TRSChartValues)

Appends the Source values to the current collection (Inherited from RSChartPanel.TRSChartValues.)

Assign(TPersistent)

Represents method Assign(TPersistent). (Inherited from RSChartPanel.TRSChartValues.)

AssignTo(TPersistent)

Represents method AssignTo(TPersistent). (Inherited from RSChartPanel.TRSChartValues.)

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. (Inherited from RSChartPanel.TRSChartValues.)

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. (Inherited from RSChartPanel.TRSChartValues.)

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). (Inherited from RSChartPanel.TRSChartValues.)

GetAxisMaximum(Integer)

Returns the maximum value in the collection for the specified dimension. (Inherited from RSChartPanel.TRSChartValues.)

GetAxisMinimum(Integer)

Returns the minimum value in the collection for the specified dimension. (Inherited from RSChartPanel.TRSChartValues.)

GetEnumerator

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

GetIsDateTime

Represents method GetIsDateTime. (Inherited from RSChartPanel.TRSChartValues.)

GetMaxValue(Integer)

Represents method GetMaxValue(Integer). (Inherited from RSChartPanel.TRSChartValues.)

GetMinValue(Integer)

Represents method GetMinValue(Integer). (Inherited from RSChartPanel.TRSChartValues.)

GetSortByDimension

Represents method GetSortByDimension. (Inherited from RSChartPanel.TRSChartValues.)

GetSum(Integer)

Represents method GetSum(Integer). (Inherited from RSChartPanel.TRSChartValues.)

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.

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.

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. (Inherited from RSChartPanel.TRSChartValues.)

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.
 

Loaded

Represents method Loaded. (Inherited from RSChartPanel.TRSChartValues.)

Notify(Classes,Classes)

Represents method Notify(Classes,Classes). (Inherited from RSChartPanel.TRSChartValues.)

Owner

Returns the chart that is the owner of the collection, or nil if there is not one. (Inherited from RSChartPanel.TRSChartValues.)

QuickSort(Integer,Integer,TValuesSortCompare)

Represents method QuickSort(Integer,Integer,TValuesSortCompare). (Inherited from RSChartPanel.TRSChartValues.)

SelectAll

Selects all values in the collection (TRSChartValue.Selected is set to true) (Inherited from RSChartPanel.TRSChartValues.)

SelectionChanged(TRSChartValue)

Represents method SelectionChanged(TRSChartValue). (Inherited from RSChartPanel.TRSChartValues.)

SelectNone

Deselects all values in the collection (TRSChartValue.Selected is set to false) (Inherited from RSChartPanel.TRSChartValues.)

SetCount(Integer)

Represents method SetCount(Integer). (Inherited from RSChartPanel.TRSChartValues.)

SetIsDateTime(Boolean)

Represents method SetIsDateTime(Boolean). (Inherited from RSChartPanel.TRSChartValues.)

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. (Inherited from RSChartPanel.TRSChartValues.)

Update(TCollectionItem)

Represents method Update(TCollectionItem). (Inherited from RSChartPanel.TRSChartValues.)

ValueChanged(TRSChartValue,Integer)

Represents method ValueChanged(TRSChartValue,Integer). (Inherited from RSChartPanel.TRSChartValues.)

VisibleChanged(TRSChartValue)

Represents method VisibleChanged(TRSChartValue). (Inherited from RSChartPanel.TRSChartValues.)

OnNotify

Occurs when a TRSChartValue is added, extracted, or removed from the collection. (Inherited from RSChartPanel.TRSChartValues.)

FAbsSum

Represents field FAbsSum. (Inherited from RSChartPanel.TRSChartValues.)

FDefaultDimension

Represents field FDefaultDimension. (Inherited from RSChartPanel.TRSChartValues.)

FHeightDim

Represents field FHeightDim.

FMaxValue

Represents field FMaxValue. (Inherited from RSChartPanel.TRSChartValues.)

FMinValue

Represents field FMinValue. (Inherited from RSChartPanel.TRSChartValues.)

FSum

Represents field FSum. (Inherited from RSChartPanel.TRSChartValues.)

FTimeDimension

Represents field FTimeDimension. (Inherited from RSChartPanel.TRSChartValues.)

FWidthDim

Represents field FWidthDim.

FXDim

Represents field FXDim. (Inherited from RSCharts.TRS2DChartValues.)

FYDim

Represents field FYDim. (Inherited from RSCharts.TRS2DChartValues.)