Class: QgsGraphBuilder

Used for making the QgsGraph object.

Class Hierarchy

Base classes

QgsGraphBuilderInterface

Interface for creating a graph.

class qgis.analysis.QgsGraphBuilder

Bases: QgsGraphBuilderInterface

__init__(crs: QgsCoordinateReferenceSystem, otfEnabled: bool = True, topologyTolerance: float = 0, ellipsoidID: str | None = '')

Default constructor

Parameters:

• crs (QgsCoordinateReferenceSystem)

• otfEnabled (bool = True)

• topologyTolerance (float = 0)

• ellipsoidID (Optional[str] = '')

virtual addVertex(self, id: int, pt: QgsPointXY)

MANDATORY BUILDER PROPERTY DECLARATION

Parameters:

• id (int)

• pt (QgsPointXY)

graph(self) → QgsGraph

Returns the generated QgsGraph.

The builder is left in its current state.

See also

takeGraph()

Return type:

QgsGraph

takeGraph(self) → QgsGraph | None

Takes the generated graph from the builder, resetting the builder back to its initial state ready for additional graph construction.

Added in version 3.22.

Return type:

Optional[QgsGraph]