Class: QgsShapeburstFillSymbolLayer¶
-
class
qgis.core.
QgsShapeburstFillSymbolLayer
(color: Union[QColor, Qt.GlobalColor] = DEFAULT_SIMPLEFILL_COLOR, color2: Union[QColor, Qt.GlobalColor] = Qt.white, colorType: QgsShapeburstFillSymbolLayer.ShapeburstColorType = QgsShapeburstFillSymbolLayer.SimpleTwoColor, blurRadius: int = 0, useWholeShape: bool = True, maxDistance: float = 5)¶ Bases:
QgsFillSymbolLayer
- Parameters
color (Union[QColor) –
color2 (Union[QColor) –
colorType (QgsShapeburstFillSymbolLayer.ShapeburstColorType = QgsShapeburstFillSymbolLayer.SimpleTwoColor) –
blurRadius (int = 0) –
useWholeShape (bool = True) –
maxDistance –
-
ColorRamp
= 1¶
-
class
ShapeburstColorType
¶ Bases:
int
-
SimpleTwoColor
= 0¶
-
blurRadius
(self) → int¶ Returns the blur radius, which controls the amount of blurring applied to the fill.
- Return type
int
- Returns
Integer representing the radius for fill blur. Higher values indicate a stronger blur. A 0 value indicates that blurring is disabled.
See also
New in version 2.3.
-
clone
(self) → QgsShapeburstFillSymbolLayer¶ - Return type
-
color2
(self) → QColor¶ Returns the color used for the endpoint of the shapeburst fill. This color is only used if the colorType is set to ShapeburstColorType.SimpleTwoColor
- Return type
QColor
- Returns
a QColor indicating the color of the endpoint of the gradient
See also
See also
New in version 2.3.
-
colorRamp
(self) → QgsColorRamp¶ Returns the color ramp used for the shapeburst fill. The color ramp is only used if the colorType is set to ShapeburstColorType.ColorRamp
- Return type
- Returns
a
QgsColorRamp
color ramp
See also
See also
New in version 2.3.
-
colorType
(self) → QgsShapeburstFillSymbolLayer.ShapeburstColorType¶ Returns the color mode used for the shapeburst fill. Shapeburst can either be drawn using a
QgsColorRamp
color ramp or by simply specificing a start and end color.- Return type
- Returns
current color mode used for the shapeburst fill
See also
See also
color()
See also
See also
New in version 2.3.
-
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¶ Creates a new
QgsShapeburstFillSymbolLayer
using the specifiedproperties
map containing symbol properties (see properties()).Caller takes ownership of the returned symbol layer.
- Parameters
properties (Dict[str) –
- Return type
-
distanceMapUnitScale
(self) → QgsMapUnitScale¶ - Return type
-
distanceUnit
(self) → QgsUnitTypes.RenderUnit¶ Returns the unit for the maximum distance to shade inside of the shape from the polygon’s boundary.
- Return type
- Returns
distance unit for the maximum distance
See also
See also
New in version 2.3.
-
estimateMaxBleed
(self, context: QgsRenderContext) → float¶ - Parameters
context (QgsRenderContext) –
- Return type
float
-
ignoreRings
(self) → bool¶ Returns whether the shapeburst fill is set to ignore polygon interior rings.
- Return type
bool
- Returns
True
if the shapeburst fill will ignore interior rings when calculating buffered shading.
See also
New in version 2.3.
-
layerType
(self) → str¶ - Return type
str
-
mapUnitScale
(self) → QgsMapUnitScale¶ - Return type
-
maxDistance
(self) → float¶ Returns the maximum distance from the shape’s boundary which is shaded. This parameter is only effective if useWholeShape is
False
.- Return type
float
- Returns
the maximum distance from the polygon’s boundary which is shaded. Distance units are indicated by distanceUnit.
See also
See also
See also
New in version 2.3.
-
offset
(self) → QPointF¶ Returns the offset for the shapeburst fill.
- Return type
QPointF
- Returns
a QPointF indicating the horizontal/vertical offset amount
See also
See also
New in version 2.3.
-
offsetMapUnitScale
(self) → QgsMapUnitScale¶ - Return type
-
offsetUnit
(self) → QgsUnitTypes.RenderUnit¶ Returns the units used for the offset of the shapeburst fill.
- Return type
- Returns
units used for the fill offset
See also
See also
New in version 2.3.
-
outputUnit
(self) → QgsUnitTypes.RenderUnit¶ - Return type
-
properties
(self) → Dict[str, str]¶ - Return type
Dict[str, str]
-
renderPolygon
(self, points: QPolygonF, rings: Iterable[QPolygonF], context: QgsSymbolRenderContext)¶ - Parameters
points (QPolygonF) –
rings (Iterable[QPolygonF]) –
context (QgsSymbolRenderContext) –
-
restoreOldDataDefinedProperties
(self, stringMap: Dict[str, str])¶ Restores older data defined properties from string map.
New in version 3.0.
-
setBlurRadius
(self, blurRadius: int)¶ Sets the blur radius, which controls the amount of blurring applied to the fill.
- Parameters
blurRadius (int) – Radius for fill blur. Values between 0 - 17 are valid, where higher values results in a stronger blur. Set to 0 to disable blur.
See also
New in version 2.3.
-
setColor2
(self, color2: Union[QColor, Qt.GlobalColor])¶ Sets the color for the endpoint of the shapeburst fill. This color is only used if setColorType is set ShapeburstColorType.SimpleTwoColor.
- Parameters
color2 (Union[QColor) – QColor to use for endpoint of gradient
See also
See also
New in version 2.3.
-
setColorRamp
(self, ramp: QgsColorRamp)¶ Sets the color
ramp
used to draw the shapeburst fill. Color ramps are only used if setColorType is set ShapeburstColorType.ColorRamp.Ownership of
ramp
is transferred to the fill.See also
See also
New in version 2.3.
- Parameters
ramp (QgsColorRamp) –
-
setColorType
(self, colorType: QgsShapeburstFillSymbolLayer.ShapeburstColorType)¶ Sets the color mode to use for the shapeburst fill. Shapeburst can either be drawn using a
QgsColorRamp
color ramp or by simply specificing a start and end color. setColorType is used to specify which mode to use for the fill.- Parameters
colorType (QgsShapeburstFillSymbolLayer.ShapeburstColorType) – color type to use for shapeburst fill
See also
See also
setColor()
See also
See also
New in version 2.3.
-
setDistanceMapUnitScale
(self, scale: QgsMapUnitScale)¶ - Parameters
scale (QgsMapUnitScale) –
-
setDistanceUnit
(self, unit: QgsUnitTypes.RenderUnit)¶ Sets the unit for the maximum distance to shade inside of the shape from the polygon’s boundary.
- Parameters
unit (QgsUnitTypes.RenderUnit) – distance unit for the maximum distance
See also
See also
New in version 2.3.
-
setIgnoreRings
(self, ignoreRings: bool)¶ Sets whether the shapeburst fill should ignore polygon rings when calculating the buffered shading.
- Parameters
ignoreRings (bool) – Set to
True
if buffers should ignore interior rings for polygons.
See also
New in version 2.3.
-
setMapUnitScale
(self, scale: QgsMapUnitScale)¶ - Parameters
scale (QgsMapUnitScale) –
-
setMaxDistance
(self, maxDistance: float)¶ Sets the maximum distance to shape inside of the shape from the polygon’s boundary.
- Parameters
maxDistance (float) – distance from boundary to shade. setUseWholeShape must be set to
False
for this parameter to take effect. Distance unit is controlled by setDistanceUnit.
See also
See also
See also
New in version 2.3.
-
setOffset
(self, offset: Union[QPointF, QPoint])¶ Sets the offset for the shapeburst fill.
- Parameters
offset (Union[QPointF) – QPointF indicating the horizontal/vertical offset amount
See also
See also
New in version 2.3.
-
setOffsetMapUnitScale
(self, scale: QgsMapUnitScale)¶ - Parameters
scale (QgsMapUnitScale) –
-
setOffsetUnit
(self, unit: QgsUnitTypes.RenderUnit)¶ Sets the units used for the offset for the shapeburst fill.
- Parameters
unit (QgsUnitTypes.RenderUnit) – units for fill offset
See also
See also
New in version 2.3.
-
setOutputUnit
(self, unit: QgsUnitTypes.RenderUnit)¶ - Parameters
unit (QgsUnitTypes.RenderUnit) –
-
setUseWholeShape
(self, useWholeShape: bool)¶ Sets whether the shapeburst fill should be drawn using the entire shape.
- Parameters
useWholeShape (bool) – Set to
True
if shapeburst should cover entire shape. IfFalse
, setMaxDistance is used to calculate how far from the boundary of the shape should be shaded
See also
See also
New in version 2.3.
-
startRender
(self, context: QgsSymbolRenderContext)¶ - Parameters
context (QgsSymbolRenderContext) –
-
stopRender
(self, context: QgsSymbolRenderContext)¶ - Parameters
context (QgsSymbolRenderContext) –
-
useWholeShape
(self) → bool¶ Returns whether the shapeburst fill is set to cover the entire shape.
- Return type
bool
- Returns
True
if shapeburst fill will cover the entire shape. IfFalse
, shapeburst is drawn to a distance of maxDistance from the polygon’s boundary.
See also
See also
New in version 2.3.