Class: QgsColorRampWidget¶
- class qgis.gui.QgsColorRampWidget¶
Bases:
QgsColorWidget
A color ramp widget. This widget consists of an interactive box filled with a color which varies along its length by a single color component (e.g., varying saturation from 0 to 100%).
New in version 2.5.
QgsColorRampWidget(parent: QWidget = None, component: QgsColorWidget.ColorComponent = QgsColorWidget.Red, orientation: QgsColorRampWidget.Orientation = QgsColorRampWidget.Horizontal) Construct a new color ramp widget.
- Parameters:
parent – parent QWidget for the widget
component – color component which varies along the ramp
orientation –
orientation for widget
Methods
Alters a color by modifying the value of a specific color component
Returns the range of valid values for the color widget's component
Returns the current value of the widget's color component
Returns the hue for the widget.
Fetches the margin between the edge of the widget and the ramp
- param event:
- param event:
- param event:
- param event:
Fetches the orientation for the color ramp
- param event:
Sets the margin between the edge of the widget and the ramp
Sets the size for drawing the triangular markers on the ramp
Sets the orientation for the color ramp
Sets whether the ramp should be drawn within a frame
Fetches whether the ramp is drawn within a frame
- rtype:
QSize
Generates a checkboard pattern pixmap for use as a background to transparent colors
- param event:
Signals
pyqtSignal(*types, name: str = ..., revision: int = ..., arguments: Sequence = ...) -> PYQT_SIGNAL
Attributes
- Horizontal = 0¶
- class Orientation¶
Bases:
int
- Vertical = 1¶
- actionEvent(self, QActionEvent)¶
- alterColor(self, color: QColor | Qt.GlobalColor | QGradient, component: QgsColorWidget.ColorComponent, newValue: int)¶
Alters a color by modifying the value of a specific color component
- Parameters:
color – color to alter
component – color component to alter
newValue – new value of color component. Values are automatically clipped to a valid range for the color component.
- changeEvent(self, QEvent)¶
- childEvent(self, QChildEvent)¶
- closeEvent(self, QCloseEvent)¶
- componentRange(self) int ¶
Returns the range of valid values for the color widget’s component
- Returns:
maximum value allowed for color component, or -1 if widget has multiple components
componentRange(self, component: QgsColorWidget.ColorComponent) -> int Returns the range of valid values a color component
- Returns:
maximum value allowed for color component
- componentValue(self) int ¶
Returns the current value of the widget’s color component
- Returns:
value of color component, or -1 if widget has multiple components or an invalid color set
See also
setComponentValue()
See also
component()
componentValue(self, component: QgsColorWidget.ColorComponent) -> int Returns the value of a component of the widget’s current color. This method correctly handles hue values when the color has an ambiguous hue (e.g., black or white shades)
- Parameters:
component – color component to return
- Returns:
value of color component, or -1 if widget has an invalid color set
See also
- connectNotify(self, QMetaMethod)¶
- contextMenuEvent(self, QContextMenuEvent)¶
- create(self, window: PyQt5.sip.voidptr = 0, initializeWindow: bool = True, destroyOldWindow: bool = True)¶
- customEvent(self, QEvent)¶
- destroy(self, destroyWindow: bool = True, destroySubWindows: bool = True)¶
- disconnectNotify(self, QMetaMethod)¶
- dragEnterEvent(self, e: QDragEnterEvent)¶
- dragLeaveEvent(self, QDragLeaveEvent)¶
- dragMoveEvent(self, QDragMoveEvent)¶
- dropEvent(self, e: QDropEvent)¶
- enterEvent(self, QEvent)¶
- event(self, QEvent) bool ¶
- focusInEvent(self, QFocusEvent)¶
- focusNextChild(self) bool ¶
- focusNextPrevChild(self, bool) bool ¶
- focusOutEvent(self, QFocusEvent)¶
- focusPreviousChild(self) bool ¶
- hideEvent(self, QHideEvent)¶
- hue(self) int ¶
Returns the hue for the widget. This may differ from the hue for the QColor returned by
color()
, as QColor returns a hue of -1 if the color’s hue is ambiguous (e.g., if the saturation is zero).- Returns:
explicitly set hue for widget
- initPainter(self, QPainter)¶
- inputMethodEvent(self, QInputMethodEvent)¶
- interiorMargin(self) int ¶
Fetches the margin between the edge of the widget and the ramp
- Return type:
int
- Returns:
margin around the ramp
See also
- isSignalConnected(self, QMetaMethod) bool ¶
- keyPressEvent(self, event: QKeyEvent)¶
- Parameters:
event (QKeyEvent) –
- keyReleaseEvent(self, QKeyEvent)¶
- leaveEvent(self, QEvent)¶
- metric(self, QPaintDevice.PaintDeviceMetric) int ¶
- mouseDoubleClickEvent(self, QMouseEvent)¶
- mouseMoveEvent(self, event: QMouseEvent)¶
- Parameters:
event (QMouseEvent) –
- mousePressEvent(self, event: QMouseEvent)¶
- Parameters:
event (QMouseEvent) –
- mouseReleaseEvent(self, event: QMouseEvent)¶
- Parameters:
event (QMouseEvent) –
- moveEvent(self, QMoveEvent)¶
- nativeEvent(self, Union[QByteArray, bytes, bytearray], PyQt5.sip.voidptr) Tuple[bool, int] ¶
- orientation(self) QgsColorRampWidget.Orientation ¶
Fetches the orientation for the color ramp
- Return type:
- Returns:
orientation for the ramp
See also
- paintEvent(self, event: QPaintEvent)¶
- Parameters:
event (QPaintEvent) –
- receivers(self, PYQT_SIGNAL) int ¶
- resizeEvent(self, QResizeEvent)¶
- sender(self) QObject ¶
- senderSignalIndex(self) int ¶
- setInteriorMargin(self, margin: int)¶
Sets the margin between the edge of the widget and the ramp
- Parameters:
margin (int) – margin around the ramp
See also
- setMarkerSize(self, markerSize: int)¶
Sets the size for drawing the triangular markers on the ramp
- Parameters:
markerSize (int) – marker size in pixels
- setOrientation(self, orientation: QgsColorRampWidget.Orientation)¶
Sets the orientation for the color ramp
- Parameters:
orientation (QgsColorRampWidget.Orientation) – new orientation for the ramp
See also
- setShowFrame(self, showFrame: bool)¶
Sets whether the ramp should be drawn within a frame
- Parameters:
showFrame (bool) – set to
True
to draw a frame around the ramp
See also
- showEvent(self, QShowEvent)¶
- showFrame(self) bool ¶
Fetches whether the ramp is drawn within a frame
- Return type:
bool
- Returns:
True
if a frame is drawn around the ramp
See also
- sizeHint(self) QSize ¶
- Return type:
QSize
- tabletEvent(self, QTabletEvent)¶
- timerEvent(self, QTimerEvent)¶
- transparentBackground() QPixmap ¶
Generates a checkboard pattern pixmap for use as a background to transparent colors
- Returns:
checkerboard pixmap
- updateMicroFocus(self)¶
- valueChanged¶
pyqtSignal(*types, name: str = …, revision: int = …, arguments: Sequence = …) -> PYQT_SIGNAL
types is normally a sequence of individual types. Each type is either a type object or a string that is the name of a C++ type. Alternatively each type could itself be a sequence of types each describing a different overloaded signal. name is the optional C++ name of the signal. If it is not specified then the name of the class attribute that is bound to the signal is used. revision is the optional revision of the signal that is exported to QML. If it is not specified then 0 is used. arguments is the optional sequence of the names of the signal’s arguments.
- Parameters:
name (str = ...) –
revision (int = ...) –
arguments (Sequence = ...) –
- Return type:
PYQT_SIGNAL
- wheelEvent(self, event: QWheelEvent)¶
- Parameters:
event (QWheelEvent) –