Appboard/2.5/builder/widgets - Revision history

imported>Jason.nicholls: /* Widget Anatomy */

2014-11-05T06:33:01Z

Widget Anatomy

← Older revision		Revision as of 06:33, 5 November 2014
Line 24:		Line 24:

	[[File:appboard-2.5-widget-anatomy.png\|frame\|center\|Example widget in the Builder]]		[[File:appboard-2.5-widget-anatomy.png\|frame\|center\|Example widget in the Builder]]

			=== Available Controls ===

			* flip: (builder only) switch between the regular widget visualization and a table displaying the raw data.
			* magnifying glass / search: ([[appboard/2.5/builder/widgets/options\|option]]) toggle text search on/off.
			* wrench / edit: (builder only) edit the widget configuration
			* lightning bolt / actions: (builder only) edit the widget actions
			* question mark / help: ([[appboard/2.5/builder/widgets/options\|option]]) widget help
			* download: ([[appboard/2.5/builder/widgets/options\|option]]) download Data Collection.
			* maximize / minimize: toggle a widget to maximize and fill the entire board and back to it's original size.
			* <tt>X</tt> / delete: (builder only) delete the widget.
			* <tt>>></tt> / toggle controls: (builder only) show/hide controls
			* home: This is not shown in the screenshot above but the home icon is present with [[appboard/2.5/builder/widgets/web_page\|Web Widgets]] only.

	== Managing Widgets ==		== Managing Widgets ==

imported>Jason.nicholls: /* Managing Widgets */

2014-10-29T08:11:21Z

Managing Widgets

← Older revision		Revision as of 08:11, 29 October 2014
Line 27:		Line 27:
	== Managing Widgets ==		== Managing Widgets ==

	The Builder offers a ''Widgets'' mode for general widget management. From this page it's possible to view all widgets in the system, modify configuration, modify actions, move widgets from one board to another, copy, and add and delete widgets. Often however it's easier to manage widgets from the ''Builder'' mode directly on the Board. Existing widgets can be modified or deleted using the widget ''Controls'', and new widgets added using the ''Add Widget'' quick action. The advantage of using the ''Builder'' mode is widgets can also be arranged on the board, the layout tweaked, and ~~the immediate feedback of~~ viewing the widget after making changes.		The Builder offers a ''Widgets'' mode for general widget management. From this page it's possible to view all widgets in the system, modify configuration, modify actions, move widgets from one board to another, copy, and add and delete widgets. Often however it's easier to manage widgets from the ''Builder'' mode directly on the Board. Existing widgets can be modified or deleted using the widget ''Controls'', and new widgets added using the ''Add Widget'' quick action. The advantage of using the ''Builder'' mode is widgets can also be arranged on the board, the layout tweaked, and immediately viewing the widget after making changes.

	=== Adding / Editing Widgets ===		=== Adding / Editing Widgets ===

imported>Jason.nicholls at 08:09, 29 October 2014

2014-10-29T08:09:27Z

← Older revision		Revision as of 08:09, 29 October 2014
Line 31:		Line 31:
	=== Adding / Editing Widgets ===		=== Adding / Editing Widgets ===

	Use the ''Add Widget'' button when in the ''Builder'' mode to add a widget onto the current board, or the ''Add'' button when in the ''Widgets'' ~~builder~~ mode.		Use the ''Add Widget'' button when in the ''Builder'' mode to add a widget onto the current board, or the ''Add'' button when in the ''Widgets'' mode.

	Editing existing widgets can be done by clicking the wrench control of a widget, or using the ''Edit'' button with a selected widget in the ''Widgets'' ~~builder~~ mode.		Editing existing widgets can be done by clicking the wrench control of a widget, or using the ''Edit'' button with a selected widget in the ''Widgets'' mode.

	The Add wizard, and Edit dialog are basically the same except that the Add operation can be cancelled, while changes to existing widgets are immediate (no cancel).		The Add wizard, and Edit dialog are basically the same except that the Add operation can be cancelled, while changes to existing widgets are immediate (no cancel).
Line 53:		Line 53:
	=== Deleting Widgets ===		=== Deleting Widgets ===

	Deleting widgets can be performed by using the widget <tt>X</tt> control in the ''Builder'' mode, or using the ''Delete'' button with a selected widget in the ''Widgets'' ~~builder~~ mode.		Deleting widgets can be performed by using the widget <tt>X</tt> control in the ''Builder'' mode, or using the ''Delete'' button with a selected widget in the ''Widgets'' mode.

	=== Moving Widgets ===		=== Moving Widgets ===
Line 59:		Line 59:
	This refers to moving widgets from one Board to another. For actual placement of a widget on a board then refer to the [[appboard/2.5/builder/layout\|Board Layout]] documentation.		This refers to moving widgets from one Board to another. For actual placement of a widget on a board then refer to the [[appboard/2.5/builder/layout\|Board Layout]] documentation.

	To move a widget you must be in the ''Widgets'' ~~builder~~ mode. Clicking in the ''Board'' column for a particular widget will allow the Board to be changed via a drop-down selection. After moving a widget it is recommended to visit both the original and target boards in the ''Builder'' mode to adjust the layout to suit.		To move a widget you must be in the ''Widgets'' mode. Clicking in the ''Board'' column for a particular widget will allow the Board to be changed via a drop-down selection. After moving a widget it is recommended to visit both the original and target boards in the ''Builder'' mode to adjust the layout to suit.

	=== Copying Widgets ===		=== Copying Widgets ===

	Copying a widget will copy the widget, all actions, and optionally the Data Collection used by the widget. Use the ''Copy'' button with a widget selected when in the ''Widgets'' ~~builder~~ mode to perform a copy. The following fields are presented:		Copying a widget will copy the widget, all actions, and optionally the Data Collection used by the widget. Use the ''Copy'' button with a widget selected when in the ''Widgets'' mode to perform a copy. The following fields are presented:

	* '''Name''': defaults to the existing name, can be modified		* '''Name''': defaults to the existing name, can be modified

imported>Jason.nicholls: /* Adding / Editing Widgets */

2014-10-29T07:51:08Z

Adding / Editing Widgets

← Older revision		Revision as of 07:51, 29 October 2014
Line 45:		Line 45:
	** '''Data Collection''': Set the data collection used to drive the widget. The presence of this option depends on the ''Widget Type'' as not all widgets have a directly associated data collection.		** '''Data Collection''': Set the data collection used to drive the widget. The presence of this option depends on the ''Widget Type'' as not all widgets have a directly associated data collection.
	* '''Visualization / ...''': Depending on the widget type at least the ''Visualization'' step will be present and optionally other steps such as ''Presentation'' etc... These steps all have to do with the specific widget type configuration. Refer to the [[appboard/2.5/builder/widgets/list\|Widget Types]] documentation for detailed information on each type.		* '''Visualization / ...''': Depending on the widget type at least the ''Visualization'' step will be present and optionally other steps such as ''Presentation'' etc... These steps all have to do with the specific widget type configuration. Refer to the [[appboard/2.5/builder/widgets/list\|Widget Types]] documentation for detailed information on each type.
	* '''Options''': Options allow for text searching, quick filters, data collection downloads, and setting widget help text. Refer to the [[~~http://stagingdocs.edge.internal/docs/~~appboard/2.5/builder/widgets/options\|Widget Options]] documentation for more information.		* '''Options''': Options allow for text searching, quick filters, data collection downloads, and setting widget help text. Refer to the [[appboard/2.5/builder/widgets/options\|Widget Options]] documentation for more information.

	=== Actions ===		=== Actions ===

imported>Jason.nicholls: /* Managing Widgets */

2014-10-29T07:50:32Z

Managing Widgets

← Older revision		Revision as of 07:50, 29 October 2014
Line 30:		Line 30:

	=== Adding / Editing Widgets ===		=== Adding / Editing Widgets ===

			Use the ''Add Widget'' button when in the ''Builder'' mode to add a widget onto the current board, or the ''Add'' button when in the ''Widgets'' builder mode.

			Editing existing widgets can be done by clicking the wrench control of a widget, or using the ''Edit'' button with a selected widget in the ''Widgets'' builder mode.

			The Add wizard, and Edit dialog are basically the same except that the Add operation can be cancelled, while changes to existing widgets are immediate (no cancel).

			Widget configuration is split into three main sections, although depending on the widget type there may be additional sections:

			* '''Data''': This step defines:
			** '''Widget Type''': Sets or changes the type of this widget. Refer to the [[appboard/2.5/builder/widgets/list\|Widget Types]] documentation information on each widget type.
			** '''Widget Name''': By default this name is used internally in the Builder as well as in the widget titlebar. However, if the ''Display Name'' is configured, then that is used in the widget titlebar instead. It is recommended to use unique and descriptive widget names. If these aren't appropriate for the widget titlebar then also set the ''Display Name''.
			** '''Display Name''': optional and as described above.
			** '''Data Collection''': Set the data collection used to drive the widget. The presence of this option depends on the ''Widget Type'' as not all widgets have a directly associated data collection.
			* '''Visualization / ...''': Depending on the widget type at least the ''Visualization'' step will be present and optionally other steps such as ''Presentation'' etc... These steps all have to do with the specific widget type configuration. Refer to the [[appboard/2.5/builder/widgets/list\|Widget Types]] documentation for detailed information on each type.
			* '''Options''': Options allow for text searching, quick filters, data collection downloads, and setting widget help text. Refer to the [[http://stagingdocs.edge.internal/docs/appboard/2.5/builder/widgets/options\|Widget Options]] documentation for more information.

			=== Actions ===

			Refer to the [[appboard/2.5/builder/widgets/actions\|Widget Actions]] page.

	=== Deleting Widgets ===		=== Deleting Widgets ===

imported>Jason.nicholls at 07:14, 29 October 2014

2014-10-29T07:14:35Z

@@ Line 55: / Line 55: @@
 * Diagrams: Diagrams themselves are global, the Diagrammer widget is used to show and modify diagrams.
 * Relationship Models
 == Related Topics ==

imported>Jason.nicholls: /* Deleting Widgets */

2014-10-29T07:14:13Z

Deleting Widgets

← Older revision		Revision as of 07:14, 29 October 2014
Line 32:		Line 32:

	=== Deleting Widgets ===		=== Deleting Widgets ===

			Deleting widgets can be performed by using the widget <tt>X</tt> control in the ''Builder'' mode, or using the ''Delete'' button with a selected widget in the ''Widgets'' builder mode.

	=== Moving Widgets ===		=== Moving Widgets ===

imported>Jason.nicholls: /* Moving Widgets */

2014-10-29T07:03:28Z

Moving Widgets

← Older revision		Revision as of 07:03, 29 October 2014
Line 34:		Line 34:

	=== Moving Widgets ===		=== Moving Widgets ===

			This refers to moving widgets from one Board to another. For actual placement of a widget on a board then refer to the [[appboard/2.5/builder/layout\|Board Layout]] documentation.

			To move a widget you must be in the ''Widgets'' builder mode. Clicking in the ''Board'' column for a particular widget will allow the Board to be changed via a drop-down selection. After moving a widget it is recommended to visit both the original and target boards in the ''Builder'' mode to adjust the layout to suit.

	=== Copying Widgets ===		=== Copying Widgets ===

imported>Jason.nicholls: /* Copying Widgets */

2014-10-29T06:59:45Z

Copying Widgets

← Older revision		Revision as of 06:59, 29 October 2014
Line 44:		Line 44:
	* '''Names Alterations''': these options are only available if ''New Data Collection'' is selected above. It allows for either a prefix and/or a suffix to be added to the data collection name.		* '''Names Alterations''': these options are only available if ''New Data Collection'' is selected above. It allows for either a prefix and/or a suffix to be added to the data collection name.

	~~Note that some widget~~ configuration remains global and shared, in particular:		Certain configuration remains global and shared even if a copy is performed, in particular:

	* Icon, Color, Shape, and Colored Shape Filters		* Icon, Color, Shape, and Colored Shape Filters
Line 59:		Line 59:
	** If the widgets are renamed when copying the stack, some actions that have references to widgets such as Topology actions or Show Clear Filter on a Filter Data Collection Action, will not work until the actions are modified to use the new names.		** If the widgets are renamed when copying the stack, some actions that have references to widgets such as Topology actions or Show Clear Filter on a Filter Data Collection Action, will not work until the actions are modified to use the new names.
	* '''Deleting''': Deleting a stack or child board will remove the specified stack or board and all it's child boards and widgets.		* '''Deleting''': Deleting a stack or child board will remove the specified stack or board and all it's child boards and widgets.

	== Related Topics ==		== Related Topics ==

	* [[appboard/2.5/mobile/widget_support\|Mobile Widget Support]]		* [[appboard/2.5/mobile/widget_support\|Mobile Widget Support]]
	* [[appboard/2.5/builder/stacks_and_boards\|Stacks & Boards]]		* [[appboard/2.5/builder/stacks_and_boards\|Stacks & Boards]]

imported>Jason.nicholls at 06:58, 29 October 2014

2014-10-29T06:58:43Z

@@ Line 25: / Line 25: @@
 [[File:appboard-2.5-widget-anatomy.png|frame|center|Example widget in the Builder]]
 == Related Topics ==
 * [[appboard/2.5/mobile/widget_support|Mobile Widget Support]]
 * [[appboard/2.5/builder/stacks_and_boards|Stacks & Boards]]