Class: QgsMultiLineString

class qgis.core.QgsMultiLineString

Bases: QgsMultiCurve

Multi line string geometry collection.

QgsMultiLineString() Constructor for an empty multilinestring geometry.

QgsMultiLineString(linestrings: Iterable[QgsLineString]) Constructor for a multilinestring containing the specified linestrings.

The linestrings will be internally cloned.

Added in version 3.38.

QgsMultiLineString(linestrings: Iterable[QgsLineString]) Constructor for a multilinestring containing the specified linestrings.

Ownership of the linestrings will be transferred to the multilinestring.

Added in version 3.38.

QgsMultiLineString(a0: QgsMultiLineString)

Methods

addGeometries	param geometries:
addGeometry	param g:
asGml2	param doc:
asGml3	param doc:
calculateBoundingBox	Default calculator for the minimal bounding box for the geometry.
calculateBoundingBox3D
childCount
childGeometry
childPoint	Returns point at index (for geometries without child geometries - i.e. curve / point).
clear
clearCache
clone	rtype: Optional[QgsMultiLineString]
compareToSameClass
createEmptyWithSameType	rtype: Optional[QgsMultiLineString]
fromCollectionWkt	Reads a collection from a WKT string.
fromWkt	param wkt:
geometryType	rtype: str
hasChildGeometries	Returns whether the geometry has any child geometries (False for point / curve, True otherwise)
insertGeometry	param g:
lineStringN	Returns the line string with the specified index.
measuredLine	Re-write the measure ordinate (or add one, if it isn't already there) interpolating the measure between the supplied start and end values.
setZMTypeFromSubGeometry	Updates the geometry type based on whether sub geometries contain z or m values.
simplifyByDistance	param tolerance:
sortIndex	Returns the sort index for the geometry, used in the compareTo() method to compare geometries of different types.
toCurveType	Returns the geometry converted to the more generic curve type QgsMultiCurve
wktOmitChildType	rtype: bool

addGeometries(self, geometries: Iterable[QgsAbstractGeometry]) → bool

Parameters:

geometries (Iterable[QgsAbstractGeometry])

Return type:

bool

addGeometry(self, g: QgsAbstractGeometry | None) → bool

Parameters:

g (Optional[QgsAbstractGeometry])

Return type:

bool

asGml2(self, doc: QDomDocument, precision: int = 17, ns: str | None = '', axisOrder: QgsAbstractGeometry.AxisOrder = QgsAbstractGeometry.AxisOrder.XY) → QDomElement

Parameters:

• doc (QDomDocument)

• precision (int = 17)

• ns (Optional[str] = '')

• axisOrder (QgsAbstractGeometry.AxisOrder = QgsAbstractGeometry.AxisOrder.XY)

Return type:

QDomElement

asGml3(self, doc: QDomDocument, precision: int = 17, ns: str | None = '', axisOrder: QgsAbstractGeometry.AxisOrder = QgsAbstractGeometry.AxisOrder.XY) → QDomElement

Parameters:

• doc (QDomDocument)

• precision (int = 17)

• ns (Optional[str] = '')

• axisOrder (QgsAbstractGeometry.AxisOrder = QgsAbstractGeometry.AxisOrder.XY)

Return type:

QDomElement

calculateBoundingBox(self) → QgsRectangle

Default calculator for the minimal bounding box for the geometry. Derived classes should override this method if a more efficient bounding box calculation is available.

calculateBoundingBox3D(self) → QgsBox3D

childCount(self) → int

childGeometry(self, index: int) → QgsAbstractGeometry | None

childPoint(self, index: int) → QgsPoint

Returns point at index (for geometries without child geometries - i.e. curve / point)

Note

used for vertex_iterator implementation

clear(self)

clearCache(self)

clone(self) → QgsMultiLineString | None

Return type:

Optional[QgsMultiLineString]

compareToSameClass(self, other: QgsAbstractGeometry | None) → int

createEmptyWithSameType(self) → QgsMultiLineString | None

Return type:

Optional[QgsMultiLineString]

fromCollectionWkt(self, wkt: str | None, subtypes: Iterable[QgsAbstractGeometry], defaultChildWkbType: str | None = '') → bool

Reads a collection from a WKT string.

fromWkt(self, wkt: str | None) → bool

Parameters:

wkt (Optional[str])

Return type:

bool

geometryType(self) → str

Return type:

str

hasChildGeometries(self) → bool

Returns whether the geometry has any child geometries (False for point / curve, True otherwise)

Note

used for vertex_iterator implementation

insertGeometry(self, g: QgsAbstractGeometry | None, index: int) → bool

Parameters:

• g (Optional[QgsAbstractGeometry])

• index (int)

Return type:

bool

lineStringN(self, index: int) → QgsLineString

Returns the line string with the specified index.

Raises:

IndexError – if no line string with the specified index exists.

Added in version 3.16.

Parameters:

index (int)

Return type:

QgsLineString

measuredLine(self, start: float, end: float) → QgsMultiLineString | None

Re-write the measure ordinate (or add one, if it isn’t already there) interpolating the measure between the supplied start and end values.

Added in version 3.36.

Parameters:

• start (float)

• end (float)

Return type:

Optional[QgsMultiLineString]

setZMTypeFromSubGeometry(self, subggeom: QgsAbstractGeometry | None, baseGeomType: Qgis.WkbType)

Updates the geometry type based on whether sub geometries contain z or m values.

simplifyByDistance(self, tolerance: float) → QgsMultiLineString | None

Parameters:

tolerance (float)

Return type:

Optional[QgsMultiLineString]

sortIndex(self) → int

Returns the sort index for the geometry, used in the compareTo() method to compare geometries of different types.

Added in version 3.20.

toCurveType(self) → QgsMultiCurve | None

Returns the geometry converted to the more generic curve type QgsMultiCurve

Return type:

Optional[QgsMultiCurve]

Returns:

the converted geometry. Caller takes ownership

wktOmitChildType(self) → bool

Return type:

bool