QScript CalculationGridCell

From Q
Jump to navigation Jump to search

CalculationGridCell

The cell that is part of a Calculation Grid.

Cells are automatically created by a Calculation Grid. You can access them using cell() in a Calculation Grid.

code

The R code which gets executed.

data

An interface that enables the querying of a Calculation's data

equals(obj)

Whether two objects are the same.
objThe object to compare against.
Returns:true or false
Example:
data_file.getQuestionByName('Q2').equals(data_file.questions()[0])

error

Errors with the R code or found in the execution of the R code. A string. Returns null if there is no error.

messages

Messages produced in the execution of the R code. A string. Returns null if there are no messages.

name

Get/set the name for this object, as it appears in the Report.

outputClasses

Returns an array of strings, which are the R classes of the output of this R calculation. If the Calculation is in error then an exception will be thrown. If R code has not been calculated before, null will be returned (and you may call update() in QScript in order to force the R code to be calculated).

text

Textual output of the R code. Returns null if the item has not produced text output, or perhaps is in error.

type

Returns "Calculation Grid Cell".

warning

Warning messages produced in the execution of the R code. A string. Returns null if there is no warning.