Class: QgsRasterIdentifyResult

Raster identify results container.

class qgis.core.QgsRasterIdentifyResult[source]

Bases: object

__init__()
__init__(format: Qgis.RasterIdentifyFormat, results: Dict[int, Any])

Constructor. Creates valid result.

Parameters:
__init__(error: QgsError)

Constructor. Creates invalid result with error.

Parameters:

error (QgsError) – the error

__init__(a0: QgsRasterIdentifyResult)
Parameters:

a0 (QgsRasterIdentifyResult)

error(self) QgsError[source]

Returns the last error

Return type:

QgsError

format(self) Qgis.RasterIdentifyFormat[source]

Returns the results format.

Return type:

Qgis.RasterIdentifyFormat

isValid(self) bool[source]

Returns True if valid

Return type:

bool

params(self) Dict[str, Any]

Gets map of optional parameters

Return type:

Dict[str, Any]

results(self) Dict[int, Any]

Returns the identify results. Results are different for each format:

  • Qgis.RasterIdentifyFormat.Value: a map of values for each band, where keys are band numbers (from 1).

  • Qgis.RasterIdentifyFormat.Feature: a map of WMS sublayer keys and lists of QgsFeatureStore values.

  • Qgis.RasterIdentifyFormat.Html: a map of WMS sublayer keys and HTML strings.

Return type:

Dict[int, Any]

setError(self, error: QgsError)[source]

Sets the last error

Parameters:

error (QgsError)

setParams(self, params: Dict[str | None, Any])[source]

Sets map of optional parameters

Parameters:

params (Dict[Optional[str], Any])