toolkit.paramSelector {shinylight}

JavaScript function: Returns a custom selection box Toolkit Control.

Description

This is different to a normal selection box because it allows tooltips on the items within the list.

Arguments

id

string when getData or setData is called on the container, the value at 'id' refers to this selector. The HTML id is set to 'param-' + id.

container

toolkit.HTMLContainerElement [optional] Where to put the control. the container came from optionsPage() the new selection box will be formatted as a table row.

labelTranslations

object A dictionary with two optional keys; 'name' gives the label to display and 'help' gives HTML help text. 'help' has no effect unless 'name' is also present.

values

Array.<int> An array of the IDs of the options in the selection.

valueTranslations

object A dictionary whose keys are the IDs of the options in the selection, the values are more dictionaries. These dictionaries have two optional keys; 'name' (giving the name to display for this option) and 'help' (giving tooltip HTML text).

initial

string ID of the option to start selecting (optional)

callback

function The (nullary) function to call when the value changes (optional)

Value

The selection box.