RiverSoftAVG Products Help

Create(TRSCustomChart,TRSChartValueClass)

Initializes a new instance of the TRSChartValues class.

Destroy

Represents the destructor of the TRSChartValues class.

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).
 

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

Represents property DateTimeAxes.

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.

HasCaptions

Specifies that at least one TRSChartValue in the collection has had a Caption assigned to it.

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).
 

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 TRSChartValues 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).
 

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).
 

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

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).

SelCount

Returns the number of   selected values in the collection

SortByDimension

Controls which dimension is used to sort the items in the collection (when     Sorted is True).

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 SortByDimension allows you to sort the items by the dimension (X usually but it could be Width in a shape chart, Level in a graph chart, etc). See the     Values and     ValueCount properties of the TRSChartValue item for more information.
 

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.

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).
 

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)

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.
 

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.
 

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.

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.

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).

OnNotify

Occurs when a TRSChartValue is added, extracted, or removed from the collection.

FAbsSum

Represents field FAbsSum.

FDefaultDimension

Represents field FDefaultDimension.

FMaxValue

Represents field FMaxValue.

FMinValue

Represents field FMinValue.

FSum

Represents field FSum.

FTimeDimension

Represents field FTimeDimension.