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

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

2015-07-13T07:42:29Z

← Older revision		Revision as of 07:42, 13 July 2015
Line 1:		Line 1:
	{{DISPLAYTITLE:~~exampleSankeyWidget~~}}		{{DISPLAYTITLE:Sankey Widget}}
	[[Category:AppBoard 2.6]]		[[Category:AppBoard 2.6]]

imported>Jason.nicholls: moved appboard/2.6/builder/widgets/html widget/example sankey widget to appboard/2.6/builder/widgets/html widget/sankey widget

2015-07-13T07:40:37Z

moved appboard/2.6/builder/widgets/html widget/example sankey widget to appboard/2.6/builder/widgets/html widget/sankey widget

← Older revision	Revision as of 07:40, 13 July 2015
(No difference)

imported>Jason.nicholls: /* Overview */

2015-06-15T11:37:09Z

Overview

← Older revision		Revision as of 11:37, 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.}}


	[[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: /* Actions */

2015-04-30T15:18:21Z

Actions

← Older revision		Revision as of 15:18, 30 April 2015
Line 30:		Line 30:
	=== Actions ===		=== Actions ===

	The Sankey Widget supports AppBoard actions ~~however~~ as the widget ~~is showing~~ summarized information the action fired represents the selected field (for action attribute filtering) and a row id for '''one''' row that matches the value of the selected node, even though there may be multiple rows that make up that node.		The Sankey Widget supports AppBoard actions by clicking on a node. However, as the widget displays summarized information the action fired represents the selected field (for action attribute filtering) and a row id for '''one''' row that matches the value of the selected node, even though there may be multiple rows that make up that node.

	Refer to the [[appboard/2.6/builder/widgets/actions\|Widget Actions]] page for more information on configuring AppBoard Actions.		Refer to the [[appboard/2.6/builder/widgets/actions\|Widget Actions]] page for more information on configuring AppBoard Actions.

imported>Jason.nicholls at 14:52, 30 April 2015

2015-04-30T14:52:36Z

← Older revision		Revision as of 14:52, 30 April 2015
Line 30:		Line 30:
	=== Actions ===		=== Actions ===

	The Sankey Widget supports AppBoard actions however as the widget is showing summarized information the ~~actions~~ fired ~~include~~ the selected field for		The Sankey Widget supports AppBoard actions however as the widget is showing summarized information the action fired represents the selected field (for action attribute filtering) and a row id for '''one''' row that matches the value of the selected node, even though there may be multiple rows that make up that node.

	Refer to the [[appboard/2.6/builder/widgets/actions\|Widget Actions]] page for more information on configuring AppBoard Actions.		Refer to the [[appboard/2.6/builder/widgets/actions\|Widget Actions]] page for more information on configuring AppBoard Actions.

imported>Jason.nicholls: /* Configuration */

2015-04-30T14:47:49Z

Configuration

← Older revision		Revision as of 14:47, 30 April 2015
Line 27:		Line 27:

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

			=== Actions ===

			The Sankey Widget supports AppBoard actions however as the widget is showing summarized information the actions fired include the selected field for

			Refer to the [[appboard/2.6/builder/widgets/actions\|Widget Actions]] page for more information on configuring AppBoard Actions.

imported>Jason.nicholls at 14:31, 30 April 2015

2015-04-30T14:31:18Z

← Older revision		Revision as of 14:31, 30 April 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\|The exampleSankeyWidget currently does not support triggering of AppBoard actions. Adding support for actions is possible, just not implemented yet.}}~~


Line 24:		Line 22:

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

			In operation if a row of data has an empty or <tt>NULL</tt> value for a particular field then the link will flow past that field until the next field with a value.


	[[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: 1 revision

2015-04-30T10:59:33Z

1 revision

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

imported>Jason.nicholls: /* Configuration */

2015-03-06T10:00:36Z

Configuration

New page

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

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

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

==Configuration==

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

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