Class: QgsCentroidFillSymbolLayer¶

A fill symbol layer which renders a marker symbol at the centroid of a polygon geometry.

Class Hierarchy¶

Base classes¶

`QgsFillSymbolLayer`	Abstract base class for fill symbol layers.
`QgsSymbolLayer`	Abstract base class for symbol layers.

Methods

`clipOnCurrentPartOnly`	Returns `True` if point markers should be clipped to the current part boundary only.
`clipPoints`	Returns `True` if point markers should be clipped to the polygon boundary.
`pointOnAllParts`	Returns whether a point is drawn for all parts or only on the biggest part of multi-part features.
`pointOnSurface`
`setClipOnCurrentPartOnly`	Sets whether point markers should be clipped to the current part boundary only.
`setClipPoints`	Sets whether point markers should be clipped to the polygon boundary.
`setPointOnAllParts`	Sets whether a point is drawn for all parts or only on the biggest part of multi-part features.
`setPointOnSurface`

Static Methods

`create`	Creates a new `QgsCentroidFillSymbolLayer` using the specified properties map containing symbol properties (see `properties()`).
`createFromSld`

class qgis.core.QgsCentroidFillSymbolLayer[source]¶

Bases: QgsFillSymbolLayer

clipOnCurrentPartOnly(self) → bool[source]¶

Returns True if point markers should be clipped to the current part boundary only.

See also

setClipPoints()

Added in version 3.14.

Return type:: bool

clipPoints(self) → bool[source]¶

Returns True if point markers should be clipped to the polygon boundary.

See also

setClipPoints()

Added in version 3.14.

Return type:: bool

static create(properties: Dict[str, Any] = {}) → QgsSymbolLayer | None[source]¶

Creates a new QgsCentroidFillSymbolLayer using the specified properties map containing symbol properties (see properties()).

Caller takes ownership of the returned symbol layer.

Parameters:: properties (Dict[str, Any] = {})
Return type:: Optional[QgsSymbolLayer]

static createFromSld(element: QDomElement) → QgsSymbolLayer | None[source]¶

Parameters:: element (QDomElement)
Return type:: Optional[QgsSymbolLayer]

pointOnAllParts(self) → bool[source]¶

Returns whether a point is drawn for all parts or only on the biggest part of multi-part features.

See also

setPointOnAllParts()

Return type:: bool

pointOnSurface(self) → bool[source]¶

Return type:: bool

setClipOnCurrentPartOnly(self, clipOnCurrentPartOnly: bool)[source]¶

Sets whether point markers should be clipped to the current part boundary only.

See also

clipOnCurrentPartOnly()

Added in version 3.14.

Parameters:: clipOnCurrentPartOnly (bool)

setClipPoints(self, clipPoints: bool)[source]¶

Sets whether point markers should be clipped to the polygon boundary.

See also

clipPoints()

Added in version 3.14.

Parameters:: clipPoints (bool)

setPointOnAllParts(self, pointOnAllParts: bool)[source]¶

Sets whether a point is drawn for all parts or only on the biggest part of multi-part features.

See also

pointOnAllParts()

Parameters:: pointOnAllParts (bool)

setPointOnSurface(self, pointOnSurface: bool)[source]¶

Parameters:: pointOnSurface (bool)