A color scale for use with color coding data such as QCPColorMap. More...

#include <qcustomplot.h>

Inheritance diagram for QCPColorScale:

Signals
void	dataRangeChanged (const QCPRange &newRange)

void	dataScaleTypeChanged (QCPAxis::ScaleType scaleType)

void	gradientChanged (const QCPColorGradient &newGradient)

Signals inherited from QCPLayerable
void	layerChanged (QCPLayer *newLayer)

Public Member Functions
QCPAxis *	axis () const

int	barWidth () const

QList< QCPColorMap * >	colorMaps () const

QCPRange	dataRange () const

QCPAxis::ScaleType	dataScaleType () const

QCPColorGradient	gradient () const

QString	label () const

	QCPColorScale (QCustomPlot *parentPlot)

bool	rangeDrag () const

bool	rangeZoom () const

void	rescaleDataRange (bool onlyVisibleMaps)

void	setBarWidth (int width)

Q_SLOT void	setDataRange (const QCPRange &dataRange)

Q_SLOT void	setDataScaleType (QCPAxis::ScaleType scaleType)

Q_SLOT void	setGradient (const QCPColorGradient &gradient)

void	setLabel (const QString &str)

void	setRangeDrag (bool enabled)

void	setRangeZoom (bool enabled)

void	setType (QCPAxis::AxisType type)

QCPAxis::AxisType	type () const

virtual void	update (UpdatePhase phase) Q_DECL_OVERRIDE

virtual	~QCPColorScale ()

Public Member Functions inherited from QCPLayoutElement
QCP::MarginSides	autoMargins () const

virtual QList< QCPLayoutElement * >	elements (bool recursive) const

QCPLayout *	layout () const

QCPMarginGroup *	marginGroup (QCP::MarginSide side) const

QHash< QCP::MarginSide, QCPMarginGroup * >	marginGroups () const

QMargins	margins () const

virtual QSize	maximumOuterSizeHint () const

QSize	maximumSize () const

QMargins	minimumMargins () const

virtual QSize	minimumOuterSizeHint () const

QSize	minimumSize () const

QRect	outerRect () const

	QCPLayoutElement (QCustomPlot *parentPlot=0)

QRect	rect () const

virtual double	selectTest (const QPointF &pos, bool onlySelectable, QVariant *details=0) const Q_DECL_OVERRIDE

void	setAutoMargins (QCP::MarginSides sides)

void	setMarginGroup (QCP::MarginSides sides, QCPMarginGroup *group)

void	setMargins (const QMargins &margins)

void	setMaximumSize (const QSize &size)

void	setMaximumSize (int width, int height)

void	setMinimumMargins (const QMargins &margins)

void	setMinimumSize (const QSize &size)

void	setMinimumSize (int width, int height)

void	setOuterRect (const QRect &rect)

void	setSizeConstraintRect (SizeConstraintRect constraintRect)

SizeConstraintRect	sizeConstraintRect () const

virtual	~QCPLayoutElement ()

Public Member Functions inherited from QCPLayerable
bool	antialiased () const

QCPLayer *	layer () const

QCPLayerable *	parentLayerable () const

QCustomPlot *	parentPlot () const

	QCPLayerable (QCustomPlot plot, QString targetLayer=QString(), QCPLayerable parentLayerable=0)

bool	realVisibility () const

void	setAntialiased (bool enabled)

Q_SLOT bool	setLayer (QCPLayer *layer)

bool	setLayer (const QString &layerName)

void	setVisible (bool on)

bool	visible () const

virtual	~QCPLayerable ()

Protected Member Functions
virtual void	applyDefaultAntialiasingHint (QCPPainter *painter) const Q_DECL_OVERRIDE

virtual void	mouseMoveEvent (QMouseEvent *event, const QPointF &startPos) Q_DECL_OVERRIDE

virtual void	mousePressEvent (QMouseEvent *event, const QVariant &details) Q_DECL_OVERRIDE

virtual void	mouseReleaseEvent (QMouseEvent *event, const QPointF &startPos) Q_DECL_OVERRIDE

virtual void	wheelEvent (QWheelEvent *event) Q_DECL_OVERRIDE

Protected Member Functions inherited from QCPLayoutElement
virtual int	calculateAutoMargin (QCP::MarginSide side)

virtual void	draw (QCPPainter *painter) Q_DECL_OVERRIDE

virtual void	layoutChanged ()

virtual void	parentPlotInitialized (QCustomPlot *parentPlot) Q_DECL_OVERRIDE

Protected Member Functions inherited from QCPLayerable
void	applyAntialiasingHint (QCPPainter *painter, bool localAntialiased, QCP::AntialiasedElement overrideElement) const

virtual QRect	clipRect () const

virtual void	deselectEvent (bool *selectionStateChanged)

void	initializeParentPlot (QCustomPlot *parentPlot)

virtual void	mouseDoubleClickEvent (QMouseEvent *event, const QVariant &details)

bool	moveToLayer (QCPLayer *layer, bool prepend)

virtual void	selectEvent (QMouseEvent event, bool additive, const QVariant &details, bool selectionStateChanged)

virtual QCP::Interaction	selectionCategory () const

void	setParentLayerable (QCPLayerable *parentLayerable)

Protected Attributes
QPointer< QCPColorScaleAxisRectPrivate >	mAxisRect

int	mBarWidth

QPointer< QCPAxis >	mColorAxis

QCPRange	mDataRange

QCPAxis::ScaleType	mDataScaleType

QCPColorGradient	mGradient

QCPAxis::AxisType	mType

Protected Attributes inherited from QCPLayoutElement
QCP::MarginSides	mAutoMargins

QHash< QCP::MarginSide, QCPMarginGroup * >	mMarginGroups

QMargins	mMargins

QSize	mMaximumSize

QMargins	mMinimumMargins

QSize	mMinimumSize

QRect	mOuterRect

QCPLayout *	mParentLayout

QRect	mRect

SizeConstraintRect	mSizeConstraintRect

Protected Attributes inherited from QCPLayerable
bool	mAntialiased

QCPLayer *	mLayer

QPointer< QCPLayerable >	mParentLayerable

QCustomPlot *	mParentPlot

bool	mVisible

Friends
class	QCPColorScaleAxisRectPrivate

Additional Inherited Members
Public Types inherited from QCPLayoutElement
enum	SizeConstraintRect { scrInnerRect, scrOuterRect }

enum	UpdatePhase { upPreparation, upMargins, upLayout }

Detailed Description

A color scale for use with color coding data such as QCPColorMap.

This layout element can be placed on the plot to correlate a color gradient with data values. It is usually used in combination with one or multiple QCPColorMaps.

The color scale can be either horizontal or vertical, as shown in the image above. The orientation and the side where the numbers appear is controlled with setType.

Use QCPColorMap::setColorScale to connect a color map with a color scale. Once they are connected, they share their gradient, data range and data scale type (setGradient, setDataRange, setDataScaleType). Multiple color maps may be associated with a single color scale, to make them all synchronize these properties.

To have finer control over the number display and axis behaviour, you can directly access the axis. See the documentation of QCPAxis for details about configuring axes. For example, if you want to change the number of automatically generated ticks, call

Placing a color scale next to the main axis rect works like with any other layout element:

In this case we have placed it to the right of the default axis rect, so it wasn't necessary to call setType, since QCPAxis::atRight is already the default. The text next to the color scale can be set with setLabel.

For optimum appearance (like in the image above), it may be desirable to line up the axis rect and the borders of the color scale. Use a QCPMarginGroup to achieve this:

Color scales are initialized with a non-zero minimum top and bottom margin (setMinimumMargins), because vertical color scales are most common and the minimum top/bottom margin makes sure it keeps some distance to the top/bottom widget border. So if you change to a horizontal color scale by setting setType to QCPAxis::atBottom or QCPAxis::atTop, you might want to also change the minimum margins accordingly, e.g. setMinimumMargins(QMargins(6, 0, 6, 0)).

Definition at line 5049 of file qcustomplot.h.

Constructor & Destructor Documentation

◆ QCPColorScale()

QCPColorScale::QCPColorScale ( QCustomPlot * parentPlot )

explicit

Constructs a new QCPColorScale.

Definition at line 19371 of file qcustomplot.cpp.

◆ ~QCPColorScale()

QCPColorScale::~QCPColorScale ( )

virtual

Definition at line 19383 of file qcustomplot.cpp.

Member Function Documentation

◆ applyDefaultAntialiasingHint()

void QCPColorScale::applyDefaultAntialiasingHint ( QCPPainter * painter ) const

protectedvirtual

Reimplemented from QCPLayoutElement.

Definition at line 19731 of file qcustomplot.cpp.

◆ axis()

QCPAxis * QCPColorScale::axis ( ) const

inline

Returns the internal QCPAxis instance of this color scale. You can access it to alter the appearance and behaviour of the axis. QCPColorScale duplicates some properties in its interface for convenience. Those are setDataRange (QCPAxis::setRange), setDataScaleType (QCPAxis::setScaleType), and the method setLabel (QCPAxis::setLabel). As they each are connected, it does not matter whether you use the method on the QCPColorScale or on its QCPAxis.

If the type of the color scale is changed with setType, the axis returned by this method will change, too, to either the left, right, bottom or top axis, depending on which type was set.

Definition at line 5067 of file qcustomplot.h.

◆ barWidth()

int QCPColorScale::barWidth ( ) const

inline

Definition at line 5073 of file qcustomplot.h.

◆ colorMaps()

QList< QCPColorMap * > QCPColorScale::colorMaps ( ) const

Returns a list of all the color maps associated with this color scale.

Definition at line 19617 of file qcustomplot.cpp.

◆ dataRange()

QCPRange QCPColorScale::dataRange ( ) const

inline

Definition at line 5069 of file qcustomplot.h.

◆ dataRangeChanged

void QCPColorScale::dataRangeChanged ( const QCPRange & newRange )

signal

This signal is emitted when the data range changes.

See also: setDataRange

◆ dataScaleType()

QCPAxis::ScaleType QCPColorScale::dataScaleType ( ) const

inline

Definition at line 5070 of file qcustomplot.h.

◆ dataScaleTypeChanged

void QCPColorScale::dataScaleTypeChanged ( QCPAxis::ScaleType scaleType )

signal

This signal is emitted when the data scale type changes.

See also: setDataScaleType

◆ gradient()

QCPColorGradient QCPColorScale::gradient ( ) const

inline

Definition at line 5071 of file qcustomplot.h.

◆ gradientChanged

void QCPColorScale::gradientChanged ( const QCPColorGradient & newGradient )

signal

This signal is emitted when the gradient changes.

See also: setGradient

◆ label()

QString QCPColorScale::label ( ) const

Definition at line 19389 of file qcustomplot.cpp.

◆ mouseMoveEvent()

void QCPColorScale::mouseMoveEvent	(	QMouseEvent *	event,
		const QPointF &	startPos
	)

protectedvirtual

This event gets called when the user moves the mouse while holding a mouse button, after this layerable has become the mouse grabber by accepting the preceding mousePressEvent.

The current pixel position of the cursor on the QCustomPlot widget is accessible via event->pos(). The parameter startPos indicates the position where the initial mousePressEvent occured, that started the mouse interaction.

The default implementation does nothing.

See also: mousePressEvent, mouseReleaseEvent, mouseDoubleClickEvent, wheelEvent

Reimplemented from QCPLayerable.

Definition at line 19748 of file qcustomplot.cpp.

◆ mousePressEvent()

void QCPColorScale::mousePressEvent	(	QMouseEvent *	event,
		const QVariant &	details
	)

protectedvirtual

This event gets called when the user presses a mouse button while the cursor is over the layerable. Whether a cursor is over the layerable is decided by a preceding call to selectTest.

The current pixel position of the cursor on the QCustomPlot widget is accessible via event->pos(). The parameter details contains layerable-specific details about the hit, which were generated in the previous call to selectTest. For example, One-dimensional plottables like QCPGraph or QCPBars convey the clicked data point in the details parameter, as QCPDataSelection packed as QVariant. Multi-part objects convey the specific SelectablePart that was hit (e.g. QCPAxis::SelectablePart in the case of axes).

QCustomPlot uses an event propagation system that works the same as Qt's system. If your layerable doesn't reimplement the mousePressEvent or explicitly calls event->ignore() in its reimplementation, the event will be propagated to the next layerable in the stacking order.

Once a layerable has accepted the mousePressEvent, it is considered the mouse grabber and will receive all following calls to mouseMoveEvent or mouseReleaseEvent for this mouse interaction (a "mouse interaction" in this context ends with the release).

The default implementation does nothing except explicitly ignoring the event with event->ignore().

See also: mouseMoveEvent, mouseReleaseEvent, mouseDoubleClickEvent, wheelEvent

Reimplemented from QCPLayerable.

Definition at line 19737 of file qcustomplot.cpp.

◆ mouseReleaseEvent()

void QCPColorScale::mouseReleaseEvent	(	QMouseEvent *	event,
		const QPointF &	startPos
	)

protectedvirtual

This event gets called when the user releases the mouse button, after this layerable has become the mouse grabber by accepting the preceding mousePressEvent.

The current pixel position of the cursor on the QCustomPlot widget is accessible via event->pos(). The parameter startPos indicates the position where the initial mousePressEvent occured, that started the mouse interaction.

The default implementation does nothing.

See also: mousePressEvent, mouseMoveEvent, mouseDoubleClickEvent, wheelEvent

Reimplemented from QCPLayerable.

Definition at line 19759 of file qcustomplot.cpp.

◆ rangeDrag()

bool QCPColorScale::rangeDrag ( ) const

Definition at line 19401 of file qcustomplot.cpp.

◆ rangeZoom()

bool QCPColorScale::rangeZoom ( ) const

Definition at line 19415 of file qcustomplot.cpp.

◆ rescaleDataRange()

void QCPColorScale::rescaleDataRange ( bool onlyVisibleMaps )

Changes the data range such that all color maps associated with this color scale are fully mapped to the gradient in the data dimension.

See also: setDataRange

Definition at line 19635 of file qcustomplot.cpp.

◆ setBarWidth()

void QCPColorScale::setBarWidth ( int width )

Sets the width (or height, for horizontal color scales) the bar where the gradient is displayed will have.

Definition at line 19569 of file qcustomplot.cpp.

◆ setDataRange()

void QCPColorScale::setDataRange ( const QCPRange & dataRange )

Sets the range spanned by the color gradient and that is shown by the axis in the color scale.

It is equivalent to calling QCPColorMap::setDataRange on any of the connected color maps. It is also equivalent to directly accessing the axis and setting its range with QCPAxis::setRange.

See also: setDataScaleType, setGradient, rescaleDataRange

Definition at line 19489 of file qcustomplot.cpp.

◆ setDataScaleType()

void QCPColorScale::setDataScaleType ( QCPAxis::ScaleType scaleType )

Sets the scale type of the color scale, i.e. whether values are associated with colors linearly or logarithmically.

It is equivalent to calling QCPColorMap::setDataScaleType on any of the connected color maps. It is also equivalent to directly accessing the axis and setting its scale type with QCPAxis::setScaleType.

Note that this method controls the coordinate transformation. For logarithmic scales, you will likely also want to use a logarithmic tick spacing and labeling, which can be achieved by setting the color scale's axis ticker to an instance of QCPAxisTickerLog :

See the documentation of QCPAxisTickerLog about the details of logarithmic axis tick creation.

See also: setDataRange, setGradient

Definition at line 19519 of file qcustomplot.cpp.

◆ setGradient()

void QCPColorScale::setGradient ( const QCPColorGradient & gradient )

Sets the color gradient that will be used to represent data values.

It is equivalent to calling QCPColorMap::setGradient on any of the connected color maps.

See also: setDataRange, setDataScaleType

Definition at line 19539 of file qcustomplot.cpp.

◆ setLabel()

void QCPColorScale::setLabel ( const QString & str )

Sets the axis label of the color scale. This is equivalent to calling QCPAxis::setLabel on the internal axis.

Definition at line 19554 of file qcustomplot.cpp.

◆ setRangeDrag()

void QCPColorScale::setRangeDrag ( bool enabled )

Sets whether the user can drag the data range (setDataRange).

Note that QCP::iRangeDrag must be in the QCustomPlot's interactions (QCustomPlot::setInteractions) to allow range dragging.

Definition at line 19580 of file qcustomplot.cpp.

◆ setRangeZoom()

void QCPColorScale::setRangeZoom ( bool enabled )

Sets whether the user can zoom the data range (setDataRange) by scrolling the mouse wheel.

Note that QCP::iRangeZoom must be in the QCustomPlot's interactions (QCustomPlot::setInteractions) to allow range dragging.

Definition at line 19600 of file qcustomplot.cpp.

◆ setType()

void QCPColorScale::setType ( QCPAxis::AxisType type )

Sets at which side of the color scale the axis is placed, and thus also its orientation.

Note that after setting type to a different value, the axis returned by axis() will be a different one. The new axis will adopt the following properties from the previous axis: The range, scale type, label and ticker (the latter will be shared and not copied).

Definition at line 19435 of file qcustomplot.cpp.

◆ type()

QCPAxis::AxisType QCPColorScale::type ( ) const

inline

Definition at line 5068 of file qcustomplot.h.

◆ update()

void QCPColorScale::update ( UpdatePhase phase )

virtual

Updates the layout element and sub-elements. This function is automatically called before every replot by the parent layout element. It is called multiple times, once for every UpdatePhase. The phases are run through in the order of the enum values. For details about what happens at the different phases, see the documentation of UpdatePhase.

Layout elements that have child elements should call the update method of their child elements, and pass the current phase unchanged.

The default implementation executes the automatic margin mechanism in the upMargins phase. Subclasses should make sure to call the base class implementation.

Reimplemented from QCPLayoutElement.

Definition at line 19695 of file qcustomplot.cpp.

◆ wheelEvent()

void QCPColorScale::wheelEvent ( QWheelEvent * event )

protectedvirtual

This event gets called when the user turns the mouse scroll wheel while the cursor is over the layerable. Whether a cursor is over the layerable is decided by a preceding call to selectTest.

The current pixel position of the cursor on the QCustomPlot widget is accessible via event->pos().

The event->delta() indicates how far the mouse wheel was turned, which is usually +/- 120 for single rotation steps. However, if the mouse wheel is turned rapidly, multiple steps may accumulate to one event, making event->delta() larger. On the other hand, if the wheel has very smooth steps or none at all, the delta may be smaller.

The default implementation does nothing.

See also: mousePressEvent, mouseMoveEvent, mouseReleaseEvent, mouseDoubleClickEvent

Reimplemented from QCPLayerable.

Definition at line 19770 of file qcustomplot.cpp.

Friends And Related Function Documentation

◆ QCPColorScaleAxisRectPrivate

friend class QCPColorScaleAxisRectPrivate

friend

Definition at line 5122 of file qcustomplot.h.

Member Data Documentation

◆ mAxisRect

QPointer<QCPColorScaleAxisRectPrivate> QCPColorScale::mAxisRect

protected

Definition at line 5108 of file qcustomplot.h.

◆ mBarWidth

int QCPColorScale::mBarWidth

protected

Definition at line 5105 of file qcustomplot.h.

◆ mColorAxis

QPointer<QCPAxis> QCPColorScale::mColorAxis

protected

Definition at line 5109 of file qcustomplot.h.

◆ mDataRange

QCPRange QCPColorScale::mDataRange

protected

Definition at line 5102 of file qcustomplot.h.

◆ mDataScaleType

QCPAxis::ScaleType QCPColorScale::mDataScaleType

protected

Definition at line 5103 of file qcustomplot.h.

◆ mGradient

QCPColorGradient QCPColorScale::mGradient

protected

Definition at line 5104 of file qcustomplot.h.

◆ mType

QCPAxis::AxisType QCPColorScale::mType

protected

Definition at line 5101 of file qcustomplot.h.

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

Signals

Public Member Functions

Protected Member Functions

Protected Attributes

Friends

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ QCPColorScale()

◆ ~QCPColorScale()

Member Function Documentation

◆ applyDefaultAntialiasingHint()

◆ axis()

◆ barWidth()

◆ colorMaps()

◆ dataRange()

◆ dataRangeChanged

◆ dataScaleType()

◆ dataScaleTypeChanged

◆ gradient()

◆ gradientChanged

◆ label()

◆ mouseMoveEvent()

◆ mousePressEvent()

◆ mouseReleaseEvent()

◆ rangeDrag()

◆ rangeZoom()

◆ rescaleDataRange()

◆ setBarWidth()

◆ setDataRange()

◆ setDataScaleType()

◆ setGradient()

◆ setLabel()

◆ setRangeDrag()

◆ setRangeZoom()

◆ setType()

◆ type()

◆ update()

◆ wheelEvent()

Friends And Related Function Documentation

◆ QCPColorScaleAxisRectPrivate

Member Data Documentation

◆ mAxisRect

◆ mBarWidth

◆ mColorAxis

◆ mDataRange

◆ mDataScaleType

◆ mGradient

◆ mType