Class: QgsElevationProfile

Represents an elevation profile attached to a project.

Added in version 4.0.

Class Hierarchy

Base classes

QObject

Methods

crs	Returns the crs associated with the profile's map coordinates.
distanceUnit	Returns the distance unit used by the profile.
icon	Returns the icon to use for the elevation profile.
layers	Returns the list of layers included in the profile.
lockAxisScales	Returns True if the distance and elevation scales are locked to each other.
name	Returns the profile's unique name.
profileCurve	Returns the profile curve.
readXml	Sets the profiles's state from a DOM element.
resolveReferences	After reading settings from XML, resolves references to any layers in a project that have been read as layer IDs.
setCrs	Sets the crs associated with the profile's map coordinates.
setDistanceUnit	Sets the distance unit used by the profile.
setLayers	Sets the list of layers to include in the profile.
setLockAxisScales	Sets whether the distance and elevation scales are locked to each other.
setName	Sets the profile's unique name.
setProfileCurve	Sets the profile curve.
setSubsectionsSymbol	Sets the symbol used to draw the subsections.
setTolerance	Sets the profile tolerance (in crs() units).
subsectionsSymbol	Returns the symbol used to draw the subsections.
tolerance	Returns the tolerance of the profile (in crs() units).
writeXml	Returns the profiles's state encapsulated in a DOM element.

Signals

nameChanged

Emitted when the profile is renamed.

class qgis.core.QgsElevationProfile

Bases: QObject

__init__(project: QgsProject | None)

Constructor for QgsElevationProfile.

Parameters:

project (Optional[QgsProject])

crs(self) → QgsCoordinateReferenceSystem

Returns the crs associated with the profile’s map coordinates.

See also

setCrs()

Return type:

QgsCoordinateReferenceSystem

distanceUnit(self) → Qgis.DistanceUnit

Returns the distance unit used by the profile.

See also

setDistanceUnit()

Return type:

Qgis.DistanceUnit

icon(self) → QIcon

Returns the icon to use for the elevation profile.

Return type:

QIcon

layers(self) → List[QgsMapLayer]

Returns the list of layers included in the profile.

See also

setLayers()

Return type:

List[QgsMapLayer]

lockAxisScales(self) → bool

Returns True if the distance and elevation scales are locked to each other.

See also

setLockAxisScales()

Return type:

bool

name(self) → str

Returns the profile’s unique name.

See also

setName()

See also

nameChanged()

Return type:

str

signal nameChanged(newName: str)

Emitted when the profile is renamed.

See also

name()

See also

setName()

Parameters:

newName (str)

profileCurve(self) → QgsCurve | None

Returns the profile curve.

The CRS associated with the curve is retrieved via crs().

See also

setProfileCurve()

Return type:

Optional[QgsCurve]

readXml(self, element: QDomElement, document: QDomDocument, context: QgsReadWriteContext) → bool

Sets the profiles’s state from a DOM element.

element is the DOM node corresponding to the profile.

See also

resolveReferences()

See also

writeXml()

Parameters:

• element (QDomElement)

• document (QDomDocument)

• context (QgsReadWriteContext)

Return type:

bool

resolveReferences(self, project: QgsProject | None)

After reading settings from XML, resolves references to any layers in a project that have been read as layer IDs.

See also

readXml()

Parameters:

project (Optional[QgsProject])

setCrs(self, crs: QgsCoordinateReferenceSystem)

Sets the crs associated with the profile’s map coordinates.

See also

crs()

Parameters:

crs (QgsCoordinateReferenceSystem)

setDistanceUnit(self, unit: Qgis.DistanceUnit)

Sets the distance unit used by the profile.

See also

distanceUnit()

Parameters:

unit (Qgis.DistanceUnit)

setLayers(self, layers: Iterable[QgsMapLayer])

Sets the list of layers to include in the profile.

See also

layers()

Parameters:

layers (Iterable[QgsMapLayer])

setLockAxisScales(self, lock: bool)

Sets whether the distance and elevation scales are locked to each other.

See also

lockAxisScales()

Parameters:

lock (bool)

setName(self, name: str | None)

Sets the profile’s unique name.

See also

name()

See also

nameChanged()

Parameters:

name (Optional[str])

setProfileCurve(self, curve: QgsCurve | None)

Sets the profile curve.

The CRS associated with curve is set via setCrs().

Ownership is transferred to the profile.

See also

profileCurve()

Parameters:

curve (Optional[QgsCurve])

setSubsectionsSymbol(self, symbol: QgsLineSymbol | None)

Sets the symbol used to draw the subsections.

If symbol is None, the subsections are not drawn. Ownership of symbol is transferred.

See also

subsectionsSymbol()

Parameters:

symbol (Optional[QgsLineSymbol])

setTolerance(self, tolerance: float)

Sets the profile tolerance (in crs() units).

This value determines how far from the profileCurve() is appropriate for inclusion of results. For instance, when a profile is generated for a point vector layer this tolerance distance will dictate how far from the actual profile curve a point can reside within to be included in the results.

See also

tolerance()

Parameters:

tolerance (float)

subsectionsSymbol(self) → QgsLineSymbol | None

Returns the symbol used to draw the subsections.

See also

setSubsectionsSymbol()

Return type:

Optional[QgsLineSymbol]

tolerance(self) → float

Returns the tolerance of the profile (in crs() units).

This value determines how far from the profileCurve() is appropriate for inclusion of results. For instance, when a profile is generated for a point vector layer this tolerance distance will dictate how far from the actual profile curve a point can reside within to be included in the results.

See also

setTolerance()

Return type:

float

writeXml(self, document: QDomDocument, context: QgsReadWriteContext) → QDomElement

Returns the profiles’s state encapsulated in a DOM element.

See also

readXml()

Parameters:

• document (QDomDocument)

• context (QgsReadWriteContext)

Return type:

QDomElement