Class: QgsMapLayer

class qgis.core.QgsMapLayer

Bases: PyQt5.QtCore.QObject

Base class for all map layer types. This is the base class for all map layer types (vector, raster).

QgsMapLayer(type: QgsMapLayerType = QgsMapLayerType.VectorLayer, name: str = ‘’, source: str = ‘’) Constructor for QgsMapLayer

Parameters
  • type – layer type

  • name – display name for the layer

  • source

    datasource of layer

    Enums

    LayerType

    alias of qgis._core.QgsMapLayerType

    Methods

    abstract

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

    accept

    Accepts the specified symbology visitor, causing it to visit all symbols associated with the layer.

    appendError

    Add error message

    attribution

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

    attributionUrl

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

    autoRefreshInterval

    Returns the auto refresh interval (in milliseconds).

    blendMode

    Returns the current blending mode for a layer.

    childEvent

    clone

    Returns a new instance equivalent to this one except for the id which is still unique.

    connectNotify

    createMapRenderer

    Returns new instance of QgsMapLayerRenderer that will be used for rendering of given context

    crs

    Returns the layer's spatial reference system.

    customEvent

    customProperties

    Read all custom properties from layer.

    customProperty

    Read a custom property from layer.

    customPropertyKeys

    Returns list of all keys within custom properties.

    dataProvider

    Returns the layer's data provider, it may be None.

    dataUrl

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

    dataUrlFormat

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

    decodedSource

    Called by readLayerXML(), used by derived classes to decode provider's specific data source from project files.

    dependencies

    Gets the list of dependencies.

    disconnectNotify

    elevationProperties

    Returns the layer's elevation properties.

    emitStyleChanged

    Triggers an emission of the styleChanged() signal.

    encodedSource

    Called by writeLayerXML(), used by derived classes to encode provider's specific data source to project files.

    error

    Gets current status error.

    exportNamedMetadata

    Export the current metadata of this layer as named metadata in a QDomDocument

    exportNamedStyle

    Export the properties of this layer as named style in a QDomDocument

    exportSldStyle

    Export the properties of this layer as SLD style in a QDomDocument

    extensionPropertyType

    Returns the extension of a Property.

    extent

    Returns the extent of the layer.

    flags

    Returns the flags for this layer.

    formatLayerName

    A convenience function to capitalize and format a layer name.

    generateId

    Generates an unique identifier for this layer, the generate ID is prefixed by layerName

    hasAutoRefreshEnabled

    Returns True if auto refresh is enabled for the layer.

    hasDependencyCycle

    Checks whether a new set of dependencies will introduce a cycle this method is now deprecated and always return False, because circular dependencies are now correctly managed.

    hasScaleBasedVisibility

    Returns whether scale based visibility is enabled for the layer.

    htmlMetadata

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

    id

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

    importNamedMetadata

    Import the metadata of this layer from a QDomDocument

    importNamedStyle

    Import the properties of this layer from a QDomDocument

    invalidateWgs84Extent

    Invalidates the WGS84 extent.

    isEditable

    Returns True if the layer can be edited.

    isInScaleRange

    Tests whether the layer should be visible at the specified scale.

    isModified

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

    isRefreshOnNotifyEnabled

    Returns True if the refresh on provider nofification is enabled

    isSignalConnected

    isSpatial

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

    isTemporary

    Returns True if the layer is considered a temporary layer.

    isValid

    Returns the status of the layer.

    keywordList

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

    legend

    Can be None.

    legendPlaceholderImage

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

    legendUrl

    Returns the URL for the layer's legend.

    legendUrlFormat

    Returns the format for a URL based layer legend.

    loadDefaultMetadata

    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)

    loadDefaultStyle

    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)

    loadNamedMetadata

    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)

    loadNamedMetadataFromDatabase

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

    loadNamedStyle

    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)

    loadNamedStyleFromDatabase

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

    loadSldStyle

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

    maximumScale

    Returns the maximum map scale (i.e.

    metadata

    Returns a reference to the layer's metadata store.

    metadataUri

    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)

    metadataUrl

    Returns the metadata URL of the layer used by QGIS Server in GetCapabilities request.

    metadataUrlFormat

    Returns the metadata format of the layer used by QGIS Server in GetCapabilities request.

    metadataUrlType

    Returns the metadata type of the layer used by QGIS Server in GetCapabilities request.

    minimumScale

    Returns the minimum map scale (i.e.

    name

    Returns the display name of the layer.

    opacity

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

    originalXmlProperties

    Returns the XML properties of the original layer as they were when the layer was first read from the project file.

    project

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

    properties

    Returns the map layer properties of this layer.

    providerType

    Returns the provider type (provider key) for this layer

    publicSource

    Gets a version of the internal layer definition that has sensitive bits removed (for example, the password).

    readCommonStyle

    Read style data common to all layer types

    readCustomProperties

    Read custom properties from project file.

    readLayerXml

    Sets state from DOM document

    readOnly

    Returns if this layer is read only.

    readSld

    param node

    readStyle

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

    readStyleManager

    Read style manager's configuration (if any).

    readSymbology

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

    readXml

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

    receivers

    refreshOnNotifyMessage

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

    reload

    Synchronises with changes in the datasource

    removeCustomProperty

    Remove a custom property from layer.

    renderer3D

    Returns 3D renderer associated with the layer.

    resolveReferences

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

    saveDefaultMetadata

    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)

    saveDefaultStyle

    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)

    saveNamedMetadata

    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)

    saveNamedStyle

    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)

    saveSldStyle

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

    sender

    senderSignalIndex

    serverProperties

    Returns QGIS Server Properties for the map layer

    setAbstract

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

    setAttribution

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

    setAttributionUrl

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

    setAutoRefreshEnabled

    Sets whether auto refresh is enabled for the layer.

    setAutoRefreshInterval

    Sets the auto refresh interval (in milliseconds) for the layer.

    setBlendMode

    Set the blending mode used for rendering a layer.

    setCrs

    Sets layer's spatial reference system

    setCustomProperties

    Set custom properties for layer.

    setCustomProperty

    Set a custom property for layer.

    setDataSource

    Updates the data source of the layer.

    setDataUrl

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

    setDataUrlFormat

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

    setDependencies

    Sets the list of dependencies.

    setError

    Sets error message

    setExtent

    Sets the extent

    setFlags

    Returns the flags for this layer.

    setKeywordList

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

    setLayerOrder

    Reorders the previously selected sublayers of this layer from bottom to top.

    setLegend

    Assign a legend controller to the map layer.

    setLegendPlaceholderImage

    Set placeholder image for legend.

    setLegendUrl

    Sets the URL for the layer's legend.

    setLegendUrlFormat

    Sets the format for a URL based layer legend.

    setMaximumScale

    Sets the maximum map scale (i.e.

    setMetadata

    Sets the layer's metadata store.

    setMetadataUrl

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

    setMetadataUrlFormat

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

    setMetadataUrlType

    Set the metadata type of the layer used by QGIS Server in GetCapabilities request MetadataUrlType indicates the standard to which the metadata complies.

    setMinimumScale

    Sets the minimum map scale (i.e.

    setName

    Set the display name of the layer.

    setOpacity

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

    setOriginalXmlProperties

    Sets the original XML properties for the layer to originalXmlProperties

    setProviderType

    Sets the providerType (provider key)

    setRefreshOnNofifyMessage

    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:

    setRefreshOnNotifyEnabled

    Set whether provider notification is connected to triggerRepaint

    setRenderer3D

    Sets 3D renderer for the layer.

    setScaleBasedVisibility

    Sets whether scale based visibility is enabled for the layer.

    setShortName

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

    setSubLayerVisibility

    Set the visibility of the given sublayer name.

    setTitle

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

    setTransformContext

    Sets the coordinate transform context to transformContext

    setValid

    Sets whether layer is valid or not

    shortName

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

    source

    Returns the source for the layer.

    styleManager

    Gets access to the layer's style manager.

    styleURI

    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)

    subLayers

    Returns the sublayers of this layer.

    supportsEditing

    Returns whether the layer supports editing or not.

    temporalProperties

    Returns the layer's temporal properties.

    timerEvent

    timestamp

    Time stamp of data source in the moment when data/metadata were loaded by provider

    title

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

    transformContext

    Returns the layer data provider coordinate transform context or a default transform context if the layer does not have a valid data provider.

    trigger3DUpdate

    Will advise any 3D maps that this layer requires to be updated in the scene.

    triggerRepaint

    Will advise the map canvas (and any other interested party) that this layer requires to be repainted.

    type

    Returns the type of the layer.

    undoStack

    Returns pointer to layer's undo stack

    undoStackStyles

    Returns pointer to layer's style undo stack

    wgs84Extent

    Returns the WGS84 extent (EPSG:4326) of the layer according to ReadFlag.FlagTrustLayerMetadata.

    writeCommonStyle

    Write style data common to all layer types

    writeCustomProperties

    Write custom properties to project file.

    writeLayerXml

    Stores state in DOM node

    writeStyle

    Write just the symbology information for the layer into the document

    writeStyleManager

    Write style manager's configuration (if exists).

    writeSymbology

    Write the style for the layer into the document provided.

    writeXml

    Called by writeLayerXML(), used by children to write state specific to them to project files.

    Signals

    autoRefreshIntervalChanged

    Emitted when the auto refresh interval changes.

    beforeResolveReferences

    Emitted when all layers are loaded and references can be resolved, just before the references of this layer are resolved.

    blendModeChanged

    Signal emitted when the blend mode is changed, through QgsMapLayer.setBlendMode() [signal]

    configChanged

    Emitted whenever the configuration is changed.

    crsChanged

    Emit a signal that layer's CRS has been reset [signal]

    customPropertyChanged

    Emitted when a custom property of the layer has been changed or removed.

    dataChanged

    Data of layer changed [signal]

    dataSourceChanged

    Emitted whenever the layer's data source has been changed.

    dependenciesChanged

    Emitted when dependencies are changed.

    editingStarted

    Emitted when editing on this layer has started.

    editingStopped

    Emitted when edited changes have been successfully written to the data provider.

    flagsChanged

    Emitted when layer's flags have been modified.

    isValidChanged

    Emitted when the validity of this layer changed.

    layerModified

    Emitted when modifications has been done on layer

    legendChanged

    Signal emitted when legend of the layer has changed

    metadataChanged

    Emitted when the layer's metadata is changed.

    nameChanged

    Emitted when the name has been changed

    opacityChanged

    Emitted when the layer's opacity is changed, where opacity is a value between 0 (transparent) and 1 (opaque).

    recalculateExtents

    This is used to send a request that any mapcanvas using this layer update its extents [signal]

    renderer3DChanged

    Signal emitted when 3D renderer associated with the layer has changed.

    rendererChanged

    Signal emitted when renderer is changed.

    repaintRequested

    By emitting this signal the layer tells that either appearance or content have been changed and any view showing the rendered layer should refresh itself.

    request3DUpdate

    Signal emitted when a layer requires an update in any 3D maps.

    statusChanged

    Emit a signal with status (e.g.

    styleChanged

    Signal emitted whenever a change affects the layer's style.

    styleLoaded

    Emitted when a style has been loaded

    willBeDeleted

    Emitted in the destructor when the layer is about to be deleted, but it is still in a perfectly valid state: the last chance for other pieces of code for some cleanup if they use the layer.

    Attributes

    Actions

    AllStyleCategories

    AttributeTable

    CustomProperties

    Diagrams

    Elevation

    Fields

    FlagDontResolveLayers

    FlagReadExtentFromXml

    FlagTrustLayerMetadata

    Forms

    GeometryOptions

    Identifiable

    Labeling

    LayerConfiguration

    Legend

    MapTips

    Metadata

    Notes

    Private

    Relations

    Removable

    Rendering

    Searchable

    Style

    Symbology

    Symbology3D

    Temporal

Actions = 64
AllStyleCategories = 262143
AttributeTable = 512
CustomProperties = 2048
Diagrams = 256
Elevation = 65536
Fields = 16
FlagDontResolveLayers = 1
FlagReadExtentFromXml = 4
FlagTrustLayerMetadata = 2
Forms = 32
GeometryOptions = 4096
Identifiable = 1
Labeling = 8
LayerConfiguration = 1
class LayerFlag

Bases: int

baseClass

alias of qgis._core.QgsMapLayer

class LayerFlags
class LayerFlags(Union[QgsMapLayer.LayerFlags, QgsMapLayer.LayerFlag]) None
class LayerFlags(QgsMapLayer.LayerFlags) None

Bases: sip.wrapper

baseClass

alias of qgis._core.QgsMapLayer

LayerType

alias of qgis._core.QgsMapLayerType

Legend = 32768
MapTips = 128
Metadata = 1
Notes = 131072
Private = 8
class PropertyType

Bases: int

class ReadFlag

Bases: int

class ReadFlags
class ReadFlags(Union[QgsMapLayer.ReadFlags, QgsMapLayer.ReadFlag]) None
class ReadFlags(QgsMapLayer.ReadFlags) None

Bases: sip.wrapper

Relations = 8192
Removable = 2
Rendering = 1024
Searchable = 4
Style = 0
class StyleCategories
class StyleCategories(Union[QgsMapLayer.StyleCategories, QgsMapLayer.StyleCategory]) None
class StyleCategories(QgsMapLayer.StyleCategories) None

Bases: sip.wrapper

baseClass

alias of qgis._core.QgsMapLayer

class StyleCategory

Bases: int

baseClass

alias of qgis._core.QgsMapLayer

Symbology = 2
Symbology3D = 4
Temporal = 16384
abstract(self) str

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

Return type

str

Returns

the layer abstract

See also

setAbstract()

accept(self, visitor: QgsStyleEntityVisitorInterface) bool

Accepts the specified symbology visitor, causing it to visit all symbols associated with the layer.

Returns True if the visitor should continue visiting other objects, or False if visiting should be canceled.

New in version 3.10.

Parameters

visitor (QgsStyleEntityVisitorInterface) –

Return type

bool

appendError(self, error: QgsErrorMessage)

Add error message

Parameters

error (QgsErrorMessage) –

attribution(self) str

Returns the attribution of the layer used by QGIS Server in GetCapabilities request. Attribution indicates the provider of a layer or collection of layers.

Return type

str

Returns

the layer attribution

See also

setAttribution()

attributionUrl(self) str

Returns the attribution URL of the layer used by QGIS Server in GetCapabilities request. Attribution indicates the provider of a layer or collection of layers.

Return type

str

Returns

the layer attribution URL

autoRefreshInterval(self) int

Returns the auto refresh interval (in milliseconds). Note that auto refresh is only active when hasAutoRefreshEnabled() is True.

New in version 3.0.

Return type

int

autoRefreshIntervalChanged

Emitted when the auto refresh interval changes.

New in version 3.0: [signal]

Parameters

interval (int) –

beforeResolveReferences

Emitted when all layers are loaded and references can be resolved, just before the references of this layer are resolved.

New in version 3.10: [signal]

Parameters

project (QgsProject) –

blendMode(self) QPainter.CompositionMode

Returns the current blending mode for a layer.

See also

setBlendMode()

Return type

QPainter.CompositionMode

blendModeChanged

Signal emitted when the blend mode is changed, through QgsMapLayer.setBlendMode() [signal]

Parameters

blendMode (QPainter.CompositionMode) –

childEvent(self, QChildEvent)
clone(self) QgsMapLayer

Returns a new instance equivalent to this one except for the id which is still unique.

Return type

QgsMapLayer

Returns

a new layer instance

New in version 3.0.

clone(self, layer: QgsMapLayer) Copies attributes like name, short name, … into another layer.

Parameters

layer – The copy recipient

New in version 3.0.

configChanged

Emitted whenever the configuration is changed. The project listens to this signal to be marked as dirty. [signal]

connectNotify(self, QMetaMethod)
createMapRenderer(self, rendererContext: QgsRenderContext) QgsMapLayerRenderer

Returns new instance of QgsMapLayerRenderer that will be used for rendering of given context

New in version 2.4.

Parameters

rendererContext (QgsRenderContext) –

Return type

QgsMapLayerRenderer

crs(self) QgsCoordinateReferenceSystem

Returns the layer’s spatial reference system.

New in version 1.4.

Return type

QgsCoordinateReferenceSystem

crsChanged

Emit a signal that layer’s CRS has been reset [signal]

customEvent(self, QEvent)
customProperties(self) QgsObjectCustomProperties

Read all custom properties from layer. Properties are stored in a map and saved in project file.

New in version 3.14.

Return type

QgsObjectCustomProperties

customProperty(self, value: str, defaultValue: Any = None) Any

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

Parameters
  • value (str) –

  • defaultValue (Any = None) –

Return type

Any

customPropertyChanged

Emitted when a custom property of the layer has been changed or removed.

New in version 3.18: [signal]

Parameters

key (str) –

customPropertyKeys(self) List[str]

Returns list of all keys within custom properties. Properties are stored in a map and saved in project file.

See also

customProperty()

New in version 3.0.

Return type

List[str]

dataChanged

Data of layer changed [signal]

dataProvider(self) QgsDataProvider

Returns the layer’s data provider, it may be None.

Return type

QgsDataProvider

dataSourceChanged

Emitted whenever the layer’s data source has been changed.

See also

setDataSource()

New in version 3.5: [signal]

dataUrl(self) str

Returns the DataUrl of the layer used by QGIS Server in GetCapabilities request. DataUrl is a a link to the underlying data represented by a particular layer.

Return type

str

Returns

the layer DataUrl

See also

setDataUrl()

dataUrlFormat(self) str

Returns the DataUrl format of the layer used by QGIS Server in GetCapabilities request. DataUrl is a a link to the underlying data represented by a particular layer.

Return type

str

Returns

the layer DataUrl format

decodedSource(self, source: str, dataProvider: str, context: QgsReadWriteContext) str

Called by readLayerXML(), used by derived classes to decode provider’s specific data source from project files. Typically resolving absolute or relative paths, usernames and passwords or drivers prefixes (“HDF5:”)

Parameters
  • source (str) – data source to decode, typically read from layer’s DOM element “datasource”

  • dataProvider (str) – string identification of data provider (e.g. “ogr”), typically read from layer’s DOM element

  • context (QgsReadWriteContext) – reading context (e.g. for conversion between relative and absolute paths)

Return type

str

Returns

decoded source, typically to be used as the layer’s datasource

New in version 3.2.

dependencies(self) Set[QgsMapLayerDependency]

Gets the list of dependencies. This includes data dependencies set by the user (setDataDependencies()) as well as dependencies given by the provider

Return type

Set[QgsMapLayerDependency]

Returns

a set of QgsMapLayerDependency

New in version 3.0.

dependenciesChanged

Emitted when dependencies are changed. [signal]

disconnectNotify(self, QMetaMethod)
editingStarted

Emitted when editing on this layer has started.

New in version 3.22: [signal]

editingStopped

Emitted when edited changes have been successfully written to the data provider.

New in version 3.22: [signal]

elevationProperties(self) QgsMapLayerElevationProperties

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

New in version 3.18.

Return type

QgsMapLayerElevationProperties

emitStyleChanged(self)

Triggers an emission of the styleChanged() signal.

New in version 2.16.

encodedSource(self, source: str, context: QgsReadWriteContext) str

Called by writeLayerXML(), used by derived classes to encode provider’s specific data source to project files. Typically resolving absolute or relative paths, usernames and passwords or drivers prefixes (“HDF5:”)

Parameters
Return type

str

Returns

encoded source, typically to be written in the DOM element “datasource”

New in version 3.2.

error(self) QgsError

Gets current status error. This error describes some principal problem for which layer cannot work and thus is not valid. It is not last error after accessing data by draw() etc.

Return type

QgsError

exportNamedMetadata(self, doc: QDomDocument, errorMsg: str)

Export the current metadata of this layer as named metadata in a QDomDocument

Parameters
  • doc (QDomDocument) – the target QDomDocument

  • errorMsg (str) – this QString will be initialized on error

New in version 3.0.

exportNamedStyle(self, doc: QDomDocument, context: QgsReadWriteContext = QgsReadWriteContext(), categories: Union[QgsMapLayer.StyleCategories, QgsMapLayer.StyleCategory] = QgsMapLayer.AllStyleCategories) str

Export the properties of this layer as named style in a QDomDocument

Parameters
  • doc (QDomDocument) – the target QDomDocument

  • errorMsg – this QString will be initialized on error

  • context (QgsReadWriteContext = QgsReadWriteContext()) – read write context

  • categories (Union[QgsMapLayer.StyleCategories) – the style categories to export during the execution of writeSymbology

Return type

str

exportSldStyle(self, doc: QDomDocument, errorMsg: str)

Export the properties of this layer as SLD style in a QDomDocument

Parameters
  • doc (QDomDocument) – the target QDomDocument

  • errorMsg (str) – this QString will be initialized on error during the execution of writeSymbology

extensionPropertyType(type: QgsMapLayer.PropertyType) str

Returns the extension of a Property.

Return type

str

Returns

The extension

New in version 3.0.

Parameters

type (QgsMapLayer.PropertyType) –

extent(self) QgsRectangle

Returns the extent of the layer.

Return type

QgsRectangle

flags(self) QgsMapLayer.LayerFlags

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()

New in version 3.4.

Return type

QgsMapLayer.LayerFlags

flagsChanged

Emitted when layer’s flags have been modified.

See also

setFlags()

See also

flags()

New in version 3.4: [signal]

formatLayerName(name: str) str

A convenience function to capitalize and format a layer name.

New in version 3.0.

Parameters

name (str) –

Return type

str

generateId(layerName: str) str

Generates an unique identifier for this layer, the generate ID is prefixed by layerName

New in version 3.8.

Parameters

layerName (str) –

Return type

str

hasAutoRefreshEnabled(self) bool

Returns True if auto refresh is enabled for the layer.

New in version 3.0.

Return type

bool

hasDependencyCycle(self, Iterable[QgsMapLayerDependency]) bool

Checks whether a new set of dependencies will introduce a cycle this method is now deprecated and always return False, because circular dependencies are now correctly managed.

Deprecated since version QGIS: 3.10

Return type

bool

hasScaleBasedVisibility(self) bool

Returns whether scale based visibility is enabled for the layer.

Return type

bool

Returns

True if scale based visibility is enabled

See also

minimumScale()

See also

maximumScale()

See also

isInScaleRange()

htmlMetadata(self) str

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

New in version 3.0.

Return type

str

id(self) str

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

Return type

str

importNamedMetadata(self, document: QDomDocument, errorMessage: str) bool

Import the metadata of this layer from a QDomDocument

Parameters
  • document (QDomDocument) – source QDomDocument

  • errorMessage (str) – this QString will be initialized on error

Return type

bool

Returns

True on success

New in version 3.0.

importNamedStyle(self, doc: QDomDocument, categories: Union[QgsMapLayer.StyleCategories, QgsMapLayer.StyleCategory] = QgsMapLayer.AllStyleCategories) Tuple[bool, str]

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

Return type

Tuple[bool, str]

Returns

True on success

New in version 2.8.

invalidateWgs84Extent(self)

Invalidates the WGS84 extent. If FlagTrustLayerMetadata is enabled, the extent is not invalidated because we want to trust metadata whatever happens.

New 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

minimumScale()

See also

maximumScale()

New in version 2.16.

Parameters

scale (float) –

isModified(self) bool

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

Note

default implementation returns False.

New in version 3.22.

Return type

bool

isRefreshOnNotifyEnabled(self) bool

Returns True if the refresh on provider nofification is enabled

New in version 3.0.

Return type

bool

isSignalConnected(self, 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.

New in version 2.16.

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)

New 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

Emitted when the validity of this layer changed.

New in version 3.16: [signal]

keywordList(self) str

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

Return type

str

Returns

the layer keyword list

See also

setKeywordList()

layerModified

Emitted when modifications has been done on layer

New in version 3.22: [signal]

legend(self) QgsMapLayerLegend

Can be None.

New in version 2.6.

Return type

QgsMapLayerLegend

legendChanged

Signal emitted when legend of the layer has changed

New in version 2.6: [signal]

legendPlaceholderImage(self) str

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

Return type

str

Returns

placholder image path

New 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

loadDefaultMetadata(self) Tuple[str, bool]

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.

Return type

Tuple[str, bool]

Returns

a QString with any status messages

New in version 3.0.

loadDefaultStyle(self) Tuple[str, bool]

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)

Return type

Tuple[str, bool]

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

also()

loadNamedMetadata(self, uri: str) Tuple[str, bool]

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 (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.

Return type

Tuple[str, bool]

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.

New in version 3.0.

loadNamedMetadataFromDatabase(self, db: str, uri: str, qmd: str) bool

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

Parameters
  • db (str) – path to sqlite database

  • uri (str) – uri for table

  • qmd (str) – will be set to QMD xml metadata content from database

Return type

bool

Returns

True if style was successfully loaded

New in version 3.0.

loadNamedStyle(self, uri: str, categories: Union[QgsMapLayer.StyleCategories, QgsMapLayer.StyleCategory] = QgsMapLayer.AllStyleCategories) Tuple[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 (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 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 (Union[QgsMapLayer.StyleCategories) – the style categories to be loaded.

Return type

Tuple[str, bool]

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

also()

loadNamedStyleFromDatabase(self, db: str, uri: str) Tuple[bool, str]

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

Parameters
  • db (str) – path to sqlite database

  • uri (str) – uri for table

Return type

Tuple[bool, str]

Returns

  • True if style was successfully loaded

  • qml: will be set to QML style content from database

loadSldStyle(self, uri: str) Tuple[str, bool]

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

Parameters
  • uri (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

Return type

Tuple[str, bool]

Returns

a string with any status or error messages

See also

saveSldStyle()

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

minimumScale()

See also

isInScaleRange()

Return type

float

metadata(self) QgsLayerMetadata

Returns a reference to the layer’s metadata store.

See also

setMetadata()

New in version 3.0.

Return type

QgsLayerMetadata

metadataChanged

Emitted when the layer’s metadata is changed.

See also

setMetadata()

See also

metadata()

New in version 3.0: [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

New in version 3.0.

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

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

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

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

maximumScale()

See also

isInScaleRange()

Return type

float

name(self) str

Returns the display name of the layer.

See also

setName()

Return type

str

nameChanged

Emitted when the name has been changed

New in version 2.16: [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

New in version 3.18.

Return type

float

opacityChanged

Emitted when the layer’s opacity is changed, where opacity is a value between 0 (transparent) and 1 (opaque).

See also

setOpacity()

See also

opacity()

Note

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

New in version 3.18: [signal]

Parameters

opacity (float) –

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

New in version 3.6.

Return type

str

project(self) QgsProject

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

New in version 3.18.

Return type

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.

New in version 3.22.

Return type

Qgis.MapLayerProperties

providerType(self) str

Returns the provider type (provider key) for this layer

Return type

str

publicSource(self) 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.

See also

source()

Return type

str

readCommonStyle(self, layerElement: QDomElement, context: QgsReadWriteContext, categories: Union[QgsMapLayer.StyleCategories, QgsMapLayer.StyleCategory] = QgsMapLayer.AllStyleCategories)

Read style data common to all layer types

New in version 3.0.

Parameters
readCustomProperties(self, layerNode: QDomNode, keyStartsWith: str = '')

Read custom properties from project file.

Parameters
  • layerNode (QDomNode) – note to read from

  • keyStartsWith (str = '') – reads only properties starting with the specified string (or all if the string is empty)

readLayerXml(self, layerElement: QDomElement, context: QgsReadWriteContext, flags: Union[QgsMapLayer.ReadFlags, QgsMapLayer.ReadFlag] = QgsMapLayer.ReadFlags()) 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.

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) bool
Parameters
  • node (QDomNode) –

  • errorMessage (str) –

Return type

bool

readStyle(self, node: QDomNode, errorMessage: str, context: QgsReadWriteContext, categories: Union[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 (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.

New in version 2.16.

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, context: QgsReadWriteContext, categories: Union[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 (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
Return type

bool

recalculateExtents

This is used to send a request that any mapcanvas using this layer update its extents [signal]

receivers(self, PYQT_SIGNAL) int
refreshOnNotifyMessage(self) str

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

New in version 3.0.

Return type

str

reload(self)

Synchronises with changes in the datasource

removeCustomProperty(self, key: str)

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

Parameters

key (str) –

renderer3D(self) QgsAbstract3DRenderer

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

New in version 3.0.

Return type

QgsAbstract3DRenderer

renderer3DChanged

Signal emitted when 3D renderer associated with the layer has changed.

New in version 3.0: [signal]

rendererChanged

Signal emitted when renderer is changed.

See also

styleChanged() [signal]

repaintRequested

By emitting this signal the layer tells that either appearance or content have been changed and any view showing the rendered layer should refresh itself. If deferredUpdate is True then the layer will only be repainted when the canvas is next re-rendered, and will not trigger any canvas redraws itself. [signal]

Parameters

deferredUpdate (bool = False) –

request3DUpdate

Signal emitted when a layer requires an update in any 3D maps.

New in version 3.18: [signal]

resolveReferences(self, project: QgsProject)

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

New in version 3.0.

Parameters

project (QgsProject) –

saveDefaultMetadata(self) Tuple[str, bool]

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)

Return type

Tuple[str, bool]

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.

New in version 3.0.

saveDefaultStyle(self) Tuple[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)

Return type

Tuple[str, bool]

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

loadNamedStyle()

saveNamedMetadata(self, uri: str) Tuple[str, bool]

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 (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.

Return type

Tuple[str, bool]

Returns

a QString with any status messages

New in version 3.0.

saveNamedStyle(self, uri: str, categories: Union[QgsMapLayer.StyleCategories, QgsMapLayer.StyleCategory] = QgsMapLayer.AllStyleCategories) Tuple[str, bool]

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 (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.

Return type

Tuple[str, bool]

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.

saveSldStyle(self, uri: str) Tuple[str, bool]

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

Parameters
  • uri (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

Return type

Tuple[str, bool]

Returns

a string with any status or error messages

See also

loadSldStyle()

sender(self) QObject
senderSignalIndex(self) int
serverProperties(self) QgsMapLayerServerProperties

Returns QGIS Server Properties for the map layer

New in version 3.22.

Return type

QgsMapLayerServerProperties

setAbstract(self, abstract: str)

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

Returns

the layer abstract

See also

abstract()

Parameters

abstract (str) –

setAttribution(self, attrib: str)

Sets the attribution of the layer used by QGIS Server in GetCapabilities request. Attribution indicates the provider of a layer or collection of layers.

Returns

the layer attribution

See also

attribution()

Parameters

attrib (str) –

setAttributionUrl(self, attribUrl: str)

Sets the attribution URL of the layer used by QGIS Server in GetCapabilities request. Attribution indicates the provider of a layer or collection of layers.

Returns

the layer attribution URL

See also

attributionUrl()

Parameters

attribUrl (str) –

setAutoRefreshEnabled(self, enabled: bool)

Sets whether auto refresh is enabled for the layer.

New in version 3.0.

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 setAutoRefreshEnabled().

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

New in version 3.0.

Parameters

interval (int) –

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

Parameters
setCustomProperties(self, properties: QgsObjectCustomProperties)

Set custom properties for layer. Current properties are dropped.

New in version 3.0.

Parameters

properties (QgsObjectCustomProperties) –

setCustomProperty(self, key: str, value: Any)

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

See also

customProperty()

Parameters
  • key (str) –

  • value (Any) –

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

Updates the data source of the layer. 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.

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

Parameters
  • dataSource (str) – new layer data source

  • baseName (str) – base name of the layer

  • provider (str) – provider string

  • loadDefaultStyleFlag (bool = False) – set to True to reset the layer’s style to the default for the data source

New in version 3.20.

setDataSource(self, dataSource: str, baseName: str, provider: str, options: QgsDataProvider.ProviderOptions, loadDefaultStyleFlag: bool = False) Updates the data source of the layer. 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.

Parameters
  • dataSource – new layer data source

  • baseName – base name of the layer

  • provider – provider string

  • options – provider options

  • loadDefaultStyleFlag – set to True to reset the layer’s style to the default for the data source

New in version 3.6.

setDataSource(self, dataSource: str, baseName: str, provider: str, options: QgsDataProvider.ProviderOptions, flags: Union[QgsDataProvider.ReadFlags, QgsDataProvider.ReadFlag]) Updates the data source of the layer. 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.

Subclasses should override setDataSourcePrivate: default implementation does nothing.

Parameters
  • dataSource – new layer data source

  • baseName – base name of the layer

  • provider – provider string

  • options – provider options

  • flags – provider read flags which control dataprovider construction like FlagTrustDataSource, FlagLoadDefaultStyle, etc

New in version 3.20.

setDataUrl(self, dataUrl: str)

Sets the DataUrl of the layer used by QGIS Server in GetCapabilities request. DataUrl is a a link to the underlying data represented by a particular layer.

Returns

the layer DataUrl

See also

dataUrl()

Parameters

dataUrl (str) –

setDataUrlFormat(self, dataUrlFormat: str)

Sets the DataUrl format of the layer used by QGIS Server in GetCapabilities request. DataUrl is a a link to the underlying data represented by a particular layer.

Returns

the layer DataUrl format

See also

dataUrlFormat()

Parameters

dataUrlFormat (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

New in version 3.0.

setError(self, error: QgsError)

Sets error message

Parameters

error (QgsError) –

setExtent(self, rect: QgsRectangle)

Sets the extent

Parameters

rect (QgsRectangle) –

setFlags(self, flags: Union[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()

New in version 3.4.

Parameters

flags (Union[QgsMapLayer.LayerFlags) –

setKeywordList(self, keywords: str)

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

Returns

the layer keyword list

See also

keywordList()

Parameters

keywords (str) –

setLayerOrder(self, layers: Iterable[str])

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[str]) –

setLegend(self, legend: QgsMapLayerLegend)

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

Parameters

legend (QgsMapLayerLegend) – Takes ownership of the object. Can be None.

New in version 2.6.

setLegendPlaceholderImage(self, imgPath: str)

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

Parameters

imgPath (str) – file path to the placeholder image

New in version 3.22.

setLegendUrl(self, legendUrl: str)

Sets the URL for the layer’s legend.

Parameters

legendUrl (str) –

setLegendUrlFormat(self, legendUrlFormat: str)

Sets the format for a URL based layer legend.

Parameters

legendUrlFormat (str) –

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

maximumScale()

Parameters

scale (float) –

setMetadata(self, metadata: QgsLayerMetadata)

Sets the layer’s metadata store.

See also

metadata()

New in version 3.0.

Parameters

metadata (QgsLayerMetadata) –

setMetadataUrl(self, metaUrl: str)

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.

Deprecated since version QGIS: 3.22

Parameters

metaUrl (str) –

setMetadataUrlFormat(self, metaUrlFormat: str)

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.

Deprecated since version QGIS: 3.22

Parameters

metaUrlFormat (str) –

setMetadataUrlType(self, metaUrlType: str)

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.

Returns

the layer metadata type

Deprecated since version QGIS: 3.22

Parameters

metaUrlType (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

minimumScale()

Parameters

scale (float) –

setName(self, name: str)

Set the display name of the layer.

See also

name()

New in version 2.16.

Parameters

name (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

New in version 3.18.

Parameters

opacity (float) –

setOriginalXmlProperties(self, originalXmlProperties: str)

Sets the original XML properties for the layer to originalXmlProperties

The storage format for the XML is qlr

New in version 3.6.

Parameters

originalXmlProperties (str) –

setProviderType(self, providerType: str)

Sets the providerType (provider key)

Parameters

providerType (str) –

setRefreshOnNofifyMessage(self, message: str)

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:

New in version 3.0.

Parameters

message (str) –

setRefreshOnNotifyEnabled(self, enabled: bool)

Set whether provider notification is connected to triggerRepaint

New in version 3.0.

Parameters

enabled (bool) –

setRenderer3D(self, renderer: QgsAbstract3DRenderer)

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

New in version 3.0.

Parameters

renderer (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

setShortName(self, shortName: str)

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

Returns

the layer short name

See also

shortName()

Parameters

shortName (str) –

setSubLayerVisibility(self, name: str, visible: bool)

Set the visibility of the given sublayer name.

Parameters
  • name (str) – sublayer name

  • visible (bool) – sublayer visibility

setTitle(self, title: str)

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

See also

title()

Parameters

title (str) –

setTransformContext(self, transformContext: QgsCoordinateTransformContext)

Sets the coordinate transform context to transformContext

New in version 3.8.

Parameters

transformContext (QgsCoordinateTransformContext) –

setValid(self, valid: bool)

Sets whether layer is valid or not

Parameters

valid (bool) –

shortName(self) str

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

See also

setShortName()

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

Emit a signal with status (e.g. to be caught by QgisApp and display a msg on status bar) [signal]

Parameters

status (str) –

styleChanged

Signal emitted whenever a change affects the layer’s style. Ie this may be triggered by renderer changes, label style changes, or other style changes such as blend mode or layer opacity changes.

Warning

This signal should never be manually emitted. Instead call the emitStyleChanged() method to ensure that the signal is only emitted when appropriate.

New in version 2.16: [signal]

styleLoaded

Emitted when a style has been loaded

Parameters

categories (Union[QgsMapLayer.StyleCategories) – style categories

New in version 3.12: [signal]

styleManager(self) QgsMapLayerStyleManager

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

New in version 2.8.

Return type

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

also()

subLayers(self) List[str]

Returns the sublayers of this layer. (Useful for providers that manage their own layers, such as WMS).

Return type

List[str]

supportsEditing(self) bool

Returns whether the layer supports editing or not.

Return type

bool

Returns

False if the layer is read only or the data provider has no editing capabilities.

Note

default implementation returns False.

New in version 3.22.

temporalProperties(self) QgsMapLayerTemporalProperties

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

New in version 3.14.

Return type

QgsMapLayerTemporalProperties

timerEvent(self, QTimerEvent)
timestamp(self) QDateTime

Time stamp of data source in the moment when data/metadata were loaded by provider

Return type

QDateTime

title(self) str

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

Return type

str

Returns

the layer title

See also

setTitle()

transformContext(self) QgsCoordinateTransformContext

Returns the layer data provider coordinate transform context or a default transform context if the layer does not have a valid data provider.

New in version 3.8.

Return type

QgsCoordinateTransformContext

trigger3DUpdate(self)

Will advise any 3D maps that this layer requires to be updated in the scene. Will emit a request3DUpdate() signal.

New in version 3.18.

triggerRepaint(self, deferredUpdate: bool = False)

Will advise the map canvas (and any other interested party) that this layer requires to be repainted. Will emit a repaintRequested() signal. If deferredUpdate is True then the layer will only be repainted when the canvas is next re-rendered, and will not trigger any canvas redraws itself.

Note

in 2.6 function moved from vector/raster subclasses to QgsMapLayer

Parameters

deferredUpdate (bool = False) –

type(self) QgsMapLayerType

Returns the type of the layer.

Return type

QgsMapLayerType

undoStack(self) QUndoStack

Returns pointer to layer’s undo stack

Return type

QUndoStack

undoStackStyles(self) QUndoStack

Returns pointer to layer’s style undo stack

New in version 2.16.

Return type

QUndoStack

wgs84Extent(self, forceRecalculate: bool = False) QgsRectangle

Returns the WGS84 extent (EPSG:4326) of the layer according to ReadFlag.FlagTrustLayerMetadata. If that flag is activated, then the WGS84 extent read in the qgs project is returned. Otherwise, the actual WGS84 extent is returned.

Parameters

forceRecalculate (bool = False) – True to return the current WGS84 extent whatever the read flags

New in version 3.20.

Return type

QgsRectangle

willBeDeleted

Emitted in the destructor when the layer is about to be deleted, but it is still in a perfectly valid state: the last chance for other pieces of code for some cleanup if they use the layer.

New in version 3.0: [signal]

writeCommonStyle(self, layerElement: QDomElement, document: QDomDocument, context: QgsReadWriteContext, categories: Union[QgsMapLayer.StyleCategories, QgsMapLayer.StyleCategory] = QgsMapLayer.AllStyleCategories)

Write style data common to all layer types

New in version 3.0.

Parameters
writeCustomProperties(self, layerNode: QDomNode, doc: QDomDocument)

Write custom properties to project file.

Parameters
  • layerNode (QDomNode) –

  • doc (QDomDocument) –

writeLayerXml(self, layerElement: QDomElement, document: QDomDocument, context: QgsReadWriteContext) bool

Stores state in DOM node

Parameters
  • layerElement (QDomElement) – is a DOM element corresponding to ``maplayer’’ tag

  • document (QDomDocument) – is a the DOM document being written

  • context (QgsReadWriteContext) – reading context (e.g. for conversion between relative and absolute paths)

note

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

This, in turn, calls writeXml() (and then writeSymbology), which is over-rideable by sub-classes so that they can write their own specific state to the given DOM node.

Invoked by QgsProject.write().

Return type

bool

Returns

True if successful

writeStyle(self, node: QDomNode, doc: QDomDocument, errorMessage: str, context: QgsReadWriteContext, categories: Union[QgsMapLayer.StyleCategories, QgsMapLayer.StyleCategory] = QgsMapLayer.AllStyleCategories) bool

Write just the symbology information for the layer into the document

Parameters
  • node (QDomNode) – the node that will have the style element added to it.

  • doc (QDomDocument) – the document that will have the QDomNode added.

  • errorMessage (str) – reference to string that will be updated with any error messages

  • context (QgsReadWriteContext) – writing context (used for transform from absolute to relative paths)

  • categories (Union[QgsMapLayer.StyleCategories) – the style categories to be written

Return type

bool

Returns

True in case of success.

Note

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

Note

There is a confusion of terms with the GUI. This method actually writes what is known as the symbology in the application.

New in version 2.16.

writeStyleManager(self, layerNode: QDomNode, doc: QDomDocument)

Write style manager’s configuration (if exists). To be called by subclasses.

Parameters
  • layerNode (QDomNode) –

  • doc (QDomDocument) –

writeSymbology(self, node: QDomNode, doc: QDomDocument, errorMessage: str, context: QgsReadWriteContext, categories: Union[QgsMapLayer.StyleCategories, QgsMapLayer.StyleCategory] = QgsMapLayer.AllStyleCategories) bool

Write the style for the layer into the document provided.

Parameters
  • node (QDomNode) – the node that will have the style element added to it.

  • doc (QDomDocument) – the document that will have the QDomNode added.

  • errorMessage (str) – reference to string that will be updated with any error messages

  • context (QgsReadWriteContext) – writing context (used for transform from absolute to relative paths)

  • categories (Union[QgsMapLayer.StyleCategories) – the style categories to be written

Note

There is a confusion of terms with the GUI. This method actually writes what is called a style in the application.

Return type

bool

Returns

True in case of success.

writeXml(self, layer_node: QDomNode, document: QDomDocument, context: QgsReadWriteContext) bool

Called by writeLayerXML(), used by children to write state specific to them to project files.

Parameters
Return type

bool