QGIS API Documentation 3.99.0-Master (21b3aa880ba)
Loading...
Searching...
No Matches
QgsLayoutChartSeriesDetailsWidget Class Reference

A widget for editing series details for a layout chart item. More...

#include <qgslayoutchartseriesdetailswidget.h>

Inheritance diagram for QgsLayoutChartSeriesDetailsWidget:

Public Member Functions

 QgsLayoutChartSeriesDetailsWidget (QgsVectorLayer *layer, int index, const QgsLayoutItemChart::SeriesDetails &seriesDetails, QWidget *parent=nullptr)
 Constructor for QgsLayoutChartSeriesDetailsWidget.
QString filterExpression () const
 Returns the filter expression.
int index () const
 Returns the series index.
QString xExpression () const
 Returns the X-axis expression.
QString yExpression () const
 Returns the Y-axis expression.
Public Member Functions inherited from QgsPanelWidget
 QgsPanelWidget (QWidget *parent=nullptr)
 Base class for any widget that can be shown as an inline panel.
virtual bool applySizeConstraintsToStack () const
 Returns true if the size constraints and hints for the panel widget should be applied to the parent QgsPanelWidgetStack which this panel is shown in.
bool autoDelete () const
 The the auto delete property on the widget.
void connectChildPanel (QgsPanelWidget *panel)
 Connect the given sub panel widgets showPanel signals to this current panels main showPanel event to bubble up to the user.
void connectChildPanels (const QList< QgsPanelWidget * > &panels)
 Connect the given sub panel widgets showPanel signals to this current panels main showPanel event to bubble up to the user.
bool dockMode () const
 Returns the dock mode state.
virtual QMenu * menuButtonMenu ()
 Returns the menu to use for the menu button for this panel, or nullptr if no menu button is required.
virtual QString menuButtonTooltip () const
 Returns the (translated) tooltip text to use for the menu button for this panel.
QString panelTitle () const
 The title of the panel.
void setAutoDelete (bool autoDelete)
 The the auto delete property on the widget.
virtual void setDockMode (bool dockMode)
 Set the widget in dock mode which tells the widget to emit panel widgets and not open dialogs.
void setPanelTitle (const QString &panelTitle)
 Set the title of the panel when shown in the interface.

Additional Inherited Members

Public Slots inherited from QgsPanelWidget
void acceptPanel ()
 Accept the panel.
void openPanel (QgsPanelWidget *panel)
 Open a panel or dialog depending on dock mode setting If dock mode is true this method will emit the showPanel signal for connected slots to handle the open event.
Signals inherited from QgsPanelWidget
void panelAccepted (QgsPanelWidget *panel)
 Emitted when the panel is accepted by the user.
void showPanel (QgsPanelWidget *panel)
 Emit when you require a panel to be show in the interface.
void widgetChanged ()
 Emitted when the widget state changes.
Static Public Member Functions inherited from QgsPanelWidget
static QgsPanelWidgetfindParentPanel (QWidget *widget)
 Traces through the parents of a widget to find if it is contained within a QgsPanelWidget widget.
Protected Member Functions inherited from QgsPanelWidget
void keyPressEvent (QKeyEvent *event) override
 Overridden key press event to handle the esc event on the widget.

Detailed Description

A widget for editing series details for a layout chart item.

Since
QGIS 4.0

Definition at line 35 of file qgslayoutchartseriesdetailswidget.h.

Constructor & Destructor Documentation

◆ QgsLayoutChartSeriesDetailsWidget()

QgsLayoutChartSeriesDetailsWidget::QgsLayoutChartSeriesDetailsWidget ( QgsVectorLayer * layer,
int index,
const QgsLayoutItemChart::SeriesDetails & seriesDetails,
QWidget * parent = nullptr )

Constructor for QgsLayoutChartSeriesDetailsWidget.

Parameters
layerthe vector layer associated to the series
indexthe series index
seriesDetailsthe series details
parentthe parent widget

Definition at line 24 of file qgslayoutchartseriesdetailswidget.cpp.

Member Function Documentation

◆ filterExpression()

QString QgsLayoutChartSeriesDetailsWidget::filterExpression ( ) const

Returns the filter expression.

Definition at line 62 of file qgslayoutchartseriesdetailswidget.cpp.

◆ index()

int QgsLayoutChartSeriesDetailsWidget::index ( ) const

Returns the series index.

Definition at line 47 of file qgslayoutchartseriesdetailswidget.cpp.

◆ xExpression()

QString QgsLayoutChartSeriesDetailsWidget::xExpression ( ) const

Returns the X-axis expression.

Definition at line 52 of file qgslayoutchartseriesdetailswidget.cpp.

◆ yExpression()

QString QgsLayoutChartSeriesDetailsWidget::yExpression ( ) const

Returns the Y-axis expression.

Definition at line 57 of file qgslayoutchartseriesdetailswidget.cpp.


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