Contents

KPlotAxis Class

Axis for KPlotWidget. More...

Header: #include <KPlotAxis>
CMake: find_package(KF6 REQUIRED COMPONENTS Plotting)
target_link_libraries(mytarget PRIVATE KF6::Plotting)

Public Functions

KPlotAxis(const QString &label = QString())
bool areTickLabelsShown() const
bool isVisible() const
QString label() const
QList<double> majorTickMarks() const
QList<double> minorTickMarks() const
void setLabel(const QString &label)
void setTickLabelFormat(char format = 'g', int fieldWidth = 0, int precision = -1)
void setTickLabelsShown(bool b)
void setTickMarks(double x0, double length)
void setVisible(bool visible)
QString tickLabel(double value) const
char tickLabelFormat() const
int tickLabelPrecision() const
int tickLabelWidth() const

Detailed Description

Contains all data for drawing an axis including format specification axis labels.

Member Function Documentation

[explicit] KPlotAxis::KPlotAxis(const QString &label = QString())

Constructor, constructs an axis with the label label.

bool KPlotAxis::areTickLabelsShown() const

Returns whether tick labels will be drawn for this axis

bool KPlotAxis::isVisible() const

Returns whether the axis is visible or not

QString KPlotAxis::label() const

Returns the label string for this axis

See also setLabel().

QList<double> KPlotAxis::majorTickMarks() const

Returns the list of coordinates of the major tickmarks for this axis

Note: the positions of tickmarks are automatically computed by setTickMarks().

See also setTickMarks() and minorTickMarks().

QList<double> KPlotAxis::minorTickMarks() const

Returns the list with the minor tickmarks

Note: the positions of tickmarks are automatically computed by setTickMarks().

See also setTickMarks() and majorTickMarks().

void KPlotAxis::setLabel(const QString &label)

Sets the axis label.

Set the label to an empty string to omit the axis label.

label a string describing the data plotted on the axis.

See also label().

void KPlotAxis::setTickLabelFormat(char format = 'g', int fieldWidth = 0, int precision = -1)

Set the display format for converting the double value of the tick's position to the QString for the tick label.

Normally, the format character is one of 'e', 'E', 'f', 'g', or 'G' (see the documentation for QString::arg(double) for details).

In addition, it is possible to set the format character to 't'; in this case the tickmark value is interpreted as a time in hours, and the ticklabel string will be in "hh:mm" clock format. Note that when the format character is 't', the fieldWidth and prec values are ignored.

format the format specification character

fieldWidth the number of characters in the output string.

If set to 0, the string will be as wide as it needs to be to fully render the value.

precision the number of characters following the decimal point.

See also tickLabelFormat().

void KPlotAxis::setTickLabelsShown(bool b)

Determine whether tick labels will be drawn for this axis.

b if true, tick labels will be drawn.

void KPlotAxis::setTickMarks(double x0, double length)

Determine the positions of major and minor tickmarks for this axis.

Note: this function is called by KPlotWidget whenever the plot's limits are modified.

x0 the minimum data coordinate of the axis.

length the range covered by the axis, in data units.

See also majorTickMarks() and minorTickMarks().

void KPlotAxis::setVisible(bool visible)

Sets the "visible" property of the axis.

visible if true, this axis will be drawn on the KPlotWidget

See also isVisible().

QString KPlotAxis::tickLabel(double value) const

Returns the ticklabel string for the given value, rendered according to the current format specification.

value the value to be rendered as a tick label.

See also setTickLabelFormat().

char KPlotAxis::tickLabelFormat() const

Returns the number format of the tick labels

See also setTickLabelFormat().

int KPlotAxis::tickLabelPrecision() const

Returns the number precision of the tick labels

int KPlotAxis::tickLabelWidth() const

Returns the field width of the tick labels