4 Accessing User Input in Script

Tabs have a property 'selectedIndex' which returns the numeric representation of the active tab.

You can access the state of different components within the Viewsheet using the selectedObject, selectedObjects, and drillMember keywords. See Walkthrough: Accessing User Selections for an example using selectedObject. See Walkthrough: Interactive Chart Drilldown for an example using drillMember.

selectedObject, selectedLabel: The selected value or label of the component: Applies to single value input elements (Sliders, Radio Buttons, etc.) and the tabs of co-located components. For example, to return the value or label selected in a radio button control:

radioButton.selectedObject

radioButton.selectedLabel

selectedObjects, selectedLabels: An array of values or labels selected in a component: Applies to multi-value input elements (e.g., Check Boxes) and selection elements (Selection Lists and Trees). For example, to return the first selected item or label in a Selection List:

SelectionList.selectedObjects[0];

SelectionList.selectedLabels[0];

drillMember: For Selection Trees, the name of the field that resides one level in the hierarchy below the user's lowest selected level:

SelectionTree.drillMember;

You can manually type these references into your script, or enter them automatically by clicking the appropriate node on the 'Component' tree of the Script Editor.

 

See Also

Accessing User-Modified Data in a Table, for information on accessing user table edits.

Accessing the Most Recent User Modification, for information on accessing the last user edit.

<< 3.4.2 onLoad Handler © 1996-2013 InetSoft Technology Corporation (v11.5) 4.1 Walkthrough: Accessing User Selections >>