Appboard/old/widgets: Difference between revisions

imported>Cmace
(removed link)
imported>Jason.nicholls
No edit summary
 
(3 intermediate revisions by 2 users not shown)
Line 1: Line 1:
This section outlines the components and procedures to use when creating visual widgets to display in AppBoard.
{{DISPLAYTITLE:AppBoard Widgets}}
[[Category:AppBoard old]]
[[Image:HeaderFlow05.png]]
A "Widget" is a visual component placed on a Board. For example, the "Data Grid Widget" gives a visual representation of tabular data in a familiar spreadsheet format. Boards contain one or more Widgets, each displaying part of the data to be visualized.


The widget designer relies upon data objects being provided to AppBoard in the appropriate format.  The server-side configuration of the data objects is described in the <i>Configure Data</i> section of this guide.  The following exhibit summarizes the logical framework of the system:


This page details how to manage Widgets, including creating, editing, or removing Widgets. Separate individual pages for each type of Widget provide additional detail for configuring the settings of that particular Widget.




Notice that from the perspective of configuring the widgets, the AppBoard widget developer need not be concerned with the process that is providing the data, as long as it comes in a usable format.
== Managing Widgets ==




*[[Configuring_Widgets|Configuring Widgets]]
Perform the following steps to view and manage Widgets:
 
# Log in to AppBoard Builder as an administrator.
# In the <b>Builder Modes</b> panel, select <b>Widgets</b>. The <b>Widgets Administration</b> panel is displayed.
# Use the "Boards" drop-down list to limit the listed Widgets to those contained on a specific Board.
# Click <b>Templates</b> to upload a Widget from a Template.
 
 
== Adding Widgets ==
 
 
Perform the following steps to add a Widget to an existing Board:
 
# Log in to AppBoard Builder as an administrator.
# In the <b>Builder Modes</b> panel, select <b>Widgets</b>.  The <b>Widgets Administration</b> panel is displayed.
# Click <b>Add</b>. The <b>Add Widget</b> wizard is displayed.
# In the <b>Name</b> box, enter a name for the Widget.
# Select a Board from the <b>Board</b> drop-down list, to which you want to add the new Web Widget.
# Select the tab to locate the category containing the type of Widget you want to create.
# Select the preview box for type of Widget you want to create and click <b>Add Widget</b>. The <b>Widget Wizard</b> is displayed.
# Configure the Data, Options, and Actions for the Widget. See the individual Widget documentation page to learn about the settings available for the selected Widget type.
# Click <b>Finish</b>.
# In the <b>Builder Modes</b> panel, select <b>Builder</b> and navigate to the appropriate Board to observe the new Widget.
 
 
== Editing Widgets ==
 
 
Perform the following steps to edit an existing Widget:
 
# Log in to AppBoard Builder as an administrator.
# In the <b>Builder Modes</b> panel, select <b>Widgets</b>.  The <b>Widgets Administration</b> panel is displayed.
# Select a Widget and then click <b>Edit</b> button to view the Widget's configuration.
# Modify the Data, Options, and Actions for the Widget. See the individual Widget documentation page to learn about the settings available for the selected Widget type.
# Click <b>Finish</b>.
# In the <b>Builder Modes</b> panel, select <b>Builder</b> and navigate to the appropriate Board to observe the new Widget.
 
 
== Removing Widgets ==
 
 
A Widget must always be tied to a specific Board. So when removing a Widget from a Board, you have two options:
 
# Move the Widget to another Board
# Delete the Widget from AppBoard
 
 
===Moving a Widget To Another Board===
 
 
Perform the following steps to move a Widget to another Board:
 
 
# Log in to AppBoard Builder as an administrator.
# In the <b>Builder Modes</b> panel, select <b>Widgets</b>. The <b>Widgets Administration</b> panel is displayed.
# In the <b>Board</b> column for the Widget, select the name of the Board to which you want to move the Widget.
 
 
===Deleting a Widget From AppBoard===
 
 
Perform the following steps to delete a Widget from AppBoard:
 
 
# Log in to AppBoard Builder as an administrator.
# In the <b>Builder Modes</b> panel, select <b>Builder</b>.
# Navigate to the Board displaying the Widget that you want to remove.
# Click the "X" in the upper-right corner of the Board. The message is displayed: "Are you sure you want to remove the widget?".
# Click <b>Yes</b>.  The Widget is deleted from AppBoard.
 
 
{{Note|An alternative to the above is to select the Widget and click <b>Delete</b> in the Widgets Administration panel.}}

Latest revision as of 06:58, 17 July 2014

HeaderFlow05.png A "Widget" is a visual component placed on a Board. For example, the "Data Grid Widget" gives a visual representation of tabular data in a familiar spreadsheet format. Boards contain one or more Widgets, each displaying part of the data to be visualized.


This page details how to manage Widgets, including creating, editing, or removing Widgets. Separate individual pages for each type of Widget provide additional detail for configuring the settings of that particular Widget.


Managing Widgets

Perform the following steps to view and manage Widgets:

  1. Log in to AppBoard Builder as an administrator.
  2. In the Builder Modes panel, select Widgets. The Widgets Administration panel is displayed.
  3. Use the "Boards" drop-down list to limit the listed Widgets to those contained on a specific Board.
  4. Click Templates to upload a Widget from a Template.


Adding Widgets

Perform the following steps to add a Widget to an existing Board:

  1. Log in to AppBoard Builder as an administrator.
  2. In the Builder Modes panel, select Widgets. The Widgets Administration panel is displayed.
  3. Click Add. The Add Widget wizard is displayed.
  4. In the Name box, enter a name for the Widget.
  5. Select a Board from the Board drop-down list, to which you want to add the new Web Widget.
  6. Select the tab to locate the category containing the type of Widget you want to create.
  7. Select the preview box for type of Widget you want to create and click Add Widget. The Widget Wizard is displayed.
  8. Configure the Data, Options, and Actions for the Widget. See the individual Widget documentation page to learn about the settings available for the selected Widget type.
  9. Click Finish.
  10. In the Builder Modes panel, select Builder and navigate to the appropriate Board to observe the new Widget.


Editing Widgets

Perform the following steps to edit an existing Widget:

  1. Log in to AppBoard Builder as an administrator.
  2. In the Builder Modes panel, select Widgets. The Widgets Administration panel is displayed.
  3. Select a Widget and then click Edit button to view the Widget's configuration.
  4. Modify the Data, Options, and Actions for the Widget. See the individual Widget documentation page to learn about the settings available for the selected Widget type.
  5. Click Finish.
  6. In the Builder Modes panel, select Builder and navigate to the appropriate Board to observe the new Widget.


Removing Widgets

A Widget must always be tied to a specific Board. So when removing a Widget from a Board, you have two options:

  1. Move the Widget to another Board
  2. Delete the Widget from AppBoard


Moving a Widget To Another Board

Perform the following steps to move a Widget to another Board:


  1. Log in to AppBoard Builder as an administrator.
  2. In the Builder Modes panel, select Widgets. The Widgets Administration panel is displayed.
  3. In the Board column for the Widget, select the name of the Board to which you want to move the Widget.


Deleting a Widget From AppBoard

Perform the following steps to delete a Widget from AppBoard:


  1. Log in to AppBoard Builder as an administrator.
  2. In the Builder Modes panel, select Builder.
  3. Navigate to the Board displaying the Widget that you want to remove.
  4. Click the "X" in the upper-right corner of the Board. The message is displayed: "Are you sure you want to remove the widget?".
  5. Click Yes. The Widget is deleted from AppBoard.


Template-note.png
An alternative to the above is to select the Widget and click Delete in the Widgets Administration panel.