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

imported>Jason.nicholls: /* Overview */

2015-06-15T11:36:00Z

Overview

← Older revision		Revision as of 11:36, 15 June 2015
Line 7:		Line 7:

	The exampleSankeyWidget is a basic implementation based on the D3.js Sankey plugin. Data is passed in from AppBoard and then based on the widget configuration is summarized to produce the diagram.		The exampleSankeyWidget is a basic implementation based on the D3.js Sankey plugin. Data is passed in from AppBoard and then based on the widget configuration is summarized to produce the diagram.

			{{Note\|Due to the dependency on D3.js this widget requires modern Chrome, Firefox, or Internet Explorer 9.0 or later.}}

	{{Note\|The exampleSankeyWidget currently does not support triggering of AppBoard actions. Adding support for actions is possible, just not implemented yet.}}		{{Note\|The exampleSankeyWidget currently does not support triggering of AppBoard actions. Adding support for actions is possible, just not implemented yet.}}
Line 12:		Line 14:

	[[File:appboard-2.5-examplesankeywidget.png\|frame\|center\|exampleSankeyWidget from the AppBoard Welcome archive.]]		[[File:appboard-2.5-examplesankeywidget.png\|frame\|center\|exampleSankeyWidget from the AppBoard Welcome archive.]]


	==Configuration==		==Configuration==

imported>Jason.nicholls: /* Configuration */

2015-03-06T10:00:36Z

Configuration

← Older revision		Revision as of 10:00, 6 March 2015
Line 20:		Line 20:
	The configuration is very basic and consists of 2 parts:		The configuration is very basic and consists of 2 parts:

	* ''Sankey Fields'': a comma separated list of fields from the configured data collection which represents the ~~nodes~~ in the diagram. The ordering is important and the nodes will appear left-to-right.		* ''Sankey Fields'': a comma separated list of fields from the configured data collection which represents the node groupings in the diagram. The ordering is important and the nodes will appear left-to-right.
	* ''Show Field Headings'': whether the fields should be shown in the diagram as headings.		* ''Show Field Headings'': whether the fields should be shown in the diagram as headings.

	The ''All Available Fields'' list is simply for reference showing the fields from the configured data collection with some summary information. The Sankey diagram is ~~best if each node has~~ a small to medium number of unique values, otherwise the diagram will explode into too many tiny nodes.		The ''All Available Fields'' list is simply for reference showing the fields from the configured data collection with some summary information. The most appropriate use of the Sankey diagram is with fields that have a small to medium number of unique values, otherwise the diagram will explode into too many tiny nodes.


	[[File:appboard-2.5-examplesankeywidget-configuration.png\|frame\|center\|exampleSankeyWidget configuration page.]]		[[File:appboard-2.5-examplesankeywidget-configuration.png\|frame\|center\|exampleSankeyWidget configuration page.]]

imported>Jason.nicholls: /* Configuration */

2015-03-06T09:57:12Z

Configuration

← Older revision		Revision as of 09:57, 6 March 2015
Line 20:		Line 20:
	The configuration is very basic and consists of 2 parts:		The configuration is very basic and consists of 2 parts:

	* Sankey Fields: a comma separated list of fields from the configured data collection which represents the nodes in the diagram. The ordering is important and the nodes will appear left-to-right.		* ''Sankey Fields'': a comma separated list of fields from the configured data collection which represents the nodes in the diagram. The ordering is important and the nodes will appear left-to-right.
	* Show Field Headings: whether the fields should be shown in the diagram as headings.		* ''Show Field Headings'': whether the fields should be shown in the diagram as headings.

	The ''All Available Fields'' list is simply for reference showing the fields from the configured data collection with some summary information. The Sankey diagram is best if each node has a small to medium number of unique values, otherwise the diagram will explode into too many tiny nodes.		The ''All Available Fields'' list is simply for reference showing the fields from the configured data collection with some summary information. The Sankey diagram is best if each node has a small to medium number of unique values, otherwise the diagram will explode into too many tiny nodes.

	[[File:appboard-2.5-examplesankeywidget-configuration.png\|frame\|center\|exampleSankeyWidget configuration page.]]		[[File:appboard-2.5-examplesankeywidget-configuration.png\|frame\|center\|exampleSankeyWidget configuration page.]]

imported>Jason.nicholls: /* Configuration */

2015-03-06T09:57:00Z

Configuration

← Older revision		Revision as of 09:57, 6 March 2015
Line 17:		Line 17:

	To access the widget configuration you must be logged in with the <tt>portalAdministration</tt> role and in the Builder. Click on the wrench icon in the top-left of the widget.		To access the widget configuration you must be logged in with the <tt>portalAdministration</tt> role and in the Builder. Click on the wrench icon in the top-left of the widget.

			The configuration is very basic and consists of 2 parts:

			* Sankey Fields: a comma separated list of fields from the configured data collection which represents the nodes in the diagram. The ordering is important and the nodes will appear left-to-right.
			* Show Field Headings: whether the fields should be shown in the diagram as headings.

			The ''All Available Fields'' list is simply for reference showing the fields from the configured data collection with some summary information. The Sankey diagram is best if each node has a small to medium number of unique values, otherwise the diagram will explode into too many tiny nodes.

	[[File:appboard-2.5-examplesankeywidget-configuration.png\|frame\|center\|exampleSankeyWidget configuration page.]]		[[File:appboard-2.5-examplesankeywidget-configuration.png\|frame\|center\|exampleSankeyWidget configuration page.]]

imported>Jason.nicholls: /* Configuration */

2015-03-06T09:53:54Z

Configuration

← Older revision		Revision as of 09:53, 6 March 2015
Line 16:		Line 16:
	==Configuration==		==Configuration==

	To access the widget configuration you must be logged in with the {{portalAdministration}} role and in the Builder. Click on the wrench icon in the top-left of the widget.		To access the widget configuration you must be logged in with the <tt>portalAdministration</tt> role and in the Builder. Click on the wrench icon in the top-left of the widget.

	[[File:appboard-2.5-examplesankeywidget-configuration.png\|frame\|center\|exampleSankeyWidget configuration page.]]		[[File:appboard-2.5-examplesankeywidget-configuration.png\|frame\|center\|exampleSankeyWidget configuration page.]]

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

2015-03-06T09:53:33Z

← Older revision		Revision as of 09:53, 6 March 2015
Line 12:		Line 12:

	[[File:appboard-2.5-examplesankeywidget.png\|frame\|center\|exampleSankeyWidget from the AppBoard Welcome archive.]]		[[File:appboard-2.5-examplesankeywidget.png\|frame\|center\|exampleSankeyWidget from the AppBoard Welcome archive.]]


			==Configuration==

			To access the widget configuration you must be logged in with the {{portalAdministration}} role and in the Builder. Click on the wrench icon in the top-left of the widget.

			[[File:appboard-2.5-examplesankeywidget-configuration.png\|frame\|center\|exampleSankeyWidget configuration page.]]

imported>Jason.nicholls: /* Overview */

2015-03-06T09:49:14Z

Overview

← Older revision		Revision as of 09:49, 6 March 2015
Line 9:		Line 9:

	{{Note\|The exampleSankeyWidget currently does not support triggering of AppBoard actions. Adding support for actions is possible, just not implemented yet.}}		{{Note\|The exampleSankeyWidget currently does not support triggering of AppBoard actions. Adding support for actions is possible, just not implemented yet.}}


	[[File:appboard-2.5-examplesankeywidget.png\|frame\|center\|exampleSankeyWidget from the AppBoard Welcome archive.]]		[[File:appboard-2.5-examplesankeywidget.png\|frame\|center\|exampleSankeyWidget from the AppBoard Welcome archive.]]

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

2015-03-06T09:49:01Z

← Older revision		Revision as of 09:49, 6 March 2015
Line 5:		Line 5:

	A Sankey diagram is very useful in depicting flows between related items (nodes). The size of the flow represents a relative quantity with respect to the other flows, and the node size also reflects the relative quantity passing through, or beginning or ending at that node.		A Sankey diagram is very useful in depicting flows between related items (nodes). The size of the flow represents a relative quantity with respect to the other flows, and the node size also reflects the relative quantity passing through, or beginning or ending at that node.

			The exampleSankeyWidget is a basic implementation based on the D3.js Sankey plugin. Data is passed in from AppBoard and then based on the widget configuration is summarized to produce the diagram.

			{{Note\|The exampleSankeyWidget currently does not support triggering of AppBoard actions. Adding support for actions is possible, just not implemented yet.}}

	[[File:appboard-2.5-examplesankeywidget.png\|frame\|center\|exampleSankeyWidget from the AppBoard Welcome archive.]]		[[File:appboard-2.5-examplesankeywidget.png\|frame\|center\|exampleSankeyWidget from the AppBoard Welcome archive.]]

imported>Jason.nicholls: Created page with '{{DISPLAYTITLE:exampleSankeyWidget}} Category:AppBoard 2.5 ==Overview== A Sankey diagram is very useful in depicting flows between related items (nodes). The size of the fl...'

2015-03-06T09:45:04Z

Created page with '{{DISPLAYTITLE:exampleSankeyWidget}} Category:AppBoard 2.5 ==Overview== A Sankey diagram is very useful in depicting flows between related items (nodes). The size of the fl...'

New page

{{DISPLAYTITLE:exampleSankeyWidget}}
[[Category:AppBoard 2.5]]

==Overview==

A Sankey diagram is very useful in depicting flows between related items (nodes). The size of the flow represents a relative quantity with respect to the other flows, and the node size also reflects the relative quantity passing through, or beginning or ending at that node.

[[File:appboard-2.5-examplesankeywidget.png|frame|center|exampleSankeyWidget from the AppBoard Welcome archive.]]