class QBarCategoryAxis#

The QBarCategoryAxis class adds categories to a chart’s axes. More

Inheritance diagram of PySide6.QtCharts.QBarCategoryAxis

Synopsis#

Properties#

Methods#

Signals#

Note

This documentation may contain snippets that were automatically translated from C++ to Python. We always welcome contributions to the snippet translation. If you see an issue with the translation, you can also let us know by creating a ticket on https:/bugreports.qt.io/projects/PYSIDE

Detailed Description#

QBarCategoryAxis can be set up to show an axis line with tick marks, grid lines, and shades. Categories are drawn between the ticks. It can be used also with a line series, as demonstrated by the Charts with Widgets Gallery .

The following code illustrates how to use QBarCategoryAxis :

QChartView *chartView = new QChartView;
QBarSeries *series = new QBarSeries;
// ...
chartView->chart()->addSeries(series);
chartView->chart()->createDefaultAxes();

QBarCategoryAxis *axisX = new QBarCategoryAxis;
QStringList categories;
categories << "Jan" << "Feb" << "Mar" << "Apr" << "May" << "Jun";
axisX->append(categories);
axisX->setRange("Feb", "May");
chartView->chart()->setAxisX(axisX, series);

Note

Properties can be used directly when from __feature__ import true_property is used or via accessor functions otherwise.

property categoriesᅟ: list of strings#

This property holds The categories of an axis..

Access functions:
property countᅟ: int#

This property holds The number of categories of an axis..

Access functions:
property maxᅟ: str#

This property holds The maximum value on the axis..

Access functions:
property minᅟ: str#

This property holds The minimum value on the axis..

Access functions:
__init__([parent=None])#
Parameters:

parentQObject

Constructs an axis object that is the child of parent.

append(category)#
Parameters:

category – str

Appends category to an axis. The maximum value on the axis will be changed to match the last category. If no categories were previously defined, the minimum value on the axis will also be changed to match category.

A category has to be a valid QString and it cannot be duplicated. Duplicated categories will not be appended.

append(categories)
Parameters:

categories – list of strings

Appends categories to an axis. The maximum value on the axis will be changed to match the last category in categories. If no categories were previously defined, the minimum value on the axis will also be changed to match the first category in categories.

A category has to be a valid QString and it cannot be duplicated. Duplicated categories will not be appended.

at(index)#
Parameters:

index – int

Return type:

str

Returns the category at index. The index must be valid.

categories()#
Return type:

list of strings

Returns categories.

See also

setCategories()

Getter of property categoriesᅟ .

categoriesChanged()#

This signal is emitted when the categories of the axis change.

Notification signal of property categoriesᅟ .

clear()#

Removes all categories. Sets the maximum and minimum values of the axis range to QString::null.

count()#
Return type:

int

Returns the number of categories.

Getter of property countᅟ .

countChanged()#

This signal is emitted when the number of categories of an axis changes.

Notification signal of property countᅟ .

insert(index, category)#
Parameters:
  • index – int

  • category – str

Inserts category to the axis at index. category has to be a valid QString and it cannot be duplicated. If category is prepended or appended to other categories, the minimum and maximum values on the axis are updated accordingly.

max()#
Return type:

str

Returns the maximum category.

See also

setMax()

Getter of property maxᅟ .

maxChanged(max)#
Parameters:

max – str

This signal is emitted when the max value of the axis changes.

Notification signal of property maxᅟ .

min()#
Return type:

str

Returns the minimum category.

See also

setMin()

Getter of property minᅟ .

minChanged(min)#
Parameters:

min – str

This signal is emitted when the min value of the axis changes.

Notification signal of property minᅟ .

rangeChanged(min, max)#
Parameters:
  • min – str

  • max – str

This signal is emitted when min or max value of the axis changes.

remove(category)#
Parameters:

category – str

Removes category from the axis. Removing a category that currently sets the maximum or minimum value on the axis will affect the axis range.

replace(oldCategory, newCategory)#
Parameters:
  • oldCategory – str

  • newCategory – str

Replaces oldCategory with newCategory. If oldCategory does not exist on the axis, nothing is done. newCategory has to be a valid QString and it cannot be duplicated. If the minimum or maximum category is replaced, the minimum and maximum values on the axis are updated accordingly.

setCategories(categories)#
Parameters:

categories – list of strings

Sets categories and discards the old ones. The axis range is adjusted to match the first and last category in categories.

A category has to be a valid QString and it cannot be duplicated.

See also

categories()

Setter of property categoriesᅟ .

setMax(maxCategory)#
Parameters:

maxCategory – str

Sets the maximum category to max.

See also

max()

Setter of property maxᅟ .

setMin(minCategory)#
Parameters:

minCategory – str

Sets the minimum category to min.

See also

min()

Setter of property minᅟ .

setRange(minCategory, maxCategory)#
Parameters:
  • minCategory – str

  • maxCategory – str

Sets the axis range from minCategory to maxCategory.