QScript Rule

From Q
Jump to navigation Jump to search

This feature is new in Q 4.8.

Rule

Represents a Rule. Rules can be applied to one or more tables or plots. See Q documentation for more information about Rules. Create new Rules using the RulesManager object. Add them to tables and plots using table.rules.add(). Change Rules by creating a new rule and using the replace() function in the RulesManager object.

appliedTo

Returns every table, plot, or other analysis item that this Rule is currently applied to.

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

isDefault

Whether this Rule is applied as a default rule for new plots and tables.

summary

Describes the Rule. May contain more specific information if the rule has already been used to calculate a table or plot.

type

Returns the name we use to refer to this class in the documentation.