Class: QgsAbstractProfileResults

Abstract base class for storage of elevation profiles.

Added in version 3.26.

Methods

asFeatures	Returns a list of features representing the calculated elevation results.
asGeometries	Returns a list of geometries representing the calculated elevation results.
copyPropertiesFromGenerator	Copies properties from specified generator to the results object.
distanceToHeightMap	Returns the map of distance (chainage) to height.
identify	Identify results visible at the specified profile point.
renderResults	Renders the results to the specified context.
sampledPoints	Returns a list of sampled points, with their calculated elevation as the point z value.
snapPoint	Snaps a point to the generated elevation profile.
type	Returns the unique string identifier for the results type.
zRange	Returns the range of the retrieved elevation values

class qgis.core.QgsAbstractProfileResults

Bases: object

class Feature

Bases: object

Encapsulates information about a feature exported from the profile results.

Added in version 3.32.

attributes

Exported attributes

geometry

Exported geometry

layerIdentifier

Identifier for grouping output features

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]

asGeometries(self) → List[QgsGeometry]

Returns a list of geometries representing the calculated elevation results.

Return type:

List[QgsGeometry]

copyPropertiesFromGenerator(self, generator: QgsAbstractProfileGenerator | None)

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

distanceToHeightMap(self) → Any

Returns the map of distance (chainage) to height.

Return type:

Any

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

Identify results visible at the specified profile point.

Parameters:

• point (QgsProfilePoint)

• context (QgsProfileIdentifyContext)

Return type:

List[QgsProfileIdentifyResults]

identify(self, distanceRange: QgsDoubleRange, elevationRange: QgsDoubleRange, context: QgsProfileIdentifyContext) → List[QgsProfileIdentifyResults]

Identify results visible within the specified ranges.

Parameters:

• distanceRange (QgsDoubleRange)

• elevationRange (QgsDoubleRange)

• context (QgsProfileIdentifyContext)

Return type:

List[QgsProfileIdentifyResults]

renderResults(self, context: QgsProfileRenderContext)

Renders the results to the specified context.

Parameters:

context (QgsProfileRenderContext)

sampledPoints(self) → List[QgsPoint]

Returns a list of sampled points, with their calculated elevation as the point z value.

Return type:

List[QgsPoint]

snapPoint(self, point: QgsProfilePoint, context: QgsProfileSnapContext) → QgsProfileSnapResult

Snaps a point to the generated elevation profile.

Parameters:

• point (QgsProfilePoint)

• context (QgsProfileSnapContext)

Return type:

QgsProfileSnapResult

type(self) → str

Returns the unique string identifier for the results type.

Return type:

str

zRange(self) → QgsDoubleRange

Returns the range of the retrieved elevation values

Return type:

QgsDoubleRange