ScriptLabelledColorPicker

From Q
Jump to navigation Jump to search

ScriptLabelledColorPicker

Represents a control that lets the user select a color, created by the RuleForm object's colorPicker() function.

getValue()

Retrieves the state of the color picker.
Returns:The color chosen, or the default if none.

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.

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

Retrieves the state of the color picker.
Returns:The color chosen, or the default if none.

setDefault(color)

Set a default color for this picker. If this is not called then the default will be red.
colorA color as described in the JavaScript Color Table.

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