diff options
Diffstat (limited to 'doc/source/modules/gui/plot/plotwidget.rst')
-rw-r--r-- | doc/source/modules/gui/plot/plotwidget.rst | 138 |
1 files changed, 80 insertions, 58 deletions
diff --git a/doc/source/modules/gui/plot/plotwidget.rst b/doc/source/modules/gui/plot/plotwidget.rst index df576fc..a8e7831 100644 --- a/doc/source/modules/gui/plot/plotwidget.rst +++ b/doc/source/modules/gui/plot/plotwidget.rst @@ -14,13 +14,8 @@ It is the basis of other plot widget, thus all plot widgets share the same API. For an introduction and examples of the plot API, see :doc:`getting_started`. -Plot API --------- - -.. currentmodule:: silx.gui.plot.Plot - -This is a choosen subset of the complete plot API, the full API is -documented in :class:`silx.gui.plot.Plot`. +:class:`PlotWidget` +------------------- .. currentmodule:: silx.gui.plot.PlotWidget @@ -37,6 +32,20 @@ Those methods allow to add and update plotted data: .. automethod:: PlotWidget.addScatter .. automethod:: PlotWidget.addHistogram +Get data +........ + +Those methods return objects providing access to plotted data: + +.. automethod:: PlotWidget.getCurve +.. automethod:: PlotWidget.getImage +.. automethod:: PlotWidget.getScatter +.. automethod:: PlotWidget.getHistogram + +.. automethod:: PlotWidget.getAllCurves +.. automethod:: PlotWidget.getAllImages + + Plot markers ............ @@ -52,59 +61,40 @@ Remove data from the plot .. automethod:: PlotWidget.clear .. automethod:: PlotWidget.remove -Title and labels -................ +Title +..... -Those methods handle the text labels of the axes and the plot title: +Those methods handle the plot title: .. automethod:: PlotWidget.getGraphTitle .. automethod:: PlotWidget.setGraphTitle -.. automethod:: PlotWidget.getGraphXLabel -.. automethod:: PlotWidget.setGraphXLabel -.. automethod:: PlotWidget.getGraphYLabel -.. automethod:: PlotWidget.setGraphYLabel - -Axes limits -........... - -Those methods change the range of data values displayed on each axis. - -.. automethod:: PlotWidget.getGraphXLimits -.. automethod:: PlotWidget.setGraphXLimits -.. automethod:: PlotWidget.getGraphYLimits -.. automethod:: PlotWidget.setGraphYLimits -.. automethod:: PlotWidget.setLimits Axes .... -The following methods handle the display properties of the axes: +Those two methods give access to :class:`.items.Axis` which handle the limits, scales and labels of axis: -.. automethod:: PlotWidget.isXAxisLogarithmic -.. automethod:: PlotWidget.setXAxisLogarithmic -.. automethod:: PlotWidget.isYAxisLogarithmic -.. automethod:: PlotWidget.setYAxisLogarithmic +.. automethod:: PlotWidget.getXAxis +.. automethod:: PlotWidget.getYAxis -.. automethod:: PlotWidget.isYAxisInverted -.. automethod:: PlotWidget.setYAxisInverted +The following methods handle plot limits, aspect ratio, grid and axes display: + +.. automethod:: PlotWidget.setLimits .. automethod:: PlotWidget.isKeepDataAspectRatio .. automethod:: PlotWidget.setKeepDataAspectRatio .. automethod:: PlotWidget.getGraphGrid .. automethod:: PlotWidget.setGraphGrid +.. automethod:: PlotWidget.setAxesDisplayed Reset zoom .......... .. automethod:: PlotWidget.resetZoom -Those methods change the behavior of :meth:`PlotWidget.resetZoom`. +The following methods allow to add margins around the data when performing a zoom reset: .. automethod:: PlotWidget.getDataMargins .. automethod:: PlotWidget.setDataMargins -.. automethod:: PlotWidget.isXAxisAutoScale -.. automethod:: PlotWidget.setXAxisAutoScale -.. automethod:: PlotWidget.isYAxisAutoScale -.. automethod:: PlotWidget.setYAxisAutoScale Defaults ........ @@ -130,10 +120,35 @@ of the plot and to toggle the use of a crosshair cursor: .. automethod:: PlotWidget.getGraphCursor .. automethod:: PlotWidget.setGraphCursor +.. automethod:: PlotWidget.isPanWithArrowKeys +.. automethod:: PlotWidget.setPanWithArrowKeys + +Coordinates conversion +...................... + +.. automethod:: PlotWidget.getDataRange +.. automethod:: PlotWidget.getPlotBoundsInPixels +.. automethod:: PlotWidget.dataToPixel +.. automethod:: PlotWidget.pixelToData + +Active Item +........... + +.. automethod:: PlotWidget.isActiveCurveHandling +.. automethod:: PlotWidget.setActiveCurveHandling +.. automethod:: PlotWidget.getActiveCurveColor +.. automethod:: PlotWidget.setActiveCurveColor +.. automethod:: PlotWidget.getActiveCurve +.. automethod:: PlotWidget.setActiveCurve +.. automethod:: PlotWidget.getActiveImage +.. automethod:: PlotWidget.setActiveImage + Misc. ..... +.. automethod:: PlotWidget.getWidgetHandle .. automethod:: PlotWidget.saveGraph +.. automethod:: PlotWidget.setDefaultBackend Signals ....... @@ -141,11 +156,6 @@ Signals The :class:`PlotWidget` provides the following Qt signals: .. autoattribute:: PlotWidget.sigPlotSignal -.. autoattribute:: PlotWidget.sigSetYAxisInverted -.. autoattribute:: PlotWidget.sigSetXAxisLogarithmic -.. autoattribute:: PlotWidget.sigSetYAxisLogarithmic -.. autoattribute:: PlotWidget.sigSetXAxisAutoScale -.. autoattribute:: PlotWidget.sigSetYAxisAutoScale .. autoattribute:: PlotWidget.sigSetKeepDataAspectRatio .. autoattribute:: PlotWidget.sigSetGraphGrid .. autoattribute:: PlotWidget.sigSetGraphCursor @@ -153,21 +163,33 @@ The :class:`PlotWidget` provides the following Qt signals: .. autoattribute:: PlotWidget.sigContentChanged .. autoattribute:: PlotWidget.sigActiveCurveChanged .. autoattribute:: PlotWidget.sigActiveImageChanged +.. autoattribute:: PlotWidget.sigActiveScatterChanged .. autoattribute:: PlotWidget.sigInteractiveModeChanged -.. Not documented: - addItem, removeItem, clearItems - isActiveCurveHandling, enableActiveCurveHandling, - getActiveCurveColor, setActiveCurveColor, - getActiveCurve, setActiveCurve, - isCurveHidden, hideCurve, - getActiveImage, setActiveImage, - getAllCurves, getCurve, getImage, getAllImages, - getScatter, getHistogram, - setDefaultPlotPoints, setDefaultPlotLines, - getWidgetHandle, notify, setCallback, graphCallback, - dataToPixel, pixelToData, getPlotBoundsInPixels, - setGraphCursorShape, pickMarker, moveMarker, pickImageOrCurve, moveImage, - onMousePress, onMouseMove, onMouseRelease, onMouseWheel, - isDrawModeEnabled, setDrawModeEnabled, getDrawMode, - isZoomModeEnabled, setZoomModeEnabled, +.. PlotWidget public API that is not documented: + Could be added: + - addItem + - pan + - getLimitsHistory + - isDefaultPlotPoints + - isDefaultPlotLines + - setGraphCursorShape + - getAutoReplot, setAutoReplot, replot + Should not be added: + * Should be private: + - notify, setCallback, graphCallback + * Use remove instead: + - removeCurve, removeImage, removeItem, removeMarker + - clearCurves, clearImages, clearItems, clearMarkers + * Use items instead: + - isCurveHidden, hideCurve + * Use items.axis instead: + - getGraphXLimits, setGraphXLimits + - getGraphYLimits, setGraphYLimits + - getGraphXLabel, setGraphXLabel + - getGraphYLabel, setGraphYLabel + - isXAxisLogarithmic, setXAxisLogarithmic + - isYAxisLogarithmic, setXAxisLogarithmic + - isXAxisAutoScale, setXAxisAutoScale + - isYAxisAutoScale, setYAxisAutoScale + - setYAxisInverted, isYAxisInverted |