Appboard/2.4/builder/widgets/actions: Difference between revisions
imported>Mike.berman (correct descriptions of new Actions) |
imported>David.moore |
||
Line 99: | Line 99: | ||
# Log in to AppBoard Builder as an administrator. | # Log in to AppBoard Builder as an administrator. | ||
# Go to the Actions panel in the Widget Wizard: | # Go to the Actions panel in the Widget Wizard: | ||
## In the <b>Builder Modes</b> panel, select <b>Builder</b> and locate the appropriate Widget in which you will create the Action. | #* ''Option 1'': | ||
## Click the lightning bolt icon in the header bar of the Widget to display the Actions panel for that Widget. | #*# In the <b>Builder Modes</b> panel, select '''Widgets'''. The '''Widgets''' panel is displayed. | ||
#*# Select a Widget and then click '''Actions''' to display the Actions panel for that Widget. | |||
#* ''Option 2'': | |||
#*# In the <b>Builder Modes</b> panel, select <b>Builder</b> and locate the appropriate Widget in which you will create the Action. | |||
#*# Click the lightning bolt icon in the header bar of the Widget to display the Actions panel for that Widget. | |||
# Click <b>Add Action</b> | # Click <b>Add Action</b> | ||
# Select the appropriate Action. See the table above for a brief summary of each Action. | # Select the appropriate Action. See the table above for a brief summary of each Action. | ||
# Configure the Action. Each Action will have different elements that are required. | # Configure the Action. Each Action will have different elements that are required. | ||
# Click <b>Close</b> to save the changes to the Action and the Widget. | # Click <b>Close</b> to save the changes to the Action and the Widget. |
Revision as of 17:48, 1 April 2014
In addition to visualizing data, Widgets allow you to configure "Actions". For example, you can contextually Filter one widget based on a selection in another, or you can Drill Down into a child board that shows details based on an item selected in the parent. The key is knowing that when you click on a Widget, you are actually clicking on the piece of data that is being represented by the Widget. Actions allow you to use this piece of data as context to alter client or server side filters for any Data Collection inside AppBoard. This flexibility allows for extremely powerful interactions.
This section lists the Actions that you can configure in a Widget, with links to additional information on the individual Actions.
AppBoard Actions
AppBoard provides Actions that can be triggered either by Mouse Click or Mouse Hover. The following Actions are available:
On Mouse Click
Action | Description |
---|---|
Do Nothing | Do not perform any Actions. |
Apply a Filter to a Data Collection | Apply a Filter to a Data Collection. |
Apply a Server Side Filter to a Data Collection | Apply a Server Side Filter to a Data Collection. |
Bundled Actions | Implement multiple Actions as a result of a single User request. |
Change Diagram Context | Change a Diagrammer Widget to use a specified Diagram Model. |
Clear Sort | Clear a user's client-side sorting on a widget and revert to the sort order of the data collection or the widget configuration. |
Copy to Clipboard | Copies context specific information into the system clipboard. |
Focus on Widget | Change the focus of the application to a specific Widget. |
Launch URL | Load and display a pre-configured piece of web content. |
Refresh a Data Collection | Update a Data Collection to the latest data in the server cache. |
Set Widget Selection | Set the selected item in a Widget based on an event or selection in another Widget. |
Show Actions Menu | Provide a list of Actions for the User to choose from. |
Show Data Tip | Display a pop-up that lists selected fields and values for a record. |
Show Record Details Window | Display a window that lists every field and value for a selected record. |
Show Widget | Display a specific Widget inside of a Stacked Widget container. |
Switch to a Board | Drill down the display to show a different Board. |
Topology Drill Down | Click in one Widget and then invoke a drill down operation in another (Topology) Widget. |
Write Static Value | Write a value for a specific field back to the data on the AppBoard server. |
On Mouse Hover
Action | Description |
---|---|
Set Widget Selection | Set the selected item in a Widget based on an event or selection in another Widget. |
Show Data Tip | Display a pop-up that lists selected fields and values for a record. |
How To Create an Action in a Widget
Perform the following steps to configure an Action in a Widget:
- Log in to AppBoard Builder as an administrator.
- Go to the Actions panel in the Widget Wizard:
- Option 1:
- In the Builder Modes panel, select Widgets. The Widgets panel is displayed.
- Select a Widget and then click Actions to display the Actions panel for that Widget.
- Option 2:
- In the Builder Modes panel, select Builder and locate the appropriate Widget in which you will create the Action.
- Click the lightning bolt icon in the header bar of the Widget to display the Actions panel for that Widget.
- Option 1:
- Click Add Action
- Select the appropriate Action. See the table above for a brief summary of each Action.
- Configure the Action. Each Action will have different elements that are required.
- Click Close to save the changes to the Action and the Widget.