QCPAxis Class Reference

Inheritance diagram for QCPAxis:

Public Types
enum	AxisType { atLeft = 0x01 , atRight = 0x02 , atTop = 0x04 , atBottom = 0x08 }
typedef QFlags< AxisType >	AxisTypes
enum	LabelSide { lsInside , lsOutside }
enum	ScaleType { stLinear , stLogarithmic }
enum	SelectablePart { spNone = 0 , spAxis = 0x001 , spTickLabels = 0x002 , spAxisLabel = 0x004 }
typedef QFlags< SelectablePart >	SelectableParts

Signals
void	rangeChanged (const QCPRange &newRange)
void	rangeChanged (const QCPRange &newRange, const QCPRange &oldRange)
void	scaleTypeChanged (QCPAxis::ScaleType scaleType)
void	selectableChanged (const QCPAxis::SelectableParts &parts)
void	selectionChanged (const QCPAxis::SelectableParts &parts)
Signals inherited from QCPLayerable
void	layerChanged (QCPLayer *newLayer)

Public Member Functions
	QCPAxis (QCPAxisRect *parent, AxisType type)
QCPAxisRect *	axisRect () const
AxisType	axisType () const
QPen	basePen () const
double	coordToPixel (double value) const
SelectablePart	getPartAt (const QPointF &pos) const
QList< QCPGraph * >	graphs () const
QCPGrid *	grid () const
QList< QCPAbstractItem * >	items () const
QString	label () const
QColor	labelColor () const
QFont	labelFont () const
int	labelPadding () const
QCPLineEnding	lowerEnding () const
void	moveRange (double diff)
QString	numberFormat () const
int	numberPrecision () const
int	offset () const
Qt::Orientation	orientation () const
int	padding () const
int	pixelOrientation () const
double	pixelToCoord (double value) const
QList< QCPAbstractPlottable * >	plottables () const
const QCPRange	range () const
bool	rangeReversed () const
void	rescale (bool onlyVisiblePlottables=false)
void	scaleRange (double factor)
void	scaleRange (double factor, double center)
ScaleType	scaleType () const
SelectableParts	selectableParts () const
QPen	selectedBasePen () const
QColor	selectedLabelColor () const
QFont	selectedLabelFont () const
SelectableParts	selectedParts () const
QPen	selectedSubTickPen () const
QColor	selectedTickLabelColor () const
QFont	selectedTickLabelFont () const
QPen	selectedTickPen () const
virtual double	selectTest (const QPointF &pos, bool onlySelectable, QVariant *details=nullptr) const override
void	setBasePen (const QPen &pen)
void	setLabel (const QString &str)
void	setLabelColor (const QColor &color)
void	setLabelFont (const QFont &font)
void	setLabelPadding (int padding)
void	setLowerEnding (const QCPLineEnding &ending)
void	setNumberFormat (const QString &formatCode)
void	setNumberPrecision (int precision)
void	setOffset (int offset)
void	setPadding (int padding)
Q_SLOT void	setRange (const QCPRange &range)
void	setRange (double lower, double upper)
void	setRange (double position, double size, Qt::AlignmentFlag alignment)
void	setRangeLower (double lower)
void	setRangeReversed (bool reversed)
void	setRangeUpper (double upper)
void	setScaleRatio (const QCPAxis *otherAxis, double ratio=1.0)
Q_SLOT void	setScaleType (QCPAxis::ScaleType type)
Q_SLOT void	setSelectableParts (const QCPAxis::SelectableParts &selectableParts)
void	setSelectedBasePen (const QPen &pen)
void	setSelectedLabelColor (const QColor &color)
void	setSelectedLabelFont (const QFont &font)
Q_SLOT void	setSelectedParts (const QCPAxis::SelectableParts &selectedParts)
void	setSelectedSubTickPen (const QPen &pen)
void	setSelectedTickLabelColor (const QColor &color)
void	setSelectedTickLabelFont (const QFont &font)
void	setSelectedTickPen (const QPen &pen)
void	setSubTickLength (int inside, int outside=0)
void	setSubTickLengthIn (int inside)
void	setSubTickLengthOut (int outside)
void	setSubTickPen (const QPen &pen)
void	setSubTicks (bool show)
void	setTicker (QSharedPointer< QCPAxisTicker > ticker)
void	setTickLabelColor (const QColor &color)
void	setTickLabelFont (const QFont &font)
void	setTickLabelPadding (int padding)
void	setTickLabelRotation (double degrees)
void	setTickLabels (bool show)
void	setTickLabelSide (LabelSide side)
void	setTickLength (int inside, int outside=0)
void	setTickLengthIn (int inside)
void	setTickLengthOut (int outside)
void	setTickPen (const QPen &pen)
void	setTicks (bool show)
void	setUpperEnding (const QCPLineEnding &ending)
int	subTickLengthIn () const
int	subTickLengthOut () const
QPen	subTickPen () const
bool	subTicks () const
QSharedPointer< QCPAxisTicker >	ticker () const
QColor	tickLabelColor () const
QFont	tickLabelFont () const
int	tickLabelPadding () const
double	tickLabelRotation () const
bool	tickLabels () const
LabelSide	tickLabelSide () const
int	tickLengthIn () const
int	tickLengthOut () const
QPen	tickPen () const
bool	ticks () const
QVector< double >	tickVector () const
QVector< QString >	tickVectorLabels () const
QCPLineEnding	upperEnding () const
Public Member Functions inherited from QCPLayerable
	QCPLayerable (QCustomPlot *plot, QString targetLayer=QString(), QCPLayerable *parentLayerable=nullptr)
bool	antialiased () const
QCPLayer *	layer () const
QCPLayerable *	parentLayerable () const
QCustomPlot *	parentPlot () const
bool	realVisibility () const
void	setAntialiased (bool enabled)
bool	setLayer (const QString &layerName)
Q_SLOT bool	setLayer (QCPLayer *layer)
void	setVisible (bool on)
bool	visible () const
Public Member Functions inherited from QObject
	QObject (QObject *parent)
QBindable< QString >	bindableObjectName ()
bool	blockSignals (bool block)
const QObjectList &	children () const const
QMetaObject::Connection	connect (const QObject *sender, const char *signal, const char *method, Qt::ConnectionType type) const const
void	deleteLater ()
void	destroyed (QObject *obj)
bool	disconnect (const char *signal, const QObject *receiver, const char *method) const const
bool	disconnect (const QObject *receiver, const char *method) const const
void	dumpObjectInfo () const const
void	dumpObjectTree () const const
QList< QByteArray >	dynamicPropertyNames () const const
virtual bool	event (QEvent *e)
virtual bool	eventFilter (QObject *watched, QEvent *event)
T	findChild (const QString &name, Qt::FindChildOptions options) const const
QList< T >	findChildren (const QRegularExpression &re, Qt::FindChildOptions options) const const
QList< T >	findChildren (const QString &name, Qt::FindChildOptions options) const const
QList< T >	findChildren (Qt::FindChildOptions options) const const
bool	inherits (const char *className) const const
void	installEventFilter (QObject *filterObj)
bool	isQuickItemType () const const
bool	isWidgetType () const const
bool	isWindowType () const const
void	killTimer (int id)
virtual const QMetaObject *	metaObject () const const
void	moveToThread (QThread *targetThread)
QString	objectName () const const
void	objectNameChanged (const QString &objectName)
QObject *	parent () const const
QVariant	property (const char *name) const const
	Q_CLASSINFO (Name, Value)
	Q_EMIT Q_EMIT
	Q_ENUM (...)
	Q_ENUM_NS (...)
	Q_ENUMS (...)
	Q_FLAG (...)
	Q_FLAG_NS (...)
	Q_FLAGS (...)
	Q_GADGET Q_GADGET
	Q_GADGET_EXPORT (EXPORT_MACRO)
	Q_INTERFACES (...)
	Q_INVOKABLE Q_INVOKABLE
	Q_MOC_INCLUDE Q_MOC_INCLUDE
	Q_NAMESPACE Q_NAMESPACE
	Q_NAMESPACE_EXPORT (EXPORT_MACRO)
	Q_OBJECT Q_OBJECT
	Q_PROPERTY (...)
	Q_REVISION Q_REVISION
	Q_SET_OBJECT_NAME (Object)
	Q_SIGNAL Q_SIGNAL
	Q_SIGNALS Q_SIGNALS
	Q_SLOT Q_SLOT
	Q_SLOTS Q_SLOTS
T	qobject_cast (const QObject *object)
T	qobject_cast (QObject *object)
	QT_NO_NARROWING_CONVERSIONS_IN_CONNECT QT_NO_NARROWING_CONVERSIONS_IN_CONNECT
void	removeEventFilter (QObject *obj)
void	setObjectName (const QString &name)
void	setObjectName (QAnyStringView name)
void	setParent (QObject *parent)
bool	setProperty (const char *name, const QVariant &value)
bool	setProperty (const char *name, QVariant &&value)
bool	signalsBlocked () const const
int	startTimer (int interval, Qt::TimerType timerType)
int	startTimer (std::chrono::milliseconds interval, Qt::TimerType timerType)
QThread *	thread () const const

Static Public Member Functions
static AxisType	marginSideToAxisType (QCP::MarginSide side)
static AxisType	opposite (AxisType type)
static Qt::Orientation	orientation (AxisType type)
Static Public Member Functions inherited from QObject
QMetaObject::Connection	connect (const QObject *sender, const char *signal, const QObject *receiver, const char *method, Qt::ConnectionType type)
QMetaObject::Connection	connect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &method, Qt::ConnectionType type)
QMetaObject::Connection	connect (const QObject *sender, PointerToMemberFunction signal, const QObject *context, Functor functor, Qt::ConnectionType type)
QMetaObject::Connection	connect (const QObject *sender, PointerToMemberFunction signal, const QObject *receiver, PointerToMemberFunction method, Qt::ConnectionType type)
QMetaObject::Connection	connect (const QObject *sender, PointerToMemberFunction signal, Functor functor)
bool	disconnect (const QMetaObject::Connection &connection)
bool	disconnect (const QObject *sender, const char *signal, const QObject *receiver, const char *method)
bool	disconnect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &method)
bool	disconnect (const QObject *sender, PointerToMemberFunction signal, const QObject *receiver, PointerToMemberFunction method)
QString	tr (const char *sourceText, const char *disambiguation, int n)

Protected Member Functions
virtual void	applyDefaultAntialiasingHint (QCPPainter *painter) const override
virtual int	calculateMargin ()
virtual void	deselectEvent (bool *selectionStateChanged) override
virtual void	draw (QCPPainter *painter) override
QPen	getBasePen () const
QColor	getLabelColor () const
QFont	getLabelFont () const
QPen	getSubTickPen () const
QColor	getTickLabelColor () const
QFont	getTickLabelFont () const
QPen	getTickPen () const
virtual void	mouseMoveEvent (QMouseEvent *event, const QPointF &startPos) override
virtual void	mousePressEvent (QMouseEvent *event, const QVariant &details) override
virtual void	mouseReleaseEvent (QMouseEvent *event, const QPointF &startPos) override
virtual void	selectEvent (QMouseEvent *event, bool additive, const QVariant &details, bool *selectionStateChanged) override
virtual QCP::Interaction	selectionCategory () const override
void	setupTickVectors ()
virtual void	wheelEvent (QWheelEvent *event) override
Protected Member Functions inherited from QCPLayerable
void	applyAntialiasingHint (QCPPainter *painter, bool localAntialiased, QCP::AntialiasedElement overrideElement) const
virtual QRect	clipRect () const
void	initializeParentPlot (QCustomPlot *parentPlot)
virtual void	mouseDoubleClickEvent (QMouseEvent *event, const QVariant &details)
bool	moveToLayer (QCPLayer *layer, bool prepend)
virtual void	parentPlotInitialized (QCustomPlot *parentPlot)
void	setParentLayerable (QCPLayerable *parentLayerable)
Protected Member Functions inherited from QObject
virtual void	childEvent (QChildEvent *event)
virtual void	connectNotify (const QMetaMethod &signal)
virtual void	customEvent (QEvent *event)
virtual void	disconnectNotify (const QMetaMethod &signal)
bool	isSignalConnected (const QMetaMethod &signal) const const
int	receivers (const char *signal) const const
QObject *	sender () const const
int	senderSignalIndex () const const
virtual void	timerEvent (QTimerEvent *event)

Protected Attributes
QCP::AntialiasedElements	mAADragBackup
QCPAxisPainterPrivate *	mAxisPainter
QCPAxisRect *	mAxisRect
AxisType	mAxisType
QPen	mBasePen
int	mCachedMargin
bool	mCachedMarginValid
bool	mDragging
QCPRange	mDragStartRange
QCPGrid *	mGrid
QString	mLabel
QColor	mLabelColor
QFont	mLabelFont
QCP::AntialiasedElements	mNotAADragBackup
bool	mNumberBeautifulPowers
QLatin1Char	mNumberFormatChar
int	mNumberPrecision
Qt::Orientation	mOrientation
int	mPadding
QCPRange	mRange
bool	mRangeReversed
ScaleType	mScaleType
SelectableParts	mSelectableParts
QPen	mSelectedBasePen
QColor	mSelectedLabelColor
QFont	mSelectedLabelFont
SelectableParts	mSelectedParts
QPen	mSelectedSubTickPen
QColor	mSelectedTickLabelColor
QFont	mSelectedTickLabelFont
QPen	mSelectedTickPen
QPen	mSubTickPen
bool	mSubTicks
QVector< double >	mSubTickVector
QSharedPointer< QCPAxisTicker >	mTicker
QColor	mTickLabelColor
QFont	mTickLabelFont
bool	mTickLabels
QPen	mTickPen
bool	mTicks
QVector< double >	mTickVector
QVector< QString >	mTickVectorLabels
Protected Attributes inherited from QCPLayerable
bool	mAntialiased
QCPLayer *	mLayer
QPointer< QCPLayerable >	mParentLayerable
QCustomPlot *	mParentPlot
bool	mVisible

Additional Inherited Members
Properties inherited from QObject
	objectName
Public Attributes inherited from QObject
typedef	QObjectList

Detailed Description

Manages a single axis inside a QCustomPlot.

Usually doesn't need to be instantiated externally. Access QCustomPlot's default four axes via QCustomPlot::xAxis (bottom), QCustomPlot::yAxis (left), QCustomPlot::xAxis2 (top) and QCustomPlot::yAxis2 (right).

Axes are always part of an axis rect, see QCPAxisRect.

Naming convention of axis parts

Overview of the spacings and paddings that define the geometry of an axis. The dashed gray line on the left represents the QCustomPlot widget border.

Each axis holds an instance of QCPAxisTicker which is used to generate the tick coordinates and tick labels. You can access the currently installed ticker or set a new one (possibly one of the specialized subclasses, or your own subclass) via setTicker. For details, see the documentation of QCPAxisTicker.

Definition at line 2063 of file qcustomplot.h.

Member Typedef Documentation

AxisTypes

typedef QFlags< AxisType > QCPAxis::AxisTypes

Definition at line 2123 of file qcustomplot.h.

SelectableParts

typedef QFlags< SelectablePart > QCPAxis::SelectableParts

Definition at line 2152 of file qcustomplot.h.

Member Enumeration Documentation

AxisType

enum QCPAxis::AxisType

Defines at which side of the axis rect the axis will appear. This also affects how the tick marks are drawn, on which side the labels are placed etc.

Enumerator
atLeft	0x01 Axis is vertical and on the left side of the axis rect
atRight	0x02 Axis is vertical and on the right side of the axis rect
atTop	0x04 Axis is horizontal and on the top side of the axis rect
atBottom	0x08 Axis is horizontal and on the bottom side of the axis rect

Definition at line 2116 of file qcustomplot.h.

LabelSide

enum QCPAxis::LabelSide

Defines on which side of the axis the tick labels (numbers) shall appear.

See also

setTickLabelSide

Enumerator
lsInside	Tick labels will be displayed inside the axis rect and clipped to the inner axis rect.
lsOutside	Tick labels will be displayed outside the axis rect.

Definition at line 2129 of file qcustomplot.h.

ScaleType

enum QCPAxis::ScaleType

Defines the scale of an axis.

See also

setScaleType

Enumerator
stLinear	Linear scaling.
stLogarithmic	Logarithmic scaling with correspondingly transformed axis coordinates (possibly also setTicker to a QCPAxisTickerLog instance).

Definition at line 2137 of file qcustomplot.h.

SelectablePart

enum QCPAxis::SelectablePart

Defines the selectable parts of an axis.

See also

setSelectableParts, setSelectedParts

Enumerator
spNone	None of the selectable parts.
spAxis	The axis backbone and tick marks.
spTickLabels	Tick labels (numbers) of this axis (as a whole, not individually)
spAxisLabel	The axis label.

Definition at line 2145 of file qcustomplot.h.

Constructor & Destructor Documentation

QCPAxis()

QCPAxis::QCPAxis ( QCPAxisRect * parent, AxisType type )

explicit

Constructs an Axis instance of Type type for the axis rect parent.

Usually it isn't necessary to instantiate axes directly, because you can let QCustomPlot create them for you with QCPAxisRect::addAxis. If you want to use own QCPAxis-subclasses however, create them manually and then inject them also via QCPAxisRect::addAxis.

Definition at line 8184 of file qcustomplot.cpp.

~QCPAxis()

QCPAxis::~QCPAxis ( )

overridevirtual

Definition at line 8253 of file qcustomplot.cpp.

Member Function Documentation

applyDefaultAntialiasingHint()

void QCPAxis::applyDefaultAntialiasingHint ( QCPPainter * painter ) const

overrideprotectedvirtual

A convenience function to easily set the QPainter::Antialiased hint on the provided painter before drawing axis lines.

This is the antialiasing state the painter passed to the draw method is in by default.

This function takes into account the local setting of the antialiasing flag as well as the overrides set with QCustomPlot::setAntialiasedElements and QCustomPlot::setNotAntialiasedElements.

\seebaseclassmethod

See also

setAntialiased

Implements QCPLayerable.

Definition at line 9651 of file qcustomplot.cpp.

axisRect()

QCPAxisRect * QCPAxis::axisRect ( ) const

inline

Definition at line 2159 of file qcustomplot.h.

axisType()

AxisType QCPAxis::axisType ( ) const

inline

Definition at line 2158 of file qcustomplot.h.

basePen()

QPen QCPAxis::basePen ( ) const

inline

Definition at line 2180 of file qcustomplot.h.

calculateMargin()

int QCPAxis::calculateMargin ( )

protectedvirtual

Returns the appropriate outward margin for this axis. It is needed if QCPAxisRect::setAutoMargins is set to true on the parent axis rect. An axis with axis type atLeft will return an appropriate left margin, atBottom will return an appropriate bottom margin and so forth. For the calculation, this function goes through similar steps as draw, so changing one function likely requires the modification of the other one as well.

The margin consists of the outward tick length, tick label padding, tick label size, label padding, label size, and padding.

The margin is cached internally, so repeated calls while leaving the axis range, fonts, etc. unchanged are very fast.

Definition at line 9812 of file qcustomplot.cpp.

coordToPixel()

double QCPAxis::coordToPixel

(

double

value

)

const

Transforms value, in coordinates of the axis, to pixel coordinates of the QCustomPlot widget.

Definition at line 9287 of file qcustomplot.cpp.

deselectEvent()

void QCPAxis::deselectEvent ( bool * selectionStateChanged )

overrideprotectedvirtual

This event is called when the layerable shall be deselected, either as consequence of a user interaction or a call to QCustomPlot::deselectAll. Subclasses should react to it by unsetting their selection appropriately.

just as in selectEvent, the output parameter selectionStateChanged (if non-null), must return true or false when the selection state of this layerable has changed or not changed, respectively.

See also

selectTest, selectEvent

Reimplemented from QCPLayerable.

Definition at line 9485 of file qcustomplot.cpp.

draw()

void QCPAxis::draw ( QCPPainter * painter )

overrideprotectedvirtual

Draws the axis with the specified painter, using the internal QCPAxisPainterPrivate instance.

\seebaseclassmethod

Implements QCPLayerable.

Definition at line 9662 of file qcustomplot.cpp.

getBasePen()

QPen QCPAxis::getBasePen ( ) const

protected

Returns the pen that is used to draw the axis base line. Depending on the selection state, this is either mSelectedBasePen or mBasePen.

Definition at line 9733 of file qcustomplot.cpp.

getLabelColor()

QColor QCPAxis::getLabelColor ( ) const

protected

Returns the color that is used to draw the axis label. Depending on the selection state, this is either mSelectedLabelColor or mLabelColor.

Definition at line 9793 of file qcustomplot.cpp.

getLabelFont()

QFont QCPAxis::getLabelFont ( ) const

protected

Returns the font that is used to draw the axis label. Depending on the selection state, this is either mSelectedLabelFont or mLabelFont.

Definition at line 9773 of file qcustomplot.cpp.

getPartAt()

QCPAxis::SelectablePart QCPAxis::getPartAt

(

const QPointF &

pos

)

const

Returns the part of the axis that is hit by pos (in pixels). The return value of this function is independent of the user-selectable parts defined with setSelectableParts. Further, this function does not change the current selection state of the axis.

If the axis is not visible (setVisible), this function always returns spNone.

See also

setSelectedParts, setSelectableParts, QCustomPlot::setInteractions

Definition at line 9345 of file qcustomplot.cpp.

getSubTickPen()

QPen QCPAxis::getSubTickPen ( ) const

protected

Returns the pen that is used to draw the subticks. Depending on the selection state, this is either mSelectedSubTickPen or mSubTickPen.

Definition at line 9753 of file qcustomplot.cpp.

getTickLabelColor()

QColor QCPAxis::getTickLabelColor ( ) const

protected

Returns the color that is used to draw the tick labels. Depending on the selection state, this is either mSelectedTickLabelColor or mTickLabelColor.

Definition at line 9783 of file qcustomplot.cpp.

getTickLabelFont()

QFont QCPAxis::getTickLabelFont ( ) const

protected

Returns the font that is used to draw the tick labels. Depending on the selection state, this is either mSelectedTickLabelFont or mTickLabelFont.

Definition at line 9763 of file qcustomplot.cpp.

getTickPen()

QPen QCPAxis::getTickPen ( ) const

protected

Returns the pen that is used to draw the (major) ticks. Depending on the selection state, this is either mSelectedTickPen or mTickPen.

Definition at line 9743 of file qcustomplot.cpp.

graphs()

QList< QCPGraph * > QCPAxis::graphs

(

)

const

Returns a list of all the graphs that have this axis as key or value axis.

See also

plottables, items

Definition at line 9398 of file qcustomplot.cpp.

grid()

QCPGrid * QCPAxis::grid ( ) const

inline

Returns the QCPGrid instance belonging to this axis. Access it to set details about the way the grid is displayed.

Definition at line 2200 of file qcustomplot.h.

items()

QList< QCPAbstractItem * > QCPAxis::items

(

)

const

Returns a list of all the items that are associated with this axis. An item is considered associated with an axis if at least one of its positions uses the axis as key or value axis.

See also

plottables, graphs

Definition at line 9417 of file qcustomplot.cpp.

label()

QString QCPAxis::label ( ) const

inline

Definition at line 2185 of file qcustomplot.h.

labelColor()

QColor QCPAxis::labelColor ( ) const

inline

Definition at line 2184 of file qcustomplot.h.

labelFont()

QFont QCPAxis::labelFont ( ) const

inline

Definition at line 2183 of file qcustomplot.h.

labelPadding()

int QCPAxis::labelPadding

(

)

const

Definition at line 8316 of file qcustomplot.cpp.

lowerEnding()

QCPLineEnding QCPAxis::lowerEnding

(

)

const

Definition at line 8328 of file qcustomplot.cpp.

marginSideToAxisType()

QCPAxis::AxisType QCPAxis::marginSideToAxisType ( QCP::MarginSide side )

static

Transforms a margin side to the logically corresponding axis type. (QCP::msLeft to QCPAxis::atLeft, QCP::msRight to QCPAxis::atRight, etc.)

Definition at line 9440 of file qcustomplot.cpp.

mouseMoveEvent()

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

overrideprotectedvirtual

This mouse event reimplementation provides the functionality to let the user drag individual axes exclusively, by startig the drag on top of the axis.

\seebaseclassmethod

Note

The dragging of possibly multiple axes at once by starting the drag anywhere in the axis rect is handled by the axis rect's mouse event, e.g. QCPAxisRect::mousePressEvent.

See also

QCPAxis::mousePressEvent

Reimplemented from QCPLayerable.

Definition at line 9546 of file qcustomplot.cpp.

mousePressEvent()

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

overrideprotectedvirtual

This mouse event reimplementation provides the functionality to let the user drag individual axes exclusively, by startig the drag on top of the axis.

For the axis to accept this event and perform the single axis drag, the parent QCPAxisRect must be configured accordingly, i.e. it must allow range dragging in the orientation of this axis (QCPAxisRect::setRangeDrag) and this axis must be a draggable axis (QCPAxisRect::setRangeDragAxes)

\seebaseclassmethod

Note

The dragging of possibly multiple axes at once by starting the drag anywhere in the axis rect is handled by the axis rect's mouse event, e.g. QCPAxisRect::mousePressEvent.

Reimplemented from QCPLayerable.

Definition at line 9508 of file qcustomplot.cpp.

mouseReleaseEvent()

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

overrideprotectedvirtual

This mouse event reimplementation provides the functionality to let the user drag individual axes exclusively, by startig the drag on top of the axis.

\seebaseclassmethod

Note

The dragging of possibly multiple axes at once by starting the drag anywhere in the axis rect is handled by the axis rect's mouse event, e.g. QCPAxisRect::mousePressEvent.

See also

QCPAxis::mousePressEvent

Reimplemented from QCPLayerable.

Definition at line 9580 of file qcustomplot.cpp.

moveRange()

void QCPAxis::moveRange

(

double

diff

)

If the scale type (setScaleType) is stLinear, diff is added to the lower and upper bounds of the range. The range is simply moved by diff.

If the scale type is stLogarithmic, the range bounds are multiplied by diff. This corresponds to an apparent "linear" move in logarithmic scaling by a distance of log(diff).

Definition at line 9099 of file qcustomplot.cpp.

numberFormat()

QString QCPAxis::numberFormat

(

)

const

Definition at line 8278 of file qcustomplot.cpp.

numberPrecision()

int QCPAxis::numberPrecision ( ) const

inline

Definition at line 2172 of file qcustomplot.h.

offset()

int QCPAxis::offset

(

)

const

Definition at line 8322 of file qcustomplot.cpp.

opposite()

QCPAxis::AxisType QCPAxis::opposite ( QCPAxis::AxisType type )

static

Returns the axis type that describes the opposite axis of an axis with the specified type.

Definition at line 9457 of file qcustomplot.cpp.

orientation() [1/2]

Qt::Orientation QCPAxis::orientation ( ) const

inline

Returns the orientation of this axis. The axis orientation (horizontal or vertical) is deduced from the axis type (left, top, right or bottom).

See also

orientation(AxisType type), pixelOrientation

Definition at line 2252 of file qcustomplot.h.

orientation() [2/2]

static Qt::Orientation QCPAxis::orientation ( AxisType type )

inlinestatic

Returns the orientation of the specified axis type

See also

orientation(), pixelOrientation

Definition at line 2267 of file qcustomplot.h.

padding()

int QCPAxis::padding ( ) const

inline

Definition at line 2187 of file qcustomplot.h.

pixelOrientation()

int QCPAxis::pixelOrientation ( ) const

inline

Returns which direction points towards higher coordinate values/keys, in pixel space.

This method returns either 1 or -1. If it returns 1, then going in the positive direction along the orientation of the axis in pixels corresponds to going from lower to higher axis coordinates. On the other hand, if this method returns -1, going to smaller pixel values corresponds to going from lower to higher axis coordinates.

For example, this is useful to easily shift axis coordinates by a certain amount given in pixels, without having to care about reversed or vertically aligned axes:

double newKey = keyAxis->pixelToCoord(keyAxis->coordToPixel(oldKey)+10*keyAxis->pixelOrientation());

newKey will then contain a key that is ten pixels towards higher keys, starting from oldKey.

Definition at line 2253 of file qcustomplot.h.

pixelToCoord()

double QCPAxis::pixelToCoord

(

double

value

)

const

Transforms value, in pixel coordinates of the QCustomPlot widget, to axis coordinates.

Definition at line 9249 of file qcustomplot.cpp.

plottables()

QList< QCPAbstractPlottable * > QCPAxis::plottables

(

)

const

Returns a list of all the plottables that have this axis as key or value axis.

If you are only interested in plottables of type QCPGraph, see graphs.

See also

graphs, items

Definition at line 9380 of file qcustomplot.cpp.

range()

const QCPRange QCPAxis::range ( ) const

inline

Definition at line 2161 of file qcustomplot.h.

rangeChanged [1/2]

void QCPAxis::rangeChanged ( const QCPRange & newRange )

signal

This signal is emitted when the range of this axis has changed. You can connect it to the setRange slot of another axis to communicate the new range to the other axis, in order for it to be synchronized.

You may also manipulate/correct the range with setRange in a slot connected to this signal. This is useful if for example a maximum range span shall not be exceeded, or if the lower/upper range shouldn't go beyond certain values (see QCPRange::bounded). For example, the following slot would limit the x axis to ranges between 0 and 10:

customPlot->xAxis->setRange(newRange.bounded(0, 10))

rangeChanged [2/2]

void QCPAxis::rangeChanged ( const QCPRange & newRange, const QCPRange & oldRange )

signal

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

Additionally to the new range, this signal also provides the previous range held by the axis as oldRange.

rangeReversed()

bool QCPAxis::rangeReversed ( ) const

inline

Definition at line 2162 of file qcustomplot.h.

rescale()

void QCPAxis::rescale

(

bool

onlyVisiblePlottables = false

)

Changes the axis range such that all plottables associated with this axis are fully visible in that dimension.

See also

QCPAbstractPlottable::rescaleAxes, QCustomPlot::rescaleAxes

Definition at line 9201 of file qcustomplot.cpp.

scaleRange() [1/2]

void QCPAxis::scaleRange

(

double

factor

)

Scales the range of this axis by factor around the center of the current axis range. For example, if factor is 2.0, then the axis range will double its size, and the point at the axis range center won't have changed its position in the QCustomPlot widget (i.e. coordinates around the center will have moved symmetrically closer).

If you wish to scale around a different coordinate than the current axis range center, use the overload scaleRange(double factor, double center).

Definition at line 9124 of file qcustomplot.cpp.

scaleRange() [2/2]

void QCPAxis::scaleRange	(	double	factor,
		double	center )

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

Scales the range of this axis by factor around the coordinate center. For example, if factor is 2.0, center is 1.0, then the axis range will double its size, and the point at coordinate 1.0 won't have changed its position in the QCustomPlot widget (i.e. coordinates around 1.0 will have moved symmetrically closer to 1.0).

See also

scaleRange(double factor)

Definition at line 9138 of file qcustomplot.cpp.

scaleType()

ScaleType QCPAxis::scaleType ( ) const

inline

Definition at line 2160 of file qcustomplot.h.

scaleTypeChanged

void QCPAxis::scaleTypeChanged ( QCPAxis::ScaleType scaleType )

signal

This signal is emitted when the scale type changes, by calls to setScaleType

selectableChanged

void QCPAxis::selectableChanged ( const QCPAxis::SelectableParts & parts )

signal

This signal is emitted when the selectability changes, by calls to setSelectableParts

selectableParts()

SelectableParts QCPAxis::selectableParts ( ) const

inline

Definition at line 2190 of file qcustomplot.h.

selectedBasePen()

QPen QCPAxis::selectedBasePen ( ) const

inline

Definition at line 2195 of file qcustomplot.h.

selectedLabelColor()

QColor QCPAxis::selectedLabelColor ( ) const

inline

Definition at line 2194 of file qcustomplot.h.

selectedLabelFont()

QFont QCPAxis::selectedLabelFont ( ) const

inline

Definition at line 2192 of file qcustomplot.h.

selectedParts()

SelectableParts QCPAxis::selectedParts ( ) const

inline

Definition at line 2189 of file qcustomplot.h.

selectedSubTickPen()

QPen QCPAxis::selectedSubTickPen ( ) const

inline

Definition at line 2197 of file qcustomplot.h.

selectedTickLabelColor()

QColor QCPAxis::selectedTickLabelColor ( ) const

inline

Definition at line 2193 of file qcustomplot.h.

selectedTickLabelFont()

QFont QCPAxis::selectedTickLabelFont ( ) const

inline

Definition at line 2191 of file qcustomplot.h.

selectedTickPen()

QPen QCPAxis::selectedTickPen ( ) const

inline

Definition at line 2196 of file qcustomplot.h.

selectEvent()

void QCPAxis::selectEvent ( QMouseEvent * event, bool additive, const QVariant & details, bool * selectionStateChanged )

overrideprotectedvirtual

This event is called when the layerable shall be selected, as a consequence of a click by the user. Subclasses should react to it by setting their selection state appropriately. The default implementation does nothing.

event is the mouse event that caused the selection. additive indicates, whether the user was holding the multi-select-modifier while performing the selection (see QCustomPlot::setMultiSelectModifier). if additive is true, the selection state must be toggled (i.e. become selected when unselected and unselected when selected).

Every selectEvent is preceded by a call to selectTest, which has returned positively (i.e. returned a value greater than 0 and less than the selection tolerance of the parent QCustomPlot). The details data you output from selectTest is fed back via details here. You may use it to transport any kind of information from the selectTest to the possibly subsequent selectEvent. Usually details is used to transfer which part was clicked, if it is a layerable that has multiple individually selectable parts (like QCPAxis). This way selectEvent doesn't need to do the calculation again to find out which part was actually clicked.

selectionStateChanged is an output parameter. If the pointer is non-null, this function must set the value either to true or false, depending on whether the selection state of this layerable was actually changed. For layerables that only are selectable as a whole and not in parts, this is simple: if additive is true, selectionStateChanged must also be set to true, because the selection toggles. If additive is false, selectionStateChanged is only set to true, if the layerable was previously unselected and now is switched to the selected state.

See also

selectTest, deselectEvent

Reimplemented from QCPLayerable.

Definition at line 9471 of file qcustomplot.cpp.

selectionCategory()

QCP::Interaction QCPAxis::selectionCategory ( ) const

overrideprotectedvirtual

Returns the selection category this layerable shall belong to. The selection category is used in conjunction with QCustomPlot::setInteractions to control which objects are selectable and which aren't.

Subclasses that don't fit any of the normal QCP::Interaction values can use QCP::iSelectOther. This is what the default implementation returns.

See also

QCustomPlot::setInteractions

Reimplemented from QCPLayerable.

Definition at line 9856 of file qcustomplot.cpp.

selectionChanged

void QCPAxis::selectionChanged ( const QCPAxis::SelectableParts & parts )

signal

This signal is emitted when the selection state of this axis has changed, either by user interaction or by a direct call to setSelectedParts.

selectTest()

double QCPAxis::selectTest ( const QPointF & pos, bool onlySelectable, QVariant * details = nullptr ) const

overridevirtual

This function is used to decide whether a click hits a layerable object or not.

pos is a point in pixel coordinates on the QCustomPlot surface. This function returns the shortest pixel distance of this point to the object. If the object is either invisible or the distance couldn't be determined, -1.0 is returned. Further, if onlySelectable is true and the object is not selectable, -1.0 is returned, too.

If the object is represented not by single lines but by an area like a QCPItemText or the bars of a QCPBars plottable, a click inside the area should also be considered a hit. In these cases this function thus returns a constant value greater zero but still below the parent plot's selection tolerance. (typically the selectionTolerance multiplied by 0.99).

Providing a constant value for area objects allows selecting line objects even when they are obscured by such area objects, by clicking close to the lines (i.e. closer than 0.99*selectionTolerance).

The actual setting of the selection state is not done by this function. This is handled by the parent QCustomPlot when the mouseReleaseEvent occurs, and the finally selected object is notified via the selectEvent/ deselectEvent methods.

details is an optional output parameter. Every layerable subclass may place any information in details. This information will be passed to selectEvent when the parent QCustomPlot decides on the basis of this selectTest call, that the object was successfully selected. The subsequent call to selectEvent will carry the details. This is useful for multi-part objects (like QCPAxis). This way, a possibly complex calculation to decide which part was clicked is only done once in selectTest. The result (i.e. the actually clicked part) can then be placed in details. So in the subsequent selectEvent, the decision which part was selected doesn't have to be done a second time for a single selection operation.

In the case of 1D Plottables (QCPAbstractPlottable1D, like QCPGraph or QCPBars) details will be set to a QCPDataSelection, describing the closest data point to pos.

You may pass nullptr as details to indicate that you are not interested in those selection details.

See also

selectEvent, deselectEvent, mousePressEvent, wheelEvent, QCustomPlot::setInteractions, QCPAbstractPlottable1D::selectTestRect

Reimplemented from QCPLayerable.

Definition at line 9361 of file qcustomplot.cpp.

setBasePen()

void QCPAxis::setBasePen

(

const QPen &

pen

)

Sets the pen, the axis base line is drawn with.

See also

setTickPen, setSubTickPen

Definition at line 8876 of file qcustomplot.cpp.

setLabel()

void QCPAxis::setLabel

(

const QString &

str

)

Sets the text of the axis label that will be shown below/above or next to the axis, depending on its orientation. To disable axis labels, pass an empty string as str.

Definition at line 8929 of file qcustomplot.cpp.

setLabelColor()

void QCPAxis::setLabelColor

(

const QColor &

color

)

Sets the color of the axis label.

See also

setLabelFont

Definition at line 8920 of file qcustomplot.cpp.

setLabelFont()

void QCPAxis::setLabelFont

(

const QFont &

font

)

Sets the font of the axis label.

See also

setLabelColor

Definition at line 8906 of file qcustomplot.cpp.

setLabelPadding()

void QCPAxis::setLabelPadding

(

int

padding

)

Sets the distance between the tick labels and the axis label.

See also

setTickLabelPadding, setPadding

Definition at line 8943 of file qcustomplot.cpp.

setLowerEnding()

void QCPAxis::setLowerEnding

(

const QCPLineEnding &

ending

)

Sets the style for the lower axis ending. See the documentation of QCPLineEnding for available styles.

For horizontal axes, this method refers to the left ending, for vertical axes the bottom ending. Note that this meaning does not change when the axis range is reversed with setRangeReversed.

See also

setUpperEnding

Definition at line 9072 of file qcustomplot.cpp.

setNumberFormat()

void QCPAxis::setNumberFormat

(

const QString &

formatCode

)

Sets the number format for the numbers in tick labels. This formatCode is an extended version of the format code used e.g. by QString::number() and QLocale::toString(). For reference about that, see the "Argument Formats" section in the detailed description of the QString class.

formatCode is a string of one, two or three characters.

The first character is identical to the normal format code used by Qt. In short, this means: 'e'/'E' scientific format, 'f' fixed format, 'g'/'G' scientific or fixed, whichever is shorter. For the 'e', 'E', and 'f' formats, the precision set by setNumberPrecision represents the number of digits after the decimal point. For the 'g' and 'G' formats, the precision represents the maximum number of significant digits, trailing zeroes are omitted.

The second and third characters are optional and specific to QCustomPlot:
If the first char was 'e' or 'g', numbers are/might be displayed in the scientific format, e.g. "5.5e9", which is ugly in a plot. So when the second char of formatCode is set to 'b' (for "beautiful"), those exponential numbers are formatted in a more natural way, i.e. "5.5 [multiplication sign] 10 [superscript] 9". By default, the multiplication sign is a centered dot. If instead a cross should be shown (as is usual in the USA), the third char of formatCode can be set to 'c'. The inserted multiplication signs are the UTF-8 characters 215 (0xD7) for the cross and 183 (0xB7) for the dot.

Examples for formatCode:

• g normal format code behaviour. If number is small, fixed format is used, if number is large, normal scientific format is used
• gb If number is small, fixed format is used, if number is large, scientific format is used with beautifully typeset decimal powers and a dot as multiplication sign
• ebc All numbers are in scientific format with beautifully typeset decimal power and a cross as multiplication sign
• fb illegal format code, since fixed format doesn't support (or need) beautifully typeset decimal powers. Format code will be reduced to 'f'.
• hello illegal format code, since first char is not 'e', 'E', 'f', 'g' or 'G'. Current format code will not be changed.

Definition at line 8698 of file qcustomplot.cpp.

setNumberPrecision()

void QCPAxis::setNumberPrecision

(

int

precision

)

Sets the precision of the tick label numbers. See QLocale::toString(double i, char f, int prec) for details. The effect of precisions are most notably for number Formats starting with 'e', see setNumberFormat

Definition at line 8758 of file qcustomplot.cpp.

setOffset()

void QCPAxis::setOffset

(

int

offset

)

Sets the offset the axis has to its axis rect side.

If an axis rect side has multiple axes and automatic margin calculation is enabled for that side, only the offset of the inner most axis has meaning (even if it is set to be invisible). The offset of the other, outer axes is controlled automatically, to place them at appropriate positions.

Definition at line 8979 of file qcustomplot.cpp.

setPadding()

void QCPAxis::setPadding

(

int

padding

)

Sets the padding of the axis.

When QCPAxisRect::setAutoMargins is enabled, the padding is the additional outer most space, that is left blank.

The axis padding has no meaning if QCPAxisRect::setAutoMargins is disabled.

See also

setLabelPadding, setTickLabelPadding

Definition at line 8962 of file qcustomplot.cpp.

setRange() [1/3]

void QCPAxis::setRange

(

const QCPRange &

range

)

Sets the range of the axis.

This slot may be connected with the rangeChanged signal of another axis so this axis is always synchronized with the other axis range, when it changes.

To invert the direction of an axis, use setRangeReversed.

Definition at line 8373 of file qcustomplot.cpp.

setRange() [2/3]

void QCPAxis::setRange	(	double	lower,
		double	upper )

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

Sets the lower and upper bound of the axis range.

To invert the direction of an axis, use setRangeReversed.

There is also a slot to set a range, see setRange(const QCPRange &range).

Definition at line 8443 of file qcustomplot.cpp.

setRange() [3/3]

void QCPAxis::setRange	(	double	position,
		double	size,
		Qt::AlignmentFlag	alignment )

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

Sets the range of the axis.

The position coordinate indicates together with the alignment parameter, where the new range will be positioned. size defines the size of the new axis range. alignment may be Qt::AlignLeft, Qt::AlignRight or Qt::AlignCenter. This will cause the left border, right border, or center of the range to be aligned with position. Any other values of alignment will default to Qt::AlignCenter.

Definition at line 8474 of file qcustomplot.cpp.

setRangeLower()

void QCPAxis::setRangeLower

(

double

lower

)

Sets the lower bound of the axis range. The upper bound is not changed.

See also

setRange

Definition at line 8488 of file qcustomplot.cpp.

setRangeReversed()

void QCPAxis::setRangeReversed

(

bool

reversed

)

Sets whether the axis range (direction) is displayed reversed. Normally, the values on horizontal axes increase left to right, on vertical axes bottom to top. When reversed is set to true, the direction of increasing values is inverted.

Note that the range and data interface stays the same for reversed axes, e.g. the lower part of the setRange interface will still reference the mathematically smaller number than the upper part.

Definition at line 8537 of file qcustomplot.cpp.

setRangeUpper()

void QCPAxis::setRangeUpper

(

double

upper

)

Sets the upper bound of the axis range. The lower bound is not changed.

See also

setRange

Definition at line 8510 of file qcustomplot.cpp.

setScaleRatio()

void QCPAxis::setScaleRatio	(	const QCPAxis *	otherAxis,
		double	ratio = 1.0 )

Scales the range of this axis to have a certain scale ratio to otherAxis. The scaling will be done around the center of the current axis range.

For example, if ratio is 1, this axis is the yAxis and otherAxis is xAxis, graphs plotted with those axes will appear in a 1:1 aspect ratio, independent of the aspect ratio the axis rect has.

This is an operation that changes the range of this axis once, it doesn't fix the scale ratio indefinitely. Note that calling this function in the constructor of the QCustomPlot's parent won't have the desired effect, since the widget dimensions aren't defined yet, and a resizeEvent will follow.

Definition at line 9177 of file qcustomplot.cpp.

setScaleType()

void QCPAxis::setScaleType

(

QCPAxis::ScaleType

type

)

Sets whether the axis uses a linear scale or a logarithmic scale.

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 axis ticker to an instance of QCPAxisTickerLog :

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

setNumberPrecision

Definition at line 8353 of file qcustomplot.cpp.

setSelectableParts()

void QCPAxis::setSelectableParts

(

const QCPAxis::SelectableParts &

selectableParts

)

Sets whether the user can (de-)select the parts in selectable by clicking on the QCustomPlot surface. (When QCustomPlot::setInteractions contains iSelectAxes.)

However, even when selectable is set to a value not allowing the selection of a specific part, it is still possible to set the selection of this part manually, by calling setSelectedParts directly.

See also

SelectablePart, setSelectedParts

Definition at line 8401 of file qcustomplot.cpp.

setSelectedBasePen()

void QCPAxis::setSelectedBasePen

(

const QPen &

pen

)

Sets the pen that is used to draw the axis base line when selected.

See also

setBasePen, setSelectableParts, setSelectedParts, QCustomPlot::setInteractions

Definition at line 9037 of file qcustomplot.cpp.

setSelectedLabelColor()

void QCPAxis::setSelectedLabelColor

(

const QColor &

color

)

Sets the color that is used for the axis label when it is selected.

See also

setLabelColor, setSelectableParts, setSelectedParts, QCustomPlot::setInteractions

Definition at line 9027 of file qcustomplot.cpp.

setSelectedLabelFont()

void QCPAxis::setSelectedLabelFont

(

const QFont &

font

)

Sets the font that is used for the axis label when it is selected.

See also

setLabelFont, setSelectableParts, setSelectedParts, QCustomPlot::setInteractions

Definition at line 9003 of file qcustomplot.cpp.

setSelectedParts()

void QCPAxis::setSelectedParts

(

const QCPAxis::SelectableParts &

selectedParts

)

Sets the selected state of the respective axis parts described by SelectablePart. When a part is selected, it uses a different pen/font.

The entire selection mechanism for axes is handled automatically when QCustomPlot::setInteractions contains iSelectAxes. You only need to call this function when you wish to change the selection state manually.

This function can change the selection state of a part, independent of the setSelectableParts setting.

emits the selectionChanged signal when selected is different from the previous selection state.

See also

SelectablePart, setSelectableParts, selectTest, setSelectedBasePen, setSelectedTickPen, setSelectedSubTickPen, setSelectedTickLabelFont, setSelectedLabelFont, setSelectedTickLabelColor, setSelectedLabelColor

Definition at line 8425 of file qcustomplot.cpp.

setSelectedSubTickPen()

void QCPAxis::setSelectedSubTickPen

(

const QPen &

pen

)

Sets the pen that is used to draw the subticks when selected.

See also

setSubTickPen, setSelectableParts, setSelectedParts, QCustomPlot::setInteractions

Definition at line 9057 of file qcustomplot.cpp.

setSelectedTickLabelColor()

void QCPAxis::setSelectedTickLabelColor

(

const QColor &

color

)

Sets the color that is used for tick labels when they are selected.

See also

setTickLabelColor, setSelectableParts, setSelectedParts, QCustomPlot::setInteractions

Definition at line 9014 of file qcustomplot.cpp.

setSelectedTickLabelFont()

void QCPAxis::setSelectedTickLabelFont

(

const QFont &

font

)

Sets the font that is used for tick labels when they are selected.

See also

setTickLabelFont, setSelectableParts, setSelectedParts, QCustomPlot::setInteractions

Definition at line 8989 of file qcustomplot.cpp.

setSelectedTickPen()

void QCPAxis::setSelectedTickPen

(

const QPen &

pen

)

Sets the pen that is used to draw the (major) ticks when selected.

See also

setTickPen, setSelectableParts, setSelectedParts, QCustomPlot::setInteractions

Definition at line 9047 of file qcustomplot.cpp.

setSubTickLength()

void QCPAxis::setSubTickLength	(	int	inside,
		int	outside = 0 )

Sets the length of the subticks in pixels. inside is the length the subticks will reach inside the plot and outside is the length they will reach outside the plot. If outside is greater than zero, the tick labels and axis label will increase their distance to the axis accordingly, so they won't collide with the ticks.

See also

setTickLength, setSubTickLengthIn, setSubTickLengthOut

Definition at line 8835 of file qcustomplot.cpp.

setSubTickLengthIn()

void QCPAxis::setSubTickLengthIn

(

int

inside

)

Sets the length of the inward subticks in pixels. inside is the length the subticks will reach inside the plot.

See also

setSubTickLengthOut, setSubTickLength, setTickLength

Definition at line 8847 of file qcustomplot.cpp.

setSubTickLengthOut()

void QCPAxis::setSubTickLengthOut

(

int

outside

)

Sets the length of the outward subticks in pixels. outside is the length the subticks will reach outside the plot. If outside is greater than zero, the tick labels will increase their distance to the axis accordingly, so they won't collide with the ticks.

See also

setSubTickLengthIn, setSubTickLength, setTickLength

Definition at line 8862 of file qcustomplot.cpp.

setSubTickPen()

void QCPAxis::setSubTickPen

(

const QPen &

pen

)

Sets the pen, subtick marks will be drawn with.

See also

setSubTickCount, setSubTickLength, setBasePen

Definition at line 8896 of file qcustomplot.cpp.

setSubTicks()

void QCPAxis::setSubTicks

(

bool

show

)

Sets whether sub tick marks are displayed.

Sub ticks are only potentially visible if (major) ticks are also visible (see setTicks)

See also

setTicks

Definition at line 8818 of file qcustomplot.cpp.

setTicker()

void QCPAxis::setTicker

(

QSharedPointer< QCPAxisTicker >

ticker

)

The axis ticker is responsible for generating the tick positions and tick labels. See the documentation of QCPAxisTicker for details on how to work with axis tickers.

You can change the tick positioning/labeling behaviour of this axis by setting a different QCPAxisTicker subclass using this method. If you only wish to modify the currently installed axis ticker, access it via ticker.

Since the ticker is stored in the axis as a shared pointer, multiple axes may share the same axis ticker simply by passing the same shared pointer to multiple axes.

See also

ticker

Definition at line 8555 of file qcustomplot.cpp.

setTickLabelColor()

void QCPAxis::setTickLabelColor

(

const QColor &

color

)

Sets the color of the tick labels.

See also

setTickLabels, setTickLabelFont

Definition at line 8627 of file qcustomplot.cpp.

setTickLabelFont()

void QCPAxis::setTickLabelFont

(

const QFont &

font

)

Sets the font of the tick labels.

See also

setTickLabels, setTickLabelColor

Definition at line 8613 of file qcustomplot.cpp.

setTickLabelPadding()

void QCPAxis::setTickLabelPadding

(

int

padding

)

Sets the distance between the axis base line (including any outward ticks) and the tick labels.

See also

setLabelPadding, setPadding

Definition at line 8599 of file qcustomplot.cpp.

setTickLabelRotation()

void QCPAxis::setTickLabelRotation

(

double

degrees

)

Sets the rotation of the tick labels. If degrees is zero, the labels are drawn normally. Else, the tick labels are drawn rotated by degrees clockwise. The specified angle is bound to values from -90 to 90 degrees.

If degrees is exactly -90, 0 or 90, the tick labels are centered on the tick coordinate. For other angles, the label is drawn with an offset such that it seems to point toward or away from the tick mark.

Definition at line 8641 of file qcustomplot.cpp.

setTickLabels()

void QCPAxis::setTickLabels

(

bool

show

)

Sets whether tick labels are displayed. Tick labels are the numbers drawn next to tick marks.

Definition at line 8584 of file qcustomplot.cpp.

setTickLabelSide()

void QCPAxis::setTickLabelSide

(

LabelSide

side

)

Sets whether the tick labels (numbers) shall appear inside or outside the axis rect.

The usual and default setting is lsOutside. Very compact plots sometimes require tick labels to be inside the axis rect, to save space. If side is set to lsInside, the tick labels appear on the inside are additionally clipped to the axis rect.

Definition at line 8657 of file qcustomplot.cpp.

setTickLength()

void QCPAxis::setTickLength	(	int	inside,
		int	outside = 0 )

Sets the length of the ticks in pixels. inside is the length the ticks will reach inside the plot and outside is the length they will reach outside the plot. If outside is greater than zero, the tick labels and axis label will increase their distance to the axis accordingly, so they won't collide with the ticks.

See also

setSubTickLength, setTickLengthIn, setTickLengthOut

Definition at line 8775 of file qcustomplot.cpp.

setTickLengthIn()

void QCPAxis::setTickLengthIn

(

int

inside

)

Sets the length of the inward ticks in pixels. inside is the length the ticks will reach inside the plot.

See also

setTickLengthOut, setTickLength, setSubTickLength

Definition at line 8787 of file qcustomplot.cpp.

setTickLengthOut()

void QCPAxis::setTickLengthOut

(

int

outside

)

Sets the length of the outward ticks in pixels. outside is the length the ticks will reach outside the plot. If outside is greater than zero, the tick labels and axis label will increase their distance to the axis accordingly, so they won't collide with the ticks.

See also

setTickLengthIn, setTickLength, setSubTickLength

Definition at line 8802 of file qcustomplot.cpp.

setTickPen()

void QCPAxis::setTickPen

(

const QPen &

pen

)

Sets the pen, tick marks will be drawn with.

See also

setTickLength, setBasePen

Definition at line 8886 of file qcustomplot.cpp.

setTicks()

void QCPAxis::setTicks

(

bool

show

)

Sets whether tick marks are displayed.

Note that setting show to false does not imply that tick labels are invisible, too. To achieve that, see setTickLabels.

See also

setSubTicks

Definition at line 8572 of file qcustomplot.cpp.

setUpperEnding()

void QCPAxis::setUpperEnding

(

const QCPLineEnding &

ending

)

Sets the style for the upper axis ending. See the documentation of QCPLineEnding for available styles.

For horizontal axes, this method refers to the right ending, for vertical axes the top ending. Note that this meaning does not change when the axis range is reversed with setRangeReversed.

See also

setLowerEnding

Definition at line 9087 of file qcustomplot.cpp.

setupTickVectors()

void QCPAxis::setupTickVectors ( )

protected

Prepares the internal tick vector, sub tick vector and tick label vector. This is done by calling QCPAxisTicker::generate on the currently installed ticker.

If a change in the label text/count is detected, the cached axis margin is invalidated to make sure the next margin calculation recalculates the label sizes and returns an up-to-date value.

Definition at line 9718 of file qcustomplot.cpp.

subTickLengthIn()

int QCPAxis::subTickLengthIn

(

)

const

Definition at line 8304 of file qcustomplot.cpp.

subTickLengthOut()

int QCPAxis::subTickLengthOut

(

)

const

Definition at line 8310 of file qcustomplot.cpp.

subTickPen()

QPen QCPAxis::subTickPen ( ) const

inline

Definition at line 2182 of file qcustomplot.h.

subTicks()

bool QCPAxis::subTicks ( ) const

inline

Definition at line 2177 of file qcustomplot.h.

ticker()

QSharedPointer< QCPAxisTicker > QCPAxis::ticker ( ) const

inline

Returns a modifiable shared pointer to the currently installed axis ticker. The axis ticker is responsible for generating the tick positions and tick labels of this axis. You can access the QCPAxisTicker with this method and modify basic properties such as the approximate tick count (QCPAxisTicker::setTickCount).

You can gain more control over the axis ticks by setting a different QCPAxisTicker subclass, see the documentation there. A new axis ticker can be set with setTicker.

Since the ticker is stored in the axis as a shared pointer, multiple axes may share the same axis ticker simply by passing the same shared pointer to multiple axes.

See also

setTicker

Definition at line 2163 of file qcustomplot.h.

tickLabelColor()

QColor QCPAxis::tickLabelColor ( ) const

inline

Definition at line 2168 of file qcustomplot.h.

tickLabelFont()

QFont QCPAxis::tickLabelFont ( ) const

inline

Definition at line 2167 of file qcustomplot.h.

tickLabelPadding()

int QCPAxis::tickLabelPadding

(

)

const

Definition at line 8260 of file qcustomplot.cpp.

tickLabelRotation()

double QCPAxis::tickLabelRotation

(

)

const

Definition at line 8266 of file qcustomplot.cpp.

tickLabels()

bool QCPAxis::tickLabels ( ) const

inline

Definition at line 2165 of file qcustomplot.h.

tickLabelSide()

QCPAxis::LabelSide QCPAxis::tickLabelSide

(

)

const

Definition at line 8272 of file qcustomplot.cpp.

tickLengthIn()

int QCPAxis::tickLengthIn

(

)

const

Definition at line 8292 of file qcustomplot.cpp.

tickLengthOut()

int QCPAxis::tickLengthOut

(

)

const

Definition at line 8298 of file qcustomplot.cpp.

tickPen()

QPen QCPAxis::tickPen ( ) const

inline

Definition at line 2181 of file qcustomplot.h.

ticks()

bool QCPAxis::ticks ( ) const

inline

Definition at line 2164 of file qcustomplot.h.

tickVector()

QVector< double > QCPAxis::tickVector ( ) const

inline

Definition at line 2173 of file qcustomplot.h.

tickVectorLabels()

QVector< QString > QCPAxis::tickVectorLabels ( ) const

inline

Definition at line 2174 of file qcustomplot.h.

upperEnding()

QCPLineEnding QCPAxis::upperEnding

(

)

const

Definition at line 8334 of file qcustomplot.cpp.

wheelEvent()

void QCPAxis::wheelEvent ( QWheelEvent * event )

overrideprotectedvirtual

This mouse event reimplementation provides the functionality to let the user zoom individual axes exclusively, by performing the wheel event on top of the axis.

For the axis to accept this event and perform the single axis zoom, the parent QCPAxisRect must be configured accordingly, i.e. it must allow range zooming in the orientation of this axis (QCPAxisRect::setRangeZoom) and this axis must be a zoomable axis (QCPAxisRect::setRangeZoomAxes)

\seebaseclassmethod

Note

The zooming of possibly multiple axes at once by performing the wheel event anywhere in the axis rect is handled by the axis rect's mouse event, e.g. QCPAxisRect::wheelEvent.

Reimplemented from QCPLayerable.

Definition at line 9607 of file qcustomplot.cpp.

Member Data Documentation

mAADragBackup

QCP::AntialiasedElements QCPAxis::mAADragBackup

protected

Definition at line 2325 of file qcustomplot.h.

mAxisPainter

QCPAxisPainterPrivate* QCPAxis::mAxisPainter

protected

Definition at line 2316 of file qcustomplot.h.

mAxisRect

QCPAxisRect* QCPAxis::mAxisRect

protected

Definition at line 2281 of file qcustomplot.h.

mAxisType

AxisType QCPAxis::mAxisType

protected

Definition at line 2280 of file qcustomplot.h.

mBasePen

QPen QCPAxis::mBasePen

protected

Definition at line 2286 of file qcustomplot.h.

mCachedMargin

int QCPAxis::mCachedMargin

protected

Definition at line 2322 of file qcustomplot.h.

mCachedMarginValid

bool QCPAxis::mCachedMarginValid

protected

Definition at line 2321 of file qcustomplot.h.

mDragging

bool QCPAxis::mDragging

protected

Definition at line 2323 of file qcustomplot.h.

mDragStartRange

QCPRange QCPAxis::mDragStartRange

protected

Definition at line 2324 of file qcustomplot.h.

mGrid

QCPGrid* QCPAxis::mGrid

protected

Definition at line 2315 of file qcustomplot.h.

mLabel

QString QCPAxis::mLabel

protected

Definition at line 2290 of file qcustomplot.h.

mLabelColor

QColor QCPAxis::mLabelColor

protected

Definition at line 2292 of file qcustomplot.h.

mLabelFont

QFont QCPAxis::mLabelFont

protected

Definition at line 2291 of file qcustomplot.h.

mNotAADragBackup

QCP::AntialiasedElements QCPAxis::mNotAADragBackup

protected

Definition at line 2325 of file qcustomplot.h.

mNumberBeautifulPowers

bool QCPAxis::mNumberBeautifulPowers

protected

Definition at line 2301 of file qcustomplot.h.

mNumberFormatChar

QLatin1Char QCPAxis::mNumberFormatChar

protected

Definition at line 2300 of file qcustomplot.h.

mNumberPrecision

int QCPAxis::mNumberPrecision

protected

Definition at line 2299 of file qcustomplot.h.

mOrientation

Qt::Orientation QCPAxis::mOrientation

protected

Definition at line 2284 of file qcustomplot.h.

mPadding

int QCPAxis::mPadding

protected

Definition at line 2283 of file qcustomplot.h.

mRange

QCPRange QCPAxis::mRange

protected

Definition at line 2310 of file qcustomplot.h.

mRangeReversed

bool QCPAxis::mRangeReversed

protected

Definition at line 2311 of file qcustomplot.h.

mScaleType

ScaleType QCPAxis::mScaleType

protected

Definition at line 2312 of file qcustomplot.h.

mSelectableParts

SelectableParts QCPAxis::mSelectableParts

protected

Definition at line 2285 of file qcustomplot.h.

mSelectedBasePen

QPen QCPAxis::mSelectedBasePen

protected

Definition at line 2286 of file qcustomplot.h.

mSelectedLabelColor

QColor QCPAxis::mSelectedLabelColor

protected

Definition at line 2292 of file qcustomplot.h.

mSelectedLabelFont

QFont QCPAxis::mSelectedLabelFont

protected

Definition at line 2291 of file qcustomplot.h.

mSelectedParts

SelectableParts QCPAxis::mSelectedParts

protected

Definition at line 2285 of file qcustomplot.h.

mSelectedSubTickPen

QPen QCPAxis::mSelectedSubTickPen

protected

Definition at line 2308 of file qcustomplot.h.

mSelectedTickLabelColor

QColor QCPAxis::mSelectedTickLabelColor

protected

Definition at line 2298 of file qcustomplot.h.

mSelectedTickLabelFont

QFont QCPAxis::mSelectedTickLabelFont

protected

Definition at line 2297 of file qcustomplot.h.

mSelectedTickPen

QPen QCPAxis::mSelectedTickPen

protected

Definition at line 2307 of file qcustomplot.h.

mSubTickPen

QPen QCPAxis::mSubTickPen

protected

Definition at line 2308 of file qcustomplot.h.

mSubTicks

bool QCPAxis::mSubTicks

protected

Definition at line 2305 of file qcustomplot.h.

mSubTickVector

QVector<double> QCPAxis::mSubTickVector

protected

Definition at line 2320 of file qcustomplot.h.

mTicker

QSharedPointer<QCPAxisTicker> QCPAxis::mTicker

protected

Definition at line 2317 of file qcustomplot.h.

mTickLabelColor

QColor QCPAxis::mTickLabelColor

protected

Definition at line 2298 of file qcustomplot.h.

mTickLabelFont

QFont QCPAxis::mTickLabelFont

protected

Definition at line 2297 of file qcustomplot.h.

mTickLabels

bool QCPAxis::mTickLabels

protected

Definition at line 2295 of file qcustomplot.h.

mTickPen

QPen QCPAxis::mTickPen

protected

Definition at line 2307 of file qcustomplot.h.

mTicks

bool QCPAxis::mTicks

protected

Definition at line 2304 of file qcustomplot.h.

mTickVector

QVector<double> QCPAxis::mTickVector

protected

Definition at line 2318 of file qcustomplot.h.

mTickVectorLabels

QVector<QString> QCPAxis::mTickVectorLabels

protected

Definition at line 2319 of file qcustomplot.h.

---

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

• qcustomplot.h
• qcustomplot.cpp