File: items.rst

package info (click to toggle)
silx 2.2.1%2Bdfsg-3
  • links: PTS, VCS
  • area: main
  • in suites: trixie
  • size: 31,652 kB
  • sloc: python: 119,829; ansic: 5,062; lisp: 4,454; cpp: 883; sh: 286; makefile: 90; xml: 46
file content (151 lines) | stat: -rw-r--r-- 3,799 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151

.. currentmodule:: silx.gui.plot

:mod:`items`: Plot primitives
=============================

.. automodule:: silx.gui.plot.items

.. currentmodule:: silx.gui.plot.items

Item
----

All plot primitives inherits from :class:`Item` as a common ground:

.. autoclass:: Item
   :show-inheritance:
   :members:

Curve
-----

.. autoclass:: Curve
   :members: getData, getXData, getYData, getXErrorData, getYErrorData, setData,
             getSymbol, setSymbol, getSymbolSize, setSymbolSize,
             getAlpha, setAlpha,
             getColor, setColor,
             getYAxis, setYAxis,
             isFill, setFill,
             getXLabel, getYLabel,
             getLineWidth, setLineWidth, getLineStyle, setLineStyle,
             isHighlighted, setHighlighted, getHighlightedStyle, setHighlightedStyle,
             getCurrentStyle

.. autoclass:: CurveStyle
   :members: getColor, getLineStyle, getLineWidth, getSymbol, getSymbolSize

Images
------

.. autoclass:: ImageData
   :members: getData, getRgbaImageData,
             getOrigin, setOrigin,
             getScale, setScale,
             isDraggable,
             getAlpha, setAlpha,
             getColormap, setColormap,
             getAlternativeImageData

.. autoclass:: ImageRgba
   :members: getData, getRgbaImageData,
             getOrigin, setOrigin,
             getScale, setScale,
             isDraggable,
             getAlpha, setAlpha

Scatter
-------

.. autoclass:: Scatter
   :members: getValueData,
             getData, getXData, getYData, getXErrorData, getYErrorData, setData,
             getSymbol, setSymbol, getSymbolSize, setSymbolSize,
             getAlpha, setAlpha,
             getColormap, setColormap

Histogram
---------

.. autoclass:: Histogram
   :members: getValueData, getBinEdgesData, getData, setData,
             getAlpha, setAlpha,
             getColor, setColor,
             getYAxis, setYAxis,
             isFill, setFill,
             getLineWidth, setLineWidth, getLineStyle, setLineStyle

Markers
-------

.. autoclass:: Marker
   :members: getText, setText, getXPosition, getYPosition, getPosition, setPosition, getConstraint,
             getSymbol, setSymbol, getSymbolSize, setSymbolSize

.. autoclass:: XMarker
   :members: getText, setText, getXPosition, getYPosition, getPosition, setPosition, getConstraint

.. autoclass:: YMarker
   :members: getText, setText, getXPosition, getYPosition, getPosition, setPosition, getConstraint

Shapes
------

.. autoclass:: Shape
   :members: setOverlay,
             getColor, setColor,
             isFill, setFill,
             getType, getPoints, setPoints

Item changed signal
-------------------

Plot items emit a :attr:`Item.sigItemChanged` signal when their values are updated.
This signal provides a flag in the following enumeration describing the modified value:

.. autoclass:: ItemChangedType
   :members:

Axis
----

.. autoclass:: Axis
   :members:


:mod:`~silx.gui.plot.items.roi`: Regions of Interest
----------------------------------------------------

.. automodule:: silx.gui.plot.items.roi
   :members:
   :show-inheritance:

   .. autoclass:: silx.gui.plot.items.roi.ArcROI
      :members:
      :show-inheritance:

   .. autoclass:: silx.gui.plot.items.roi.BandROI
      :members:
      :show-inheritance:


Base class for regions of interest
++++++++++++++++++++++++++++++++++

.. autoclass:: silx.gui.plot.items._roi_base._RegionOfInterestBase
   :members:
   :show-inheritance:

.. autoclass:: silx.gui.plot.items.roi.RegionOfInterest
   :members:
   :show-inheritance:

.. autoclass:: silx.gui.plot.items.roi.HandleBasedROI
   :members:
   :show-inheritance:

.. autoclass:: silx.gui.plot.items.roi.InteractionModeMixIn
   :members:

.. autoclass:: silx.gui.plot.items.roi.RoiInteractionMode
   :members: