Class: QgsAbstractProfileResults

class qgis.core.QgsAbstractProfileResults

Bases: sip.wrapper

Abstract base class for storage of elevation profiles.

New in version 3.26:

Methods

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

asGeometries(self) List[QgsGeometry]

Returns a list of geometries representing the calculated elevation results.

Return type:

List[QgsGeometry]

copyPropertiesFromGenerator(self, generator: QgsAbstractProfileGenerator)

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

distanceToHeightMap(self) object

Returns the map of distance (chainage) to height.

Return type:

object

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:
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:
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