RiverSoftAVG Products Help

Create(TComponent)

Initializes a new instance of the TRSCustomChartFunction class.

Destroy

Represents the destructor of the TRSCustomChartFunction class.

CenterTimePeriod

Represents property CenterTimePeriod.

Enabled

Controls whether the function class should execute. When Enabled is True, the PerformFunction method will be called every time the ValueChanged IChartPanelListener method executes.

FunctionType

Defines the function to apply to the SourceChart to generate the TargetChart values

To define a custom function, set FunctionType to cftCustom and create an OnCustomFunction event handler

Modified

Represents property Modified.

OnExecutedFunction

Use the OnExecutedFunction event for handling tear down or finalization code for your custom function. The occurs just after the function finishes executing but before the TargetChart's EndUpdate method is called.

OnExecutingFunction

Use the OnExecutingFunction event for handling setup or initialization code for your custom function. The occurs just  before the function starts executing but after the TargetChart's old values have been deleted.

Period

The Period and PeriodValue properties define the period for a function, i.e., over what time span or value range should the function be called. The Period divides the SourceChart values collection into chunks (usually based on a time span) and calls the FunctionType for every chunk.

The predefined period values (Second, Minute, Hour, ... Year) ignore the PeriodValue property.

PeriodValue

The Period and PeriodValue properties define the period for a function, i.e., over what time span or value range should the function be called. The Period divides the SourceChart values collection into chunks (usually based on a time span) and calls the FunctionType for every chunk.

The PeriodValue may be a percentage (between 0 and 1) or an Index Range. For example, call the function for 25% (PeriodValue=0.25;Period=cfpPercentageCount) of the SourceChart values, or call the function for every 5 (PeriodValue=5;Period=cfpIndexRange) SourceChart values.
 

SourceChart

Defines the input or source chart for the function. The function uses the SourceChart values to create values for the TargetChart

SourceDim

Defines the input source dimension to apply the function on

TargetChart

Defines the output or target chart for the function. The function transforms the input SourceChart values and adds values to the TargetChart

TargetDim

Defines the output target dimension to apply the function on

AddValue(TRSCustomChart,TRSChartValueType,TDateTime,Integer)

Adds the specified TimeStamp and Value to the Chart. The TimeStamp is set to the TRSCustomChart.Values.TimeDimension in the Values property if present and Value to TRSCustomChart.Values.DefaultDimension

Average(TRSCustomChart,Integer,Integer,TDateTime,Integer)

Overloaded. Calculates the average of all values from IndexLow to IndexHigh in the SourceChart and returns the average

Average(TRSCustomChart,TRSCustomChart,Integer,Integer,TDateTime,Integer,Integer)

Overloaded. Calculates the average of all values from IndexLow to IndexHigh in the SourceChart and adds the average to the TargetChart. If the TargetChart is of a type that has more than 2 dimensions, such as a TRSLineChart with X and Y values, the new TargetChart value includes the TimeStamp.

Changed

Represents method Changed.

ChartAdded(TRSCustomChart)

IChartPanelListener interface method that occurs when a chart is added to a panel. It is ignored by the function class.

ChartChanged(TRSCustomChart)

IChartPanelListener interface method that occurs when the SourceChart changes (e.g., Caption, Align, etc) . It is ignored by the function class.

ChartDeleted(TRSCustomChart)

IChartPanelListener interface method that occurs when a chart is removed from a panel. It is ignored by the function class.

Copy(TRSCustomChart,TRSCustomChart,Integer,Integer,TDateTime,Integer,Integer)

Overloaded. Represents method Copy(TRSCustomChart,TRSCustomChart,Integer,Integer,TDateTime,Integer,Integer).

DoFunction

Represents method DoFunction.

GetPeriodIndex(TRSCustomChart,Integer,TDateTime)

Returns the Source Chart Index for the end of the period defined by the StopTime from the LowIndex

GreatestCommonDivisor(TRSCustomChart,Integer,Integer,TDateTime,Integer)

Overloaded. Calculates the greatest common divisor (gcd) of the SourceChart Values and returns the value. The SourceChart Values are rounded into integers and the GCD calculated from this array. The GCD of two or more integers, when at least one of them is not zero, is the largest positive integer that divides the numbers without a remainder. For example, the GCD of 8 and 12 is 4.

GreatestCommonDivisor(TRSCustomChart,TRSCustomChart,Integer,Integer,TDateTime,Integer,Integer)

Overloaded.  Calculates the greatest common divisor (gcd) of the SourceChart Values and adds the GCD to the TargetChart. The SourceChart Values are rounded into integers and the GCD calculated from this array. The GCD of two or more integers, when at least one of them is not zero, is the largest positive integer that divides the numbers without a remainder. For example, the GCD of 8 and 12 is 4.

If the TargetChart is of a type that has more than 2 dimensions, such as a TRSLineChart with X and Y values, the new TargetChart value includes the TimeStamp.

IsModified

Returns true if the SourceChart has been modified since the last time the chart has applied the function

Maximum(TRSCustomChart,Integer,Integer,TDateTime,Integer)

Overloaded. Calculates the maximum of all values from IndexLow to IndexHigh in the SourceChart and returns the maximum

Maximum(TRSCustomChart,TRSCustomChart,Integer,Integer,TDateTime,Integer,Integer)

Overloaded. Calculates the maximum of all values from IndexLow to IndexHigh in the SourceChart and adds the maximum to the TargetChart. If the TargetChart is of a type that has more than 2 dimensions, such as a TRSLineChart with X and Y values, the new TargetChart value includes the TimeStamp.

Median(TRSCustomChart,Integer,Integer,TDateTime,Integer)

Overloaded. Calculates the median of all values from IndexLow to IndexHigh in the SourceChart and returns the median. The function also returns the timestamp of the median value if the SourceChart contains timestamps (SourceChart.Values.IsDateTime=True)

Median(TRSCustomChart,TRSCustomChart,Integer,Integer,TDateTime,Integer,Integer)

Overloaded. Calculates the median of all values from IndexLow to IndexHigh in the SourceChart and adds the median to the TargetChart. If the TargetChart is of a type that has more than 2 dimensions, such as a TRSLineChart with X and Y values, the new TargetChart value includes the TimeStamp.

Minimum(TRSCustomChart,Integer,Integer,TDateTime,Integer)

Overloaded. Calculates the minimum of all values from IndexLow to IndexHigh in the SourceChart and returns the minimum

Minimum(TRSCustomChart,TRSCustomChart,Integer,Integer,TDateTime,Integer,Integer)

Overloaded. Calculates the minimum of all values from IndexLow to IndexHigh in the SourceChart and adds the minimum to the TargetChart. If the TargetChart is of a type that has more than 2 dimensions, such as a TRSLineChart with X and Y values, the new TargetChart value includes the TimeStamp.

Norm(TRSCustomChart,Integer,Integer,TDateTime,Integer)

Overloaded. Calculates the Euclidean 'L-2' norm for the values in the SourceChart over the time period.

Norm(TRSCustomChart,TRSCustomChart,Integer,Integer,TDateTime,Integer,Integer)

Overloaded. Calculates the Euclidean 'L-2' norm for the values in the SourceChart over the time period and adds the value to the TargetChart. The 'L-2' norm is the square root of the sum of squares. If the TargetChart is of a type that has more than 2 dimensions, such as a TRSLineChart with X and Y values, the new TargetChart value includes the TimeStamp.

Notification(TComponent,TOperation)

Represents method Notification(TComponent,TOperation).

PanelChange

IChartPanelListener interface method that occurs when the panel changes. It is ignored by the function class.

PerformFunction

Executes the function on the SourceChart and adds values to the TargetChart

PopnStdDev(TRSCustomChart,Integer,Integer,TDateTime,Integer)

Overloaded. Calculates the population standard deviation (the square root of the population variance) of all values in the SourceChart over the time period.

PopnStdDev(TRSCustomChart,TRSCustomChart,Integer,Integer,TDateTime,Integer,Integer)

Overloaded. Calculates the population standard deviation (the square root of the population variance) of all values in the SourceChart over the time period and adds the value to the TargetChart. If the TargetChart is of a type that has more than 2 dimensions, such as a TRSLineChart with X and Y values, the new TargetChart value includes the TimeStamp.
 

PopnVariance(TRSCustomChart,Integer,Integer,TDateTime,Integer)

Overloaded. Calculates the population variance of all values in the SourceChart over the time period, using the n method (biased): TotalVariance / n.

PopnVariance(TRSCustomChart,TRSCustomChart,Integer,Integer,TDateTime,Integer,Integer)

Overloaded. Calculates the population variance of all values in the SourceChart over the time period and adds the value to the TargetChart, using the n method (biased): TotalVariance / n. If the TargetChart is of a type that has more than 2 dimensions, such as a TRSLineChart with X and Y values, the new TargetChart value includes the TimeStamp.
 

SelectionChanged(TObject)

IChartPanelListener interface method that occurs when the SourceChart's value is selected or deselected. It is ignored by the function class.

SetFunction

Represents method SetFunction.

StdDev(TRSCustomChart,Integer,Integer,TDateTime,Integer)

Overloaded. Calculates the sample standard deviation (the square root of the sample variance) of all SourceChart's values over the time period.

StdDev(TRSCustomChart,TRSCustomChart,Integer,Integer,TDateTime,Integer,Integer)

Overloaded. Calculates the sample standard deviation (the square root of the sample variance) of all SourceChart's values over the time period and adds the value to the TargetChart. If the TargetChart is of a type that has more than 2 dimensions, such as a TRSLineChart with X and Y values, the new TargetChart value includes the TimeStamp.

Sum(TRSCustomChart,Integer,Integer,TDateTime,Integer)

Overloaded. Calculates the sum of all values from IndexLow to IndexHigh in the SourceChart and returns the sum

Sum(TRSCustomChart,TRSCustomChart,Integer,Integer,TDateTime,Integer,Integer)

Overloaded. Calculates the sum of all values from IndexLow to IndexHigh in the SourceChart and adds the sum to the TargetChart. If the TargetChart is of a type that has more than 2 dimensions, such as a TRSLineChart with X and Y values, the new TargetChart value includes the TimeStamp.

SumOfSquares(TRSCustomChart,Integer,Integer,TDateTime,Integer)

Overloaded. Calculates the sum of the squares of the SourceChart values over the time period: Data[0]^2 + Data[1]^2 + Data[2]^2....

SumOfSquares(TRSCustomChart,TRSCustomChart,Integer,Integer,TDateTime,Integer,Integer)

Overloaded. Calculates the sum of the squares of the SourceChart values over the time period: Data[0]^2 + Data[1]^2 + Data[2]^2...and adds the value to the TargetChart. If the TargetChart
is of a type that has more than 2 dimensions, such as a TRSLineChart with X and Y values, the new TargetChart value includes the TimeStamp.
 

ToArray(TRSCustomChart,Integer,Integer,Integer)

Creates a TRSChartValueTypeArray of all the Values in the Chart from IndexLow to IndexHigh for the specified dimension

TotalVariance(TRSCustomChart,Integer,Integer,TDateTime,Integer)

Overloaded. Calculates the sum of the squares of the difference between each SourceChart value and the mean of the SourceChart values over the time period.

TotalVariance(TRSCustomChart,TRSCustomChart,Integer,Integer,TDateTime,Integer,Integer)

Overloaded. Calculates the sum of the squares of the difference between each SourceChart value and the mean of the SourceChart values over the time period and adds the value to the TargetChart. If the TargetChart is of a type that has more than 2 dimensions, such as a TRSLineChart with X and Y values, the new TargetChart value includes the TimeStamp.
 

ValueChanged(TRSCustomChart,TRSChartValue)

IChartPanelListener interface method that occurs when the SourceChart's value is changed. If the function class is Enabled, new values are generated for the TargetChart.

Variance(TRSCustomChart,Integer,Integer,TDateTime,Integer)

Overloaded. Calculates the sample variance of all values in the SourceChart over the time period, using the n-1 method (unbiased).

Variance(TRSCustomChart,TRSCustomChart,Integer,Integer,TDateTime,Integer,Integer)

Overloaded. Calculates the sample variance of all values in the SourceChart over the time period and adds the value to the TargetChart, using the n-1 method (unbiased). If the TargetChart is of a type that has more than 2 dimensions, such as a TRSLineChart with X and Y values, the new TargetChart value includes the TimeStamp.
 

VisibleChanged(TObject)

IChartPanelListener interface method that occurs when the SourceChart's or value's visibility is changed. It is ignored by the function class.

ChartFunction

Represents property ChartFunction.

OnCustomFunction

Create an OnCustomFunction event handler to write your own functions. Note that the OnCustomFunction event handler is called for every Period in the SourceChart.

You only need to write the function itself and for adding value(s) to the TargetChart. The TRSCustomChartFunction class does all the housekeeping necessary for preparing the TargetChart (e.g., calling BeginUpdate/EndUpdate, clearing values)