QgsColorRampShaderWidget Class Reference

It has 2 ways how to use it. More...

#include <qgscolorrampshaderwidget.h>

Inheritance diagram for QgsColorRampShaderWidget:

Public Slots
void	classify ()
	Executes the single band pseudo raster classification. More...
void	loadMinimumMaximumFromTree ()
	Loads min and max values from color ramp tree. More...

Signals
void	classificationModeChanged (QgsColorRampShader::ClassificationMode mode)
	Classification mode changed. More...
void	minimumMaximumChangedFromTree (double minimum, double maximum)
	Color ramp tree has changed. More...
void	widgetChanged ()
	Widget changed. More...

Public Member Functions
	QgsColorRampShaderWidget (QWidget *parent=nullptr)
	Creates new color ramp shader widget. More...
void	initializeForUseWithRasterLayer ()
	Allows quantile classification mode for raster layers. More...
double	maximum () const
	Gets max value. More...
double	minimum () const
	Gets min value. More...
void	setExtent (const QgsRectangle &extent)
	Sets extent, only when used for raster layer. More...
void	setFromShader (const QgsColorRampShader &colorRampShader)
	Sets widget state from the color ramp shader. More...
void	setMinimumMaximum (double minimum, double maximum)
	Sets min max. More...
void	setMinimumMaximumAndClassify (double minimum, double maximum)
	Sets min max and classify color tree. More...
void	setRasterBand (int band)
	Sets raster band, only when used for raster layer. More...
void	setRasterDataProvider (QgsRasterDataProvider *dp)
	Associates raster with the widget, only when used for raster layer. More...
QgsColorRampShader	shader () const
	Returns shared function used in the renderer. More...

Protected Member Functions
void	populateColormapTreeWidget (const QList< QgsColorRampShader::ColorRampItem > &colorRampItems)
	Populates color ramp tree from ramp items. More...

Detailed Description

It has 2 ways how to use it.

For raster layers, raster data provider and band is assigned and the Quantile classification mode can be used and the LoadFromBandButton is visible.

The other mode is used to style mesh layer contours (scalar datasets)

Since

QGIS 3.4

Definition at line 45 of file qgscolorrampshaderwidget.h.

Constructor & Destructor Documentation

QgsColorRampShaderWidget()

QgsColorRampShaderWidget::QgsColorRampShaderWidget

(

QWidget *

parent = nullptr

)

Creates new color ramp shader widget.

Definition at line 49 of file qgscolorrampshaderwidget.cpp.

Member Function Documentation

classificationModeChanged

void QgsColorRampShaderWidget::classificationModeChanged ( QgsColorRampShader::ClassificationMode  mode )

signal

Classification mode changed.

classify

void QgsColorRampShaderWidget::classify ( )

slot

Executes the single band pseudo raster classification.

Definition at line 307 of file qgscolorrampshaderwidget.cpp.

initializeForUseWithRasterLayer()

void QgsColorRampShaderWidget::initializeForUseWithRasterLayer

(

)

Allows quantile classification mode for raster layers.

Definition at line 114 of file qgscolorrampshaderwidget.cpp.

loadMinimumMaximumFromTree

void QgsColorRampShaderWidget::loadMinimumMaximumFromTree ( )

slot

Loads min and max values from color ramp tree.

Definition at line 719 of file qgscolorrampshaderwidget.cpp.

maximum()

double QgsColorRampShaderWidget::maximum

(

)

const

Gets max value.

Definition at line 690 of file qgscolorrampshaderwidget.cpp.

minimum()

double QgsColorRampShaderWidget::minimum

(

)

const

Gets min value.

Definition at line 685 of file qgscolorrampshaderwidget.cpp.

minimumMaximumChangedFromTree

void QgsColorRampShaderWidget::minimumMaximumChangedFromTree ( double  minimum, double  maximum  )

signal

Color ramp tree has changed.

populateColormapTreeWidget()

void QgsColorRampShaderWidget::populateColormapTreeWidget ( const QList< QgsColorRampShader::ColorRampItem > &  colorRampItems )

protected

Populates color ramp tree from ramp items.

Definition at line 423 of file qgscolorrampshaderwidget.cpp.

setExtent()

void QgsColorRampShaderWidget::setExtent

(

const QgsRectangle &

extent

)

Sets extent, only when used for raster layer.

Definition at line 138 of file qgscolorrampshaderwidget.cpp.

setFromShader()

void QgsColorRampShaderWidget::setFromShader

(

const QgsColorRampShader &

colorRampShader

)

Sets widget state from the color ramp shader.

Definition at line 602 of file qgscolorrampshaderwidget.cpp.

setMinimumMaximum()

void QgsColorRampShaderWidget::setMinimumMaximum	(	double	minimum,
		double	maximum
	)

Sets min max.

Definition at line 678 of file qgscolorrampshaderwidget.cpp.

setMinimumMaximumAndClassify()

void QgsColorRampShaderWidget::setMinimumMaximumAndClassify	(	double	minimum,
		double	maximum
	)

Sets min max and classify color tree.

Definition at line 669 of file qgscolorrampshaderwidget.cpp.

setRasterBand()

void QgsColorRampShaderWidget::setRasterBand

(

int

band

)

Sets raster band, only when used for raster layer.

Definition at line 126 of file qgscolorrampshaderwidget.cpp.

setRasterDataProvider()

void QgsColorRampShaderWidget::setRasterDataProvider

(

QgsRasterDataProvider *

dp

)

Associates raster with the widget, only when used for raster layer.

Definition at line 120 of file qgscolorrampshaderwidget.cpp.

shader()

QgsColorRampShader QgsColorRampShaderWidget::shader

(

)

const

Returns shared function used in the renderer.

Definition at line 143 of file qgscolorrampshaderwidget.cpp.

widgetChanged

void QgsColorRampShaderWidget::widgetChanged ( )

signal

Widget changed.

---

The documentation for this class was generated from the following files:

• /build/qgis-3.24.2+99sid/src/gui/raster/qgscolorrampshaderwidget.h
• /build/qgis-3.24.2+99sid/src/gui/raster/qgscolorrampshaderwidget.cpp