Appboard/2.5/builder/widgets/html widget - Revision history

imported>Jason.nicholls: /* Overview */

2015-03-06T10:45:15Z

Overview

← Older revision		Revision as of 10:45, 6 March 2015
Line 15:		Line 15:
	For more information on creating HTML Widgets please refer to the [[appboard/2.5/builder/widgets/html_widget/api\|API documentation]].		For more information on creating HTML Widgets please refer to the [[appboard/2.5/builder/widgets/html_widget/api\|API documentation]].

			AppBoard includes a number of example widgets making use of the HTML Widget API:

			*[[appboard/2.5/builder/widgets/html_widget/example_table_widget\|Example Table Widget]]
			*[[appboard/2.5/builder/widgets/html_widget/example_sankey_widget\|Example Sankey Widget]]
			*[[appboard/2.5/builder/widgets/html_widget/example_heat_map_widget\|Example Heat Map Widget]]
			*[[appboard/2.5/builder/widgets/html_widget/example_alerts_widget\|Example Alerts Widget]]

	== Using HTML Widgets ==		== Using HTML Widgets ==

imported>Jason.nicholls at 09:30, 6 March 2015

2015-03-06T09:30:54Z

← Older revision		Revision as of 09:30, 6 March 2015
Line 1:		Line 1:
	{{DISPLAYTITLE:HTML Widget}}		{{DISPLAYTITLE:HTML Widget}}
	[[Category:AppBoard 2.5]]		[[Category:AppBoard 2.5]]

			==Overview==

	The '''HTML Widget''' is not a specific widget but provides access to custom HTML widgets made available through the HTML Widget API. AppBoard ships with an example HTML table widget for experimentation out of the box.		The '''HTML Widget''' is not a specific widget but provides access to custom HTML widgets made available through the HTML Widget API. AppBoard ships with an example HTML table widget for experimentation out of the box.

imported>Jason.nicholls: 1 revision

2014-06-26T15:52:26Z

1 revision

← Older revision	Revision as of 15:52, 26 June 2014
(No difference)

imported>Jason.nicholls: /* HTML Widget Configuration */

2014-04-10T07:42:40Z

HTML Widget Configuration

New page

{{DISPLAYTITLE:HTML Widget}}
[[Category:AppBoard 2.5]]

The '''HTML Widget''' is not a specific widget but provides access to custom HTML widgets made available through the HTML Widget API. AppBoard ships with an example HTML table widget for experimentation out of the box.

HTML Widgets using the API are able to behave as native widgets:

* Linked to data collections. Any changes to the data collections such as through server side filter actions are reflected in the HTML Widget.
* Standard Widget ''Options'' such as text search, quick filters, and data collection download.
* HTML Widget is able to trigger standard AppBoard actions. These are defined on the widget just like a native widget.
* HTML Widgets can also have their own configuration which is stored with AppBoard. This ensures a consistent way to backup/restore configuration and allow for separate configured instances of the same HTML Widget type.

For more information on creating HTML Widgets please refer to the [[appboard/2.5/builder/widgets/html_widget/api|API documentation]].

== Using HTML Widgets ==

For instructions on creating an instance of a HTML Widget, see the general instructions in [[appboard/2.5/builder/widgets#Adding_Widgets|Adding Widgets]]. The '''HTML Widget''' is located under the '''Web''' category on the Widget Type selection screen.

[[File:appboard-2.4-html-widget-selection.png|frame|Widget Type selection dialog]]

== HTML Widget Configuration ==

HTML Widgets share common configuration with native widgets for the following areas:

# Selection of Widget Type and Data Collection
# ''[[appboard/2.5/builder/widgets/options|Options]]'' Configuration
# ''[[appboard/2.5/builder/widgets/actions|Actions]]'' Configuration

However, widget specific configuration needs to be implemented and made available by the widget itself. As a result HTML Widgets may not offer any configuration, or if there is configuration it may be made available in different ways.

The exampleTableWidget shipped with AppBoard provides an example implementation of widget specific configuration, refer to the image below:

[[File:appboard-2.4-html-example-table-widget.png|frame|exampleTableWidget - HTML Widget provided with AppBoard, showing the widget configuration]]