Class: QgsMarkerSymbolLayer¶
-
class
qgis.core.
QgsMarkerSymbolLayer
(locked: bool = False)¶ Bases:
QgsSymbolLayer
Constructor for QgsMarkerSymbolLayer.
- Parameters
locked (bool = False) – set to
True
to lock symbol color
Abstract base class for marker symbol layers.
Methods
Returns the rotation angle for the marker, in degrees clockwise from north.
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.
Copies all data defined properties of this layer to another symbol layer.
Copies paint effect of this layer to another symbol layer
- param context
Returns the horizontal anchor point for positioning the symbol.
- 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.
Returns the marker’s offset, which is the horizontal and vertical displacement which the rendered marker will have from the original feature’s geometry.
Returns the map unit scale for the symbol’s offset.
Returns the units for the symbol’s offset.
- rtype
QgsUnitTypes.RenderUnit
Renders a marker at the specified point.
Restores older data defined properties from string map.
Returns the method to use for scaling the marker’s size.
Sets the rotation angle for the marker.
Sets the horizontal anchor point for positioning the symbol.
Sets the line angle modification for the symbol’s angle.
- param scale
Sets the marker’s offset, which is the horizontal and vertical displacement which the rendered marker should have from the original feature’s geometry.
Sets the map unit scale for the symbol’s offset.
Sets the units for the symbol’s offset.
- param unit
Sets the method to use for scaling the marker’s size.
Sets the symbol size.
Sets the map unit scale for the symbol’s size.
Sets the units for the symbol’s size.
Sets the vertical anchor point for positioning the symbol.
Returns the symbol size.
Returns the map unit scale for the symbol’s size.
Returns the units for the symbol’s size.
QgsMarkerSymbolLayer
cannot be copied- param context
- param doc
Returns the vertical anchor point for positioning the symbol.
Writes the symbol layer definition as a SLD XML element.
Attributes
-
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
- Return type
float
-
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.
- Return type
QRectF
- Returns
approximate symbol bounds, in painter units
New in version 2.14.
- Parameters
point (Union[QPointF) –
context (QgsSymbolRenderContext) –
-
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.
-
drawPreviewIcon
(self, context: QgsSymbolRenderContext, size: QSize)¶ - Parameters
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
- Return type
-
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 (QgsSymbolRenderContext) – 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)
- Return type
Tuple[float, float]
-
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
- Parameters
context (QgsSymbolRenderContext) –
width (float) –
height (float) –
widthUnit (QgsUnitTypes.RenderUnit) –
heightUnit (QgsUnitTypes.RenderUnit) –
widthMapUnitScale (QgsMapUnitScale) –
heightMapUnitScale (QgsMapUnitScale) –
- Return type
Tuple[float, float]
-
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 (QgsSymbolRenderContext) – symbol render context
width (float) – marker width
height (float) – 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
- Return type
Tuple[float, float]
-
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
- Return type
QPointF
-
offsetMapUnitScale
(self) → QgsMapUnitScale¶ Returns the map unit scale for the symbol’s offset.
See also
See also
See also
- Return type
-
offsetUnit
(self) → QgsUnitTypes.RenderUnit¶ Returns the units for the symbol’s offset.
See also
See also
See also
- Return type
-
outputUnit
(self) → QgsUnitTypes.RenderUnit¶ - Return type
-
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 (Union[QPointF) – position at which to render point, in painter units
context (QgsSymbolRenderContext) – symbol render context
-
restoreOldDataDefinedProperties
(self, stringMap: Dict[str, str])¶ Restores older data defined properties from string map.
New in version 3.0.
-
scaleMethod
(self) → QgsSymbol.ScaleMethod¶ Returns the method to use for scaling the marker’s size.
See also
- Return type
-
setAngle
(self, angle: float)¶ Sets the rotation angle for the marker.
- Parameters
angle (float) – 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 (QgsMarkerSymbolLayer.HorizontalAnchorPoint) – 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 (float) – 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)¶ - Parameters
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 (Union[QPointF) – 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 (QgsMapUnitScale) – 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 (QgsUnitTypes.RenderUnit) – offset units
See also
See also
See also
-
setOutputUnit
(self, unit: QgsUnitTypes.RenderUnit)¶ - Parameters
unit (QgsUnitTypes.RenderUnit) –
-
setScaleMethod
(self, scaleMethod: QgsSymbol.ScaleMethod)¶ Sets the method to use for scaling the marker’s size.
- Parameters
scaleMethod (QgsSymbol.ScaleMethod) – scale method
See also
-
setSize
(self, size: float)¶ Sets the symbol size.
- Parameters
size (float) – 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 (QgsMapUnitScale) – 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 (QgsUnitTypes.RenderUnit) – size units
See also
See also
See also
-
setVerticalAnchorPoint
(self, v: QgsMarkerSymbolLayer.VerticalAnchorPoint)¶ Sets the vertical anchor point for positioning the symbol.
- Parameters
v (QgsMarkerSymbolLayer.VerticalAnchorPoint) – 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
- Return type
float
-
sizeMapUnitScale
(self) → QgsMapUnitScale¶ Returns the map unit scale for the symbol’s size.
See also
See also
See also
- Return type
-
sizeUnit
(self) → QgsUnitTypes.RenderUnit¶ Returns the units for the symbol’s size.
See also
See also
See also
- Return type
-
startRender
(self, context: QgsSymbolRenderContext)¶ QgsMarkerSymbolLayer
cannot be copied- Parameters
context (QgsSymbolRenderContext) –
-
stopRender
(self, context: QgsSymbolRenderContext)¶ - Parameters
context (QgsSymbolRenderContext) –
-
toSld
(self, doc: QDomDocument, element: QDomElement, props: Dict[str, str])¶ - Parameters
doc (QDomDocument) –
element (QDomElement) –
props (Dict[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
- Return type
-
writeSldMarker
(self, doc: QDomDocument, element: QDomElement, props: Dict[str, str])¶ Writes the symbol layer definition as a SLD XML element.
- Parameters
doc (QDomDocument) – XML document
element (QDomElement) – parent XML element
props (Dict[str) – symbol layer definition (see
properties()
)