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: qgis._core.QgsFillSymbolLayer

Methods

blurRadius Returns the blur radius, which controls the amount of blurring applied to the fill.
clone
color2 Returns the color used for the endpoint of the shapeburst fill.
colorRamp Returns the color ramp used for the shapeburst fill.
colorType Returns the color mode used for the shapeburst fill.
copyDataDefinedProperties
copyPaintEffect
create
distanceMapUnitScale
distanceUnit Returns the unit for the maximum distance to shade inside of the shape from the polygon’s boundary.
estimateMaxBleed
ignoreRings Returns whether the shapeburst fill is set to ignore polygon interior rings.
layerType
mapUnitScale
maxDistance Returns the maximum distance from the shape’s boundary which is shaded.
offset Returns the offset for the shapeburst fill.
offsetMapUnitScale
offsetUnit Returns the units used for the offset of the shapeburst fill.
outputUnit
properties
renderPolygon
restoreOldDataDefinedProperties
setBlurRadius Sets the blur radius, which controls the amount of blurring applied to the fill.
setColor2 Sets the color for the endpoint of the shapeburst fill.
setColorRamp Sets the color ramp used to draw the shapeburst fill.
setColorType Sets the color mode to use for the shapeburst fill.
setDistanceMapUnitScale
setDistanceUnit Sets the unit for the maximum distance to shade inside of the shape from the polygon’s boundary.
setIgnoreRings Sets whether the shapeburst fill should ignore polygon rings when calculating the buffered shading.
setMapUnitScale
setMaxDistance Sets the maximum distance to shape inside of the shape from the polygon’s boundary.
setOffset Sets the offset for the shapeburst fill.
setOffsetMapUnitScale
setOffsetUnit Sets the units used for the offset for the shapeburst fill.
setOutputUnit
setUseWholeShape Sets whether the shapeburst fill should be drawn using the entire shape.
startRender
stopRender
useWholeShape Returns whether the shapeburst fill is set to cover the entire shape.

Signals

Attributes

ColorRamp
SimpleTwoColor
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.

Returns:Integer representing the radius for fill blur. Higher values indicate a stronger blur. A 0 value indicates that blurring is disabled.

See also

setBlurRadius()

New in version 2.3.

clone(self) → QgsShapeburstFillSymbolLayer
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

Returns:a QColor indicating the color of the endpoint of the gradient

See also

setColor2()

See also

colorType()

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

Returns:a QgsColorRamp color ramp

See also

setColorRamp()

See also

colorType()

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.

Returns:current color mode used for the shapeburst fill

See also

setColorType()

See also

color()

See also

color2()

See also

colorRamp()

New in version 2.3.

copyDataDefinedProperties()
copyPaintEffect()
create(properties: Dict[str, str] = {}) → QgsSymbolLayer
distanceMapUnitScale(self) → QgsMapUnitScale
distanceUnit(self) → QgsUnitTypes.RenderUnit

Returns the unit for the maximum distance to shade inside of the shape from the polygon’s boundary.

Returns:distance unit for the maximum distance

See also

maxDistance()

New in version 2.3.

estimateMaxBleed(self, context: QgsRenderContext) → float
ignoreRings(self) → bool

Returns whether the shapeburst fill is set to ignore polygon interior rings.

Returns:True if the shapeburst fill will ignore interior rings when calculating buffered shading.

See also

setIgnoreRings()

New in version 2.3.

layerType(self) → str
mapUnitScale(self) → QgsMapUnitScale
maxDistance(self) → float

Returns the maximum distance from the shape’s boundary which is shaded. This parameter is only effective if useWholeShape is false.

Returns:the maximum distance from the polygon’s boundary which is shaded. Distance units are indicated by distanceUnit.

See also

useWholeShape()

See also

setMaxDistance()

See also

distanceUnit()

New in version 2.3.

offset(self) → QPointF

Returns the offset for the shapeburst fill.

Returns:a QPointF indicating the horizontal/vertical offset amount

See also

setOffset()

See also

offsetUnit()

New in version 2.3.

offsetMapUnitScale(self) → QgsMapUnitScale
offsetUnit(self) → QgsUnitTypes.RenderUnit

Returns the units used for the offset of the shapeburst fill.

Returns:units used for the fill offset

See also

offset()

See also

setOffsetUnit()

New in version 2.3.

outputUnit(self) → QgsUnitTypes.RenderUnit
properties(self) → Dict[str, str]
renderPolygon(self, points: QPolygonF, rings: Iterable[QPolygonF], context: QgsSymbolRenderContext)
restoreOldDataDefinedProperties()
setBlurRadius(self, blurRadius: int)

Sets the blur radius, which controls the amount of blurring applied to the fill.

Parameters:blurRadius – 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

blurRadius()

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 – QColor to use for endpoint of gradient

See also

setColorType()

See also

color2()

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.

Parameters:ramp – color ramp to use for shapeburst fill

See also

setColorType()

See also

colorRamp()

New in version 2.3.

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 – color type to use for shapeburst fill

See also

colorType()

See also

setColor()

See also

setColor2()

See also

setColorRamp()

New in version 2.3.

setDistanceMapUnitScale(self, 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 – distance unit for the maximum distance

See also

setMaxDistance()

See also

distanceUnit()

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 – Set to true if buffers should ignore interior rings for polygons.

See also

ignoreRings()

New in version 2.3.

setMapUnitScale(self, scale: QgsMapUnitScale)
setMaxDistance(self, maxDistance: float)

Sets the maximum distance to shape inside of the shape from the polygon’s boundary.

Parameters:maxDistance – 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

maxDistance()

New in version 2.3.

setOffset(self, offset: Union[QPointF, QPoint])

Sets the offset for the shapeburst fill.

Parameters:offset – QPointF indicating the horizontal/vertical offset amount

See also

offset()

See also

setOffsetUnit()

New in version 2.3.

setOffsetMapUnitScale(self, scale: QgsMapUnitScale)
setOffsetUnit(self, unit: QgsUnitTypes.RenderUnit)

Sets the units used for the offset for the shapeburst fill.

Parameters:unit – units for fill offset

See also

setOffset()

See also

offsetUnit()

New in version 2.3.

setOutputUnit(self, unit: QgsUnitTypes.RenderUnit)
setUseWholeShape(self, useWholeShape: bool)

Sets whether the shapeburst fill should be drawn using the entire shape.

Parameters:useWholeShape – Set to true if shapeburst should cover entire shape. If false, setMaxDistance is used to calculate how far from the boundary of the shape should be shaded

See also

useWholeShape()

See also

setMaxDistance()

New in version 2.3.

startRender(self, context: QgsSymbolRenderContext)
stopRender(self, context: QgsSymbolRenderContext)
useWholeShape(self) → bool

Returns whether the shapeburst fill is set to cover the entire shape.

Returns:True if shapeburst fill will cover the entire shape. If false, shapeburst is drawn to a distance of maxDistance from the polygon’s boundary.

See also

maxDistance()

New in version 2.3.