From 3d820400d32da0b5dbc47e1fc19cf458f71b9e2b Mon Sep 17 00:00:00 2001 From: Luke Campagnola Date: Fri, 31 May 2013 14:04:04 -0400 Subject: [PATCH] Added GLLinePlotItem documentation --- doc/source/3dgraphics/gllineplotitem.rst | 8 ++++++++ doc/source/3dgraphics/index.rst | 1 + pyqtgraph/opengl/items/GLLinePlotItem.py | 3 ++- 3 files changed, 11 insertions(+), 1 deletion(-) create mode 100644 doc/source/3dgraphics/gllineplotitem.rst diff --git a/doc/source/3dgraphics/gllineplotitem.rst b/doc/source/3dgraphics/gllineplotitem.rst new file mode 100644 index 00000000..490ba298 --- /dev/null +++ b/doc/source/3dgraphics/gllineplotitem.rst @@ -0,0 +1,8 @@ +GLLinePlotItem +============== + +.. autoclass:: pyqtgraph.opengl.GLLinePlotItem + :members: + + .. automethod:: pyqtgraph.opengl.GLLinePlotItem.__init__ + diff --git a/doc/source/3dgraphics/index.rst b/doc/source/3dgraphics/index.rst index 255f550b..d025a4c7 100644 --- a/doc/source/3dgraphics/index.rst +++ b/doc/source/3dgraphics/index.rst @@ -20,6 +20,7 @@ Contents: glvolumeitem glimageitem glmeshitem + gllineplotitem glaxisitem glgraphicsitem glscatterplotitem diff --git a/pyqtgraph/opengl/items/GLLinePlotItem.py b/pyqtgraph/opengl/items/GLLinePlotItem.py index 9ef34cab..bb5ce2f6 100644 --- a/pyqtgraph/opengl/items/GLLinePlotItem.py +++ b/pyqtgraph/opengl/items/GLLinePlotItem.py @@ -11,6 +11,7 @@ class GLLinePlotItem(GLGraphicsItem): """Draws line plots in 3D.""" def __init__(self, **kwds): + """All keyword arguments are passed to setData()""" GLGraphicsItem.__init__(self) glopts = kwds.pop('glOptions', 'additive') self.setGLOptions(glopts) @@ -22,7 +23,7 @@ class GLLinePlotItem(GLGraphicsItem): def setData(self, **kwds): """ Update the data displayed by this item. All arguments are optional; - for example it is allowed to update spot positions while leaving + for example it is allowed to update vertex positions while leaving colors unchanged, etc. ==================== ==================================================