Subgroup: Raster

Class: QgsRasterTransparency

class qgis.core.QgsRasterTransparency

Bases: sip.wrapper

Constructor for QgsRasterTransparency.

QgsRasterTransparency(QgsRasterTransparency)

Defines the list of pixel values to be considered as transparent or semi transparent when rendering rasters.

Methods

alphaValue Returns the transparency value for a single value Pixel
initializeTransparentPixelList Reset to the transparency list to a single value
isEmpty True if there are no entries in the pixel lists except the nodata value
readXml Reads the transparency information from an XML document.
setTransparentSingleValuePixelList Mutator for transparentSingleValuePixelList
setTransparentThreeValuePixelList Mutator for transparentThreeValuePixelList
transparentSingleValuePixelList Accessor for transparentSingleValuePixelList
transparentThreeValuePixelList Accessor for transparentThreeValuePixelList
writeXml Writes the transparency information to an XML document.

Signals

Attributes

class TransparentSingleValuePixel

Bases: sip.wrapper

QgsRasterTransparency.TransparentSingleValuePixel(QgsRasterTransparency.TransparentSingleValuePixel)

max
min
percentTransparent
class TransparentThreeValuePixel

Bases: sip.wrapper

QgsRasterTransparency.TransparentThreeValuePixel(QgsRasterTransparency.TransparentThreeValuePixel)

blue
green
percentTransparent
red
alphaValue(self, a0: float, globalTransparency: int = 255) → int

Returns the transparency value for a single value Pixel

alphaValue(self, a0: float, a1: float, a2: float, globalTransparency: int = 255) -> int
Return the transparency value for a RGB Pixel
initializeTransparentPixelList(self, float)

Reset to the transparency list to a single value

initializeTransparentPixelList(self, float, float, float)
Reset to the transparency list to a single value
isEmpty(self) → bool

True if there are no entries in the pixel lists except the nodata value

readXml(self, elem: QDomElement)

Reads the transparency information from an XML document.

setTransparentSingleValuePixelList(self, newList: Iterable[QgsRasterTransparency.TransparentSingleValuePixel])

Mutator for transparentSingleValuePixelList

setTransparentThreeValuePixelList(self, newList: Iterable[QgsRasterTransparency.TransparentThreeValuePixel])

Mutator for transparentThreeValuePixelList

transparentSingleValuePixelList(self) → object

Accessor for transparentSingleValuePixelList

transparentThreeValuePixelList(self) → object

Accessor for transparentThreeValuePixelList

writeXml(self, doc: QDomDocument, parentElem: QDomElement)

Writes the transparency information to an XML document.