Class: QgsSimpleMarkerSymbolLayer

class qgis.core.QgsSimpleMarkerSymbolLayer(shape: QgsSimpleMarkerSymbolLayerBase.Shape = QgsSimpleMarkerSymbolLayerBase.Circle, size: float = DEFAULT_SIMPLEMARKER_SIZE, angle: float = DEFAULT_SIMPLEMARKER_ANGLE, scaleMethod: QgsSymbol.ScaleMethod = DEFAULT_SCALE_METHOD, color: Union[QColor, Qt.GlobalColor] = DEFAULT_SIMPLEMARKER_COLOR, strokeColor: Union[QColor, Qt.GlobalColor] = DEFAULT_SIMPLEMARKER_BORDERCOLOR, penJoinStyle: Qt.PenJoinStyle = DEFAULT_SIMPLEMARKER_JOINSTYLE)

Bases: QgsSimpleMarkerSymbolLayerBase

Constructor for QgsSimpleMarkerSymbolLayer.

Parameters
  • shape (QgsSimpleMarkerSymbolLayerBase.Shape = QgsSimpleMarkerSymbolLayerBase.Circle) – symbol shape

  • size (float = DEFAULT_SIMPLEMARKER_SIZE) – symbol size (in mm)

  • angle (float = DEFAULT_SIMPLEMARKER_ANGLE) – symbol rotation angle

  • scaleMethod (QgsSymbol.ScaleMethod = DEFAULT_SCALE_METHOD) – scaling method for data defined scaling

  • color (Union[QColor) – fill color for symbol

  • strokeColor (Union[QColor) – stroke color for symbol

  • penJoinStyle (Qt.PenJoinStyle = DEFAULT_SIMPLEMARKER_JOINSTYLE) – join style for stroke pen

Simple marker symbol layer, consisting of a rendered shape with solid fill color and an stroke.

Methods

bounds

param point

calculateOffsetAndRotation

calculateSize

clone

rtype

QgsSimpleMarkerSymbolLayer

color

rtype

QColor

copyDataDefinedProperties

copyPaintEffect

create

Creates a new QgsSimpleMarkerSymbolLayer.

createFromSld

Creates a new QgsSimpleMarkerSymbolLayer from an SLD XML element.

draw

drawMarker

Draws the marker shape in the specified painter.

fillColor

rtype

QColor

layerType

rtype

str

mapUnitScale

rtype

QgsMapUnitScale

markerOffset

markerOffset2

markerOffsetWithWidthAndHeight

ogrFeatureStyle

param mmScaleFactor

outputUnit

rtype

QgsUnitTypes.RenderUnit

penJoinStyle

Returns the marker’s stroke join style (e.g., miter, bevel, etc).

prepareCache

Prepares cache image

prepareMarkerPath

prepareMarkerShape

properties

rtype

Dict[str, str]

renderPoint

param point

restoreOldDataDefinedProperties

setColor

param color

setFillColor

param color

setMapUnitScale

param scale

setOutputUnit

param unit

setPenJoinStyle

Sets the marker’s stroke join style (e.g., miter, bevel, etc).

setStrokeColor

Sets the marker’s stroke color.

setStrokeStyle

Sets the marker’s stroke style (e.g., solid, dashed, etc)

setStrokeWidth

Sets the width of the marker’s stroke.

setStrokeWidthMapUnitScale

Sets the map scale for the width of the marker’s stroke.

setStrokeWidthUnit

Sets the unit for the width of the marker’s stroke.

shapeToPolygon

startRender

param context

strokeColor

Returns the marker’s stroke color.

strokeStyle

Returns the marker’s stroke style (e.g., solid, dashed, etc)

strokeWidth

Returns the width of the marker’s stroke.

strokeWidthMapUnitScale

Returns the map scale for the width of the marker’s stroke.

strokeWidthUnit

Returns the unit for the width of the marker’s stroke.

writeDxf

param e

writeSldMarker

param doc

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

QRectF

calculateOffsetAndRotation()
calculateSize()
clone(self) → QgsSimpleMarkerSymbolLayer
Return type

QgsSimpleMarkerSymbolLayer

color(self) → QColor
Return type

QColor

copyDataDefinedProperties()
copyPaintEffect()
create(properties: Dict[str, str] = {}) → QgsSymbolLayer

Creates a new QgsSimpleMarkerSymbolLayer.

Parameters

properties (Dict[str) – a property map containing symbol properties (see properties())

Return type

QgsSymbolLayer

Returns

new QgsSimpleMarkerSymbolLayer

createFromSld(element: QDomElement) → QgsSymbolLayer

Creates a new QgsSimpleMarkerSymbolLayer from an SLD XML element.

Parameters

element (QDomElement) – XML element containing SLD definition of symbol

Return type

QgsSymbolLayer

Returns

new QgsSimpleMarkerSymbolLayer

draw()
drawMarker(self, p: QPainter, context: QgsSymbolRenderContext)

Draws the marker shape in the specified painter.

Parameters

Note

this method does not handle setting the painter pen or brush to match the symbol’s fill or stroke

fillColor(self) → QColor
Return type

QColor

layerType(self) → str
Return type

str

mapUnitScale(self) → QgsMapUnitScale
Return type

QgsMapUnitScale

markerOffset()
markerOffset2()
markerOffsetWithWidthAndHeight()
ogrFeatureStyle(self, mmScaleFactor: float, mapUnitScaleFactor: float) → str
Parameters
  • mmScaleFactor (float) –

  • mapUnitScaleFactor (float) –

Return type

str

outputUnit(self) → QgsUnitTypes.RenderUnit
Return type

QgsUnitTypes.RenderUnit

penJoinStyle(self) → Qt.PenJoinStyle

Returns the marker’s stroke join style (e.g., miter, bevel, etc).

See also

strokeColor()

See also

strokeStyle()

New in version 2.16.

Return type

Qt.PenJoinStyle

prepareCache(self, context: QgsSymbolRenderContext) → bool

Prepares cache image

Return type

bool

Returns

True in case of success, False if cache image size too large

Parameters

context (QgsSymbolRenderContext) –

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

Dict[str, str]

renderPoint(self, point: Union[QPointF, QPoint], context: QgsSymbolRenderContext)
Parameters
restoreOldDataDefinedProperties()
setColor(self, color: Union[QColor, Qt.GlobalColor])
Parameters

color (Union[QColor) –

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

color (Union[QColor) –

setMapUnitScale(self, scale: QgsMapUnitScale)
Parameters

scale (QgsMapUnitScale) –

setOutputUnit(self, unit: QgsUnitTypes.RenderUnit)
Parameters

unit (QgsUnitTypes.RenderUnit) –

setPenJoinStyle(self, style: Qt.PenJoinStyle)

Sets the marker’s stroke join style (e.g., miter, bevel, etc).

Parameters

style (Qt.PenJoinStyle) – join style

See also

penJoinStyle()

See also

setStrokeColor()

See also

setStrokeStyle()

New in version 2.16.

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

Sets the marker’s stroke color.

Parameters

color (Union[QColor) – stroke color

See also

strokeColor()

See also

setStrokeStyle()

setStrokeStyle(self, strokeStyle: Qt.PenStyle)

Sets the marker’s stroke style (e.g., solid, dashed, etc)

Parameters

strokeStyle (Qt.PenStyle) – style

See also

strokeStyle()

See also

setStrokeColor()

New in version 2.4.

setStrokeWidth(self, w: float)

Sets the width of the marker’s stroke.

Parameters

w (float) – stroke width. See strokeWidthUnit() for units.

See also

strokeWidth()

setStrokeWidthMapUnitScale(self, scale: QgsMapUnitScale)

Sets the map scale for the width of the marker’s stroke.

Parameters

scale (QgsMapUnitScale) – stroke width map unit scale

See also

setStrokeWidth()

setStrokeWidthUnit(self, u: QgsUnitTypes.RenderUnit)

Sets the unit for the width of the marker’s stroke.

Parameters

u (QgsUnitTypes.RenderUnit) – stroke width unit

See also

setStrokeWidth()

shapeToPolygon()
startRender(self, context: QgsSymbolRenderContext)
Parameters

context (QgsSymbolRenderContext) –

strokeColor(self) → QColor

Returns the marker’s stroke color.

See also

setStrokeColor()

See also

strokeStyle()

See also

penJoinStyle()

Return type

QColor

strokeStyle(self) → Qt.PenStyle

Returns the marker’s stroke style (e.g., solid, dashed, etc)

See also

setStrokeStyle()

See also

strokeColor()

See also

penJoinStyle()

New in version 2.4.

Return type

Qt.PenStyle

strokeWidth(self) → float

Returns the width of the marker’s stroke.

See also

setStrokeWidth()

Return type

float

strokeWidthMapUnitScale(self) → QgsMapUnitScale

Returns the map scale for the width of the marker’s stroke.

See also

strokeWidth()

Return type

QgsMapUnitScale

strokeWidthUnit(self) → QgsUnitTypes.RenderUnit

Returns the unit for the width of the marker’s stroke.

See also

strokeWidth()

Return type

QgsUnitTypes.RenderUnit

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) –