Class: QgsEllipseSymbolLayer

class qgis.core.QgsEllipseSymbolLayer

Bases: QgsMarkerSymbolLayer

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

Methods

bounds

param point

clone

rtype

QgsEllipseSymbolLayer

copyDataDefinedProperties

Copies all data defined properties of this layer to another symbol layer.

copyPaintEffect

Copies paint effect of this layer to another symbol layer

create

param properties

createFromSld

param element

fillColor

rtype

QColor

layerType

rtype

str

mapUnitScale

rtype

QgsMapUnitScale

markerOffset

Calculates the required marker offset, including both the symbol offset and any displacement required to align with the marker’s anchor point.

markerOffset2

markerOffsetWithWidthAndHeight

Calculates the required marker offset, including both the symbol offset and any displacement required to align with the marker’s anchor point.

outputUnit

rtype

QgsUnitTypes.RenderUnit

penJoinStyle

Gets stroke join style.

properties

rtype

Dict[str, str]

renderPoint

param point

restoreOldDataDefinedProperties

Restores older data defined properties from string map.

setFillColor

param c

setMapUnitScale

param scale

setOutputUnit

param unit

setPenJoinStyle

Set stroke join style.

setSize

param size

setStrokeColor

param c

setStrokeStyle

param strokeStyle

setStrokeWidth

param w

setStrokeWidthMapUnitScale

param scale

setStrokeWidthUnit

Sets the units for the symbol’s stroke width.

setSymbolHeight

param h

setSymbolHeightMapUnitScale

param scale

setSymbolHeightUnit

Sets the units for the symbol’s height.

setSymbolName

param name

setSymbolWidth

param w

setSymbolWidthMapUnitScale

param scale

setSymbolWidthUnit

Sets the units for the symbol’s width.

startRender

param context

stopRender

param context

strokeColor

rtype

QColor

strokeStyle

rtype

Qt.PenStyle

strokeWidth

rtype

float

strokeWidthMapUnitScale

rtype

QgsMapUnitScale

strokeWidthUnit

Returns the units for the symbol’s stroke width.

symbolHeight

rtype

float

symbolHeightMapUnitScale

rtype

QgsMapUnitScale

symbolHeightUnit

Returns the units for the symbol’s height.

symbolName

rtype

str

symbolWidth

rtype

float

symbolWidthMapUnitScale

rtype

QgsMapUnitScale

symbolWidthUnit

Returns the units for the symbol’s width.

toSld

param doc

writeDxf

param e

writeSldMarker

param doc

bounds(self, point: Union[QPointF, QPoint], context: QgsSymbolRenderContext) → QRectF
Parameters
Return type

QRectF

clone(self)QgsEllipseSymbolLayer
Return type

QgsEllipseSymbolLayer

copyDataDefinedProperties(self, destLayer: QgsSymbolLayer)

Copies all data defined properties of this layer to another symbol layer.

Parameters

destLayer – destination layer

copyPaintEffect(self, destLayer: QgsSymbolLayer)

Copies paint effect of this layer to another symbol layer

Parameters

destLayer – destination layer

New in version 2.9.

create(properties: Dict[str, str] = {})QgsSymbolLayer
Parameters

properties (Dict[str) –

Return type

QgsSymbolLayer

createFromSld(element: QDomElement)QgsSymbolLayer
Parameters

element (QDomElement) –

Return type

QgsSymbolLayer

fillColor(self) → QColor
Return type

QColor

layerType(self) → str
Return type

str

mapUnitScale(self)QgsMapUnitScale
Return type

QgsMapUnitScale

markerOffset(self, context: QgsSymbolRenderContext) → Tuple[float, float]

Calculates the required marker offset, including both the symbol offset and any displacement required to align with the marker’s anchor point.

Parameters
  • context – symbol render context

  • offsetX – will be set to required horizontal offset (in painter units)

  • offsetY – will be set to required vertical offset (in painter units)

markerOffset2(self, context: QgsSymbolRenderContext, width: float, height: float, widthUnit: QgsUnitTypes.RenderUnit, heightUnit: QgsUnitTypes.RenderUnit, widthMapUnitScale: QgsMapUnitScale, heightMapUnitScale: QgsMapUnitScale) → Tuple[float, float]

Note

available in Python bindings as markerOffset2

markerOffsetWithWidthAndHeight(self, context: QgsSymbolRenderContext, width: float, height: float) → Tuple[float, float]

Calculates the required marker offset, including both the symbol offset and any displacement required to align with the marker’s anchor point.

Parameters
  • context – symbol render context

  • width – marker width

  • height – marker height

  • offsetX – will be set to required horizontal offset (in painter units)

  • offsetY – will be set to required vertical offset (in painter units)

Note

available in Python as markerOffsetWithWidthAndHeight

outputUnit(self)QgsUnitTypes.RenderUnit
Return type

QgsUnitTypes.RenderUnit

penJoinStyle(self) → Qt.PenJoinStyle

Gets stroke join style.

New in version 2.16.

Return type

Qt.PenJoinStyle

properties(self) → Dict[str, str]
Return type

Dict[str, str]

renderPoint(self, point: Union[QPointF, QPoint], context: QgsSymbolRenderContext)
Parameters
restoreOldDataDefinedProperties(self, stringMap: Dict[str, str])

Restores older data defined properties from string map.

New in version 3.0.

setFillColor(self, c: Union[QColor, Qt.GlobalColor])
Parameters

c (Union[QColor) –

setMapUnitScale(self, scale: QgsMapUnitScale)
Parameters

scale (QgsMapUnitScale) –

setOutputUnit(self, unit: QgsUnitTypes.RenderUnit)
Parameters

unit (QgsUnitTypes.RenderUnit) –

setPenJoinStyle(self, style: Qt.PenJoinStyle)

Set stroke join style.

New in version 2.16.

Parameters

style (Qt.PenJoinStyle) –

setSize(self, size: float)
Parameters

size (float) –

setStrokeColor(self, c: Union[QColor, Qt.GlobalColor])
Parameters

c (Union[QColor) –

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: QgsUnitTypes.RenderUnit)

Sets the units for the symbol’s stroke width.

Parameters

unit (QgsUnitTypes.RenderUnit) – symbol units

setSymbolHeight(self, h: float)
Parameters

h (float) –

setSymbolHeightMapUnitScale(self, scale: QgsMapUnitScale)
Parameters

scale (QgsMapUnitScale) –

setSymbolHeightUnit(self, unit: QgsUnitTypes.RenderUnit)

Sets the units for the symbol’s height.

Parameters

unit (QgsUnitTypes.RenderUnit) – symbol units

setSymbolName(self, name: str)
Parameters

name (str) –

setSymbolWidth(self, w: float)
Parameters

w (float) –

setSymbolWidthMapUnitScale(self, scale: QgsMapUnitScale)
Parameters

scale (QgsMapUnitScale) –

setSymbolWidthUnit(self, unit: QgsUnitTypes.RenderUnit)

Sets the units for the symbol’s width.

Parameters

unit (QgsUnitTypes.RenderUnit) – symbol units

startRender(self, context: QgsSymbolRenderContext)
Parameters

context (QgsSymbolRenderContext) –

stopRender(self, context: QgsSymbolRenderContext)
Parameters

context (QgsSymbolRenderContext) –

strokeColor(self) → QColor
Return type

QColor

strokeStyle(self) → Qt.PenStyle
Return type

Qt.PenStyle

strokeWidth(self) → float
Return type

float

strokeWidthMapUnitScale(self)QgsMapUnitScale
Return type

QgsMapUnitScale

strokeWidthUnit(self)QgsUnitTypes.RenderUnit

Returns the units for the symbol’s stroke width.

Return type

QgsUnitTypes.RenderUnit

symbolHeight(self) → float
Return type

float

symbolHeightMapUnitScale(self)QgsMapUnitScale
Return type

QgsMapUnitScale

symbolHeightUnit(self)QgsUnitTypes.RenderUnit

Returns the units for the symbol’s height.

Return type

QgsUnitTypes.RenderUnit

symbolName(self) → str
Return type

str

symbolWidth(self) → float
Return type

float

symbolWidthMapUnitScale(self)QgsMapUnitScale
Return type

QgsMapUnitScale

symbolWidthUnit(self)QgsUnitTypes.RenderUnit

Returns the units for the symbol’s width.

Return type

QgsUnitTypes.RenderUnit

toSld(self, doc: QDomDocument, element: QDomElement, props: Dict[str, str])
Parameters
  • doc (QDomDocument) –

  • element (QDomElement) –

  • props (Dict[str) –

writeDxf(self, e: QgsDxfExport, mmMapUnitScaleFactor: float, layerName: str, context: QgsSymbolRenderContext, shift: Union[QPointF, QPoint] = QPointF(0, 0)) → bool
Parameters
Return type

bool

writeSldMarker(self, doc: QDomDocument, element: QDomElement, props: Dict[str, str])
Parameters
  • doc (QDomDocument) –

  • element (QDomElement) –

  • props (Dict[str) –