Class: QgsEllipseSymbolLayer¶
A symbol layer for rendering objects with major and minor axis (e.g. ellipse, rectangle, etc).
Class Hierarchy¶
Base classes¶
Abstract base class for marker symbol layers. |
|
Abstract base class for symbol layers. |
Methods
Returns the marker's stroke cap style (e.g., flat, round, etc). |
|
Gets stroke join style. |
|
Sets the marker's stroke cap style (e.g., flat, round, etc). |
|
Set stroke join style. |
|
Sets the rendered ellipse marker shape. |
|
Sets the units for the symbol's stroke width. |
|
Sets the units for the symbol's height. |
|
Sets the rendered ellipse marker shape using a symbol name. |
|
Sets the units for the symbol's width. |
|
Returns the shape for the rendered ellipse marker symbol. |
|
Returns the units for the symbol's stroke width. |
|
Returns the units for the symbol's height. |
|
Returns the shape name for the rendered ellipse marker symbol. |
|
Returns the units for the symbol's width. |
Static Methods
Returns a list of all available shape types. |
|
Creates the symbol layer |
|
Attempts to decode a string representation of a shape name to the corresponding shape. |
|
Encodes a shape to its string representation. |
|
Returns |
Attributes
- class qgis.core.QgsEllipseSymbolLayer[source]¶
Bases:
QgsMarkerSymbolLayer
- Arrow = 4¶
- Circle = 0¶
- Cross = 3¶
- Diamond = 2¶
- HalfArc = 5¶
- Hexagon = 13¶
- LeftHalfTriangle = 8¶
- Octagon = 14¶
- Pentagon = 12¶
- QuarterCircle = 11¶
- Rectangle = 1¶
- RightHalfTriangle = 7¶
- SemiCircle = 9¶
- class Shape¶
Bases:
int
- Star = 15¶
- ThirdCircle = 10¶
- Triangle = 6¶
- static availableShapes() List[QgsEllipseSymbolLayer.Shape] ¶
Returns a list of all available shape types.
- Return type:
- static create(properties: Dict[str, Any] = {}) QgsSymbolLayer | None [source]¶
Creates the 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]
- static decodeShape(name: str | None)[source]¶
Attempts to decode a string representation of a shape name to the corresponding shape.
- Parameters:
name (Optional[str]) -> (QgsEllipseSymbolLayer.Shape) – encoded shape name
ok – if specified, will be set to
True
if shape was successfully decoded
- Returns:
decoded name
See also
Added in version 3.20.
- static encodeShape(shape: QgsEllipseSymbolLayer.Shape) str [source]¶
Encodes a shape to its string representation.
- Parameters:
shape (QgsEllipseSymbolLayer.Shape) – shape to encode
- Return type:
str
- Returns:
encoded string
See also
Added in version 3.20.
- penCapStyle(self) Qt.PenCapStyle [source]¶
Returns the marker’s stroke cap style (e.g., flat, round, etc).
See also
See also
See also
strokeColor()
See also
Added in version 3.20.
- Return type:
Qt.PenCapStyle
- setPenCapStyle(self, style: Qt.PenCapStyle)[source]¶
Sets the marker’s stroke cap
style
(e.g., flat, round, etc).See also
See also
See also
setStrokeColor()
See also
Added in version 3.20.
- Parameters:
style (Qt.PenCapStyle)
- setPenJoinStyle(self, style: Qt.PenJoinStyle)[source]¶
Set stroke join style.
- Parameters:
style (Qt.PenJoinStyle)
- setShape(self, shape: QgsEllipseSymbolLayer.Shape)[source]¶
Sets the rendered ellipse marker shape.
- Parameters:
shape (QgsEllipseSymbolLayer.Shape) – new ellipse marker shape
See also
Added in version 3.20.
- setStrokeWidthMapUnitScale(self, scale: QgsMapUnitScale)[source]¶
- Parameters:
scale (QgsMapUnitScale)
- setStrokeWidthUnit(self, unit: Qgis.RenderUnit)[source]¶
Sets the units for the symbol’s stroke width.
- Parameters:
unit (Qgis.RenderUnit) – symbol units
See also
- setSymbolHeightMapUnitScale(self, scale: QgsMapUnitScale)[source]¶
- Parameters:
scale (QgsMapUnitScale)
- setSymbolHeightUnit(self, unit: Qgis.RenderUnit)[source]¶
Sets the units for the symbol’s height.
- Parameters:
unit (Qgis.RenderUnit) – symbol units
See also
See also
- setSymbolName(self, name: str | None)[source]¶
Sets the rendered ellipse marker shape using a symbol
name
.See also
See also
Deprecated since version 3.20.
- Parameters:
name (Optional[str])
- setSymbolWidthMapUnitScale(self, scale: QgsMapUnitScale)[source]¶
- Parameters:
scale (QgsMapUnitScale)
- setSymbolWidthUnit(self, unit: Qgis.RenderUnit)[source]¶
Sets the units for the symbol’s width.
- Parameters:
unit (Qgis.RenderUnit) – symbol units
See also
See also
- shape(self) QgsEllipseSymbolLayer.Shape [source]¶
Returns the shape for the rendered ellipse marker symbol.
See also
Added in version 3.20.
- Return type:
- static shapeIsFilled(shape: QgsEllipseSymbolLayer.Shape) bool [source]¶
Returns
True
if ashape
has a fill.- Return type:
bool
- Returns:
True
if shape uses a fill, orFalse
if shape uses lines only
Added in version 3.20.
- Parameters:
shape (QgsEllipseSymbolLayer.Shape)
- strokeWidthMapUnitScale(self) QgsMapUnitScale ¶
- Return type:
- strokeWidthUnit(self) Qgis.RenderUnit [source]¶
Returns the units for the symbol’s stroke width.
See also
- Return type:
- symbolHeightMapUnitScale(self) QgsMapUnitScale ¶
- Return type:
- symbolHeightUnit(self) Qgis.RenderUnit [source]¶
Returns the units for the symbol’s height.
See also
See also
- Return type:
- symbolName(self) str [source]¶
Returns the shape name for the rendered ellipse marker symbol.
See also
See also
Deprecated since version 3.20.
- Return type:
str
- symbolWidthMapUnitScale(self) QgsMapUnitScale ¶
- Return type:
- symbolWidthUnit(self) Qgis.RenderUnit [source]¶
Returns the units for the symbol’s width.
See also
See also
- Return type: