Manages a single axis inside a QCustomPlot. More...

#include <qcustomplot.h>

Inheritance diagram for QCPAxis:

Public Types
enum	AxisType { atLeft = 0x01 , atRight = 0x02 , atTop = 0x04 , atBottom = 0x08 }
	Defines at which side of the axis rect the axis will appear. More...

enum	LabelType { ltNumber , ltDateTime }
	When automatic tick label generation is enabled (setAutoTickLabels), defines how the coordinate of the tick is interpreted, i.e. More...

enum	ScaleType { stLinear , stLogarithmic }
	Defines the scale of an axis. More...

enum	SelectablePart { spNone = 0 , spAxis = 0x001 , spTickLabels = 0x002 , spAxisLabel = 0x004 }
	Defines the selectable parts of an axis. More...

Signals
void	ticksRequest ()
	This signal is emitted when setAutoTicks is false and the axis is about to generate tick labels for a replot.

void	rangeChanged (const QCPRange &newRange)
	This signal is emitted when the range of this axis has changed.

void	rangeChanged (const QCPRange &newRange, const QCPRange &oldRange)
	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.

void	scaleTypeChanged (QCPAxis::ScaleType scaleType)
	This signal is emitted when the scale type changes, by calls to setScaleType.

void	selectionChanged (const QCPAxis::SelectableParts &parts)
	This signal is emitted when the selection state of this axis has changed, either by user interaction or by a direct call to setSelectedParts.

void	selectableChanged (const QCPAxis::SelectableParts &parts)
	This signal is emitted when the selectability changes, by calls to setSelectableParts.

Signals inherited from QCPLayerable
void	layerChanged (QCPLayer *newLayer)
	This signal is emitted when the layer of this layerable changes, i.e.

Public Member Functions
	QCPAxis (QCPAxisRect *parent, AxisType type)
	Constructs an Axis instance of Type type for the axis rect parent.

virtual	~QCPAxis ()

AxisType	axisType () const

QCPAxisRect *	axisRect () const

ScaleType	scaleType () const

double	scaleLogBase () const

const QCPRange	range () const

bool	rangeReversed () const

bool	autoTicks () const

int	autoTickCount () const

bool	autoTickLabels () const

bool	autoTickStep () const

bool	autoSubTicks () const

bool	ticks () const

bool	tickLabels () const

int	tickLabelPadding () const

LabelType	tickLabelType () const

QFont	tickLabelFont () const

QColor	tickLabelColor () const

double	tickLabelRotation () const

QString	dateTimeFormat () const

Qt::TimeSpec	dateTimeSpec () const

QString	numberFormat () const

int	numberPrecision () const

double	tickStep () const

QVector< double >	tickVector () const

QVector< QString >	tickVectorLabels () const

int	tickLengthIn () const

int	tickLengthOut () const

int	subTickCount () const

int	subTickLengthIn () const

int	subTickLengthOut () const

QPen	basePen () const

QPen	tickPen () const

QPen	subTickPen () const

QFont	labelFont () const

QColor	labelColor () const

QString	label () const

int	labelPadding () const

int	padding () const

int	offset () const

SelectableParts	selectedParts () const

SelectableParts	selectableParts () const

QFont	selectedTickLabelFont () const

QFont	selectedLabelFont () const

QColor	selectedTickLabelColor () const

QColor	selectedLabelColor () const

QPen	selectedBasePen () const

QPen	selectedTickPen () const

QPen	selectedSubTickPen () const

QCPLineEnding	lowerEnding () const

QCPLineEnding	upperEnding () const

QCPGrid *	grid () const
	Returns the QCPGrid instance belonging to this axis.

Q_SLOT void	setScaleType (QCPAxis::ScaleType type)
	Sets whether the axis uses a linear scale or a logarithmic scale.

void	setScaleLogBase (double base)
	If setScaleType is set to stLogarithmic, base will be the logarithm base of the scaling.

Q_SLOT void	setRange (const QCPRange &range)
	Sets the range of the axis.

void	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.

void	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.

void	setRangeLower (double lower)
	Sets the lower bound of the axis range.

void	setRangeUpper (double upper)
	Sets the upper bound of the axis range.

void	setRangeReversed (bool reversed)
	Sets whether the axis range (direction) is displayed reversed.

void	setAutoTicks (bool on)
	Sets whether the tick positions should be calculated automatically (either from an automatically generated tick step or a tick step provided manually via setTickStep, see setAutoTickStep).

void	setAutoTickCount (int approximateCount)
	When setAutoTickStep is true, approximateCount determines how many ticks should be generated in the visible range, approximately.

void	setAutoTickLabels (bool on)
	Sets whether the tick labels are generated automatically.

void	setAutoTickStep (bool on)
	Sets whether the tick step, i.e.

void	setAutoSubTicks (bool on)
	Sets whether the number of sub ticks in one tick interval is determined automatically.

void	setTicks (bool show)
	Sets whether tick marks are displayed.

void	setTickLabels (bool show)
	Sets whether tick labels are displayed.

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

void	setTickLabelType (LabelType type)
	Sets whether the tick labels display numbers or dates/times.

void	setTickLabelFont (const QFont &font)
	Sets the font of the tick labels.

void	setTickLabelColor (const QColor &color)
	Sets the color of the tick labels.

void	setTickLabelRotation (double degrees)
	Sets the rotation of the tick labels.

void	setDateTimeFormat (const QString &format)
	Sets the format in which dates and times are displayed as tick labels, if setTickLabelType is ltDateTime.

void	setDateTimeSpec (const Qt::TimeSpec &timeSpec)
	Sets the time spec that is used for the date time values when setTickLabelType is ltDateTime.

void	setNumberFormat (const QString &formatCode)
	Sets the number format for the numbers drawn as tick labels (if tick label type is ltNumber).

void	setNumberPrecision (int precision)
	Sets the precision of the tick label numbers.

void	setTickStep (double step)
	If setAutoTickStep is set to false, use this function to set the tick step manually.

void	setTickVector (const QVector< double > &vec)
	If you want full control over what ticks (and possibly labels) the axes show, this function is used to set the coordinates at which ticks will appear.

void	setTickVectorLabels (const QVector< QString > &vec)
	If you want full control over what ticks and labels the axes show, this function is used to set a number of QStrings that will be displayed at the tick positions which you need to provide with setTickVector.

void	setTickLength (int inside, int outside=0)
	Sets the length of the ticks in pixels.

void	setTickLengthIn (int inside)
	Sets the length of the inward ticks in pixels.

void	setTickLengthOut (int outside)
	Sets the length of the outward ticks in pixels.

void	setSubTickCount (int count)
	Sets the number of sub ticks in one (major) tick step.

void	setSubTickLength (int inside, int outside=0)
	Sets the length of the subticks in pixels.

void	setSubTickLengthIn (int inside)
	Sets the length of the inward subticks in pixels.

void	setSubTickLengthOut (int outside)
	Sets the length of the outward subticks in pixels.

void	setBasePen (const QPen &pen)
	Sets the pen, the axis base line is drawn with.

void	setTickPen (const QPen &pen)
	Sets the pen, tick marks will be drawn with.

void	setSubTickPen (const QPen &pen)
	Sets the pen, subtick marks will be drawn with.

void	setLabelFont (const QFont &font)
	Sets the font of the axis label.

void	setLabelColor (const QColor &color)
	Sets the color of the axis label.

void	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.

void	setLabelPadding (int padding)
	Sets the distance between the tick labels and the axis label.

void	setPadding (int padding)
	Sets the padding of the axis.

void	setOffset (int offset)
	Sets the offset the axis has to its axis rect side.

void	setSelectedTickLabelFont (const QFont &font)
	Sets the font that is used for tick labels when they are selected.

void	setSelectedLabelFont (const QFont &font)
	Sets the font that is used for the axis label when it is selected.

void	setSelectedTickLabelColor (const QColor &color)
	Sets the color that is used for tick labels when they are selected.

void	setSelectedLabelColor (const QColor &color)
	Sets the color that is used for the axis label when it is selected.

void	setSelectedBasePen (const QPen &pen)
	Sets the pen that is used to draw the axis base line when selected.

void	setSelectedTickPen (const QPen &pen)
	Sets the pen that is used to draw the (major) ticks when selected.

void	setSelectedSubTickPen (const QPen &pen)
	Sets the pen that is used to draw the subticks when selected.

Q_SLOT void	setSelectableParts (const QCPAxis::SelectableParts &selectableParts)
	Sets whether the user can (de-)select the parts in selectable by clicking on the QCustomPlot surface.

Q_SLOT void	setSelectedParts (const QCPAxis::SelectableParts &selectedParts)
	Sets the selected state of the respective axis parts described by SelectablePart.

void	setLowerEnding (const QCPLineEnding &ending)
	Sets the style for the lower axis ending.

void	setUpperEnding (const QCPLineEnding &ending)
	Sets the style for the upper axis ending.

virtual double	selectTest (const QPointF &pos, bool onlySelectable, QVariant *details=0) const
	This function is used to decide whether a click hits a layerable object or not.

Qt::Orientation	orientation () const
	Returns the orientation of this axis.

void	moveRange (double diff)
	If the scale type (setScaleType) is stLinear, diff is added to the lower and upper bounds of the range.

void	scaleRange (double factor, double center)
	Scales the range of this axis by factor around the coordinate center.

void	setScaleRatio (const QCPAxis *otherAxis, double ratio=1.0)
	Scales the range of this axis to have a certain scale ratio to otherAxis.

void	rescale (bool onlyVisiblePlottables=false)
	Changes the axis range such that all plottables associated with this axis are fully visible in that dimension.

double	pixelToCoord (double value) const
	Transforms value, in pixel coordinates of the QCustomPlot widget, to axis coordinates.

double	coordToPixel (double value) const
	Transforms value, in coordinates of the axis, to pixel coordinates of the QCustomPlot widget.

SelectablePart	getPartAt (const QPointF &pos) const
	Returns the part of the axis that is hit by pos (in pixels).

QList< QCPAbstractPlottable * >	plottables () const
	Returns a list of all the plottables that have this axis as key or value axis.

QList< QCPGraph * >	graphs () const
	Returns a list of all the graphs that have this axis as key or value axis.

QList< QCPAbstractItem * >	items () const
	Returns a list of all the items that are associated with this axis.

Public Member Functions inherited from QCPLayerable
	QCPLayerable (QCustomPlot plot, QString targetLayer="", QCPLayerable parentLayerable=0)
	Creates a new QCPLayerable instance.

	~QCPLayerable ()

bool	visible () const

QCustomPlot *	parentPlot () const

QCPLayerable *	parentLayerable () const
	Returns the parent layerable of this layerable.

QCPLayer *	layer () const

bool	antialiased () const

void	setVisible (bool on)
	Sets the visibility of this layerable object.

Q_SLOT bool	setLayer (QCPLayer *layer)
	Sets the layer of this layerable object.

bool	setLayer (const QString &layerName)
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. Sets the layer of this layerable object by name.

void	setAntialiased (bool enabled)
	Sets whether this object will be drawn antialiased or not.

bool	realVisibility () const
	Returns whether this layerable is visible, taking the visibility of the layerable parent and the visibility of the layer this layerable is on into account.

Static Public Member Functions
static AxisType	marginSideToAxisType (QCP::MarginSide side)
	Transforms a margin side to the logically corresponding axis type.

static Qt::Orientation	orientation (AxisType type)
	Returns the orientation of the specified axis type.

static AxisType	opposite (AxisType type)
	Returns the axis type that describes the opposite axis of an axis with the specified type.

Protected Member Functions
virtual void	setupTickVectors ()

virtual void	generateAutoTicks ()

virtual int	calculateAutoSubTickCount (double tickStep) const

virtual int	calculateMargin ()

virtual void	applyDefaultAntialiasingHint (QCPPainter *painter) const

virtual void	draw (QCPPainter *painter)

virtual QCP::Interaction	selectionCategory () const

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

virtual void	deselectEvent (bool *selectionStateChanged)

void	visibleTickBounds (int &lowIndex, int &highIndex) const

double	baseLog (double value) const

double	basePow (double value) const

QPen	getBasePen () const

QPen	getTickPen () const

QPen	getSubTickPen () const

QFont	getTickLabelFont () const

QFont	getLabelFont () const

QColor	getTickLabelColor () const

QColor	getLabelColor () const

Protected Member Functions inherited from QCPLayerable
virtual void	parentPlotInitialized (QCustomPlot *parentPlot)

virtual QRect	clipRect () const

void	initializeParentPlot (QCustomPlot *parentPlot)

void	setParentLayerable (QCPLayerable *parentLayerable)

bool	moveToLayer (QCPLayer *layer, bool prepend)

void	applyAntialiasingHint (QCPPainter *painter, bool localAntialiased, QCP::AntialiasedElement overrideElement) const

Protected Attributes
AxisType	mAxisType

QCPAxisRect *	mAxisRect

int	mPadding

Qt::Orientation	mOrientation

SelectableParts	mSelectableParts

SelectableParts	mSelectedParts

QPen	mBasePen

QPen	mSelectedBasePen

QString	mLabel

QFont	mLabelFont

QFont	mSelectedLabelFont

QColor	mLabelColor

QColor	mSelectedLabelColor

bool	mTickLabels

bool	mAutoTickLabels

LabelType	mTickLabelType

QFont	mTickLabelFont

QFont	mSelectedTickLabelFont

QColor	mTickLabelColor

QColor	mSelectedTickLabelColor

QString	mDateTimeFormat

Qt::TimeSpec	mDateTimeSpec

int	mNumberPrecision

char	mNumberFormatChar

bool	mNumberBeautifulPowers

bool	mTicks

double	mTickStep

int	mSubTickCount

int	mAutoTickCount

bool	mAutoTicks

bool	mAutoTickStep

bool	mAutoSubTicks

QPen	mTickPen

QPen	mSelectedTickPen

QPen	mSubTickPen

QPen	mSelectedSubTickPen

QCPRange	mRange

bool	mRangeReversed

ScaleType	mScaleType

double	mScaleLogBase

double	mScaleLogBaseLogInv

QCPGrid *	mGrid

QCPAxisPainterPrivate *	mAxisPainter

int	mLowestVisibleTick

int	mHighestVisibleTick

QVector< double >	mTickVector

QVector< QString >	mTickVectorLabels

QVector< double >	mSubTickVector

bool	mCachedMarginValid

int	mCachedMargin

Protected Attributes inherited from QCPLayerable
bool	mVisible

QCustomPlot *	mParentPlot

QPointer< QCPLayerable >	mParentLayerable

QCPLayer *	mLayer

bool	mAntialiased

Friends
class	QCustomPlot

class	QCPGrid

class	QCPAxisRect

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.

Definition at line 979 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 1040 of file qcustomplot.h.

◆ LabelType

enum QCPAxis::LabelType

When automatic tick label generation is enabled (setAutoTickLabels), defines how the coordinate of the tick is interpreted, i.e.

translated into a string.

See also: setTickLabelType

Enumerator
ltNumber	Tick coordinate is regarded as normal number and will be displayed as such. (see setNumberFormat)
ltDateTime	Tick coordinate is regarded as a date/time (seconds since 1970-01-01T00:00:00 UTC) and will be displayed and formatted as such. (for details, see setDateTimeFormat)

Definition at line 1053 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 plots and (major) tick marks at every base power (see setScaleLogBase).

Definition at line 1061 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 1069 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.

You shouldn't instantiate axes directly, rather use QCPAxisRect::addAxis.

Definition at line 4109 of file qcustomplot.cpp.

◆ ~QCPAxis()

QCPAxis::~QCPAxis ( )

virtual

Definition at line 4188 of file qcustomplot.cpp.

Member Function Documentation

◆ applyDefaultAntialiasingHint()

void QCPAxis::applyDefaultAntialiasingHint ( QCPPainter * painter ) const

protectedvirtual

Implements QCPLayerable.

Definition at line 5874 of file qcustomplot.cpp.

◆ autoSubTicks()

bool QCPAxis::autoSubTicks ( ) const

inline

Definition at line 1091 of file qcustomplot.h.

◆ autoTickCount()

int QCPAxis::autoTickCount ( ) const

inline

Definition at line 1088 of file qcustomplot.h.

◆ autoTickLabels()

bool QCPAxis::autoTickLabels ( ) const

inline

Definition at line 1089 of file qcustomplot.h.

◆ autoTicks()

bool QCPAxis::autoTicks ( ) const

inline

Definition at line 1087 of file qcustomplot.h.

◆ autoTickStep()

bool QCPAxis::autoTickStep ( ) const

inline

Definition at line 1090 of file qcustomplot.h.

◆ axisRect()

QCPAxisRect * QCPAxis::axisRect ( ) const

inline

Definition at line 1082 of file qcustomplot.h.

◆ axisType()

AxisType QCPAxis::axisType ( ) const

inline

Definition at line 1081 of file qcustomplot.h.

◆ baseLog()

double QCPAxis::baseLog ( double value ) const

protected

Definition at line 5989 of file qcustomplot.cpp.

◆ basePen()

QPen QCPAxis::basePen ( ) const

inline

Definition at line 1111 of file qcustomplot.h.

◆ basePow()

double QCPAxis::basePow ( double value ) const

protected

Definition at line 6001 of file qcustomplot.cpp.

◆ calculateAutoSubTickCount()

int QCPAxis::calculateAutoSubTickCount ( double tickStep ) const

protectedvirtual

Definition at line 5782 of file qcustomplot.cpp.

◆ calculateMargin()

int QCPAxis::calculateMargin ( )

protectedvirtual

Definition at line 6090 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 5423 of file qcustomplot.cpp.

◆ dateTimeFormat()

QString QCPAxis::dateTimeFormat ( ) const

inline

Definition at line 1099 of file qcustomplot.h.

◆ dateTimeSpec()

Qt::TimeSpec QCPAxis::dateTimeSpec ( ) const

inline

Definition at line 1100 of file qcustomplot.h.

◆ deselectEvent()

void QCPAxis::deselectEvent ( bool * selectionStateChanged )

protectedvirtual

Reimplemented from QCPLayerable.

Definition at line 5853 of file qcustomplot.cpp.

◆ draw()

void QCPAxis::draw ( QCPPainter * painter )

protectedvirtual

Implements QCPLayerable.

Definition at line 5884 of file qcustomplot.cpp.

◆ generateAutoTicks()

void QCPAxis::generateAutoTicks ( )

protectedvirtual

Definition at line 5706 of file qcustomplot.cpp.

◆ getBasePen()

QPen QCPAxis::getBasePen ( ) const

protected

Definition at line 6011 of file qcustomplot.cpp.

◆ getLabelColor()

QColor QCPAxis::getLabelColor ( ) const

protected

Definition at line 6071 of file qcustomplot.cpp.

◆ getLabelFont()

QFont QCPAxis::getLabelFont ( ) const

protected

Definition at line 6051 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 5481 of file qcustomplot.cpp.

◆ getSubTickPen()

QPen QCPAxis::getSubTickPen ( ) const

protected

Definition at line 6031 of file qcustomplot.cpp.

◆ getTickLabelColor()

QColor QCPAxis::getTickLabelColor ( ) const

protected

Definition at line 6061 of file qcustomplot.cpp.

◆ getTickLabelFont()

QFont QCPAxis::getTickLabelFont ( ) const

protected

Definition at line 6041 of file qcustomplot.cpp.

◆ getTickPen()

QPen QCPAxis::getTickPen ( ) const

protected

Definition at line 6021 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 5534 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 1131 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 5553 of file qcustomplot.cpp.

◆ label()

QString QCPAxis::label ( ) const

inline

Definition at line 1116 of file qcustomplot.h.

◆ labelColor()

QColor QCPAxis::labelColor ( ) const

inline

Definition at line 1115 of file qcustomplot.h.

◆ labelFont()

QFont QCPAxis::labelFont ( ) const

inline

Definition at line 1114 of file qcustomplot.h.

◆ labelPadding()

int QCPAxis::labelPadding ( ) const

Definition at line 4244 of file qcustomplot.cpp.

◆ lowerEnding()

QCPLineEnding QCPAxis::lowerEnding ( ) const

Definition at line 4256 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 5577 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 5249 of file qcustomplot.cpp.

◆ numberFormat()

QString QCPAxis::numberFormat ( ) const

Definition at line 4206 of file qcustomplot.cpp.

◆ numberPrecision()

int QCPAxis::numberPrecision ( ) const

inline

Definition at line 1102 of file qcustomplot.h.

◆ offset()

int QCPAxis::offset ( ) const

Definition at line 4250 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 5594 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)

Definition at line 1193 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()

Definition at line 1206 of file qcustomplot.h.

◆ padding()

int QCPAxis::padding ( ) const

inline

Definition at line 1118 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 5385 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 5516 of file qcustomplot.cpp.

◆ range()

const QCPRange QCPAxis::range ( ) const

inline

Definition at line 1085 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.

◆ 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 1086 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 5336 of file qcustomplot.cpp.

◆ scaleLogBase()

double QCPAxis::scaleLogBase ( ) const

inline

Definition at line 1084 of file qcustomplot.h.

◆ scaleRange()

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

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).

Definition at line 5272 of file qcustomplot.cpp.

◆ scaleType()

ScaleType QCPAxis::scaleType ( ) const

inline

Definition at line 1083 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 1121 of file qcustomplot.h.

◆ selectedBasePen()

QPen QCPAxis::selectedBasePen ( ) const

inline

Definition at line 1126 of file qcustomplot.h.

◆ selectedLabelColor()

QColor QCPAxis::selectedLabelColor ( ) const

inline

Definition at line 1125 of file qcustomplot.h.

◆ selectedLabelFont()

QFont QCPAxis::selectedLabelFont ( ) const

inline

Definition at line 1123 of file qcustomplot.h.

◆ selectedParts()

SelectableParts QCPAxis::selectedParts ( ) const

inline

Definition at line 1120 of file qcustomplot.h.

◆ selectedSubTickPen()

QPen QCPAxis::selectedSubTickPen ( ) const

inline

Definition at line 1128 of file qcustomplot.h.

◆ selectedTickLabelColor()

QColor QCPAxis::selectedTickLabelColor ( ) const

inline

Definition at line 1124 of file qcustomplot.h.

◆ selectedTickLabelFont()

QFont QCPAxis::selectedTickLabelFont ( ) const

inline

Definition at line 1122 of file qcustomplot.h.

◆ selectedTickPen()

QPen QCPAxis::selectedTickPen ( ) const

inline

Definition at line 1127 of file qcustomplot.h.

◆ selectEvent()

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

protectedvirtual

Reimplemented from QCPLayerable.

Definition at line 5839 of file qcustomplot.cpp.

◆ selectionCategory()

QCP::Interaction QCPAxis::selectionCategory ( ) const

protectedvirtual

Reimplemented from QCPLayerable.

Definition at line 6135 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 = `0`
	)		const

virtual

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 item is represented not by single lines but by an area like QCPItemRect or QCPItemText, a click inside the area returns a constant value greater zero (typically the selectionTolerance of the parent QCustomPlot multiplied by 0.99). If the click lies outside the area, this function returns -1.0.

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.

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

See also: selectEvent, deselectEvent, QCustomPlot::setInteractions

Reimplemented from QCPLayerable.

Definition at line 5497 of file qcustomplot.cpp.

◆ setAutoSubTicks()

void QCPAxis::setAutoSubTicks ( bool on )

Sets whether the number of sub ticks in one tick interval is determined automatically.

This works, as long as the tick step mantissa is a multiple of 0.5. When setAutoTickStep is enabled, this is always the case.

When on is set to false, you may set the sub tick count with setSubTickCount manually.

See also: setAutoTickCount, setAutoTicks, setAutoTickStep

Definition at line 4597 of file qcustomplot.cpp.

◆ setAutoTickCount()

void QCPAxis::setAutoTickCount ( int approximateCount )

When setAutoTickStep is true, approximateCount determines how many ticks should be generated in the visible range, approximately.

It's not guaranteed that this number of ticks is met exactly, but approximately within a tolerance of about two.

Only values greater than zero are accepted as approximateCount.

See also: setAutoTickStep, setAutoTicks, setAutoSubTicks

Definition at line 4530 of file qcustomplot.cpp.

◆ setAutoTickLabels()

void QCPAxis::setAutoTickLabels ( bool on )

Sets whether the tick labels are generated automatically.

Depending on the tick label type (ltNumber or ltDateTime), the labels will either show the coordinate as floating point number (setNumberFormat), or a date/time formatted according to setDateTimeFormat.

If on is set to false, you should provide the tick labels via setTickVectorLabels. This is usually used in a combination with setAutoTicks set to false for complete control over tick positions and labels, e.g. when the ticks should be at multiples of pi and show "2pi", "3pi" etc. as tick labels.

If you need dynamically calculated tick vectors (and possibly tick label vectors), set the vectors in a slot connected to the ticksRequest signal.

See also: setAutoTicks

Definition at line 4558 of file qcustomplot.cpp.

◆ setAutoTicks()

void QCPAxis::setAutoTicks ( bool on )

Sets whether the tick positions should be calculated automatically (either from an automatically generated tick step or a tick step provided manually via setTickStep, see setAutoTickStep).

If on is set to false, you must provide the tick positions manually via setTickVector. For these manual ticks you may let QCPAxis generate the appropriate labels automatically by leaving setAutoTickLabels set to true. If you also wish to control the displayed labels manually, set setAutoTickLabels to false and provide the label strings with setTickVectorLabels.

If you need dynamically calculated tick vectors (and possibly tick label vectors), set the vectors in a slot connected to the ticksRequest signal.

See also: setAutoTickLabels, setAutoSubTicks, setAutoTickCount, setAutoTickStep

Definition at line 4510 of file qcustomplot.cpp.

◆ setAutoTickStep()

void QCPAxis::setAutoTickStep ( bool on )

Sets whether the tick step, i.e.

the interval between two (major) ticks, is calculated automatically. If on is set to true, the axis finds a tick step that is reasonable for human readable plots.

The number of ticks the algorithm aims for within the visible range can be specified with setAutoTickCount.

If on is set to false, you may set the tick step manually with setTickStep.

See also: setAutoTicks, setAutoSubTicks, setAutoTickCount

Definition at line 4579 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 5026 of file qcustomplot.cpp.

◆ setDateTimeFormat()

void QCPAxis::setDateTimeFormat ( const QString & format )

Sets the format in which dates and times are displayed as tick labels, if setTickLabelType is ltDateTime.

for details about the format string, see the documentation of QDateTime::toString().

Newlines can be inserted with "\n".

See also: setDateTimeSpec

Definition at line 4730 of file qcustomplot.cpp.

◆ setDateTimeSpec()

void QCPAxis::setDateTimeSpec ( const Qt::TimeSpec & timeSpec )

Sets the time spec that is used for the date time values when setTickLabelType is ltDateTime.

The default value of QDateTime objects (and also QCustomPlot) is Qt::LocalTime. However, if the date time values passed to QCustomPlot are given in the UTC spec, set timeSpec to Qt::UTC to get the correct axis labels.

See also: setDateTimeFormat

Definition at line 4749 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 5079 of file qcustomplot.cpp.

◆ setLabelColor()

void QCPAxis::setLabelColor ( const QColor & color )

Sets the color of the axis label.

See also: setLabelFont

Definition at line 5070 of file qcustomplot.cpp.

◆ setLabelFont()

void QCPAxis::setLabelFont ( const QFont & font )

Sets the font of the axis label.

See also: setLabelColor

Definition at line 5056 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 5093 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 5222 of file qcustomplot.cpp.

◆ setNumberFormat()

void QCPAxis::setNumberFormat ( const QString & formatCode )

Sets the number format for the numbers drawn as tick labels (if tick label type is ltNumber).

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.

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.

If the scale type (setScaleType) is stLogarithmic and the formatCode uses the 'b' option (beautifully typeset decimal powers), the display usually is "1 [multiplication sign] 10 [superscript] n", which looks unnatural for logarithmic scaling (the "1 [multiplication sign]" part). To only display the decimal power, set the number precision to zero with setNumberPrecision.

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 4790 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

If the scale type (setScaleType) is stLogarithmic and the number format (setNumberFormat) uses the 'b' format code (beautifully typeset decimal powers), the display usually is "1 [multiplication sign] 10 [superscript] n", which looks unnatural for logarithmic scaling (the redundant "1 [multiplication sign]" part). To only display the decimal power "10 [superscript] n", set precision to zero.

Definition at line 4856 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 5129 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 5112 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 4318 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 4389 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 4421 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 4435 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 4486 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 4458 of file qcustomplot.cpp.

◆ setScaleLogBase()

void QCPAxis::setScaleLogBase ( double base )

If setScaleType is set to stLogarithmic, base will be the logarithm base of the scaling.

In logarithmic axis scaling, major tick marks appear at all powers of base.

Properties like tick step (setTickStep) don't apply in logarithmic scaling. If you wish a decimal base but less major ticks, consider choosing base 100, 1000 or even higher.

Definition at line 4299 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 5312 of file qcustomplot.cpp.

◆ setScaleType()

void QCPAxis::setScaleType ( QCPAxis::ScaleType type )

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

If type is set to stLogarithmic, the logarithm base can be set with setScaleLogBase. In logarithmic axis scaling, major tick marks appear at all powers of the logarithm base. Properties like tick step (setTickStep) don't apply in logarithmic scaling. If you wish a decimal base but less major ticks, consider choosing a logarithm base of 100, 1000 or even higher.

If type is stLogarithmic and the number format (setNumberFormat) uses the 'b' option (beautifully typeset decimal powers), the display usually is "1 [multiplication sign] 10 [superscript] n", which looks unnatural for logarithmic scaling (the "1 [multiplication sign]" part). To only display the decimal power, set the number precision to zero with setNumberPrecision.

Definition at line 4280 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 4347 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 5187 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 5177 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 5153 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 4371 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 5207 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 5164 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 5139 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 5197 of file qcustomplot.cpp.

◆ setSubTickCount()

void QCPAxis::setSubTickCount ( int count )

Sets the number of sub ticks in one (major) tick step.

A sub tick count of three for example, divides the tick intervals in four sub intervals.

By default, the number of sub ticks is chosen automatically in a reasonable manner as long as the mantissa of the tick step is a multiple of 0.5. When setAutoTickStep is enabled, this is always the case.

If you want to disable automatic sub tick count and use this function to set the count manually, see setAutoSubTicks.

Definition at line 4972 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 4985 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 4997 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 5012 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 5046 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 4695 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 4681 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 4637 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 4713 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 4624 of file qcustomplot.cpp.

◆ setTickLabelType()

void QCPAxis::setTickLabelType ( LabelType type )

Sets whether the tick labels display numbers or dates/times.

If type is set to ltNumber, the format specifications of setNumberFormat apply.

If type is set to ltDateTime, the format specifications of setDateTimeFormat apply.

In QCustomPlot, date/time coordinates are double numbers representing the seconds since 1970-01-01T00:00:00 UTC. This format can be retrieved from QDateTime objects with the QDateTime::toTime_t() function. Since this only gives a resolution of one second, there is also the QDateTime::toMSecsSinceEpoch() function which returns the timespan described above in milliseconds. Divide its return value by 1000.0 to get a value with the format needed for date/time plotting, with a resolution of one millisecond.

Using the toMSecsSinceEpoch function allows dates that go back to 2nd January 4713 B.C. (represented by a negative number), unlike the toTime_t function, which works with unsigned integers and thus only goes back to 1st January 1970. So both for range and accuracy, use of toMSecsSinceEpoch()/1000.0 should be preferred as key coordinate for date/time axes.

See also: setTickLabels

Definition at line 4667 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 4925 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 4937 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 4952 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 5036 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.

Definition at line 4612 of file qcustomplot.cpp.

◆ setTickStep()

void QCPAxis::setTickStep ( double step )

If setAutoTickStep is set to false, use this function to set the tick step manually.

The tick step is the interval between (major) ticks, in plot coordinates.

See also: setSubTickCount

Definition at line 4870 of file qcustomplot.cpp.

◆ setTickVector()

void QCPAxis::setTickVector ( const QVector< double > & vec )

If you want full control over what ticks (and possibly labels) the axes show, this function is used to set the coordinates at which ticks will appear.

setAutoTicks must be disabled, else the provided tick vector will be overwritten with automatically generated tick coordinates upon replot. The labels of the ticks can be generated automatically when setAutoTickLabels is left enabled. If it is disabled, you can set the labels manually with setTickVectorLabels.

vec is a vector containing the positions of the ticks, in plot coordinates.

Warning: vec must be sorted in ascending order, no additional checks are made to ensure this.

See also: setTickVectorLabels

Definition at line 4892 of file qcustomplot.cpp.

◆ setTickVectorLabels()

void QCPAxis::setTickVectorLabels ( const QVector< QString > & vec )

If you want full control over what ticks and labels the axes show, this function is used to set a number of QStrings that will be displayed at the tick positions which you need to provide with setTickVector.

These two vectors should have the same size. (Note that you need to disable setAutoTicks and setAutoTickLabels first.)

vec is a vector containing the labels of the ticks. The entries correspond to the respective indices in the tick vector, passed via setTickVector.

See also: setTickVector

Definition at line 4910 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 5237 of file qcustomplot.cpp.

◆ setupTickVectors()

void QCPAxis::setupTickVectors ( )

protectedvirtual

Definition at line 5613 of file qcustomplot.cpp.

◆ subTickCount()

int QCPAxis::subTickCount ( ) const

inline

Definition at line 1108 of file qcustomplot.h.

◆ subTickLengthIn()

int QCPAxis::subTickLengthIn ( ) const

Definition at line 4232 of file qcustomplot.cpp.

◆ subTickLengthOut()

int QCPAxis::subTickLengthOut ( ) const

Definition at line 4238 of file qcustomplot.cpp.

◆ subTickPen()

QPen QCPAxis::subTickPen ( ) const

inline

Definition at line 1113 of file qcustomplot.h.

◆ tickLabelColor()

QColor QCPAxis::tickLabelColor ( ) const

inline

Definition at line 1097 of file qcustomplot.h.

◆ tickLabelFont()

QFont QCPAxis::tickLabelFont ( ) const

inline

Definition at line 1096 of file qcustomplot.h.

◆ tickLabelPadding()

int QCPAxis::tickLabelPadding ( ) const

Definition at line 4194 of file qcustomplot.cpp.

◆ tickLabelRotation()

double QCPAxis::tickLabelRotation ( ) const

Definition at line 4200 of file qcustomplot.cpp.

◆ tickLabels()

bool QCPAxis::tickLabels ( ) const

inline

Definition at line 1093 of file qcustomplot.h.

◆ tickLabelType()

LabelType QCPAxis::tickLabelType ( ) const

inline

Definition at line 1095 of file qcustomplot.h.

◆ tickLengthIn()

int QCPAxis::tickLengthIn ( ) const

Definition at line 4220 of file qcustomplot.cpp.

◆ tickLengthOut()

int QCPAxis::tickLengthOut ( ) const

Definition at line 4226 of file qcustomplot.cpp.

◆ tickPen()

QPen QCPAxis::tickPen ( ) const

inline

Definition at line 1112 of file qcustomplot.h.

◆ ticks()

bool QCPAxis::ticks ( ) const

inline

Definition at line 1092 of file qcustomplot.h.

◆ ticksRequest

void QCPAxis::ticksRequest ( )

signal

This signal is emitted when setAutoTicks is false and the axis is about to generate tick labels for a replot.

Modifying the tick positions can be done with setTickVector. If you also want to control the tick labels, set setAutoTickLabels to false and also provide the labels with setTickVectorLabels.

If you only want static ticks you probably don't need this signal, since you can just set the tick vector (and possibly tick label vector) once. However, if you want to provide ticks (and maybe labels) dynamically, e.g. depending on the current axis range, connect a slot to this signal and set the vector/vectors there.

◆ tickStep()

double QCPAxis::tickStep ( ) const

inline

Definition at line 1103 of file qcustomplot.h.

◆ tickVector()

QVector< double > QCPAxis::tickVector ( ) const

inline

Definition at line 1104 of file qcustomplot.h.

◆ tickVectorLabels()

QVector< QString > QCPAxis::tickVectorLabels ( ) const

inline

Definition at line 1105 of file qcustomplot.h.

◆ upperEnding()

QCPLineEnding QCPAxis::upperEnding ( ) const

Definition at line 4262 of file qcustomplot.cpp.

◆ visibleTickBounds()

void QCPAxis::visibleTickBounds	(	int &	lowIndex,
		int &	highIndex
	)		const

protected

Definition at line 5949 of file qcustomplot.cpp.

Friends And Related Symbol Documentation

◆ QCPAxisRect

friend class QCPAxisRect

friend

Definition at line 1301 of file qcustomplot.h.

◆ QCPGrid

friend class QCPGrid

friend

Definition at line 1300 of file qcustomplot.h.

◆ QCustomPlot

friend class QCustomPlot

friend

Definition at line 1299 of file qcustomplot.h.

Member Data Documentation

◆ mAutoSubTicks

bool QCPAxis::mAutoSubTicks

protected

Definition at line 1250 of file qcustomplot.h.

◆ mAutoTickCount

int QCPAxis::mAutoTickCount

protected

Definition at line 1249 of file qcustomplot.h.

◆ mAutoTickLabels

bool QCPAxis::mAutoTickLabels

protected

Definition at line 1235 of file qcustomplot.h.

◆ mAutoTicks

bool QCPAxis::mAutoTicks

protected

Definition at line 1250 of file qcustomplot.h.

◆ mAutoTickStep

bool QCPAxis::mAutoTickStep

protected

Definition at line 1250 of file qcustomplot.h.

◆ mAxisPainter

QCPAxisPainterPrivate* QCPAxis::mAxisPainter

protected

Definition at line 1262 of file qcustomplot.h.

◆ mAxisRect

QCPAxisRect* QCPAxis::mAxisRect

protected

Definition at line 1221 of file qcustomplot.h.

◆ mAxisType

AxisType QCPAxis::mAxisType

protected

Definition at line 1220 of file qcustomplot.h.

◆ mBasePen

QPen QCPAxis::mBasePen

protected

Definition at line 1226 of file qcustomplot.h.

◆ mCachedMargin

int QCPAxis::mCachedMargin

protected

Definition at line 1268 of file qcustomplot.h.

◆ mCachedMarginValid

bool QCPAxis::mCachedMarginValid

protected

Definition at line 1267 of file qcustomplot.h.

◆ mDateTimeFormat

QString QCPAxis::mDateTimeFormat

protected

Definition at line 1240 of file qcustomplot.h.

◆ mDateTimeSpec

Qt::TimeSpec QCPAxis::mDateTimeSpec

protected

Definition at line 1241 of file qcustomplot.h.

◆ mGrid

QCPGrid* QCPAxis::mGrid

protected

Definition at line 1261 of file qcustomplot.h.

◆ mHighestVisibleTick

int QCPAxis::mHighestVisibleTick

protected

Definition at line 1263 of file qcustomplot.h.

◆ mLabel

QString QCPAxis::mLabel

protected

Definition at line 1230 of file qcustomplot.h.

◆ mLabelColor

QColor QCPAxis::mLabelColor

protected

Definition at line 1232 of file qcustomplot.h.

◆ mLabelFont

QFont QCPAxis::mLabelFont

protected

Definition at line 1231 of file qcustomplot.h.

◆ mLowestVisibleTick

int QCPAxis::mLowestVisibleTick

protected

Definition at line 1263 of file qcustomplot.h.

◆ mNumberBeautifulPowers

bool QCPAxis::mNumberBeautifulPowers

protected

Definition at line 1244 of file qcustomplot.h.

◆ mNumberFormatChar

char QCPAxis::mNumberFormatChar

protected

Definition at line 1243 of file qcustomplot.h.

◆ mNumberPrecision

int QCPAxis::mNumberPrecision

protected

Definition at line 1242 of file qcustomplot.h.

◆ mOrientation

Qt::Orientation QCPAxis::mOrientation

protected

Definition at line 1224 of file qcustomplot.h.

◆ mPadding

int QCPAxis::mPadding

protected

Definition at line 1223 of file qcustomplot.h.

◆ mRange

QCPRange QCPAxis::mRange

protected

Definition at line 1255 of file qcustomplot.h.

◆ mRangeReversed

bool QCPAxis::mRangeReversed

protected

Definition at line 1256 of file qcustomplot.h.

◆ mScaleLogBase

double QCPAxis::mScaleLogBase

protected

Definition at line 1258 of file qcustomplot.h.

◆ mScaleLogBaseLogInv

double QCPAxis::mScaleLogBaseLogInv

protected

Definition at line 1258 of file qcustomplot.h.

◆ mScaleType

ScaleType QCPAxis::mScaleType

protected

Definition at line 1257 of file qcustomplot.h.

◆ mSelectableParts

SelectableParts QCPAxis::mSelectableParts

protected

Definition at line 1225 of file qcustomplot.h.

◆ mSelectedBasePen

QPen QCPAxis::mSelectedBasePen

protected

Definition at line 1226 of file qcustomplot.h.

◆ mSelectedLabelColor

QColor QCPAxis::mSelectedLabelColor

protected

Definition at line 1232 of file qcustomplot.h.

◆ mSelectedLabelFont

QFont QCPAxis::mSelectedLabelFont

protected

Definition at line 1231 of file qcustomplot.h.

◆ mSelectedParts

SelectableParts QCPAxis::mSelectedParts

protected

Definition at line 1225 of file qcustomplot.h.

◆ mSelectedSubTickPen

QPen QCPAxis::mSelectedSubTickPen

protected

Definition at line 1253 of file qcustomplot.h.

◆ mSelectedTickLabelColor

QColor QCPAxis::mSelectedTickLabelColor

protected

Definition at line 1239 of file qcustomplot.h.

◆ mSelectedTickLabelFont

QFont QCPAxis::mSelectedTickLabelFont

protected

Definition at line 1238 of file qcustomplot.h.

◆ mSelectedTickPen

QPen QCPAxis::mSelectedTickPen

protected

Definition at line 1252 of file qcustomplot.h.

◆ mSubTickCount

int QCPAxis::mSubTickCount

protected

Definition at line 1249 of file qcustomplot.h.

◆ mSubTickPen

QPen QCPAxis::mSubTickPen

protected

Definition at line 1253 of file qcustomplot.h.

◆ mSubTickVector

QVector<double> QCPAxis::mSubTickVector

protected

Definition at line 1266 of file qcustomplot.h.

◆ mTickLabelColor

QColor QCPAxis::mTickLabelColor

protected

Definition at line 1239 of file qcustomplot.h.

◆ mTickLabelFont

QFont QCPAxis::mTickLabelFont

protected

Definition at line 1238 of file qcustomplot.h.

◆ mTickLabels

bool QCPAxis::mTickLabels

protected

Definition at line 1235 of file qcustomplot.h.

◆ mTickLabelType

LabelType QCPAxis::mTickLabelType

protected

Definition at line 1237 of file qcustomplot.h.

◆ mTickPen

QPen QCPAxis::mTickPen

protected

Definition at line 1252 of file qcustomplot.h.

◆ mTicks

bool QCPAxis::mTicks

protected

Definition at line 1247 of file qcustomplot.h.

◆ mTickStep

double QCPAxis::mTickStep

protected

Definition at line 1248 of file qcustomplot.h.

◆ mTickVector

QVector<double> QCPAxis::mTickVector

protected

Definition at line 1264 of file qcustomplot.h.

◆ mTickVectorLabels

QVector<QString> QCPAxis::mTickVectorLabels

protected

Definition at line 1265 of file qcustomplot.h.

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

icub-main/src/tools/skinManagerGui/qcustomplot.h
icub-main/src/tools/skinManagerGui/qcustomplot.cpp

Public Types

Signals

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Friends

Detailed Description

Member Enumeration Documentation

◆ AxisType

◆ LabelType

◆ ScaleType

◆ SelectablePart

Constructor & Destructor Documentation

◆ QCPAxis()

◆ ~QCPAxis()

Member Function Documentation

◆ applyDefaultAntialiasingHint()

◆ autoSubTicks()

◆ autoTickCount()

◆ autoTickLabels()

◆ autoTicks()

◆ autoTickStep()

◆ axisRect()

◆ axisType()

◆ baseLog()

◆ basePen()

◆ basePow()

◆ calculateAutoSubTickCount()

◆ calculateMargin()

◆ coordToPixel()

◆ dateTimeFormat()

◆ dateTimeSpec()

◆ deselectEvent()

◆ draw()

◆ generateAutoTicks()

◆ getBasePen()

◆ getLabelColor()

◆ getLabelFont()

◆ getPartAt()

◆ getSubTickPen()

◆ getTickLabelColor()

◆ getTickLabelFont()

◆ getTickPen()

◆ graphs()

◆ grid()

◆ items()

◆ label()

◆ labelColor()

◆ labelFont()

◆ labelPadding()

◆ lowerEnding()

◆ marginSideToAxisType()

◆ moveRange()

◆ numberFormat()

◆ numberPrecision()

◆ offset()

◆ opposite()

◆ orientation() [1/2]

◆ orientation() [2/2]

◆ padding()

◆ pixelToCoord()

◆ plottables()

◆ range()

◆ rangeChanged [1/2]

◆ rangeChanged [2/2]

◆ rangeReversed()

◆ rescale()

◆ scaleLogBase()

◆ scaleRange()

◆ scaleType()

◆ scaleTypeChanged

◆ selectableChanged

◆ selectableParts()

◆ selectedBasePen()

◆ selectedLabelColor()

◆ selectedLabelFont()

◆ selectedParts()

◆ selectedSubTickPen()

◆ selectedTickLabelColor()