Class: QgsLayerItem

class qgis.core.QgsLayerItem

Bases: QgsDataItem

Item that represents a layer that can be opened with one of the providers

QgsLayerItem(parent: QgsDataItem, name: str, path: str, uri: str, layerType: Qgis.BrowserLayerType, providerKey: str) Constructor for QgsLayerItem.

Enums

LayerType

alias of BrowserLayerType

Methods

childEvent

comments

Returns comments of the layer

connectNotify

customEvent

databaseConnection

rtype:

QgsAbstractDatabaseProviderConnection

deferredDelete

The item is scheduled to be deleted.

deleteLayer

Delete this layer item Use QgsDataItemGuiProvider.deleteLayer instead

disconnectNotify

equal

param other:

hasDragEnabled

rtype:

bool

iconDefault

rtype:

QIcon

iconForWkbType

Returns the icon for a vector layer whose geometry type is provided.

iconLine

rtype:

QIcon

iconMesh

Returns icon for mesh layer type

iconName

Returns the icon name of the given layerType

iconPoint

rtype:

QIcon

iconPointCloud

Returns icon for point cloud layer

iconPolygon

rtype:

QIcon

iconRaster

rtype:

QIcon

iconTable

rtype:

QIcon

iconVectorTile

Returns icon for vector tile layer

isSignalConnected

layerName

rtype:

str

layerTypeAsString

Returns the string representation of the given layerType

mapLayerType

Returns QgsMapLayerType

mimeUris

rtype:

List[QgsMimeDataUtils.Uri]

populate

providerKey

Returns provider key

receivers

refresh

Refresh the items from a specified list of child items.

sender

senderSignalIndex

supportedCrs

Returns the supported CRS

supportedFormats

Returns the supported formats

timerEvent

typeFromMapLayer

Returns the layer item type corresponding to a QgsMapLayer layer.

updateIcon

Will request a repaint of this icon.

uri

Returns layer uri or empty string if layer cannot be created

LayerType

alias of BrowserLayerType

childEvent(self, QChildEvent)
comments(self) str

Returns comments of the layer

New in version 2.12.

Return type:

str

connectNotify(self, QMetaMethod)
customEvent(self, QEvent)
databaseConnection(self) QgsAbstractDatabaseProviderConnection
Return type:

QgsAbstractDatabaseProviderConnection

deferredDelete(self) bool

The item is scheduled to be deleted. E.g. if deleteLater() is called when item is in Populating state (createChildren() running in another thread), the deferredDelete() returns True and item will be deleted once Populating finished. Items with slow reateChildren() (for example network or database based) may check during createChildren() if deferredDelete() returns True and return from createChildren() immediately because result will be useless.

deleteLayer(self) bool

Delete this layer item Use QgsDataItemGuiProvider.deleteLayer instead

Deprecated since version QGIS: 3.10

Return type:

bool

disconnectNotify(self, QMetaMethod)
equal(self, other: QgsDataItem) bool
Parameters:

other (QgsDataItem) –

Return type:

bool

hasDragEnabled(self) bool
Return type:

bool

iconDefault() QIcon
Return type:

QIcon

iconForWkbType(type: QgsWkbTypes.Type) QIcon

Returns the icon for a vector layer whose geometry type is provided.

New in version 3.18.

Parameters:

type (QgsWkbTypes.Type) –

Return type:

QIcon

iconLine() QIcon
Return type:

QIcon

iconMesh() QIcon

Returns icon for mesh layer type

Return type:

QIcon

iconName(layerType: Qgis.BrowserLayerType) str

Returns the icon name of the given layerType

New in version 3.

Parameters:

layerType (Qgis.BrowserLayerType) –

Return type:

str

iconPoint() QIcon
Return type:

QIcon

iconPointCloud() QIcon

Returns icon for point cloud layer

Return type:

QIcon

iconPolygon() QIcon
Return type:

QIcon

iconRaster() QIcon
Return type:

QIcon

iconTable() QIcon
Return type:

QIcon

iconVectorTile() QIcon

Returns icon for vector tile layer

Return type:

QIcon

isSignalConnected(self, QMetaMethod) bool
layerName(self) str
Return type:

str

Returns:

the layer name

layerTypeAsString(layerType: Qgis.BrowserLayerType) str

Returns the string representation of the given layerType

New in version 3.

Parameters:

layerType (Qgis.BrowserLayerType) –

Return type:

str

mapLayerType(self) QgsMapLayerType

Returns QgsMapLayerType

Return type:

QgsMapLayerType

mimeUris(self) List[QgsMimeDataUtils.Uri]
Return type:

List[QgsMimeDataUtils.Uri]

populate(self, children: Iterable[QgsDataItem])
populate(self, foreground: bool = False) None
providerKey(self) str

Returns provider key

Return type:

str

receivers(self, PYQT_SIGNAL) int
refresh(self, children: Iterable[QgsDataItem])

Refresh the items from a specified list of child items.

refresh(self)

sender(self) QObject
senderSignalIndex(self) int
supportedCrs(self) List[str]

Returns the supported CRS

New in version 2.8.

Return type:

List[str]

supportedFormats(self) List[str]

Returns the supported formats

New in version 2.8.

Return type:

List[str]

timerEvent(self, QTimerEvent)
typeFromMapLayer(layer: QgsMapLayer) Qgis.BrowserLayerType

Returns the layer item type corresponding to a QgsMapLayer layer.

New in version 3.6.

Parameters:

layer (QgsMapLayer) –

Return type:

Qgis.BrowserLayerType

updateIcon(self)

Will request a repaint of this icon.

New in version 3.0.

uri(self) str

Returns layer uri or empty string if layer cannot be created

Return type:

str