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:
objectEncapsulates 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:
type (Qgis.ProfileExportType)
feedback (Optional[QgsFeedback] = None)
- Return type:
- asGeometries(self) List[QgsGeometry]¶
Returns a list of geometries representing the calculated elevation results.
- Return type:
- copyPropertiesFromGenerator(self, generator: QgsAbstractProfileGenerator | None)[source]¶
Copies properties from specified
generatorto 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])
- 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:
point (QgsProfilePoint)
context (QgsProfileIdentifyContext)
- Return type:
- 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.
- snapPoint(self, point: QgsProfilePoint, context: QgsProfileSnapContext) QgsProfileSnapResult[source]¶
Snaps a
pointto the generated elevation profile.- Parameters:
point (QgsProfilePoint)
context (QgsProfileSnapContext)
- Return type:
- zRange(self) QgsDoubleRange[source]¶
Returns the range of the retrieved elevation values
- Return type: