ScriptStatisticPicker

This feature is new in Q 4.8.

ScriptStatisticPicker

Represents a drop-down that allows statistic selection. Only the statistics available for the current table or plot will appear in the list. The first entry is always a special entry, which selects the default statistic, and doesn't care if that statistic is different on different tables. However if the user explicitly selects a statistic then the Rule will not be applied to tables or plots that do not support that statistic.

controlName

Unique name for each control. Used as key for storing serialized values. May be null if the control will never store values (e.g. ScriptLabel).

form

The format whose script created this control. The format stores our value (serialized to a string).

getValue()

Retrieves the selected statistic.

Returns:

The name of a statistic, or null if the user wants the main statistic (which is the default).

isExpression

Use this to control whether the item should be treated as an expression or as a string in R code. Only applicable to textBox, comboBox and dropBox controls.

limitToNumericStatistics()

If called then the table this Rule is applied to must yield a numeric statistic, else this rule will be skipped.

lineBreakAfter

Use this where your Rule has many controls, and they do not fit comfortably in a single line. It allows you to specify that a new row will be started after this control.

Example:

c.lineBreakAfter = true;

requireValue()

There is always a default statistic.

Returns:

The name of the selected statistic.

type

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

visible

Set this to false if you want a control you have created to not be shown to the user. This property is only available in Q v5.4