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

imported>Mike.berman: 1 revision: Update latest pages from 2.6.1 builds

2016-04-13T20:33:40Z

1 revision: Update latest pages from 2.6.1 builds

← Older revision	Revision as of 20:33, 13 April 2016
(No difference)

imported>Nick.chang at 19:47, 16 March 2016

2016-03-16T19:47:36Z

← Older revision		Revision as of 19:47, 16 March 2016
Line 22:		Line 22:
	*[[appboard/2.6/builder/widgets/html_widget/heat_map_widget\|Heat Map Widget]]		*[[appboard/2.6/builder/widgets/html_widget/heat_map_widget\|Heat Map Widget]]
	*[[appboard/2.6/builder/widgets/html_widget/small_multiples_widget\|Small Multiples Widget]]		*[[appboard/2.6/builder/widgets/html_widget/small_multiples_widget\|Small Multiples Widget]]
			*[[appboard/2.6/builder/widgets/html_widget/data_search_table_widget\|Data Search Table Widget]]
			*[[appboard/2.6/builder/widgets/html_widget/tree_view_widget\|TreeView Widget]]

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

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

2015-08-04T13:28:12Z

HTML Widget Configuration

← Older revision		Revision as of 13:28, 4 August 2015
Line 35:		Line 35:

	# ''Data'' step providing selection of the Widget Type, select <tt>HTML Widget</tt>, Data Collection, and Name.		# ''Data'' step providing selection of the Widget Type, select <tt>HTML Widget</tt>, Data Collection, and Name.
	# ''Visualization'' step where the specific HTML Widget is selected from the ''HTML Component Selection'' drop-down. Optionally the ''Provide access to additional Data Collections'' checkbox can be selected to expose additional Data Collections beyond the primary Data Collection. This feature is disabled by default as it only makes sense if the HTML Widget actually makes use or requires access to additional Data Collections.		# ''Visualization'' step where the specific HTML Widget is selected from the ''HTML Component Selection'' drop-down. Optionally the ''Provide access to additional Data Collections'' checkbox can be selected to expose additional Data Collections beyond the primary Data Collection. This feature is disabled by default as it only makes sense if the HTML Widget actually makes use of, or requires access to, additional Data Collections.
	# ''[[appboard/2.6/builder/widgets/options\|Options]]'' Configuration		# ''[[appboard/2.6/builder/widgets/options\|Options]]'' Configuration
	# ''[[appboard/2.6/builder/widgets/actions\|Actions]]'' Configuration		# ''[[appboard/2.6/builder/widgets/actions\|Actions]]'' Configuration

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

2015-08-04T13:26:24Z

HTML Widget Configuration

← Older revision		Revision as of 13:26, 4 August 2015
Line 34:		Line 34:
	HTML Widgets share common configuration with native widgets for the following areas:		HTML Widgets share common configuration with native widgets for the following areas:

	# ~~Selection~~ of Widget Type and Data Collection		# ''Data'' step providing selection of the Widget Type, select <tt>HTML Widget</tt>, Data Collection, and Name.
			# ''Visualization'' step where the specific HTML Widget is selected from the ''HTML Component Selection'' drop-down. Optionally the ''Provide access to additional Data Collections'' checkbox can be selected to expose additional Data Collections beyond the primary Data Collection. This feature is disabled by default as it only makes sense if the HTML Widget actually makes use or requires access to additional Data Collections.
	# ''[[appboard/2.6/builder/widgets/options\|Options]]'' Configuration		# ''[[appboard/2.6/builder/widgets/options\|Options]]'' Configuration
	# ''[[appboard/2.6/builder/widgets/actions\|Actions]]'' Configuration		# ''[[appboard/2.6/builder/widgets/actions\|Actions]]'' Configuration

imported>Jason.nicholls: /* Overview */

2015-07-13T07:40:59Z

Overview

← Older revision		Revision as of 07:40, 13 July 2015
Line 19:		Line 19:
	*[[appboard/2.6/builder/widgets/html_widget/example_table_widget\|Example Table Widget]]		*[[appboard/2.6/builder/widgets/html_widget/example_table_widget\|Example Table Widget]]
	*[[appboard/2.6/builder/widgets/html_widget/example_alerts_widget\|Example Alerts Widget]]		*[[appboard/2.6/builder/widgets/html_widget/example_alerts_widget\|Example Alerts Widget]]
	*[[appboard/2.6/builder/widgets/html_widget/~~example_sankey_widget~~\|Sankey Widget]]		*[[appboard/2.6/builder/widgets/html_widget/sankey_widget\|Sankey Widget]]
	*[[appboard/2.6/builder/widgets/html_widget/~~example_heat_map_widget~~\|Heat Map Widget]]		*[[appboard/2.6/builder/widgets/html_widget/heat_map_widget\|Heat Map Widget]]
	*[[appboard/2.6/builder/widgets/html_widget/small_multiples_widget\|Small Multiples Widget]]		*[[appboard/2.6/builder/widgets/html_widget/small_multiples_widget\|Small Multiples Widget]]


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

imported>Jason.nicholls at 07:39, 13 July 2015

2015-07-13T07:39:21Z

← Older revision		Revision as of 07:39, 13 July 2015
Line 18:		Line 18:

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


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

imported>Jason.nicholls: 1 revision

2015-04-30T10:59:32Z

1 revision

← Older revision	Revision as of 10:59, 30 April 2015
(No difference)

imported>Jason.nicholls: /* Overview */

2015-03-06T10:45:15Z

Overview

New page

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

==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.

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.6/builder/widgets/html_widget/api|API documentation]].

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

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

== Using HTML Widgets ==

For instructions on creating an instance of a HTML Widget, see the general instructions in [[appboard/2.6/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.6/builder/widgets/options|Options]]'' Configuration
# ''[[appboard/2.6/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]]