Class: QgsSingleBandColorDataRenderer¶
- class qgis.core.QgsSingleBandColorDataRenderer¶
Bases:
QgsRasterRenderer
Raster renderer pipe for single band color.
Methods
- param bandNo:
QgsSingleBandColorDataRenderer
cannot be copied.- param elem:
- rtype:
Qgis.RasterRendererFlags
Fill in histogram defaults if not specified
Fill in statistics defaults if not specified
- rtype:
int
Returns the color for the renderer to use to represent nodata pixels.
- param input:
- param band:
- rtype:
List[int]
- param doc:
- block(self, bandNo: int, extent: QgsRectangle, width: int, height: int, feedback: QgsRasterBlockFeedback = None) QgsRasterBlock ¶
- Parameters:
bandNo (int) –
extent (QgsRectangle) –
width (int) –
height (int) –
feedback (
QgsRasterBlockFeedback
= None) –
- Return type:
- clone(self) QgsSingleBandColorDataRenderer ¶
QgsSingleBandColorDataRenderer
cannot be copied. Useclone()
instead.- Return type:
- create(elem: QDomElement, input: QgsRasterInterface) QgsRasterRenderer ¶
- Parameters:
elem (QDomElement) –
input (QgsRasterInterface) –
- Return type:
- flags(self) Qgis.RasterRendererFlags ¶
- Return type:
- initHistogram(self, histogram: QgsRasterHistogram, bandNo: int, binCount: int, minimum: object = Py_None, maximum: object = Py_None, boundingBox: QgsRectangle = QgsRectangle(), sampleSize: int = 0, includeOutOfRange: bool = False)¶
Fill in histogram defaults if not specified
Note
the parameters are the same as in
histogram()
- initStatistics(self, statistics: QgsRasterBandStats, bandNo: int, stats: int, boundingBox: QgsRectangle = QgsRectangle(), binCount: int = 0)¶
Fill in statistics defaults if not specified
Deprecated since version Use:
Qgis
.RasterBandStatistic instead of int forstats
argumentinitStatistics(self, statistics:
QgsRasterBandStats
, bandNo: int, stats: Union[Qgis.RasterBandStatistics, Qgis.RasterBandStatistic] = Qgis.RasterBandStatistic.All, boundingBox:QgsRectangle
= QgsRectangle(), binCount: int = 0) Fill in statistics defaults if not specified
- inputBand(self) int ¶
- Return type:
int
- renderColorForNodataPixel(self) int ¶
Returns the color for the renderer to use to represent nodata pixels.
Subclasses should use this rather then
nodataColor()
to determine the color to use for nodata pixels during an actual rendering operation.New in version 3.10.
- setInput(self, input: QgsRasterInterface) bool ¶
- Parameters:
input (QgsRasterInterface) –
- Return type:
bool
- setInputBand(self, band: int) bool ¶
- Parameters:
band (int) –
- Return type:
bool
- usesBands(self) List[int] ¶
- Return type:
List[int]
- writeXml(self, doc: QDomDocument, parentElem: QDomElement)¶
- Parameters:
doc (QDomDocument) –
parentElem (QDomElement) –