|
OpenAPI 1.0 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface AQSeriesFunction
SeriesFunction
Synopsis: SeriesFunction is a function which accepts a set of parameters and generates a series of data Description: SeriesFunctions are specified in the ChartProperties to add a data series generated by a mathematical function. Functions can be performed on values contained in other series. These series references are specified using a zero-based index. By default, functions are performed on all values in the series.
Method Summary | |
---|---|
List<Number> |
evaluate(List<AQFunctionParameter> parameters,
AQChartModel model)
Evaluate the function using the specified parameters and data model. |
String |
getFunctionWithParameterDescriptions()
Get a description of the function, including parameter names. |
String |
getFunctionWithParameterValues()
Get a description of the function, including parameter values. |
List<String> |
getMetaData()
Get metadata returned by the function. |
String |
getName()
Get the name of the function. |
String[] |
getParameterDescriptions()
Get an array of string parameter descriptions. |
String |
getParameterDescriptionsString()
Get a string containing the parameter descriptions. |
List<AQFunctionParameter> |
getParameters()
Get the list of function parameters. |
String |
getParameterValuesString()
Get a string containing the parameter values. |
boolean |
isValid(List<AQFunctionParameter> parameters,
AQChartModel model,
int functionSeriesIndex)
Returns TRUE if the specified function parameters are valid when used with the ChartModel. |
void |
setParameters(List<AQFunctionParameter> functionParameters)
Set the list of function parameters. |
boolean |
setParameters(String parameterString)
Set the function parameters using by parsing the specified string. |
Method Detail |
---|
String getName()
String[] getParameterDescriptions()
List<Number> evaluate(List<AQFunctionParameter> parameters, AQChartModel model)
parameters
- List of function parametersmodel
- Data model
boolean isValid(List<AQFunctionParameter> parameters, AQChartModel model, int functionSeriesIndex)
parameters
- List of function parametersmodel
- Data modelfunctionSeriesIndex
- index of function series
List<String> getMetaData()
String getFunctionWithParameterDescriptions()
String getFunctionWithParameterValues()
String getParameterValuesString()
String getParameterDescriptionsString()
boolean setParameters(String parameterString)
parameterString
- String containing parameter values
List<AQFunctionParameter> getParameters()
void setParameters(List<AQFunctionParameter> functionParameters)
functionParameters
- List of function parameters
|
OpenAPI 1.0 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |