Commit 1b650083 authored by Luke Campagnola's avatar Luke Campagnola
Browse files

Added parametertree documentation

parent 237625a4
...@@ -10,4 +10,5 @@ Contents: ...@@ -10,4 +10,5 @@ Contents:
graphicsItems/index graphicsItems/index
widgets/index widgets/index
3dgraphics/index 3dgraphics/index
parametertree/index
graphicsscene/index graphicsscene/index
...@@ -20,7 +20,8 @@ Contents: ...@@ -20,7 +20,8 @@ Contents:
3dgraphics 3dgraphics
style style
region_of_interest region_of_interest
parametertree prototyping
parametertree/index
internals internals
apireference apireference
......
.. _api_widgets:
ParameterTree API Reference
===========================
Also see the 'parametertree' example included with pyqtgraph
Contents:
.. toctree::
:maxdepth: 2
parameter
parametertree
parametertypes
parameteritem
.. _parametertree:
Parameter Trees
===============
Parameter trees are a system for handling hierarchies of parameters while automatically generating one or more GUIs to display and interact with the parameters.
This feature is commonly seen, for example, in user interface design applications which display a list of editable properties for each widget.
Parameters generally have a name, a data type (int, float, string, color, etc), and a value matching the data type. Parameters may be grouped and nested
to form hierarchies and may be subclassed to provide custom behavior and display widgets.
Pyqtgraph's parameter tree system works similarly to the model-view architecture used by some components of Qt: Parameters are purely data-handling classes
that exist independent of any graphical interface. A ParameterTree is a widget that automatically generates a graphical interface which represents
the state of a haierarchy of Parameter objects and allows the user to edit the values within that hierarchy. This separation of data (model) and graphical
interface (view) allows the same data to be represented multiple times and in a variety of different ways.
For more information, see the 'parametertree' example included with pyqtgraph and the API reference
.. toctree::
:maxdepth: 2
apiref
Parameter
=========
.. autoclass:: pyqtgraph.parametertree.Parameter
:members:
.. automethod:: pyqtgraph.parametertree.Parameter.__init__
ParameterItem
=============
.. autoclass:: pyqtgraph.parametertree.ParameterItem
:members:
.. automethod:: pyqtgraph.parametertree.ParameterItem.__init__
ParameterTree
=============
.. autoclass:: pyqtgraph.parametertree.ParameterTree
:members:
.. automethod:: pyqtgraph.parametertree.ParameterTree.__init__
Built-in Parameter Types
========================
.. automodule:: pyqtgraph.parametertree.parameterTypes
:members:
...@@ -10,7 +10,7 @@ Parameter Trees ...@@ -10,7 +10,7 @@ Parameter Trees
The parameter tree system provides a widget displaying a tree of modifiable values similar to those used in most GUI editor applications. This allows a large number of variables to be controlled by the user with relatively little programming effort. The system also provides separation between the data being controlled and the user interface controlling it (model/view architecture). Parameters may be grouped/nested to any depth and custom parameter types can be built by subclassing from Parameter and ParameterItem. The parameter tree system provides a widget displaying a tree of modifiable values similar to those used in most GUI editor applications. This allows a large number of variables to be controlled by the user with relatively little programming effort. The system also provides separation between the data being controlled and the user interface controlling it (model/view architecture). Parameters may be grouped/nested to any depth and custom parameter types can be built by subclassing from Parameter and ParameterItem.
See the parametertree example for more information. See the `parametertree documentation <parametertree>`_ for more information.
Visual Programming Flowcharts Visual Programming Flowcharts
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment