Class: QgsAbstractProfileResults¶

Abstract base class for storage of elevation profiles.

Added in version 3.26.

Note

This is an abstract class, with methods which must be implemented by a subclass.

The following methods must be implemented: asGeometries(), distanceToHeightMap(), renderResults(), sampledPoints(), type(), zRange()

Abstract Methods

`asGeometries`	Returns a list of geometries representing the calculated elevation results.
`distanceToHeightMap`	Returns the map of distance (chainage) to height.
`renderResults`	Renders the results to the specified context.
`sampledPoints`	Returns a list of sampled points, with their calculated elevation as the point z value.
`type`	Returns the unique string identifier for the results type.
`zRange`	Returns the range of the retrieved elevation values

Virtual Methods

In PyQGIS, only methods marked as virtual can be safely overridden in a Python subclass of QgsAbstractProfileResults. See the FAQ for more details.

`asFeatures`	Returns a list of features representing the calculated elevation results.
`copyPropertiesFromGenerator`	Copies properties from specified generator to the results object.
`identify`	Identify results visible at the specified profile point.
`snapPoint`	Snaps a point to the generated elevation profile.

class qgis.core.QgsAbstractProfileResults[source]¶

Bases: object

class Feature¶

Bases: object

Encapsulates information about a feature exported from the profile results.

Added in version 3.32.

attributes: Dict[str, object]¶: Exported attributes

geometry: QgsGeometry¶: Exported geometry

layerIdentifier: str¶: Identifier for grouping output features

virtual asFeatures(self, type: Qgis.ProfileExportType, feedback: QgsFeedback | None = None) → List[QgsAbstractProfileResults.Feature]¶

Returns a list of features representing the calculated elevation results.

The default implementation returns an empty list.

Added in version 3.32.

Parameters:

type (Qgis.ProfileExportType)
feedback (Optional[QgsFeedback] = None)

Return type:

List[QgsAbstractProfileResults.Feature]

abstract asGeometries(self) → List[QgsGeometry]¶

Returns a list of geometries representing the calculated elevation results.

Return type:: List[QgsGeometry]

virtual copyPropertiesFromGenerator(self, generator: QgsAbstractProfileGenerator | None)[source]¶

Copies properties from specified generator to the results object.

For instance, this method can be used to copy any properties relating to rendering the gathered results to reflect the generator’s current properties.

The base class method does nothing.