Class: QgsEllipseSymbolLayer¶
-
class
qgis.core.
QgsEllipseSymbolLayer
¶ Bases:
QgsMarkerSymbolLayer
A symbol layer for rendering objects with major and minor axis (e.g. ellipse, rectangle )*
Methods
- param point
- rtype
QgsEllipseSymbolLayer
Copies all data defined properties of this layer to another symbol layer.
Copies paint effect of this layer to another symbol layer
- param properties
- param element
- 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.
- rtype
QgsUnitTypes.RenderUnit
Gets stroke join style.
- rtype
Dict[str, str]
- param point
Restores older data defined properties from string map.
- param c
- param scale
- param unit
Set stroke join style.
- param size
- param c
- param strokeStyle
- param w
- param scale
Sets the units for the symbol’s stroke width.
- param h
- param scale
Sets the units for the symbol’s height.
- param name
- param w
- param scale
Sets the units for the symbol’s width.
- param context
- param context
- rtype
QColor
- rtype
Qt.PenStyle
- rtype
float
- rtype
QgsMapUnitScale
Returns the units for the symbol’s stroke width.
- rtype
float
- rtype
QgsMapUnitScale
Returns the units for the symbol’s height.
- rtype
str
- rtype
float
- rtype
QgsMapUnitScale
Returns the units for the symbol’s width.
- param doc
- param e
- param doc
-
bounds
(self, point: Union[QPointF, QPoint], context: QgsSymbolRenderContext) → QRectF¶ - Parameters
point (Union[QPointF) –
context (QgsSymbolRenderContext) –
- Return type
QRectF
-
clone
(self) → QgsEllipseSymbolLayer¶ - Return type
-
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
-
createFromSld
(element: QDomElement) → QgsSymbolLayer¶ - Parameters
element (QDomElement) –
- Return type
-
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
-
outputUnit
(self) → QgsUnitTypes.RenderUnit¶ - Return type
-
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
point (Union[QPointF) –
context (QgsSymbolRenderContext) –
-
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
See also
-
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
See also
See also
-
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
See also
See also
-
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
-
strokeWidthUnit
(self) → QgsUnitTypes.RenderUnit¶ Returns the units for the symbol’s stroke width.
See also
- Return type
-
symbolHeight
(self) → float¶ - Return type
float
-
symbolHeightMapUnitScale
(self) → QgsMapUnitScale¶ - Return type
-
symbolHeightUnit
(self) → QgsUnitTypes.RenderUnit¶ Returns the units for the symbol’s height.
See also
See also
- Return type
-
symbolName
(self) → str¶ - Return type
str
-
symbolWidth
(self) → float¶ - Return type
float
-
symbolWidthMapUnitScale
(self) → QgsMapUnitScale¶ - Return type
-
symbolWidthUnit
(self) → QgsUnitTypes.RenderUnit¶ Returns the units for the symbol’s width.
See also
See also
- Return type
-
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
e (QgsDxfExport) –
mmMapUnitScaleFactor (float) –
layerName (str) –
context (QgsSymbolRenderContext) –
shift (Union[QPointF) –
- Return type
bool
-
writeSldMarker
(self, doc: QDomDocument, element: QDomElement, props: Dict[str, str])¶ - Parameters
doc (QDomDocument) –
element (QDomElement) –
props (Dict[str) –