Documentation/4.1/Developers/Charts - Revision history

UpdateBot: Prepend documentation/versioncheck template. See http://na-mic.org/Mantis/view.php?id=2887

2013-06-14T07:22:31Z

Prepend documentation/versioncheck template. See http://na-mic.org/Mantis/view.php?id=2887

2012-06-09T14:20:32Z

Chart View

2012-06-09T14:20:01Z

Chart View

2012-06-09T14:19:08Z

Chart View

2012-06-09T14:17:52Z

MRML Nodes

2012-06-09T14:17:11Z

Architecture

2012-06-07T00:52:20Z

2012-06-06T21:47:42Z

Under the hood

2012-06-06T21:46:29Z

Under the hood

2012-06-06T21:45:39Z

Bar charts with categorical data

← Older revision		Revision as of 07:22, 14 June 2013
Line 1:		Line 1:
		+	<noinclude>{{documentation/versioncheck}}</noinclude>
	<gallery widths=400px heights=225px>		<gallery widths=400px heights=225px>
	Image:SlicerRT-0.2 screenshot.png\|Charting in radiation therapy.		Image:SlicerRT-0.2 screenshot.png\|Charting in radiation therapy.

@@ Line 32: / Line 32: @@
 ; [http://slicer.org/doc/html/classqMRMLChartView.html qMRMLChartView]
 : Display canvas of the chart. This is currently a subclass of QWebView as the charting facilities is based on a [http://jquery.com jQuery] library called [http://www.jqplot.com jqPlot].
-; [http://slicer.org/doc/html/qMRMLChartViewControllerWidget.html qMRMLChartViewControllerWidget]
+; [http://slicer.org/doc/html/classqMRMLChartViewControllerWidget.html qMRMLChartViewControllerWidget]
 : Widget to control the content and display of a chart.

@@ Line 32: / Line 32: @@
 ; [http://slicer.org/doc/html/classqMRMLChartView.html qMRMLChartView]
 : Display canvas of the chart. This is currently a subclass of QWebView as the charting facilities is based on a [http://jquery.com jQuery] library called [http://www.jqplot.com jqPlot].
-; [http://slicer.org/doc/html/qMRMLChartControllerWidget.html qMRMLChartViewControllerWidget]
+; [http://slicer.org/doc/html/qMRMLChartViewControllerWidget.html qMRMLChartViewControllerWidget]
 : Widget to control the content and display of a chart.

@@ Line 28: / Line 28: @@
 == Chart View ==
-; qMRMLChartWidget
+; [http://slicer.org/doc/html/classqMRMLChartWidget.html qMRMLChartWidget]
 : The toplevel charting widget that is packed in layout. Subclass of qMRMLWidget. Contains a qMRMLChartView and a qMRMLChartViewControllerWidget. There can be several Chart Widgets in a single layout.
-; qMRMLChartView
+; [http://slicer.org/doc/html/classqMRMLChartView.html qMRMLChartView]
 : Display canvas of the chart. This is currently a subclass of QWebView as the charting facilities is based on a [http://jquery.com jQuery] library called [http://www.jqplot.com jqPlot].
-; qMRMLChartViewControllerWidget
+; [http://slicer.org/doc/html/qMRMLChartControllerWidget.html qMRMLChartViewControllerWidget]
 : Widget to control the content and display of a chart.

@@ Line 40: / Line 40: @@
 ; [http://slicer.org/doc/html/classvtkMRMLChartNode.html vtkMRMLChartNode]
 : Represents the content and properties of a chart.  Manages a list of Array Nodes to display in the chart.  Provides methods to set the properties of a chart or the properties of each Array Node.
-; http://slicer.org/doc/html/classvtkMRMLDoubleArrayNode.html vtkMRMLDoubleArrayNode]
+; [http://slicer.org/doc/html/classvtkMRMLDoubleArrayNode.html vtkMRMLDoubleArrayNode]
 : Represents the data that can be displayed in a chart.  Array nodes contain a series of 3-tuples representing the (X, Y, Error) measurement values.

@@ Line 36: / Line 36: @@
 == MRML Nodes ==
-; vtkMRMLChartViewNode
+; [http://slicer.org/doc/html/classvtkMRMLChartViewNode.html vtkMRMLChartViewNode]
 : Node associated with a Chart View. Keeps track of which chart to display in a Chart View. There can be multiple charts in a scene and a given Chart View can display any of the charts.
-; vtkMRMLChartNode
+; [http://slicer.org/doc/html/classvtkMRMLChartNode.html vtkMRMLChartNode]
 : Represents the content and properties of a chart.  Manages a list of Array Nodes to display in the chart.  Provides methods to set the properties of a chart or the properties of each Array Node.
-; vtkMRMLDoubleArrayNode
+; http://slicer.org/doc/html/classvtkMRMLDoubleArrayNode.html vtkMRMLDoubleArrayNode]
 : Represents the data that can be displayed in a chart.  Array nodes contain a series of 3-tuples representing the (X, Y, Error) measurement values.

@@ Line 1: / Line 1: @@
 <gallery widths=400px heights=225px>
 Image:SlicerRT-0.2 screenshot.png|Charting in radiation therapy.
-Image:3D Slicer 4.0.1.2012-02-03 180.png|Charting regional statistics
+Image:3D Slicer 4.0.1.2012-02-03 180.png|Charting regional statistics.
 </gallery>
 = Slicer Charting Overview =

@@ Line 155: / Line 155: @@
 * Script element for the chart
 * Conversion of the Array nodes to javascript arrays suitable for jqPlot
-* Construction of the plot options from the Chart properties
+* Construction of the jqPlot options from the Chart properties
 * Call to jqPlot to generate the plot
 * Slots and hooks for resizing the Chart and handling the mouse over and data point click signals

@@ Line 148: / Line 148: @@
 = Under the hood =
-The architecture of the Charting is divided into two layers.  The first layer is the public layer available to Slicer developers consisting of the MRML nodes and associated Widgets.  The second layer is the rendering architecture for the Chart.  The rendering of Chart utilizes a  [http://jquery.com jQuery] library called [http://www.jqplot.com jqPlot] to generate a plot.  The Chart View is actually a QWebView Widget that displays a web page that is generated on the fly by Slicer to display a Chart.
+The architecture of the Charting is divided into two layers.  The first layer is the public layer available to Slicer developers consisting of the MRML nodes and associated Widgets.  This layer can be used by module writers to construct charts and orchestrate their display. The second layer is the rendering architecture for the Chart.  The rendering of Chart utilizes a  [http://jquery.com jQuery] library called [http://www.jqplot.com jqPlot] to generate a plot.  The Chart View is actually a QWebView Widget that displays a web page that is generated on the fly by Slicer to display a Chart.
 The method qMRMLChartViewPrivate::updateWidgetFromMRML() generates the HTML and javascript to display a Chart, passes the generated code to the QWebView, calls the QWebView::show() method, and then exposes a Qt object to the javascript layer to support signals and slots. The HTML and javascript generation includes

@@ Line 143: / Line 143: @@
 </pre>
-[[Image:BarChartWithCategoricalData.png|400px]]
+[[Image:BarChartWithCategoricalData.png|400px|Bar chart with categorical data]]
 Currently, this capability is not provided for line charts.