Subgroup: Marker
Class: QgsMarkerSymbolLayer¶
-
class
qgis.core.
QgsMarkerSymbolLayer
(locked: bool = False)¶ Bases:
qgis._core.QgsSymbolLayer
Constructor for QgsMarkerSymbolLayer.
Parameters: locked – set to true to lock symbol color QgsMarkerSymbolLayer(QgsMarkerSymbolLayer)
Abstract base class for marker symbol layers.
Methods
angle
Returns the rotation angle for the marker, in degrees clockwise from north. bounds
Returns the approximate bounding box of the marker symbol layer, taking into account any data defined overrides and offsets which are set for the marker layer. copyDataDefinedProperties
copyPaintEffect
drawPreviewIcon
horizontalAnchorPoint
Returns the horizontal anchor point for positioning the symbol. mapUnitScale
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. offset
Returns the marker’s offset, which is the horizontal and vertical displacement which the rendered marker will have from the original feature’s geometry. offsetMapUnitScale
Returns the map unit scale for the symbol’s offset. offsetUnit
Returns the units for the symbol’s offset. outputUnit
renderPoint
Renders a marker at the specified point. restoreOldDataDefinedProperties
scaleMethod
Returns the method to use for scaling the marker’s size. setAngle
Sets the rotation angle for the marker. setHorizontalAnchorPoint
Sets the horizontal anchor point for positioning the symbol. setLineAngle
Sets the line angle modification for the symbol’s angle. setMapUnitScale
setOffset
Sets the marker’s offset, which is the horizontal and vertical displacement which the rendered marker should have from the original feature’s geometry. setOffsetMapUnitScale
Sets the map unit scale for the symbol’s offset. setOffsetUnit
Sets the units for the symbol’s offset. setOutputUnit
setScaleMethod
Sets the method to use for scaling the marker’s size. setSize
Sets the symbol size. setSizeMapUnitScale
Sets the map unit scale for the symbol’s size. setSizeUnit
Sets the units for the symbol’s size. setVerticalAnchorPoint
Sets the vertical anchor point for positioning the symbol. size
Returns the symbol size. sizeMapUnitScale
Returns the map unit scale for the symbol’s size. sizeUnit
Returns the units for the symbol’s size. startRender
toSld
verticalAnchorPoint
Returns the vertical anchor point for positioning the symbol. writeSldMarker
Writes the symbol layer definition as a SLD XML element. Signals
Attributes
Bottom
HCenter
Left
Right
Top
VCenter
-
Bottom
= 2¶
-
HCenter
= 1¶
-
class
HorizontalAnchorPoint
¶ Bases:
int
-
Left
= 0¶
-
Right
= 2¶
-
Top
= 0¶
-
VCenter
= 1¶
-
class
VerticalAnchorPoint
¶ Bases:
int
-
angle
(self) → float¶ Returns the rotation angle for the marker, in degrees clockwise from north.
See also
-
bounds
(self, point: Union[QPointF, QPoint], context: QgsSymbolRenderContext) → QRectF¶ Returns the approximate bounding box of the marker symbol layer, taking into account any data defined overrides and offsets which are set for the marker layer.
Returns: approximate symbol bounds, in painter units New in version 2.14.
-
copyDataDefinedProperties
()¶
-
copyPaintEffect
()¶
-
drawPreviewIcon
(self, context: QgsSymbolRenderContext, size: QSize)¶
-
horizontalAnchorPoint
(self) → QgsMarkerSymbolLayer.HorizontalAnchorPoint¶ Returns the horizontal anchor point for positioning the symbol. The symbol will be drawn so that the horizontal anchor point is aligned with the marker’s desired location.
See also
See also
-
mapUnitScale
(self) → 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
-
offset
(self) → QPointF¶ Returns the marker’s offset, which is the horizontal and vertical displacement which the rendered marker will have from the original feature’s geometry. Units are specified by offsetUnit().
See also
See also
See also
-
offsetMapUnitScale
(self) → QgsMapUnitScale¶ Returns the map unit scale for the symbol’s offset.
See also
See also
See also
-
offsetUnit
(self) → QgsUnitTypes.RenderUnit¶ Returns the units for the symbol’s offset.
See also
See also
See also
-
outputUnit
(self) → QgsUnitTypes.RenderUnit¶
-
renderPoint
(self, point: Union[QPointF, QPoint], context: QgsSymbolRenderContext)¶ Renders a marker at the specified point. Derived classes must implement this to handle drawing the point.
Parameters: - point – position at which to render point, in painter units
- context – symbol render context
-
restoreOldDataDefinedProperties
()¶
-
scaleMethod
(self) → QgsSymbol.ScaleMethod¶ Returns the method to use for scaling the marker’s size.
See also
-
setAngle
(self, angle: float)¶ Sets the rotation angle for the marker.
Parameters: angle – angle in degrees clockwise from north. See also
See also
-
setHorizontalAnchorPoint
(self, h: QgsMarkerSymbolLayer.HorizontalAnchorPoint)¶ Sets the horizontal anchor point for positioning the symbol.
Parameters: h – anchor point. Symbol will be drawn so that the horizontal anchor point is aligned with the marker’s desired location. See also
See also
-
setLineAngle
(self, lineAngle: float)¶ Sets the line angle modification for the symbol’s angle. This angle is added to the marker’s rotation and data defined rotation before rendering the symbol, and is usually used for orienting symbols to match a line’s angle.
Parameters: lineAngle – Angle in degrees clockwise from north, valid values are between 0 and 360 See also
See also
New in version 2.9.
-
setMapUnitScale
(self, scale: QgsMapUnitScale)¶
-
setOffset
(self, offset: Union[QPointF, QPoint])¶ Sets the marker’s offset, which is the horizontal and vertical displacement which the rendered marker should have from the original feature’s geometry.
Parameters: offset – marker offset. Units are specified by offsetUnit() See also
See also
See also
-
setOffsetMapUnitScale
(self, scale: QgsMapUnitScale)¶ Sets the map unit scale for the symbol’s offset.
Parameters: scale – offset map unit scale See also
See also
See also
-
setOffsetUnit
(self, unit: QgsUnitTypes.RenderUnit)¶ Sets the units for the symbol’s offset.
Parameters: unit – offset units See also
See also
See also
-
setOutputUnit
(self, unit: QgsUnitTypes.RenderUnit)¶
-
setScaleMethod
(self, scaleMethod: QgsSymbol.ScaleMethod)¶ Sets the method to use for scaling the marker’s size.
Parameters: scaleMethod – scale method See also
-
setSize
(self, size: float)¶ Sets the symbol size.
Parameters: size – symbol size. Units are specified by sizeUnit(). See also
See also
See also
-
setSizeMapUnitScale
(self, scale: QgsMapUnitScale)¶ Sets the map unit scale for the symbol’s size.
Parameters: scale – size map unit scale See also
See also
See also
-
setSizeUnit
(self, unit: QgsUnitTypes.RenderUnit)¶ Sets the units for the symbol’s size.
Parameters: unit – size units See also
See also
See also
-
setVerticalAnchorPoint
(self, v: QgsMarkerSymbolLayer.VerticalAnchorPoint)¶ Sets the vertical anchor point for positioning the symbol.
Parameters: v – anchor point. Symbol will be drawn so that the vertical anchor point is aligned with the marker’s desired location. See also
See also
-
size
(self) → float¶ Returns the symbol size. Units are specified by sizeUnit().
See also
See also
See also
-
sizeMapUnitScale
(self) → QgsMapUnitScale¶ Returns the map unit scale for the symbol’s size.
See also
See also
See also
-
sizeUnit
(self) → QgsUnitTypes.RenderUnit¶ Returns the units for the symbol’s size.
See also
See also
See also
-
startRender
(self, context: QgsSymbolRenderContext)¶
-
toSld
(self, doc: QDomDocument, element: QDomElement, props: Dict[str, str])¶
-
verticalAnchorPoint
(self) → QgsMarkerSymbolLayer.VerticalAnchorPoint¶ Returns the vertical anchor point for positioning the symbol. The symbol will be drawn so that the vertical anchor point is aligned with the marker’s desired location.
See also
See also
-
writeSldMarker
(self, doc: QDomDocument, element: QDomElement, props: Dict[str, str])¶ Writes the symbol layer definition as a SLD XML element.
Parameters: - doc – XML document
- element – parent XML element
- props – symbol layer definition (see properties())
-