Class: QgsAbstractProfileResults

Abstract base class for storage of elevation profiles.

Added in version 3.26.

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
geometry
layerIdentifier
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:
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)[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])

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.

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

Renders the results to the specified context.

Parameters:

context (QgsProfileRenderContext)

sampledPoints(self) List[QgsPoint][source]

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[source]

Snaps a point to the generated elevation profile.

Parameters:
Return type:

QgsProfileSnapResult

type(self) str[source]

Returns the unique string identifier for the results type.

Return type:

str

zRange(self) QgsDoubleRange[source]

Returns the range of the retrieved elevation values

Return type:

QgsDoubleRange