Class: QgsEllipseSymbolLayer

A symbol layer for rendering objects with major and minor axis (e.g. ellipse, rectangle, etc).

Class Hierarchy

Base classes

QgsMarkerSymbolLayer	Abstract base class for marker symbol layers.
QgsSymbolLayer	Constructor for QgsSymbolLayer.

Methods

penCapStyle	Returns the marker's stroke cap style (e.g., flat, round, etc).
penJoinStyle	Gets stroke join style.
setPenCapStyle	Sets the marker's stroke cap style (e.g., flat, round, etc).
setPenJoinStyle	Set stroke join style.
setShape	Sets the rendered ellipse marker shape.
setStrokeStyle
setStrokeWidth
setStrokeWidthMapUnitScale
setStrokeWidthUnit	Sets the units for the symbol's stroke width.
setSymbolHeight
setSymbolHeightMapUnitScale
setSymbolHeightUnit	Sets the units for the symbol's height.
setSymbolName	Sets the rendered ellipse marker shape using a symbol name.
setSymbolWidth
setSymbolWidthMapUnitScale
setSymbolWidthUnit	Sets the units for the symbol's width.
shape	Returns the shape for the rendered ellipse marker symbol.
strokeStyle
strokeWidth
strokeWidthMapUnitScale
strokeWidthUnit	Returns the units for the symbol's stroke width.
symbolHeight
symbolHeightMapUnitScale
symbolHeightUnit	Returns the units for the symbol's height.
symbolName	Returns the shape name for the rendered ellipse marker symbol.
symbolWidth
symbolWidthMapUnitScale
symbolWidthUnit	Returns the units for the symbol's width.

Static Methods

availableShapes	Returns a list of all available shape types.
create	Creates the symbol layer
createFromSld
decodeShape	Attempts to decode a string representation of a shape name to the corresponding shape.
encodeShape	Encodes a shape to its string representation.
shapeIsFilled	Returns True if a shape has a fill.

Attributes

Arrow
Circle
Cross
Diamond
HalfArc
Hexagon
LeftHalfTriangle
Octagon
Pentagon
QuarterCircle
Rectangle
RightHalfTriangle
SemiCircle
Star
ThirdCircle
Triangle

class qgis.core.QgsEllipseSymbolLayer

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:

List[QgsEllipseSymbolLayer.Shape]

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

Creates the symbol layer

Parameters:

properties (Dict[str, Any] = {})

Return type:

Optional[QgsSymbolLayer]

static createFromSld(element: QDomElement) → QgsSymbolLayer | None

Parameters:

element (QDomElement)

Return type:

Optional[QgsSymbolLayer]

static decodeShape(name: str | None)

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

encodeShape()

Added in version 3.20.

static encodeShape(shape: QgsEllipseSymbolLayer.Shape) → str

Encodes a shape to its string representation.

Parameters:

shape (QgsEllipseSymbolLayer.Shape) – shape to encode

Return type:

str

Returns:

encoded string

See also

decodeShape()

Added in version 3.20.

penCapStyle(self) → Qt.PenCapStyle

Returns the marker’s stroke cap style (e.g., flat, round, etc).

See also

setPenCapStyle()

See also

penJoinStyle()

See also

strokeColor()

See also

strokeStyle()

Added in version 3.20.

Return type:

Qt.PenCapStyle

penJoinStyle(self) → Qt.PenJoinStyle

Gets stroke join style.

Return type:

Qt.PenJoinStyle

setPenCapStyle(self, style: Qt.PenCapStyle)

Sets the marker’s stroke cap style (e.g., flat, round, etc).

See also

penCapStyle()

See also

penJoinStyle()

See also

setStrokeColor()

See also

setStrokeStyle()

Added in version 3.20.

Parameters:

style (Qt.PenCapStyle)

setPenJoinStyle(self, style: Qt.PenJoinStyle)

Set stroke join style.

Parameters:

style (Qt.PenJoinStyle)

setShape(self, shape: QgsEllipseSymbolLayer.Shape)

Sets the rendered ellipse marker shape.

Parameters:

shape (QgsEllipseSymbolLayer.Shape) – new ellipse marker shape

See also

shape()

Added in version 3.20.

setStrokeStyle(self, strokeStyle: Qt.PenStyle)

Parameters:

strokeStyle (Qt.PenStyle)

setStrokeWidth(self, w: float)

Parameters:

w (float)

setStrokeWidthMapUnitScale(self, scale: QgsMapUnitScale)

Parameters:

scale (QgsMapUnitScale)

setStrokeWidthUnit(self, unit: Qgis.RenderUnit)

Sets the units for the symbol’s stroke width.

Parameters:

unit (Qgis.RenderUnit) – symbol units

See also

strokeWidthUnit()

setSymbolHeight(self, h: float)

Parameters:

h (float)

setSymbolHeightMapUnitScale(self, scale: QgsMapUnitScale)

Parameters:

scale (QgsMapUnitScale)

setSymbolHeightUnit(self, unit: Qgis.RenderUnit)

Sets the units for the symbol’s height.

Parameters:

unit (Qgis.RenderUnit) – symbol units

See also

symbolHeightUnit()

See also

setSymbolWidthUnit()

setSymbolName(self, name: str | None)

Sets the rendered ellipse marker shape using a symbol name.

See also

setShape()

See also

shape()

Deprecated since version 3.20.

Parameters:

name (Optional[str])

setSymbolWidth(self, w: float)

Parameters:

w (float)

setSymbolWidthMapUnitScale(self, scale: QgsMapUnitScale)

Parameters:

scale (QgsMapUnitScale)

setSymbolWidthUnit(self, unit: Qgis.RenderUnit)

Sets the units for the symbol’s width.

Parameters:

unit (Qgis.RenderUnit) – symbol units

See also

symbolWidthUnit()

See also

setSymbolHeightUnit()

shape(self) → QgsEllipseSymbolLayer.Shape

Returns the shape for the rendered ellipse marker symbol.

See also

setShape()

Added in version 3.20.

Return type:

QgsEllipseSymbolLayer.Shape

static shapeIsFilled(shape: QgsEllipseSymbolLayer.Shape) → bool

Returns True if a shape has a fill.

Return type:

bool

Returns:

True if shape uses a fill, or False if shape uses lines only

Added in version 3.20.

Parameters:

shape (QgsEllipseSymbolLayer.Shape)

strokeStyle(self) → Qt.PenStyle

Return type:

Qt.PenStyle

strokeWidth(self) → float

Return type:

float

strokeWidthMapUnitScale(self) → QgsMapUnitScale

Return type:

QgsMapUnitScale

strokeWidthUnit(self) → Qgis.RenderUnit

Returns the units for the symbol’s stroke width.

See also

setStrokeWidthUnit()

Return type:

Qgis.RenderUnit

symbolHeight(self) → float

Return type:

float

symbolHeightMapUnitScale(self) → QgsMapUnitScale

Return type:

QgsMapUnitScale

symbolHeightUnit(self) → Qgis.RenderUnit

Returns the units for the symbol’s height.

See also

setSymbolHeightUnit()

See also

symbolWidthUnit()

Return type:

Qgis.RenderUnit

symbolName(self) → str

Returns the shape name for the rendered ellipse marker symbol.

See also

shape()

See also

setShape()

Deprecated since version 3.20.

Return type:

str

symbolWidth(self) → float

Return type:

float

symbolWidthMapUnitScale(self) → QgsMapUnitScale

Return type:

QgsMapUnitScale

symbolWidthUnit(self) → Qgis.RenderUnit

Returns the units for the symbol’s width.

See also

setSymbolWidthUnit()

See also

symbolHeightUnit()

Return type:

Qgis.RenderUnit