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()

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]¶

geometry: QgsGeometry¶

layerIdentifier: str¶

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.

Parameters:: generator (Optional[QgsAbstractProfileGenerator])

abstract distanceToHeightMap(self) → Any¶

Returns the map of distance (chainage) to height.

Return type:: Any

virtual identify(self, point: QgsProfilePoint, context: QgsProfileIdentifyContext) → List[QgsProfileIdentifyResults]¶

Identify results visible at the specified profile point.

identify(self, distanceRange: QgsDoubleRange, elevationRange: QgsDoubleRange, context: QgsProfileIdentifyContext) -> List[QgsProfileIdentifyResults] Identify results visible within the specified ranges.

Parameters: