Class: QgsRasterFillSymbolLayer

class qgis.core.QgsRasterFillSymbolLayer(imageFilePath: str = '')

Bases: qgis._core.QgsImageFillSymbolLayer

Constructor for QgsRasterFillSymbolLayer, using a raster fill from the specified imageFilePath.

A class for filling symbols with a repeated raster image.

New in version 2.7: Methods

applyDataDefinedSettings
clone
coordinateMode Coordinate mode for fill.
copyDataDefinedProperties
copyPaintEffect
create Creates a new QgsRasterFillSymbolLayer from a properties map.
estimateMaxBleed
imageFilePath The path to the raster image used for the fill.
layerType
offset Returns the offset for the fill.
offsetMapUnitScale Returns the map unit scale for the fill’s offset.
offsetUnit Returns the units for the fill’s offset.
opacity Returns the opacity for the raster image used in the fill.
properties
renderPolygon
resolvePaths Turns relative paths in properties map to absolute when reading and vice versa when writing.
restoreOldDataDefinedProperties
setCoordinateMode Set the coordinate mode for fill.
setImageFilePath Sets the path to the raster image used for the fill.
setOffset Sets the offset for the fill.
setOffsetMapUnitScale Sets the map unit scale for the fill’s offset.
setOffsetUnit Sets the units for the fill’s offset.
setOpacity Sets the opacity for the raster image used in the fill.
setSubSymbol
setWidth Sets the width for scaling the image used in the fill.
setWidthMapUnitScale Sets the map unit scale for the image’s width.
setWidthUnit Sets the units for the image’s width.
startRender
stopRender
subSymbol
width Returns the width used for scaling the image used in the fill.
widthMapUnitScale Returns the map unit scale for the image’s width.
widthUnit Returns the units for the image’s width.

Signals

Attributes

Feature
Viewport
Feature = 0
class FillCoordinateMode

Bases: int

Viewport = 1
applyDataDefinedSettings(self, context: QgsSymbolRenderContext)
clone(self) → QgsRasterFillSymbolLayer
coordinateMode(self) → QgsRasterFillSymbolLayer.FillCoordinateMode

Coordinate mode for fill. Controls how the top left corner of the image fill is positioned relative to the feature.

Returns:coordinate mode
copyDataDefinedProperties()
copyPaintEffect()
create(properties: Dict[str, str] = {}) → QgsSymbolLayer

Creates a new QgsRasterFillSymbolLayer from a properties map. The caller takes ownership of the returned object.

estimateMaxBleed(self, context: QgsRenderContext) → float
imageFilePath(self) → str

The path to the raster image used for the fill.

Returns:path to image file
layerType(self) → str
offset(self) → QPointF

Returns the offset for the fill.

Returns:offset for fill

See also

setOffset()

See also

offsetUnit()

offsetMapUnitScale(self) → QgsMapUnitScale

Returns the map unit scale for the fill’s offset.

Returns:map unit scale for offset

See also

offset()

See also

offsetUnit()

offsetUnit(self) → QgsUnitTypes.RenderUnit

Returns the units for the fill’s offset.

Returns:units for offset

See also

setOffsetUnit()

See also

offset()

opacity(self) → float

Returns the opacity for the raster image used in the fill.

Returns:opacity value between 0 (fully transparent) and 1 (fully opaque)

See also

setOpacity()

properties(self) → Dict[str, str]
renderPolygon(self, points: QPolygonF, rings: Iterable[QPolygonF], context: QgsSymbolRenderContext)
resolvePaths(properties: Dict[str, str], pathResolver: QgsPathResolver, saving: bool)

Turns relative paths in properties map to absolute when reading and vice versa when writing. Used internally when reading/writing symbols.

New in version 3.0.

restoreOldDataDefinedProperties()
setCoordinateMode(self, mode: QgsRasterFillSymbolLayer.FillCoordinateMode)

Set the coordinate mode for fill. Controls how the top left corner of the image fill is positioned relative to the feature.

Parameters:mode – coordinate mode

See also

coordinateMode()

setImageFilePath(self, imagePath: str)

Sets the path to the raster image used for the fill.

Parameters:imagePath – path to image file

See also

imageFilePath()

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

Sets the offset for the fill.

Parameters:offset – offset for fill

See also

offset()

See also

setOffsetUnit()

setOffsetMapUnitScale(self, scale: QgsMapUnitScale)

Sets the map unit scale for the fill’s offset.

Parameters:scale – map unit scale for offset

See also

setOffset()

See also

setOffsetUnit()

setOffsetUnit(self, unit: QgsUnitTypes.RenderUnit)

Sets the units for the fill’s offset.

Parameters:unit – units for offset

See also

offsetUnit()

See also

setOffset()

setOpacity(self, opacity: float)

Sets the opacity for the raster image used in the fill.

Parameters:opacity – opacity value between 0 (fully transparent) and 1 (fully opaque)

See also

opacity()

setSubSymbol(self, symbol: QgsSymbol) → bool
setWidth(self, width: float)

Sets the width for scaling the image used in the fill. The image’s height will also be scaled to maintain the image’s aspect ratio.

Parameters:width – width for scaling the image

See also

width()

See also

setWidthUnit()

setWidthMapUnitScale(self, scale: QgsMapUnitScale)

Sets the map unit scale for the image’s width.

Parameters:scale – map unit scale for width

See also

setWidth()

See also

setWidthUnit()

setWidthUnit(self, unit: QgsUnitTypes.RenderUnit)

Sets the units for the image’s width.

Parameters:unit – units for width

See also

widthUnit()

See also

setWidth()

startRender(self, context: QgsSymbolRenderContext)
stopRender(self, context: QgsSymbolRenderContext)
subSymbol(self) → QgsSymbol
width(self) → float

Returns the width used for scaling the image used in the fill. The image’s height is scaled to maintain the image’s aspect ratio.

Returns:width used for scaling the image

See also

setWidth()

See also

widthUnit()

widthMapUnitScale(self) → QgsMapUnitScale

Returns the map unit scale for the image’s width.

Returns:map unit scale for width

See also

width()

See also

widthUnit()

widthUnit(self) → QgsUnitTypes.RenderUnit

Returns the units for the image’s width.

Returns:units for width

See also

setWidthUnit()

See also

width()