An vector layer plot data gatherer class for XY series. More...

#include <qgsvectorlayerplotdatagatherer.h>

Inheritance diagram for QgsVectorLayerXyPlotDataGatherer:

[legend]

Classes
struct	XySeriesDetails
	XY series details. More...

Public Member Functions
	QgsVectorLayerXyPlotDataGatherer (Qgis::PlotAxisType xAxisType=Qgis::PlotAxisType::Interval)
	The vector layer XY plot data gatherer constructor.
	~QgsVectorLayerXyPlotDataGatherer () override=default
QgsPlotData	data () const override
	Returns the plot data.
bool	run () override
	Performs the task's operation.
void	setPredefinedCategories (const QStringList &categories)
	Sets the predefined categories list that will be used to restrict the categories used when gathering the data.
void	setSeriesDetails (const QList< QgsVectorLayerXyPlotDataGatherer::XySeriesDetails > &details)
	Sets the series details list that will be used to prepare the data being gathered.
Public Member Functions inherited from QgsVectorLayerAbstractPlotDataGatherer
	QgsVectorLayerAbstractPlotDataGatherer ()=default
	~QgsVectorLayerAbstractPlotDataGatherer () override=default
void	setExpressionContext (const QgsExpressionContext &context)
	Sets the expression context used when evaluating values being gathered.
void	setFeatureIterator (QgsFeatureIterator &iterator)
	Sets the feature iterator used to gather data from.
Public Member Functions inherited from QgsTask
	QgsTask (const QString &description=QString(), QgsTask::Flags flags=AllFlags)
	Constructor for QgsTask.
	~QgsTask () override
void	addSubTask (QgsTask *subTask, const QgsTaskList &dependencies=QgsTaskList(), SubTaskDependency subTaskDependency=SubTaskIndependent)
	Adds a subtask to this task.
bool	canCancel () const
	Returns `true` if the task can be canceled.
virtual void	cancel ()
	Notifies the task that it should terminate.
QList< QgsMapLayer * >	dependentLayers () const
	Returns the list of layers on which the task depends.
QString	description () const
	Returns the task's description.
qint64	elapsedTime () const
	Returns the elapsed time since the task commenced, in milliseconds.
Flags	flags () const
	Returns the flags associated with the task.
void	hold ()
	Places the task on hold.
bool	isActive () const
	Returns `true` if the task is active, ie it is not complete and has not been canceled.
double	progress () const
	Returns the task's progress (between 0.0 and 100.0).
void	setDependentLayers (const QList< QgsMapLayer * > &dependentLayers)
	Sets a list of layers on which the task depends.
void	setDescription (const QString &description)
	Sets the task's description.
TaskStatus	status () const
	Returns the current task status.
void	unhold ()
	Releases the task from being held.
bool	waitForFinished (int timeout=30000)
	Blocks the current thread until the task finishes or a maximum of timeout milliseconds.

Protected Attributes
QgsPlotData	mData
Protected Attributes inherited from QgsVectorLayerAbstractPlotDataGatherer
QgsExpressionContext	mExpressionContext
QgsFeatureIterator	mIterator

Additional Inherited Members
Public Types inherited from QgsTask
enum	Flag { CanCancel = 1 << 1 , CancelWithoutPrompt = 1 << 2 , Hidden = 1 << 3 , Silent = 1 << 4 , AllFlags = CanCancel }
	Task flags. More...
typedef QFlags< Flag >	Flags
enum	SubTaskDependency { SubTaskIndependent = 0 , ParentDependsOnSubTask }
	Controls how subtasks relate to their parent task. More...
enum	TaskStatus { Queued , OnHold , Running , Complete , Terminated }
	Status of tasks. More...
Signals inherited from QgsTask
void	begun ()
	Will be emitted by task to indicate its commencement.
void	progressChanged (double progress)
	Will be emitted by task when its progress changes.
void	statusChanged (int status)
	Will be emitted by task when its status changes.
void	taskCompleted ()
	Will be emitted by task to indicate its successful completion.
void	taskTerminated ()
	Will be emitted by task if it has terminated for any reason other then completion (e.g., when a task has been canceled or encountered an internal error).
Protected Slots inherited from QgsTask
void	setProgress (double progress)
	Sets the task's current progress.
Protected Member Functions inherited from QgsTask
virtual void	finished (bool result)
	If the task is managed by a QgsTaskManager, this will be called after the task has finished (whether through successful completion or via early termination).
bool	isCanceled () const
	Will return `true` if task should terminate ASAP.

Detailed Description

An vector layer plot data gatherer class for XY series.

Since: QGIS 4.0

Definition at line 89 of file qgsvectorlayerplotdatagatherer.h.

Constructor & Destructor Documentation

◆ QgsVectorLayerXyPlotDataGatherer()

QgsVectorLayerXyPlotDataGatherer::QgsVectorLayerXyPlotDataGatherer ( Qgis::PlotAxisType xAxisType = Qgis::PlotAxisType::Interval )

explicit

The vector layer XY plot data gatherer constructor.

Parameters

xAxisType The X-axis type that will define what type of X values to gather.

Definition at line 24 of file qgsvectorlayerplotdatagatherer.cpp.

◆ ~QgsVectorLayerXyPlotDataGatherer()

QgsVectorLayerXyPlotDataGatherer::~QgsVectorLayerXyPlotDataGatherer ( )

overridedefault

Member Function Documentation

◆ data()

QgsPlotData QgsVectorLayerXyPlotDataGatherer::data ( ) const

overridevirtual

Returns the plot data.

Implements QgsVectorLayerAbstractPlotDataGatherer.

Definition at line 205 of file qgsvectorlayerplotdatagatherer.cpp.

◆ run()

bool QgsVectorLayerXyPlotDataGatherer::run ( )

overridevirtual

Performs the task's operation.

This method will be called when the task commences (ie via calling start() ), and subclasses should implement the operation they wish to perform in the background within this method.

A task must return a boolean value to indicate whether the task was completed successfully or terminated before completion.

Implements QgsTask.

Definition at line 39 of file qgsvectorlayerplotdatagatherer.cpp.

◆ setPredefinedCategories()

void QgsVectorLayerXyPlotDataGatherer::setPredefinedCategories ( const QStringList & categories )

Sets the predefined categories list that will be used to restrict the categories used when gathering the data.

Note: This is only used when the gatherer's X-axis type is set to categorical.

Definition at line 34 of file qgsvectorlayerplotdatagatherer.cpp.

◆ setSeriesDetails()

void QgsVectorLayerXyPlotDataGatherer::setSeriesDetails ( const QList< QgsVectorLayerXyPlotDataGatherer::XySeriesDetails > & details )

Sets the series details list that will be used to prepare the data being gathered.

Definition at line 29 of file qgsvectorlayerplotdatagatherer.cpp.

Member Data Documentation

◆ mData

QgsPlotData QgsVectorLayerXyPlotDataGatherer::mData

protected

Definition at line 133 of file qgsvectorlayerplotdatagatherer.h.

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

/build/qgis-3.99.0+git20251205+26c88405ac0+99sid/src/core/plot/qgsvectorlayerplotdatagatherer.h
/build/qgis-3.99.0+git20251205+26c88405ac0+99sid/src/core/plot/qgsvectorlayerplotdatagatherer.cpp

Classes

Public Member Functions

Protected Attributes

Additional Inherited Members