Edge Documentation

{{DISPLAYTITLE:Set Widget Selection}}
[[Category:AppBoard 2.5]]
The "Set Widget Selection" Action controls what item is selected in a Widget based on an event or selection in another Widget.


== How To Create a Set Widget Selection Action ==

For instructions on adding an Action to a Widget, see the general instructions in [[appboard/2.5/builder/widgets/actions#How_To_Create_an_Action_in_a_Widget|How To Create an Action in a Widget]].


== How To Configure a Set Widget Selection Action ==

Perform the following steps to configure a "Set Widget Selection" Action:

# Follow the instructions above to create the Action in the <b>Widget Actions</b> panel.
# <b>Name</b>: Enter a name for this Action.  For convenience, a default name is provided.  The Name is not used anywhere else in AppBoard, and only displayed on this configuration page.
# <b>On selection of</b>:
## Select "any" or "specific" for the type of data selection by the User that will trigger the Action. When selecting "specific", perform the following additional steps:
### Click the <b>Filter</b> button. The <b>Filter Editor</b> is displayed.
### Click <b>Add Rule</b> to create one or more rules that indicate what data should trigger the Action, when selected.
### Click <b>Close</b> to save the Filter settings.
## Select the Data Source name. When the Widget is run, selection of data in this Data Source will trigger the Action. 
# Under <b>Set selection on</b>, select the name of the target Widget in which you want to set the selected value.
# Choose one of the options for how the selection should be determined:
## <b>as no selection</b>: Set the Widget to remove any previous selection so that nothing in the Widget will be selected.
## <b>from event</b>: Select the name of the property on the data used to trigger this event.
## <b>from widget's last selection</b>: Use the last selected item in a source Widget to determine what to select in the target Widget.
# Check the box next to <b>Trigger actions on target widget</b> if you want any Actions associated with clicking on the target Widget to be invoked, as if the User had clicked the selected item in the target Widget.
# Click <b>Close</b> to exit the Widget Wizard and test the Action.


== Sample Use Case ==

Suppose you have two Widgets, a Map and a table. You want to select (highlight) the row in the table that corresponds to the node that is clicked in the map.  Perform the following steps to configure the Set Widget Selection Action:


# In the Map Widget, click the lightning bolt to go to the Actions panel in the Widget Wizard.
# Click <b>Add Event Action</b> and select the <b>Set Widget Selection</b> Action.
# Under <b>Set selection on</b>, select the name of the Table Widget.
# Choose <b>from widget's last selection</b> and select the name of the Map Widget from the list. 


Perform the steps outlined above to create an Action configuration similar to what is presented in the following image:


[[File:appboard-setWidgetSelectionConfigure.png|center|thumb|300px|Sample Configuration of Set Widget Selection Action]]



When the User clicks a node in the Map Widget, the corresponding row in the Table Widget is selected:


[[File:appboard-setWidgetSelectionResult.png|center|thumb|300px|Sample Result of Set Widget Selection Action]]