Class: QgsMapLayer ¶

See also

setScaleBasedVisibility()

See also

See also

isInScaleRange()

htmlMetadata(self) → str¶

Obtain a formatted HTML string containing assorted metadata for this layer.

Return type:: str

id(self) → str¶

Returns the layer’s unique ID, which is used to access this layer from QgsProject.

See also

setId()

See also

idChanged()

Return type:: str

idChanged¶

pyqtSignal(*types, name: str = …, revision: int = …, arguments: Sequence = …) -> PYQT_SIGNAL

types is normally a sequence of individual types. Each type is either a type object or a string that is the name of a C++ type. Alternatively each type could itself be a sequence of types each describing a different overloaded signal. name is the optional C++ name of the signal. If it is not specified then the name of the class attribute that is bound to the signal is used. revision is the optional revision of the signal that is exported to QML. If it is not specified then 0 is used. arguments is the optional sequence of the names of the signal’s arguments.

Parameters:

name (str = ...)
revision (int = ...)
arguments (Sequence = ...)

Return type:

PYQT_SIGNAL

importNamedMetadata(self, document: QDomDocument, errorMessage: str | None) → bool¶

Import the metadata of this layer from a QDomDocument

Parameters:

document (QDomDocument) – source QDomDocument
errorMessage (Optional[str]) – this QString will be initialized on error

Return type:

bool

Returns:

True on success

importNamedStyle(self, doc: QDomDocument, categories: QgsMapLayer.StyleCategories | QgsMapLayer.StyleCategory = QgsMapLayer.AllStyleCategories)¶

Import the properties of this layer from a QDomDocument

Parameters:

doc (QDomDocument) – source QDomDocument
errorMsg – this QString will be initialized on error during the execution of readSymbology
categories (Union[QgsMapLayer.StyleCategories) – the style categories to import

Returns:

True on success

invalidateWgs84Extent(self)¶: Invalidates the WGS84 extent. If FlagTrustLayerMetadata is enabled, the extent is not invalidated because we want to trust metadata whatever happens.

Added in version 3.20.

isEditable(self) → bool¶

Returns True if the layer can be edited.

Return type:: bool

isInScaleRange(self, scale: float) → bool¶

Tests whether the layer should be visible at the specified scale. The scale value indicates the scale denominator, e.g. 1000.0 for a 1:1000 map.

Return type:: bool
Returns:: True if the layer is visible at the given scale.

See also

See also

See also

Parameters:: scale (float)

isModified(self) → bool¶

Returns True if the layer has been modified since last commit/save.

Note

default implementation returns False.

Added in version 3.22.

Return type:: bool

isRefreshOnNotifyEnabled(self) → bool¶

Returns True if the refresh on provider nofification is enabled

Return type:: bool

isSignalConnected(self, signal: QMetaMethod) → bool¶

isSpatial(self) → bool¶

Returns True if the layer is considered a spatial layer, ie it has some form of geometry associated with it.

Return type:: bool

isTemporary(self) → bool¶

Returns True if the layer is considered a temporary layer.

These include memory-only layers such as those created by the “memory” data provider, layers stored inside a local temporary folder (such as the “/tmp” folder on Linux) or layer with temporary data (as temporary mesh layer dataset)

Added in version 3.10.1.

Return type:: bool

isValid(self) → bool¶

Returns the status of the layer. An invalid layer is one which has a bad datasource or other problem. Child classes set this flag when initialized.

Return type:: bool
Returns:: True if the layer is valid and can be accessed

isValidChanged¶

pyqtSignal(*types, name: str = …, revision: int = …, arguments: Sequence = …) -> PYQT_SIGNAL

types is normally a sequence of individual types. Each type is either a type object or a string that is the name of a C++ type. Alternatively each type could itself be a sequence of types each describing a different overloaded signal. name is the optional C++ name of the signal. If it is not specified then the name of the class attribute that is bound to the signal is used. revision is the optional revision of the signal that is exported to QML. If it is not specified then 0 is used. arguments is the optional sequence of the names of the signal’s arguments.

Parameters:

name (str = ...)
revision (int = ...)
arguments (Sequence = ...)

Return type:

PYQT_SIGNAL

keywordList(self) → str¶

Returns the keyword list of the layer used by QGIS Server in GetCapabilities request.

Deprecated since version QGIS: 3.38 use serverProperties()->:py:func:~QgsMapLayer.keywordList instead.

Return type:: str

layerModified¶

pyqtSignal(*types, name: str = …, revision: int = …, arguments: Sequence = …) -> PYQT_SIGNAL

types is normally a sequence of individual types. Each type is either a type object or a string that is the name of a C++ type. Alternatively each type could itself be a sequence of types each describing a different overloaded signal. name is the optional C++ name of the signal. If it is not specified then the name of the class attribute that is bound to the signal is used. revision is the optional revision of the signal that is exported to QML. If it is not specified then 0 is used. arguments is the optional sequence of the names of the signal’s arguments.

Parameters:

name (str = ...)
revision (int = ...)
arguments (Sequence = ...)

Return type:

PYQT_SIGNAL

legend(self) → QgsMapLayerLegend | None¶

Can be None.

Return type:: Optional[QgsMapLayerLegend]

legendChanged¶

pyqtSignal(*types, name: str = …, revision: int = …, arguments: Sequence = …) -> PYQT_SIGNAL

types is normally a sequence of individual types. Each type is either a type object or a string that is the name of a C++ type. Alternatively each type could itself be a sequence of types each describing a different overloaded signal. name is the optional C++ name of the signal. If it is not specified then the name of the class attribute that is bound to the signal is used. revision is the optional revision of the signal that is exported to QML. If it is not specified then 0 is used. arguments is the optional sequence of the names of the signal’s arguments.

Parameters:

name (str = ...)
revision (int = ...)
arguments (Sequence = ...)

Return type:

PYQT_SIGNAL

legendPlaceholderImage(self) → str¶

Returns path to the placeholder image or an empty string if a generated legend is shown

Return type:: str
Returns:: placeholder image path

Added in version 3.22.

legendUrl(self) → str¶

Returns the URL for the layer’s legend.

Return type:: str

legendUrlFormat(self) → str¶

Returns the format for a URL based layer legend.

Return type:: str

listStylesInDatabase(self)¶

Lists all the style in db split into related to the layer and not related to

Parameters:

ids – the list in which will be stored the style db ids
names – the list in which will be stored the style names

Returns:

the number of styles related to current layer (-1 on not implemented)
descriptions: the list in which will be stored the style descriptions
msgError: will be set to a descriptive error message if any occurs

Note

Since QGIS 3.2 Styles related to the layer are ordered with the default style first then by update time for Postgres, MySQL and Spatialite.

loadDefaultMetadata(self)¶

Retrieve the default metadata for this layer if one exists (either as a .qmd file on disk or as a record in the users metadata table in their personal qgis.db)

Parameters:: resultFlag – a reference to a flag that will be set to False if we did not manage to load the default metadata.
Returns:: a QString with any status messages

loadDefaultStyle(self)¶

Retrieve the default style for this layer if one exists (either as a .qml file on disk or as a record in the users style table in their personal qgis.db)

Returns:

a QString with any status messages
resultFlag: a reference to a flag that will be set to False if we did not manage to load the default style.

See also

loadNamedMetadata(self, uri: str | None)¶

Retrieve a named metadata for this layer if one exists (either as a .qmd file on disk or as a record in the users style table in their personal qgis.db)

Parameters:

uri (Optional[str]) -> (str) –

the file name or other URI for the

metadata file. First an attempt will be made to see if this is a file and load that, if that fails the qgis.db metadata table will be consulted to see if there is a metadata who’s key matches the URI.

Returns:

a QString with any status messages
resultFlag: a reference to a flag that will be set to False if we did not manage to load the default metadata.

loadNamedMetadataFromDatabase(self, db: str | None, uri: str | None, qmd: str | None) → bool¶

Retrieve a named metadata for this layer from a sqlite database.

Parameters:

db (Optional[str]) – path to sqlite database
uri (Optional[str]) – uri for table
qmd (Optional[str]) – will be set to QMD xml metadata content from database

Return type:

bool

Returns:

True if style was successfully loaded

loadNamedStyle(self, theURI: str | None, loadFromLocalDb: bool, categories: QgsMapLayer.StyleCategories | QgsMapLayer.StyleCategory = QgsMapLayer.AllStyleCategories, flags: Qgis.LoadStyleFlags | Qgis.LoadStyleFlag = Qgis.LoadStyleFlags())¶

Loads a named style from file/local db/datasource db

Parameters:

theURI (Optional[str]) – the URI of the style or the URI of the layer
resultFlag – will be set to True if a named style is correctly loaded
loadFromLocalDb (bool) – if True forces to load from local db instead of datasource one
categories (Union[QgsMapLayer.StyleCategories) – the style categories to be loaded.
flags (Union[Qgis.LoadStyleFlags) – flags controlling how the style should be loaded (since QGIS 3.38)

loadNamedStyle(self, uri: Optional[str], categories: Union[QgsMapLayer.StyleCategories, QgsMapLayer.StyleCategory] = QgsMapLayer.AllStyleCategories, flags: Union[Qgis.LoadStyleFlags, Qgis.LoadStyleFlag] = Qgis.LoadStyleFlags()) -> (str, bool) Retrieve a named style for this layer if one exists (either as a .qml file on disk or as a record in the users style table in their personal qgis.db)

Parameters:

uri –
- the file name or other URI for the
style file. First an attempt will be made to see if this is a file and load that, if that fails the qgis.db styles table will be consulted to see if there is a style who’s key matches the URI.
categories – the style categories to be loaded.
flags – flags controlling how the style should be loaded (since QGIS 3.38)

Returns:

a QString with any status messages
resultFlag: a reference to a flag that will be set to False if we did not manage to load the default style.

See also

loadDefaultStyle()

loadNamedStyleFromDatabase(self, db: str | None, uri: str | None)¶

Retrieve a named style for this layer from a sqlite database.

Parameters:

db (Optional[str]) – path to sqlite database
uri (Optional[str]) -> (bool) – uri for table

Returns:

True if style was successfully loaded
qml: will be set to QML style content from database

loadSldStyle(self, uri: str | None)¶

Attempts to style the layer using the formatting from an SLD type file.

Parameters:

uri (Optional[str]) -> (str) – uri of source SLD file
resultFlag – a reference to a flag that will be set to False if the SLD file could not be loaded

Returns:

a string with any status or error messages

See also

saveSldStyle()

mapTipTemplate(self) → str¶

The mapTip is a pretty, html representation for feature information.

It may also contain embedded expressions.

Added in version 3.30.

Return type:: str

mapTipTemplateChanged¶

pyqtSignal(*types, name: str = …, revision: int = …, arguments: Sequence = …) -> PYQT_SIGNAL

types is normally a sequence of individual types. Each type is either a type object or a string that is the name of a C++ type. Alternatively each type could itself be a sequence of types each describing a different overloaded signal. name is the optional C++ name of the signal. If it is not specified then the name of the class attribute that is bound to the signal is used. revision is the optional revision of the signal that is exported to QML. If it is not specified then 0 is used. arguments is the optional sequence of the names of the signal’s arguments.

Parameters:

name (str = ...)
revision (int = ...)
arguments (Sequence = ...)

Return type:

PYQT_SIGNAL

mapTipsEnabled(self) → bool¶

Returns true if map tips are enabled for this layer

Added in version 3.32.

Return type:: bool

mapTipsEnabledChanged¶

pyqtSignal(*types, name: str = …, revision: int = …, arguments: Sequence = …) -> PYQT_SIGNAL

types is normally a sequence of individual types. Each type is either a type object or a string that is the name of a C++ type. Alternatively each type could itself be a sequence of types each describing a different overloaded signal. name is the optional C++ name of the signal. If it is not specified then the name of the class attribute that is bound to the signal is used. revision is the optional revision of the signal that is exported to QML. If it is not specified then 0 is used. arguments is the optional sequence of the names of the signal’s arguments.

Parameters:

name (str = ...)
revision (int = ...)
arguments (Sequence = ...)

Return type:

PYQT_SIGNAL

maximumScale(self) → float¶

Returns the maximum map scale (i.e. most “zoomed in” scale) at which the layer will be visible. The scale value indicates the scale denominator, e.g. 1000.0 for a 1:1000 map. A scale of 0 indicates no maximum scale visibility.

Note

Scale based visibility is only used if setScaleBasedVisibility() is set to True.

See also

setMaximumScale()

See also

See also

See also

isInScaleRange()

Return type:: float

metadata(self) → QgsLayerMetadata¶

Returns a reference to the layer’s metadata store.

See also

setMetadata()

See also

metadataChanged()

Return type:: QgsLayerMetadata

metadataChanged¶

pyqtSignal(*types, name: str = …, revision: int = …, arguments: Sequence = …) -> PYQT_SIGNAL

types is normally a sequence of individual types. Each type is either a type object or a string that is the name of a C++ type. Alternatively each type could itself be a sequence of types each describing a different overloaded signal. name is the optional C++ name of the signal. If it is not specified then the name of the class attribute that is bound to the signal is used. revision is the optional revision of the signal that is exported to QML. If it is not specified then 0 is used. arguments is the optional sequence of the names of the signal’s arguments.

Parameters:

name (str = ...)
revision (int = ...)
arguments (Sequence = ...)

Return type:

PYQT_SIGNAL

metadataUri(self) → str¶

Retrieve the metadata URI for this layer (either as a .qmd file on disk or as a record in the users style table in their personal qgis.db)

Return type:: str
Returns:: a QString with the metadata file name

metadataUrl(self) → str¶

Returns the metadata URL of the layer used by QGIS Server in GetCapabilities request. MetadataUrl is a a link to the detailed, standardized metadata about the data. Since QGIS 3.22, it returns the first metadata URL link.

Return type:: str
Returns:: the layer metadata URL

See also

Deprecated since version QGIS: 3.22

metadataUrlFormat(self) → str¶

Returns the metadata format of the layer used by QGIS Server in GetCapabilities request. MetadataUrlType indicates how the metadata is structured. Since QGIS 3.22, it returns the first metadata URL format.

Return type:: str
Returns:: the layer metadata format

See also

Deprecated since version QGIS: 3.22

metadataUrlType(self) → str¶

Returns the metadata type of the layer used by QGIS Server in GetCapabilities request. MetadataUrlType indicates the standard to which the metadata complies. Since QGIS 3.22, it returns the first metadata URL type.

Return type:: str
Returns:: the layer metadata type

See also

Deprecated since version QGIS: 3.22

minimumScale(self) → float¶

Returns the minimum map scale (i.e. most “zoomed out” scale) at which the layer will be visible. The scale value indicates the scale denominator, e.g. 1000.0 for a 1:1000 map. A scale of 0 indicates no minimum scale visibility.

Note

Scale based visibility is only used if setScaleBasedVisibility() is set to True.

See also

setMinimumScale()

See also

See also

QgsDataProvider.ReadFlags

See also

isInScaleRange()

Return type:: float

name(self) → str¶

Returns the display name of the layer.

See also

setName()

Return type:: str

nameChanged¶

pyqtSignal(*types, name: str = …, revision: int = …, arguments: Sequence = …) -> PYQT_SIGNAL

types is normally a sequence of individual types. Each type is either a type object or a string that is the name of a C++ type. Alternatively each type could itself be a sequence of types each describing a different overloaded signal. name is the optional C++ name of the signal. If it is not specified then the name of the class attribute that is bound to the signal is used. revision is the optional revision of the signal that is exported to QML. If it is not specified then 0 is used. arguments is the optional sequence of the names of the signal’s arguments.

Parameters:

name (str = ...)
revision (int = ...)
arguments (Sequence = ...)

Return type:

PYQT_SIGNAL

opacity(self) → float¶

Returns the opacity for the layer, where opacity is a value between 0 (totally transparent) and 1.0 (fully opaque).

See also

setOpacity()

See also

opacityChanged()

Note

Prior to QGIS 3.18, this method was available for vector layers only

Added in version 3.18.

Return type:: float

opacityChanged¶

pyqtSignal(*types, name: str = …, revision: int = …, arguments: Sequence = …) -> PYQT_SIGNAL

types is normally a sequence of individual types. Each type is either a type object or a string that is the name of a C++ type. Alternatively each type could itself be a sequence of types each describing a different overloaded signal. name is the optional C++ name of the signal. If it is not specified then the name of the class attribute that is bound to the signal is used. revision is the optional revision of the signal that is exported to QML. If it is not specified then 0 is used. arguments is the optional sequence of the names of the signal’s arguments.

Parameters:

name (str = ...)
revision (int = ...)
arguments (Sequence = ...)

Return type:

PYQT_SIGNAL

originalXmlProperties(self) → str¶

Returns the XML properties of the original layer as they were when the layer was first read from the project file. In case of new layers this is normally empty.

The storage format for the XML is qlr

Added in version 3.6.

Return type:: str

project(self) → QgsProject | None¶

Returns the parent project if this map layer is added to a project. Otherwise returns None

Added in version 3.18.

Return type:: Optional[QgsProject]

properties(self) → Qgis.MapLayerProperties¶

Returns the map layer properties of this layer.

Note

properties() differ from flags() in that flags() are user settable, and reflect options that users can enable for map layers. In contrast properties() are reflections of inherent capabilities for the layer, which cannot be directly changed by users.

Added in version 3.22.

Return type:: Qgis.MapLayerProperties

providerReadFlags(layerNode: QDomNode, layerReadFlags: QgsMapLayer.ReadFlags | QgsMapLayer.ReadFlag) → QgsDataProvider.ReadFlags¶

Returns provider read flag deduced from layer read flags layerReadFlags and a dom node layerNode that describes a layer (corresponding to ``maplayer’’ tag in a DOM document project file read by QgsProject). This static method is used when loading a project.

Added in version 3.32.

Parameters:

layerNode (QDomNode)
layerReadFlags (Union[QgsMapLayer.ReadFlags)

Return type:

providerType(self) → str¶

Returns the provider type (provider key) for this layer

Return type:: str

publicSource(self, hidePassword: bool = False) → str¶

Gets a version of the internal layer definition that has sensitive bits removed (for example, the password). This function should be used when displaying the source name for general viewing.

Parameters:: hidePassword (bool = False) – False, if the password should be removed or replaced by an arbitrary string, since QGIS 3.34

See also

source()

Return type:: str

readCommonStyle(self, layerElement: QDomElement, context: QgsReadWriteContext, categories: QgsMapLayer.StyleCategories | QgsMapLayer.StyleCategory = QgsMapLayer.AllStyleCategories)¶

Read style data common to all layer types

Parameters:

layerElement (QDomElement)
context (QgsReadWriteContext)
categories (Union[QgsMapLayer.StyleCategories)

readCustomProperties(self, layerNode: QDomNode, keyStartsWith: str | None = '')¶

Read custom properties from project file.

Parameters:

layerNode (QDomNode) – note to read from
keyStartsWith (Optional[str] = '') – reads only properties starting with the specified string (or all if the string is empty)

readLayerXml(self, layerElement: QDomElement, context: QgsReadWriteContext, flags: QgsMapLayer.ReadFlags | QgsMapLayer.ReadFlag = QgsMapLayer.ReadFlags(), preloadedProvider: QgsDataProvider | None = None) → bool¶

Sets state from DOM document

Parameters:

layerElement (QDomElement) – The DOM element corresponding to ``maplayer’’ tag
context (QgsReadWriteContext) – writing context (e.g. for conversion between relative and absolute paths)
flags (Union[QgsMapLayer.ReadFlags) – optional argument which can be used to control layer reading behavior.
preloadedProvider (Optional[QgsDataProvider] = None) – optional preloaded data provider that will be used as data provider for this layer, takes ownership (since QGIS 3.32)

note

The DOM node corresponds to a DOM document project file XML element read by QgsProject.

This, in turn, calls readXml() (and then readSymbology()), which is overridable by sub-classes so that they can read their own specific state from the given DOM node.

Invoked by QgsProject.read().

Return type:: bool
Returns:: True if successful

readOnly(self) → bool¶

Returns if this layer is read only.

Return type:: bool

readSld(self, node: QDomNode, errorMessage: str | None) → bool¶

Parameters:

node (QDomNode)
errorMessage (Optional[str])

Return type:

bool

readStyle(self, node: QDomNode, errorMessage: str | None, context: QgsReadWriteContext, categories: QgsMapLayer.StyleCategories | QgsMapLayer.StyleCategory = QgsMapLayer.AllStyleCategories) → bool¶

Read the style for the current layer from the DOM node supplied.

Parameters:

node (QDomNode) – node that will contain the style definition for this layer.
errorMessage (Optional[str]) – reference to string that will be updated with any error messages
context (QgsReadWriteContext) – reading context (used for transform from relative to absolute paths)
categories (Union[QgsMapLayer.StyleCategories) – the style categories to be read

Return type:

bool

Returns:

True in case of success.

Note

To be implemented in subclasses. Default implementation does nothing and returns False.

readStyleManager(self, layerNode: QDomNode)¶

Read style manager’s configuration (if any). To be called by subclasses.

Parameters:: layerNode (QDomNode)

readSymbology(self, node: QDomNode, errorMessage: str | None, context: QgsReadWriteContext, categories: QgsMapLayer.StyleCategories | QgsMapLayer.StyleCategory = QgsMapLayer.AllStyleCategories) → bool¶

Read the symbology for the current layer from the DOM node supplied.

Parameters:

node (QDomNode) – node that will contain the symbology definition for this layer.
errorMessage (Optional[str]) – reference to string that will be updated with any error messages
context (QgsReadWriteContext) – reading context (used for transform from relative to absolute paths)
categories (Union[QgsMapLayer.StyleCategories) – the style categories to be read

Return type:

bool

Returns:

True in case of success.

readXml(self, layer_node: QDomNode, context: QgsReadWriteContext) → bool¶

Called by readLayerXML(), used by children to read state specific to them from project files.

Parameters:

layer_node (QDomNode)
context (QgsReadWriteContext)

Return type:

bool

recalculateExtents¶

pyqtSignal(*types, name: str = …, revision: int = …, arguments: Sequence = …) -> PYQT_SIGNAL

types is normally a sequence of individual types. Each type is either a type object or a string that is the name of a C++ type. Alternatively each type could itself be a sequence of types each describing a different overloaded signal. name is the optional C++ name of the signal. If it is not specified then the name of the class attribute that is bound to the signal is used. revision is the optional revision of the signal that is exported to QML. If it is not specified then 0 is used. arguments is the optional sequence of the names of the signal’s arguments.

Parameters:

name (str = ...)
revision (int = ...)
arguments (Sequence = ...)

Return type:

PYQT_SIGNAL

receivers(self, signal: PYQT_SIGNAL) → int¶

refreshOnNotifyMessage(self) → str¶

Returns the message that should be notified by the provider to triggerRepaint

Return type:: str

reload(self)¶: Synchronises with changes in the datasource

removeCustomProperty(self, key: str | None)¶

Remove a custom property from layer. Properties are stored in a map and saved in project file.

See also

setCustomProperty()

Parameters:: key (Optional[str])

renderer3D(self) → QgsAbstract3DRenderer | None¶

Returns 3D renderer associated with the layer. May be None.

Return type:: Optional[QgsAbstract3DRenderer]

renderer3DChanged¶

pyqtSignal(*types, name: str = …, revision: int = …, arguments: Sequence = …) -> PYQT_SIGNAL

types is normally a sequence of individual types. Each type is either a type object or a string that is the name of a C++ type. Alternatively each type could itself be a sequence of types each describing a different overloaded signal. name is the optional C++ name of the signal. If it is not specified then the name of the class attribute that is bound to the signal is used. revision is the optional revision of the signal that is exported to QML. If it is not specified then 0 is used. arguments is the optional sequence of the names of the signal’s arguments.

Parameters:

name (str = ...)
revision (int = ...)
arguments (Sequence = ...)

Return type:

PYQT_SIGNAL

rendererChanged¶

pyqtSignal(*types, name: str = …, revision: int = …, arguments: Sequence = …) -> PYQT_SIGNAL

types is normally a sequence of individual types. Each type is either a type object or a string that is the name of a C++ type. Alternatively each type could itself be a sequence of types each describing a different overloaded signal. name is the optional C++ name of the signal. If it is not specified then the name of the class attribute that is bound to the signal is used. revision is the optional revision of the signal that is exported to QML. If it is not specified then 0 is used. arguments is the optional sequence of the names of the signal’s arguments.

Parameters:

name (str = ...)
revision (int = ...)
arguments (Sequence = ...)

Return type:

PYQT_SIGNAL

repaintRequested¶

pyqtSignal(*types, name: str = …, revision: int = …, arguments: Sequence = …) -> PYQT_SIGNAL

types is normally a sequence of individual types. Each type is either a type object or a string that is the name of a C++ type. Alternatively each type could itself be a sequence of types each describing a different overloaded signal. name is the optional C++ name of the signal. If it is not specified then the name of the class attribute that is bound to the signal is used. revision is the optional revision of the signal that is exported to QML. If it is not specified then 0 is used. arguments is the optional sequence of the names of the signal’s arguments.

Parameters:

name (str = ...)
revision (int = ...)
arguments (Sequence = ...)

Return type:

PYQT_SIGNAL

request3DUpdate¶

pyqtSignal(*types, name: str = …, revision: int = …, arguments: Sequence = …) -> PYQT_SIGNAL

types is normally a sequence of individual types. Each type is either a type object or a string that is the name of a C++ type. Alternatively each type could itself be a sequence of types each describing a different overloaded signal. name is the optional C++ name of the signal. If it is not specified then the name of the class attribute that is bound to the signal is used. revision is the optional revision of the signal that is exported to QML. If it is not specified then 0 is used. arguments is the optional sequence of the names of the signal’s arguments.

Parameters:

name (str = ...)
revision (int = ...)
arguments (Sequence = ...)

Return type:

PYQT_SIGNAL

resolveReferences(self, project: QgsProject | None)¶

Resolve references to other layers (kept as layer IDs after reading XML) into layer objects.

Parameters:: project (Optional[QgsProject])

saveDefaultMetadata(self)¶

Save the current metadata of this layer as the default metadata (either as a .qmd file on disk or as a record in the users style table in their personal qgis.db)

Returns:

a QString with any status messages
resultFlag: a reference to a flag that will be set to False if we did not manage to save the default metadata.

saveDefaultStyle(self, categories: QgsMapLayer.StyleCategories | QgsMapLayer.StyleCategory)¶

Save the properties of this layer as the default style (either as a .qml file on disk or as a record in the users style table in their personal qgis.db)

Parameters:

categories (Union[QgsMapLayer.StyleCategories) – the style categories to be saved (since QGIS 3.26)

Returns:

a QString with any status messages
resultFlag: a reference to a flag that will be set to False if we did not manage to save the default style.

See also

See also

saveNamedStyle()

saveDefaultStyle(self) -> (str, bool) Save the properties of this layer as the default style (either as a .qml file on disk or as a record in the users style table in their personal qgis.db)

Returns:

a QString with any status messages
resultFlag: a reference to a flag that will be set to False if we did not manage to save the default style.

See also

hasAutoRefreshEnabled()

See also

saveNamedStyle()

Deprecated since version QGIS: 3.26

saveNamedMetadata(self, uri: str | None)¶

Save the current metadata of this layer as a named metadata (either as a .qmd file on disk or as a record in the users style table in their personal qgis.db)

Parameters:

uri (Optional[str]) -> (str) – the file name or other URI for the metadata file. First an attempt will be made to see if this is a file and save to that, if that fails the qgis.db metadata table will be used to create a metadata entry who’s key matches the URI.
resultFlag – a reference to a flag that will be set to False if we did not manage to save the default metadata.

Returns:

a QString with any status messages

saveNamedStyle(self, uri: str | None, categories: QgsMapLayer.StyleCategories | QgsMapLayer.StyleCategory = QgsMapLayer.AllStyleCategories)¶

Save the properties of this layer as a named style (either as a .qml file on disk or as a record in the users style table in their personal qgis.db)

Parameters:

uri (Optional[str]) – the file name or other URI for the style file. First an attempt will be made to see if this is a file and save to that, if that fails the qgis.db styles table will be used to create a style entry who’s key matches the URI.
categories (Union[QgsMapLayer.StyleCategories) – the style categories to be saved.

Returns:

a QString with any status messages
resultFlag: a reference to a flag that will be set to False if we did not manage to save the default style.

See also

saveDefaultStyle()

saveSldStyle(self, uri: str | None)¶

Saves the properties of this layer to an SLD format file.

Parameters:

uri (Optional[str]) -> (str) – uri of destination for exported SLD file.
resultFlag – a reference to a flag that will be set to False if the SLD file could not be generated

Returns:

a string with any status or error messages

See also

loadSldStyle()

See also

saveSldStyleV2()

saveSldStyleV2(self, exportContext: QgsSldExportContext)¶

Saves the properties of this layer to an SLD format file.

Parameters:

exportContext (QgsSldExportContext) -> (str) – SLD export context

Returns:

a string with any status or error messages
resultFlag: a reference to a flag that will be set to False if the SLD file could not be generated

See also

loadSldStyle()

Added in version 3.30.

saveStyleToDatabase(self, name: str | None, description: str | None, useAsDefault: bool, uiFileContent: str | None, categories: QgsMapLayer.StyleCategories | QgsMapLayer.StyleCategory = QgsMapLayer.AllStyleCategories) → str¶

Saves named and sld style of the layer to the style table in the db.

Parameters:

name (Optional[str]) – Style name
description (Optional[str]) – A description of the style
useAsDefault (bool) – Set to True if style should be used as the default style for the layer
uiFileContent (Optional[str])
msgError – will be set to a descriptive error message if any occurs
categories (Union[QgsMapLayer.StyleCategories) – the style categories to be saved.

Note

Prior to QGIS 3.24, this method would show a message box warning when a style with the same styleName already existed to confirm replacing the style with the user. Since 3.24, calling this method will ALWAYS overwrite any existing style with the same name. Use QgsProviderRegistry.styleExists() to test in advance if a style already exists and handle this appropriately in your client code.

Return type:: str

selectionProperties(self) → QgsMapLayerSelectionProperties | None¶

Returns the layer’s selection properties. This may be None, depending on the layer type.

Added in version 3.34.

Return type:: Optional[QgsMapLayerSelectionProperties]

sender(self) → QObject | None¶

senderSignalIndex(self) → int¶

serverProperties(self) → QgsMapLayerServerProperties | None¶

Returns QGIS Server Properties for the map layer

Added in version 3.22.

Return type:: Optional[QgsMapLayerServerProperties]

setAbstract(self, abstract: str | None)¶

Sets the abstract of the layer used by QGIS Server in GetCapabilities request.

Deprecated since version QGIS: 3.38 use serverProperties()->:py:func:~QgsMapLayer.setAbstract instead.

Parameters:: abstract (Optional[str])

setAttribution(self, attrib: str | None)¶

Sets the attribution of the layerused by QGIS Server in GetCapabilities request.

Deprecated since version QGIS: 3.38 use serverProperties()->:py:func:~QgsMapLayer.setAttribution instead.

Parameters:: attrib (Optional[str])

setAttributionUrl(self, attribUrl: str | None)¶

Sets the attribution URL of the layer used by QGIS Server in GetCapabilities request.

Deprecated since version QGIS: 3.38 use serverProperties()->:py:func:~QgsMapLayer.setAttributionUrl instead.

Parameters:: attribUrl (Optional[str])

setAutoRefreshEnabled(self, enabled: bool)¶

Sets whether auto refresh is enabled for the layer.

See also

See also

setAutoRefreshInterval()

Deprecated since version Use: setAutoRefreshMode() instead.

Parameters:: enabled (bool)

setAutoRefreshInterval(self, interval: int)¶

Sets the auto refresh interval (in milliseconds) for the layer. This will cause the layer to be automatically redrawn on a matching interval. Note that auto refresh must be enabled by calling setAutoRefreshMode().

Note that auto refresh triggers deferred repaints of the layer. Any map canvas must be refreshed separately in order to view the refreshed layer.

See also

autoRefreshInterval()

See also

setAutoRefreshEnabled()

Parameters:: interval (int)

setAutoRefreshMode(self, mode: Qgis.AutoRefreshMode)¶

Sets the automatic refresh mode for the layer.

See also

autoRefreshMode()

See also

setAutoRefreshInterval()

Added in version 3.34.

Parameters:: mode (Qgis.AutoRefreshMode)

setBlendMode(self, blendMode: QPainter.CompositionMode)¶

Set the blending mode used for rendering a layer.

Parameters:: blendMode (QPainter.CompositionMode) – new blending mode

See also

blendMode()

setCrs(self, srs: QgsCoordinateReferenceSystem, emitSignal: bool = True)¶

Sets layer’s spatial reference system.

If emitSignal is True, changing the CRS will trigger a crsChanged() signal. Additionally, if crs is a compound CRS, then the verticalCrsChanged() signal will also be emitted.

See also

crs()

See also

crsChanged()

See also

setVerticalCrs()

Parameters:

srs (QgsCoordinateReferenceSystem)
emitSignal (bool = True)

setCustomProperties(self, properties: QgsObjectCustomProperties)¶

Set custom properties for layer. Current properties are dropped.

Parameters:: properties (QgsObjectCustomProperties)

setCustomProperty(self, key: str | None, value: Any)¶

Set a custom property for layer. Properties are stored in a map and saved in project file.

See also

customProperty()

See also

removeCustomProperty()

Parameters:

key (Optional[str])
value (Any)

setDataSource(self, dataSource: str | None, baseName: str | None, provider: str | None, loadDefaultStyleFlag: bool = False)¶

Updates the data source of the layer.

The dataSource argument must specify the new data source string for the layer. The format varies depending on the specified data provider in use. See QgsDataSourceUri and the documentation for the various QgsMapLayer subclasses for further details on data source strings.

The baseName argument specifies the user-visible name to use for the layer. (See name() or setName()).

The provider argument is used to specify the unique key of the data provider to use for the layer. This must match one of the values returned by QgsProviderRegistry.instance()->:py:func:~QgsMapLayer.providerList. (See providerType()).

If loadDefaultStyleFlag is set to True then the layer’s existing style will be reset to the default for the data source.

Note

If loadDefaultStyleFlag is False then the layer’s renderer and legend will be preserved only if the geometry type of the new data source matches the current geometry type of the layer.

After setting a new data source callers can test isValid() to determine whether the new source and provider are valid and ready for use. If setting the new data source fails and the layer returns False to isValid(), then descriptive errors relating to setting the data source can be retrieved by calling error().

This method was defined in QgsVectorLayer since 2.10 and was marked as deprecated since 3.2

See also

dataSourceChanged()

Added in version 3.20.

setDataSource(self, dataSource: Optional[str], baseName: Optional[str], provider: Optional[str], options: QgsDataProvider.ProviderOptions, loadDefaultStyleFlag: bool = False) Updates the data source of the layer.

The dataSource argument must specify the new data source string for the layer. The format varies depending on the specified data provider in use. See QgsDataSourceUri and the documentation for the various QgsMapLayer subclasses for further details on data source strings.

The baseName argument specifies the user-visible name to use for the layer. (See name() or setName()).

The provider argument is used to specify the unique key of the data provider to use for the layer. This must match one of the values returned by QgsProviderRegistry.instance()->:py:func:~QgsMapLayer.providerList. (See providerType()).

The options argument can be used to pass additional layer properties to the new data provider.

If loadDefaultStyleFlag is set to True then the layer’s existing style will be reset to the default for the data source.

Note

If loadDefaultStyleFlag is False then the layer’s renderer and legend will be preserved only if the geometry type of the new data source matches the current geometry type of the layer.

After setting a new data source callers can test isValid() to determine whether the new source and provider are valid and ready for use. If setting the new data source fails and the layer returns False to isValid(), then descriptive errors relating to setting the data source can be retrieved by calling error().

See also

dataSourceChanged()

Added in version 3.6.

setDataSource(self, dataSource: Optional[str], baseName: Optional[str], provider: Optional[str], options: QgsDataProvider.ProviderOptions, flags: Union[QgsDataProvider.ReadFlags, QgsDataProvider.ReadFlag]) Updates the data source of the layer.

The dataSource argument must specify the new data source string for the layer. The format varies depending on the specified data provider in use. See QgsDataSourceUri and the documentation for the various QgsMapLayer subclasses for further details on data source strings.

The baseName argument specifies the user-visible name to use for the layer. (See name() or setName()).

The provider argument is used to specify the unique key of the data provider to use for the layer. This must match one of the values returned by QgsProviderRegistry.instance()->:py:func:~QgsMapLayer.providerList. (See providerType()).

The options argument can be used to pass additional layer properties to the new data provider.

The flags argument specifies provider read flags which control the data provider construction, such as QgsDataProvider.ReadFlag.FlagTrustDataSource, QgsDataProvider.ReadFlag.FlagLoadDefaultStyle, etc.

Note

The layer’s renderer and legend will be preserved only if the geometry type of the new data source matches the current geometry type of the layer.

After setting a new data source callers can test isValid() to determine whether the new source and provider are valid and ready for use. If setting the new data source fails and the layer returns False to isValid(), then descriptive errors relating to setting the data source can be retrieved by calling error().

See also

dataSourceChanged()

Added in version 3.20.

Parameters:

dataSource (Optional[str])
baseName (Optional[str])
provider (Optional[str])
loadDefaultStyleFlag (bool = False)

setDataUrl(self, dataUrl: str | None)¶

Sets the DataUrl of the layer used by QGIS Server in GetCapabilities request.

Deprecated since version QGIS: 3.38 use serverProperties()->:py:func:~QgsMapLayer.setDataUrl instead.

Parameters:: dataUrl (Optional[str])

setDataUrlFormat(self, dataUrlFormat: str | None)¶

Sets the DataUrl format of the layer used by QGIS Server in GetCapabilities request.

Deprecated since version QGIS: 3.38 use serverProperties()->:py:func:~QgsMapLayer.setDataUrlFormat instead.

Parameters:: dataUrlFormat (Optional[str])

setDependencies(self, layers: Iterable[QgsMapLayerDependency]) → bool¶

Sets the list of dependencies.

See also

dependencies()

Parameters:: layers (Iterable[QgsMapLayerDependency]) – set of QgsMapLayerDependency. Only user-defined dependencies will be added
Return type:: bool
Returns:: False if a dependency cycle has been detected

setError(self, error: QgsError)¶

Sets error message

Parameters:: error (QgsError)

setExtent(self, rect: QgsRectangle)¶

Sets the extent

Parameters:: rect (QgsRectangle)

setExtent3D(self, box: QgsBox3D)¶

Sets the extent

Added in version 3.36.

Parameters:: box (QgsBox3D)

setFlags(self, flags: QgsMapLayer.LayerFlags | QgsMapLayer.LayerFlag)¶

Returns the flags for this layer.

Note

Flags are options specified by the user used for the UI but are not preventing any API call. For instance, even if the Removable flag is not set, the layer can still be removed with the API but the action will not be listed in the legend menu.

See also

properties()

Added in version 3.4.

Parameters:: flags (Union[QgsMapLayer.LayerFlags)

setId(self, id: str | None) → bool¶

Sets the layer’s id.

Returns True if the layer ID was successfully changed, or False if it could not be changed (e.g. because the layer is owned by a QgsProject or QgsMapLayerStore).

Warning

It is the caller’s responsibility to ensure that the layer ID is unique in the desired context. Generally this method should not be called, and the auto generated ID should be used instead.

Warning

This method should not be called on layers which already belong to a QgsProject or QgsMapLayerStore.

See also

id()

See also

idChanged()

Added in version 3.38.

Parameters:: id (Optional[str])
Return type:: bool

setKeywordList(self, keywords: str | None)¶

Sets the keyword list of the layerused by QGIS Server in GetCapabilities request.

Deprecated since version QGIS: 3.38 use serverProperties()->:py:func:~QgsMapLayer.setKeywordList instead.

Parameters:: keywords (Optional[str])

setLayerOrder(self, layers: Iterable[str | None])¶

Reorders the previously selected sublayers of this layer from bottom to top. (Useful for providers that manage their own layers, such as WMS).

Parameters:: layers (Iterable[Optional[str]])

setLegend(self, legend: QgsMapLayerLegend | None)¶

Assign a legend controller to the map layer. The object will be responsible for providing legend items.

Parameters:: legend (Optional[QgsMapLayerLegend]) – Takes ownership of the object. Can be None.

setLegendPlaceholderImage(self, imgPath: str | None)¶

Set placeholder image for legend. If the string is empty, a generated legend will be shown.

Parameters:: imgPath (Optional[str]) – file path to the placeholder image

Added in version 3.22.

setLegendUrl(self, legendUrl: str | None)¶

Sets the URL for the layer’s legend.

Parameters:: legendUrl (Optional[str])

setLegendUrlFormat(self, legendUrlFormat: str | None)¶

Sets the format for a URL based layer legend.

Parameters:: legendUrlFormat (Optional[str])

setMapTipTemplate(self, mapTipTemplate: str | None)¶

The mapTip is a pretty, html representation for feature information.

It may also contain embedded expressions.

Added in version 3.30.

Parameters:: mapTipTemplate (Optional[str])

setMapTipsEnabled(self, enabled: bool)¶

Enable or disable map tips for this layer

Parameters:: enabled (bool) – Whether map tips are enabled for this layer

Added in version 3.32.

setMaximumScale(self, scale: float)¶

Sets the maximum map scale (i.e. most “zoomed in” scale) at which the layer will be visible. The scale value indicates the scale denominator, e.g. 1000.0 for a 1:1000 map. A scale of 0 indicates no maximum scale visibility.

Note

Scale based visibility is only used if setScaleBasedVisibility() is set to True.

See also

setScaleBasedVisibility()

See also

setMinimumScale()

See also

Parameters:: scale (float)

setMetadata(self, metadata: QgsLayerMetadata)¶

Sets the layer’s metadata store.

See also

metadata()

See also

metadataChanged()

Parameters:: metadata (QgsLayerMetadata)

setMetadataUrl(self, metaUrl: str | None)¶

Sets the metadata URL of the layer used by QGIS Server in GetCapabilities request. MetadataUrl is a a link to the detailed, standardized metadata about the data. Since QGIS 3.22, it edits the first metadata URL link.

See also

Deprecated since version QGIS: 3.22

Parameters:: metaUrl (Optional[str])

setMetadataUrlFormat(self, metaUrlFormat: str | None)¶

Sets the metadata format of the layer used by QGIS Server in GetCapabilities request. MetadataUrlType indicates how the metadata is structured. Since QGIS 3.22, it edits the first metadata URL format.

See also

Deprecated since version QGIS: 3.22

Parameters:: metaUrlFormat (Optional[str])

setMetadataUrlType(self, metaUrlType: str | None)¶

Set the metadata type of the layer used by QGIS Server in GetCapabilities request MetadataUrlType indicates the standard to which the metadata complies. Since QGIS 3.22, it edits the first metadata URL type.

See also

Deprecated since version QGIS: 3.22

Parameters:: metaUrlType (Optional[str])

setMinimumScale(self, scale: float)¶

Sets the minimum map scale (i.e. most “zoomed out” scale) at which the layer will be visible. The scale value indicates the scale denominator, e.g. 1000.0 for a 1:1000 map. A scale of 0 indicates no minimum scale visibility.

Note

Scale based visibility is only used if setScaleBasedVisibility() is set to True.

See also

setScaleBasedVisibility()

See also

setMaximumScale()

See also

Parameters:: scale (float)

setName(self, name: str | None)¶

Set the display name of the layer.

See also

name()

Parameters:: name (Optional[str])

setOpacity(self, opacity: float)¶

Sets the opacity for the layer, where opacity is a value between 0 (totally transparent) and 1.0 (fully opaque).

See also

opacity()

See also

opacityChanged()

Note

Prior to QGIS 3.18, this method was available for vector layers only

Added in version 3.18.

Parameters:: opacity (float)

setOriginalXmlProperties(self, originalXmlProperties: str | None)¶

Sets the original XML properties for the layer to originalXmlProperties

The storage format for the XML is qlr

Added in version 3.6.

Parameters:: originalXmlProperties (Optional[str])

setProviderType(self, providerType: str | None)¶

Sets the providerType (provider key)

Parameters:: providerType (Optional[str])

setRefreshOnNofifyMessage(self, message: str | None)¶

Set the notification message that triggers repaint If refresh on notification is enabled, the notification will triggerRepaint only if the notification message is equal to:param message:

Parameters:: message (Optional[str])

setRefreshOnNotifyEnabled(self, enabled: bool)¶

Set whether provider notification is connected to triggerRepaint

Parameters:: enabled (bool)

setRenderer3D(self, renderer: QgsAbstract3DRenderer | None)¶

Sets 3D renderer for the layer. Takes ownership of the renderer.

Parameters:: renderer (Optional[QgsAbstract3DRenderer])

setScaleBasedVisibility(self, enabled: bool)¶

Sets whether scale based visibility is enabled for the layer.

Parameters:: enabled (bool) – set to True to enable scale based visibility

See also

setMinimumScale()

See also

setMaximumScale()

See also

setShortName(self, shortName: str | None)¶

Sets the short name of the layer used by QGIS Server to identify the layer.

Deprecated since version QGIS: 3.38 use serverProperties()->:py:func:~QgsMapLayer.setShortName instead.

Parameters:: shortName (Optional[str])

setSubLayerVisibility(self, name: str | None, visible: bool)¶

Set the visibility of the given sublayer name.

Parameters:

name (Optional[str]) – sublayer name
visible (bool) – sublayer visibility

setTitle(self, title: str | None)¶

Sets the title of the layer used by QGIS Server in GetCapabilities request.

Deprecated since version QGIS: 3.38 use serverProperties()->:py:func:~QgsMapLayer.setTitle instead.

Parameters:: title (Optional[str])

setTransformContext(self, transformContext: QgsCoordinateTransformContext)¶

Sets the coordinate transform context to transformContext

Added in version 3.8.

Parameters:: transformContext (QgsCoordinateTransformContext)

setValid(self, valid: bool)¶

Sets whether layer is valid or not

Parameters:: valid (bool)

setVerticalCrs(self, crs: QgsCoordinateReferenceSystem)¶

Sets the layer’s vertical coordinate reference system.

The verticalCrsChanged() signal will be raised if the vertical CRS is changed.

Note

If the layer crs() is a compound CRS, then the CRS returned for verticalCrs() will be the vertical component of crs(). Otherwise it will be the value explicitly set by this call.

Parameters:

crs (QgsCoordinateReferenceSystem) -> (bool) – the vertical CRS

Returns:

True if vertical CRS was successfully set
errorMessage: will be set to a descriptive message if the vertical CRS could not be set

See also

verticalCrs()

See also

setCrs()

Added in version 3.38.

shortName(self) → str¶

Returns the short name of the layer used by QGIS Server to identify the layer.

Deprecated since version QGIS: 3.38 use serverProperties()->:py:func:~QgsMapLayer.shortName instead.

Return type:: str

source(self) → str¶

Returns the source for the layer. This source may contain usernames, passwords and other sensitive information.

See also

publicSource()

Return type:: str

statusChanged¶

pyqtSignal(*types, name: str = …, revision: int = …, arguments: Sequence = …) -> PYQT_SIGNAL

types is normally a sequence of individual types. Each type is either a type object or a string that is the name of a C++ type. Alternatively each type could itself be a sequence of types each describing a different overloaded signal. name is the optional C++ name of the signal. If it is not specified then the name of the class attribute that is bound to the signal is used. revision is the optional revision of the signal that is exported to QML. If it is not specified then 0 is used. arguments is the optional sequence of the names of the signal’s arguments.

Parameters:

name (str = ...)
revision (int = ...)
arguments (Sequence = ...)

Return type:

PYQT_SIGNAL

styleChanged¶

pyqtSignal(*types, name: str = …, revision: int = …, arguments: Sequence = …) -> PYQT_SIGNAL

types is normally a sequence of individual types. Each type is either a type object or a string that is the name of a C++ type. Alternatively each type could itself be a sequence of types each describing a different overloaded signal. name is the optional C++ name of the signal. If it is not specified then the name of the class attribute that is bound to the signal is used. revision is the optional revision of the signal that is exported to QML. If it is not specified then 0 is used. arguments is the optional sequence of the names of the signal’s arguments.

Parameters:

name (str = ...)
revision (int = ...)
arguments (Sequence = ...)

Return type:

PYQT_SIGNAL

styleLoaded¶

pyqtSignal(*types, name: str = …, revision: int = …, arguments: Sequence = …) -> PYQT_SIGNAL

types is normally a sequence of individual types. Each type is either a type object or a string that is the name of a C++ type. Alternatively each type could itself be a sequence of types each describing a different overloaded signal. name is the optional C++ name of the signal. If it is not specified then the name of the class attribute that is bound to the signal is used. revision is the optional revision of the signal that is exported to QML. If it is not specified then 0 is used. arguments is the optional sequence of the names of the signal’s arguments.

Parameters:

name (str = ...)
revision (int = ...)
arguments (Sequence = ...)

Return type:

PYQT_SIGNAL

styleManager(self) → QgsMapLayerStyleManager | None¶

Gets access to the layer’s style manager. Style manager allows switching between multiple styles.

Return type:: Optional[QgsMapLayerStyleManager]

styleURI(self) → str¶

Retrieve the style URI for this layer (either as a .qml file on disk or as a record in the users style table in their personal qgis.db)

Return type:: str
Returns:: a QString with the style file name

See also