Class: QgsSimpleMarkerSymbolLayer¶
- class qgis.core.QgsSimpleMarkerSymbolLayer¶
Bases:
QgsSimpleMarkerSymbolLayerBase
Simple marker symbol layer, consisting of a rendered shape with solid fill color and an stroke.
QgsSimpleMarkerSymbolLayer(shape: Qgis.MarkerShape = Qgis.MarkerShape.Circle, size: float = DEFAULT_SIMPLEMARKER_SIZE, angle: float = DEFAULT_SIMPLEMARKER_ANGLE, scaleMethod: Qgis.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) Constructor for QgsSimpleMarkerSymbolLayer.
- Parameters:
shape – symbol shape
size – symbol size (in mm)
angle – symbol rotation angle
scaleMethod – scaling method for data defined scaling
color – fill color for symbol
strokeColor – stroke color for symbol
penJoinStyle –
join style for stroke pen
Methods
- param point:
- rtype:
QgsSimpleMarkerSymbolLayer
- rtype:
QColor
Copies all data defined properties of this layer to another symbol layer.
Copies paint effect of this layer to another symbol layer
Creates a new QgsSimpleMarkerSymbolLayer.
Creates a new
QgsSimpleMarkerSymbolLayer
from an SLD XML element.Draws the marker shape in the specified painter.
- rtype:
QColor
- rtype:
str
- rtype:
QgsMapUnitScale
Calculates the required marker offset, including both the symbol offset and any displacement required to align with the marker's anchor point.
Calculates the required marker offset, including both the symbol offset and any displacement required to align with the marker's anchor point.
- param mmScaleFactor:
- rtype:
QgsUnitTypes.RenderUnit
Returns the marker's stroke cap style (e.g., flat, round, etc).
Returns the marker's stroke join style (e.g., miter, bevel, etc).
Prepares cache image
- rtype:
Dict[str, Any]
- param point:
Restores older data defined properties from string map.
- param color:
- param color:
- param scale:
- param unit:
Sets the marker's stroke cap
style
(e.g., flat, round, etc).Sets the marker's stroke join style (e.g., miter, bevel, etc).
Sets the marker's stroke color.
Sets the marker's stroke style (e.g., solid, dashed, etc)
Sets the width of the marker's stroke.
Sets the map scale for the width of the marker's stroke.
Sets the unit for the width of the marker's stroke.
- param context:
Returns the marker's stroke color.
Returns the marker's stroke style (e.g., solid, dashed, etc)
Returns the width of the marker's stroke.
Returns the map scale for the width of the marker's stroke.
Returns the unit for the width of the marker's stroke.
- rtype:
bool
- param e:
- param doc:
- bounds(self, point: QPointF | QPoint, context: QgsSymbolRenderContext) QRectF ¶
- Parameters:
point (Union[QPointF) –
context (QgsSymbolRenderContext) –
- Return type:
QRectF
- calculateOffsetAndRotation()¶
- calculateSize()¶
- clone(self) QgsSimpleMarkerSymbolLayer ¶
- Return type:
- color(self) QColor ¶
- Return type:
QColor
- 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, Any] = {}) QgsSymbolLayer ¶
Creates a new QgsSimpleMarkerSymbolLayer.
- Parameters:
properties (Dict[str) – a property map containing symbol properties (see
properties()
)- Return type:
- 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:
- Returns:
new QgsSimpleMarkerSymbolLayer
- draw()¶
- drawMarker(self, p: QPainter, context: QgsSymbolRenderContext)¶
Draws the marker shape in the specified painter.
- Parameters:
p (QPainter) – destination QPainter
context (QgsSymbolRenderContext) – symbol context
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:
- 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
- ogrFeatureStyle(self, mmScaleFactor: float, mapUnitScaleFactor: float) str ¶
- Parameters:
mmScaleFactor (float) –
mapUnitScaleFactor (float) –
- Return type:
str
- outputUnit(self) QgsUnitTypes.RenderUnit ¶
- Return type:
- penCapStyle(self) Qt.PenCapStyle ¶
Returns the marker’s stroke cap style (e.g., flat, round, etc).
See also
See also
See also
See also
New in version 3.20.
- Return type:
Qt.PenCapStyle
- penJoinStyle(self) Qt.PenJoinStyle ¶
Returns the marker’s stroke join style (e.g., miter, bevel, etc).
See also
See also
See also
See also
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, Any] ¶
- Return type:
Dict[str, Any]
- renderPoint(self, point: QPointF | QPoint, context: QgsSymbolRenderContext)¶
- Parameters:
point (Union[QPointF) –
context (QgsSymbolRenderContext) –
- restoreOldDataDefinedProperties(self, stringMap: Dict[str, Any])¶
Restores older data defined properties from string map.
New in version 3.0.
- setColor(self, color: QColor | Qt.GlobalColor)¶
- Parameters:
color (Union[QColor) –
- setFillColor(self, color: QColor | Qt.GlobalColor)¶
- Parameters:
color (Union[QColor) –
- setMapUnitScale(self, scale: QgsMapUnitScale)¶
- Parameters:
scale (QgsMapUnitScale) –
- setOutputUnit(self, unit: QgsUnitTypes.RenderUnit)¶
- Parameters:
unit (QgsUnitTypes.RenderUnit) –
- setPenCapStyle(self, style: Qt.PenCapStyle)¶
Sets the marker’s stroke cap
style
(e.g., flat, round, etc).See also
See also
See also
See also
New in version 3.20.
- Parameters:
style (Qt.PenCapStyle) –
- 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
See also
See also
See also
New in version 2.16.
- setStrokeColor(self, color: QColor | Qt.GlobalColor)¶
Sets the marker’s stroke color.
- Parameters:
color (Union[QColor) – stroke color
See also
See also
See also
- setStrokeStyle(self, strokeStyle: Qt.PenStyle)¶
Sets the marker’s stroke style (e.g., solid, dashed, etc)
- Parameters:
strokeStyle (Qt.PenStyle) – style
See also
See also
See also
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
See also
See also
- 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
See also
See also
- 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
See also
See also
- shapeToPolygon()¶
- startRender(self, context: QgsSymbolRenderContext)¶
- Parameters:
context (QgsSymbolRenderContext) –
- strokeColor(self) QColor ¶
Returns the marker’s stroke color.
See also
See also
See also
- Return type:
QColor
- strokeStyle(self) Qt.PenStyle ¶
Returns the marker’s stroke style (e.g., solid, dashed, etc)
See also
See also
See also
New in version 2.4.
- Return type:
Qt.PenStyle
- strokeWidth(self) float ¶
Returns the width of the marker’s stroke.
See also
See also
See also
- Return type:
float
- strokeWidthMapUnitScale(self) QgsMapUnitScale ¶
Returns the map scale for the width of the marker’s stroke.
See also
See also
See also
- Return type:
- strokeWidthUnit(self) QgsUnitTypes.RenderUnit ¶
Returns the unit for the width of the marker’s stroke.
See also
See also
See also
- Return type:
- usesMapUnits(self) bool ¶
- Return type:
bool
- writeDxf(self, e: QgsDxfExport, mmMapUnitScaleFactor: float, layerName: str, context: QgsSymbolRenderContext, shift: QPointF | QPoint = QPointF(0, 0)) bool ¶
- Parameters:
e (QgsDxfExport) –
mmMapUnitScaleFactor (float) –
layerName (str) –
context (QgsSymbolRenderContext) –
shift (Union[QPointF) –
- Return type:
bool
- writeSldMarker(self, doc: QDomDocument, element: QDomElement, props: Dict[str, Any])¶
- Parameters:
doc (QDomDocument) –
element (QDomElement) –
props (Dict[str) –