QGIS Python API

https://qgis.org/pyqgis/master/
Admin
Documentation for the QGIS Python API, which provides access to QGIS functionalities for geospatial...
Tokens:4,401,337
Snippets:36,142
Trust Score:9.9
Update:3 months ago
Show doc for...
Tokens:
Raw
### start

Source: https://qgis.org/pyqgis/master/core/QgsMapRendererJob.html

Starts the rendering job. If rendering is already in progress, this method does nothing.

```APIDOC
## start

### Description
Start the rendering job and immediately return. Does nothing if the rendering is already in progress.

### Method
`start(self)`
```

--------------------------------

### Start Capturing

Source: https://qgis.org/pyqgis/master/gui/QgsMapToolCapture.html

Initiates the capturing process.

```APIDOC
## startCapturing(_self_)

### Description
Start capturing.
```

--------------------------------

### editorWidgetSetup

Source: https://qgis.org/pyqgis/master/gui/QgsEditorWidgetAutoConfPlugin.html

Abstract method that must be implemented by subclasses to provide widget setup configurations for a given field in a vector layer. It returns a QgsEditorWidgetSetup object and an integer score indicating the quality of the setup.

```APIDOC
## editorWidgetSetup

### Description
This abstract method is intended to be implemented by subclasses of `QgsEditorWidgetAutoConfPlugin`. It is responsible for determining and configuring an appropriate widget for a specific field in a vector layer. The method returns a `QgsEditorWidgetSetup` object and an integer score that indicates how well the plugin was able to configure the widget.

### Method Signature
`editorWidgetSetup(_self_, _vl: QgsVectorLayer | None, _fieldName: str | None) -> (QgsEditorWidgetSetup, int)`

### Parameters
*   **vl** (_Optional_[QgsVectorLayer]) - The vector layer for which the widget setup is being determined.
*   **fieldName** (_Optional_[str]) - The name of the field within the vector layer for which the widget setup is being determined.

### Return Value
*   A tuple containing:
    *   `QgsEditorWidgetSetup`: An object representing the configured widget setup.
    *   `int`: An integer score indicating the quality of the setup. Typical scores range from 0 (no match) to 20 (determined from external configuration).
```

--------------------------------

### Get Gradient Start Color

Source: https://qgis.org/pyqgis/master/core/QgsGradientColorRamp.html

Returns the gradient start color.

```python
start_color = gradient_ramp.color1()
```

--------------------------------

### Setup and Initialization

Source: https://qgis.org/pyqgis/master/core/QgsAuthManager.html

Methods for setting up and initializing the authentication manager.

```APIDOC
## registerCoreAuthMethods

### Description
Instantiate and register existing C++ core authentication methods from plugins.

### Method
`registerCoreAuthMethods()`

## setDefaultCertTrustPolicy

### Description
Sets the default certificate trust policy preferred by user.

### Method
`setDefaultCertTrustPolicy(policyId)`

## setup

### Description
Sets up the authentication manager configuration.

### Method
`setup(configPath)`
```

--------------------------------

### setup

Source: https://qgis.org/pyqgis/master/core/QgsAuthManager.html

Sets up the authentication manager configuration with plugin and database paths.

```APIDOC
## setup

### Description
Sets up the authentication manager configuration. This method does not initialize the authentication framework; that is deferred to lazy-initialization when required.

### Method
setup(_self_, _pluginPath: str | None = '', _authDatabasePath: str | None = '')

### Parameters
* **pluginPath** (_Optional_[str] = '') - The path to the plugin.
* **authDatabasePath** (_Optional_[str] = '') - The authentication DB URI (or just the file path for SQLite).

### See Also
`ensureInitialized()`
```

--------------------------------

### Start Time Configuration

Source: https://qgis.org/pyqgis/master/core/QgsVectorLayerTemporalProperties.html

Methods for setting and getting the start time expression or field.

```APIDOC
## startExpression()

### Description
Returns the expression for the start time for the feature’s time spans.

### Return type
str

## setStartExpression(startExpression: str | None)

### Description
Sets the `expression` to use for the start time for the feature’s time spans.

### Parameters
- **startExpression** (Optional[str]): The expression for the start time.

## startField()

### Description
Returns the name of the start datetime field, which contains the start time for the feature’s time spans.

### Return type
str

## setStartField(field: str | None)

### Description
Sets the name of the start datetime `field`, which contains the start time for the feature’s time spans.

### Parameters
- **field** (Optional[str]): The name of the start datetime field.
```

--------------------------------

### Initialize QGIS Server

Source: https://qgis.org/pyqgis/master/server/QgsServer.html

Creates an instance of the QgsServer. This is the starting point for setting up a web service.

```python
server = QgsServer()
```

--------------------------------

### Get Start Elevation

Source: https://qgis.org/pyqgis/master/core/QgsMeshElevationAveragingMethod.html

Returns the start elevation of the averaging range. This value is absolute to the model's datum.

```python
startElevation(self) -> float
```

--------------------------------

### Get Starting Vertical Level

Source: https://qgis.org/pyqgis/master/core/QgsMeshMultiLevelsAveragingMethod.html

Retrieve the index of the starting vertical level for averaging. The indexing is 1-based and depends on the `countedFromTop` setting.

```python
startVerticalLevel() -> int
```

--------------------------------

### QgsLayoutGuide Constructor

Source: https://qgis.org/pyqgis/master/core/QgsLayoutGuide.html

Initializes a new QgsLayoutGuide with a specified orientation, position, and optional page. The layout must be set separately using setLayout() or by adding the guide to a QgsLayoutGuideCollection.

```APIDOC
## __init__

### Description
Constructor for a new guide with the specified `orientation` and initial `position`. A layout must be set by calling `setLayout()` before the guide can be used. Adding the guide to a `QgsLayoutGuideCollection` will automatically set the corresponding layout for you.

### Parameters
* **orientation** (Qt.Orientation) - The orientation of the guide (horizontal or vertical).
* **position** (QgsLayoutMeasurement) - The initial position of the guide.
* **page** (Optional[QgsLayoutItemPage]) - The page the guide is contained within, or None.
```

--------------------------------

### Getting the start height of the averaging range

Source: https://qgis.org/pyqgis/master/core/QgsMeshRelativeHeightAveragingMethod.html

Retrieves the starting depth or height for the averaging range. This value is always less than or equal to the end height.

```python
startHeight() -> float
```

--------------------------------

### init

Source: https://qgis.org/pyqgis/master/core/QgsAuthManager.html

Initializes QCA, prioritizing the qca-ossl plugin and optionally setting up the authentication database.

```APIDOC
## init

### Description
Initializes QCA, prioritizing qca-ossl plugin and optionally setting up the authentication database.

### Parameters
- **pluginPath** (Optional[str] = '') - The plugin path.
- **authDatabasePath** (Optional[str] = '') - The authentication DB path.

### Return Type
bool

### Returns
`True` on success

### Deprecated since version
3.36: Use `setup()` or `ensureInitialized()` instead.
```

--------------------------------

### Constructor

Source: https://qgis.org/pyqgis/master/core/QgsLayoutItemMapAtlasClippingSettings.html

Initializes a new instance of QgsLayoutItemMapAtlasClippingSettings.

```APIDOC
## __init__

### Description
Constructor for QgsLayoutItemMapAtlasClippingSettings, with the specified `map` parent.

### Parameters
* **map** (_Optional_ _[__QgsLayoutItemMap_ _]__= None_)
```

--------------------------------

### QgsSimpleLineCallout offsetFromAnchor Method

Source: https://qgis.org/pyqgis/master/core/QgsSimpleLineCallout.html

Gets the offset distance from the anchor point where the line starts.

```APIDOC
## offsetFromAnchor

### Description
Returns the offset distance from the anchor point at which to start the line.

### Method
offsetFromAnchor

### Return Type
float
```

--------------------------------

### QgsLayoutGuideProxyModel Constructor

Source: https://qgis.org/pyqgis/master/core/QgsLayoutGuideProxyModel.html

Initializes a QgsLayoutGuideProxyModel, filtering guides by orientation and page.

```APIDOC
## __init__

### Description
Constructor for QgsLayoutGuideProxyModel, filtered to guides of the specified `orientation` and `page` only. Page numbers begin at 0.

### Parameters
#### parent (_Optional_ [QObject])
#### orientation (Qt.Orientation)
#### page (int)
```

--------------------------------

### overrunDistance

Source: https://qgis.org/pyqgis/master/core/QgsLabelLineSettings.html

Gets the distance labels are allowed to extend beyond the start or end of line features.

```APIDOC
## overrunDistance

### Description
Returns the distance which labels are allowed to overrun past the start or end of line features.

### Returns
- `float`: The overrun distance.

### See Also
- `setOverrunDistance()`
- `overrunDistanceUnit()`
- `overrunDistanceMapUnitScale()`
```

--------------------------------

### Get Start Fraction of Sigma Averaging Method

Source: https://qgis.org/pyqgis/master/core/QgsMeshSigmaAveragingMethod.html

Retrieves the starting fraction for the sigma averaging method. This value represents the lower bound (closer to the bed) of the averaged portion of the mesh data.

```python
start_fraction = sigma_method.startFraction()
```

--------------------------------

### Constructor

Source: https://qgis.org/pyqgis/master/core/QgsProjectGpsSettings.html

Initializes a new instance of QgsProjectGpsSettings.

```APIDOC
## __init__

### Description
Constructor for QgsProjectGpsSettings with the specified `parent` object.

### Parameters
* **parent** (_Optional_ _[__QObject_ _]__= None_)
```

--------------------------------

### Default Themes Folder

Source: https://qgis.org/pyqgis/master/core/QgsApplication.html

Returns the path to the default themes folder from the installation, serving as a starting point.

```APIDOC
## static defaultThemesFolder()

### Description
Returns the path to default themes folder from install (works as a starting point).

### Returns
- `str`: The path to the default themes folder.
```

--------------------------------

### instance

Source: https://qgis.org/pyqgis/master/core/QgsProject.html

Returns the QgsProject singleton instance.

```APIDOC
## instance

### Description
Returns the `QgsProject` singleton instance.

### Returns
Optional[QgsProject] - The singleton QgsProject instance, or None if not initialized.
```

--------------------------------

### startDownload

Source: https://qgis.org/pyqgis/master/core/QgsFileDownloader.html

Initiates the file download process. This method should be called if `delayStart` was set to `True` during initialization.

```APIDOC
## startDownload

### Description
Called to start the download.
```

--------------------------------

### startItem

Source: https://qgis.org/pyqgis/master/gui/QgsModelArrowItem.html

Gets the graphical item at the start of the arrow. This method returns the QgsModelComponentGraphicItem object representing the source of the arrow.

```APIDOC
## startItem

### Description
Returns the item at the start of the arrow.

### Method
`startItem()`

### Returns
- **Optional[QgsModelComponentGraphicItem]** - The item at the start of the arrow, or None if not set.
```

--------------------------------

### Get Segment Length in QgsAbstractGeometry

Source: https://qgis.org/pyqgis/master/core/QgsAbstractGeometry.html

Calculates the length of a geometry segment starting from a given vertex ID using Cartesian mathematics.

```python
geometry.segmentLength(startVertex=QgsVertexId())
```

--------------------------------

### instance

Source: https://qgis.org/pyqgis/master/core/QgsApplication.html

Returns the singleton instance of the QgsApplication.

```APIDOC
## instance

### Description
Returns the singleton instance of the QgsApplication.

### Method
GET (assumed)

### Endpoint
/qgsapplication/instance

### Response
#### Success Response (200)
- **instance** (QgsApplication) - The singleton instance of QgsApplication.
```

--------------------------------

### QgsApplicationThemeRegistry Constructor

Source: https://qgis.org/pyqgis/master/core/QgsApplicationThemeRegistry.html

Constructs an empty user interface theme registry.

```APIDOC
## __init__

### Description
Constructor for an empty user interface theme registry.

### Parameters
None
```

--------------------------------

### Set Simplification Flags

Source: https://qgis.org/pyqgis/master/core/QgsMapToPixelSimplifier.html

Sets the simplification hints for the vector layer. These flags guide the simplification process, for example, to simplify envelopes.

```python
simplifier.setSimplifyFlags(QgsMapToPixelSimplifier.SimplifyEnvelope)
```

--------------------------------

### Create Database

Source: https://qgis.org/pyqgis/master/core/QgsApplication.html

Initializes the qgis.db database.

```APIDOC
## static createDatabase(_errorMessage_)

### Description
Initialize qgis.db.

### Parameters
- **errorMessage** (_Optional_[`str`]): An optional error message string.

### Returns
- `bool`: True if the database was created successfully, False otherwise.
```

--------------------------------

### Get Elapsed Time of QgsTask

Source: https://qgis.org/pyqgis/master/core/QgsTask.html

Returns the time in milliseconds that has elapsed since the QgsTask commenced. This value is undefined for tasks that have not yet started.

```python
elapsedTime(_self_) → int[source]
```

--------------------------------

### QgsFileDownloader Constructor

Source: https://qgis.org/pyqgis/master/core/QgsFileDownloader.html

Initializes a new QgsFileDownloader instance. The download can start immediately or be delayed. Optional authentication, HTTP method, and POST data can be provided.

```APIDOC
## __init__

### Description
Initializes a new QgsFileDownloader instance. The download can start immediately or be delayed. Optional authentication, HTTP method, and POST data can be provided.

### Parameters
* **url** (_QUrl_) - The download URL.
* **outputFileName** (_Optional[str]_) - File name where the downloaded content will be stored.
* **authcfg** (_Optional[str]_) - Optionally apply this authentication configuration.
* **delayStart** (_bool = False_) - If `True`, the download will not be commenced immediately and must be triggered by a later call to `startDownload()`.
* **httpMethod** (_Qgis.HttpMethod = Qgis.HttpMethod.Get_) - Method for the HTTP request: GET or POST, since QGIS 3.22.
* **data** (_Union[QByteArray, bytes, bytearray, memoryview] = QByteArray()_) - If the request is POST, some data can be added, since QGIS 3.22.
```

--------------------------------

### Getting the end height of the averaging range

Source: https://qgis.org/pyqgis/master/core/QgsMeshRelativeHeightAveragingMethod.html

Retrieves the ending depth or height for the averaging range. This value is always greater than or equal to the start height.

```python
endHeight() -> float
```

--------------------------------

### QgsServerOgcApi Constructor

Source: https://qgis.org/pyqgis/master/server/QgsServerOgcApi.html

Illustrates the initialization of a QgsServerOgcApi object with its server interface, root path, name, description, and version.

```python
QgsServerOgcApi(_serverIface : QgsServerInterface | None_, _rootPath : str | None_, _name : str | None_, _description : str | None = ''_, _version : str | None = ''_)
```

--------------------------------

### Retrieving Triangle Medians

Source: https://qgis.org/pyqgis/master/core/QgsTriangle.html

Shows how to get the three medians of a QgsTriangle, where each median is a QgsLineString from a vertex to the midpoint of the opposite side. Includes an example for an empty triangle.

```python
tri = QgsTriangle( QgsPoint( 0, 0 ), QgsPoint( 0, 5 ), QgsPoint( 5, 5 ) )
[med.asWkt() for med in tri.medians()]
# ['LineString (0 0, 2.5 5)', 'LineString (0 5, 2.5 2.5)', 'LineString (5 5, 0 2.5)']
QgsTriangle().medians()
# []
```

--------------------------------

### Get Map Layer Renderer Flags

Source: https://qgis.org/pyqgis/master/core/QgsMapLayerRenderer.html

Returns flags that control the behavior of the map layer rendering. These flags can modify how the layer is rendered, for example, by forcing rasterization.

```python
flags(_self_) → Qgis.MapLayerRendererFlag[source]
```

--------------------------------

### Initialize QgsDataProvider

Source: https://qgis.org/pyqgis/master/core/QgsDataProvider.html

Create a new data provider instance with a specified URI and optional provider options and creation flags. The URI specifies the data source, while options and flags can customize the provider's behavior.

```python
provider = QgsDataProvider(uri='path/to/data', providerOptions=QgsDataProvider.ProviderOptions(), flags=Qgis.DataProviderReadFlags())
```

--------------------------------

### Get Unique Values from Field

Source: https://qgis.org/pyqgis/master/core/QgsVectorLayerUtils.html

Fetches all unique values from a specified field name or expression. This is useful for creating lists of distinct values, for example, in combo boxes or for analysis.

```python
QgsVectorLayerUtils.uniqueValues(layer, field)
```

--------------------------------

### Constructor

Source: https://qgis.org/pyqgis/master/gui/QgsPresetColorRampDialog.html

Initializes a new instance of the QgsPresetColorRampDialog class.

```APIDOC
## __init__

### Description
Constructor for QgsPresetColorRampDialog.

### Parameters
* **ramp** (QgsPresetSchemeColorRamp) - initial ramp to show in dialog
* **parent** (Optional[QWidget]) - parent widget
```

--------------------------------

### Get QML Import Path

Source: https://qgis.org/pyqgis/master/core/QgsApplication.html

Retrieves the installation path for QML components used by the QGIS Quick library. Returns an empty string if QGIS was built without Quick support.

```python
QgsApplication.qmlImportPath()
```

--------------------------------

### Getting Triangle Side Lengths

Source: https://qgis.org/pyqgis/master/core/QgsTriangle.html

Shows how to retrieve the lengths of the three sides of a QgsTriangle. The lengths are returned in a list, corresponding to sides AB, BC, and CA. Includes an example for an empty triangle.

```python
tri = QgsTriangle( QgsPoint( 0, 0 ), QgsPoint( 0, 5 ), QgsPoint( 5, 5 ) )
tri.lengths()
# [5.0, 5.0, 7.0710678118654755]
QgsTriangle().lengths()
# []
```

--------------------------------

### Constructor

Source: https://qgis.org/pyqgis/master/gui/QgsSensorAbstractGuiMetadata.html

Initializes a new instance of the QgsSensorAbstractGuiMetadata class.

```APIDOC
class qgis.gui.QgsSensorAbstractGuiMetadata:
    __init__(self, _type: str | None = None, _visibleName: str | None = None)
    __init__(self, a0: QgsSensorAbstractGuiMetadata)

    Constructor for QgsSensorAbstractGuiMetadata with the specified class `type`.
    `visibleName` should be set to a translated, user visible name identifying the corresponding sensor type.

    Parameters:
        type (Optional[str]): The unique type code for the sensor class.
        visibleName (Optional[str]): A translated, user visible name identifying the corresponding sensor type.
        a0 (QgsSensorAbstractGuiMetadata): Another QgsSensorAbstractGuiMetadata object to copy.
```

--------------------------------

### QgsSettingsEntryBaseTemplateQColorBase Constructors

Source: https://qgis.org/pyqgis/master/core/QgsSettingsEntryBaseTemplateQColorBase.html

Provides constructors for initializing QgsSettingsEntryBaseTemplateQColorBase objects with various parameters including name, parent, default value, description, and options.

```APIDOC
## Constructors

### `__init__`

**Overload 1:**
```python
__init__(_name: str | None, _parent: QgsSettingsTreeNode | None, _defaultValue: Any, _description: str | None = '', _options: Qgis.SettingsOption = Qgis.SettingsOptions())
```
Constructor for `QgsSettingsEntryByReference`.

Parameters:
* **name** (_Optional_ _[__str_ _]_) – specifies the key of the settings.
* **parent** (_Optional_ _[__QgsSettingsTreeNode_ _]_) – specifies the parent in the tree of settings.
* **defaultValue** (_Any_) – specifies the default value for the settings entry.
* **description** (_Optional_ _[__str_ _]__= ''_) – specifies a description for the settings entry.
* **options** (_Qgis.SettingsOption = Qgis.SettingsOptions_ _(__)_) – specifies the options for the settings entry.

Raises:
**QgsSettingsException** – if the number of given parent named items doesn’t match the complete key definition
Added in version 3.30.

**Overload 2:**
```python
__init__(_key: str | None, _section: str | None, _defaultValue: Any, _description: str | None = '', _options: Qgis.SettingsOption = Qgis.SettingsOptions())
```
Constructor for `QgsSettingsEntryByReference`.

Parameters:
* **key** (_Optional_ _[__str_ _]_) – specifies the key of the settings.
* **section** (_Optional_ _[__str_ _]_) – specifies the section.
* **defaultValue** (_Any_) – specifies the default value for the settings entry.
* **description** (_Optional_ _[__str_ _]__= ''_) – specifies a description for the settings entry.
* **options** (_Qgis.SettingsOption = Qgis.SettingsOptions_ _(__)_) – specifies the options for the settings entry.

**Overload 3:**
```python
__init__(_a0: QgsSettingsEntryBaseTemplateQColorBase_)
```
Parameters:
**a0** (_QgsSettingsEntryBaseTemplateQColorBase_)

```

--------------------------------

### guides

Source: https://qgis.org/pyqgis/master/core/QgsLayoutPageCollection.html

Returns a reference to the collection's guide collection, which manages page snap guides.

```APIDOC
## guides

### Description
Returns a reference to the collection's guide collection, which manages page snap guides.

### Returns
* **QgsLayoutGuideCollection** - A reference to the guide collection.
```

--------------------------------

### __init__

Source: https://qgis.org/pyqgis/master/core/QgsProjectStoredObjectManagerBase.html

Constructor for QgsProjectStoredObjectManagerBase, for objects attached to the specified project.

```APIDOC
## __init__ __init__(self, project: QgsProject | None = None)

### Description
Constructor for QgsProjectStoredObjectManagerBase, for objects attached to the specified `project`.

### Parameters
#### Path Parameters
* **project** (QgsProject | None) - Optional - The QgsProject to attach the manager to. Defaults to None.
```

--------------------------------

### Set Gradient Start Color

Source: https://qgis.org/pyqgis/master/core/QgsGradientColorRamp.html

Sets the gradient start color.

```python
gradient_ramp.setColor1(QColor("red"))
```

--------------------------------

### Grid and Guide Settings

Source: https://qgis.org/pyqgis/master/core/QgsLayout.html

Accesses the layout's grid and guide settings.

```APIDOC
## gridSettings

### Description
Returns a reference to the layout’s grid settings, which stores settings relating to grid appearance, spacing and offsets.

### Method
`gridSettings(self) -> QgsLayoutGridSettings`

### Returns
QgsLayoutGridSettings

## guides

### Description
Returns a reference to the layout’s guide collection, which manages page snap guides.

### Method
`guides(self) -> QgsLayoutGuideCollection`

### Returns
QgsLayoutGuideCollection
```

--------------------------------

### Constructor: __init__

Source: https://qgis.org/pyqgis/master/gui/QgsOWSSourceSelect.html

Initializes a new instance of the QgsOWSSourceSelect dialog.

```APIDOC
## __init__

### Description
Initializes a new instance of the QgsOWSSourceSelect dialog.

### Parameters
* **service** (_Optional_ _[__str_ _]_) - The service string.
* **parent** (_Optional_ _[__QWidget_ _]__= None_) - The parent widget.
* **fl** (_Qt.WindowType = QgsGuiUtils.ModalDialogFlags_) - Window flags.
* **widgetMode** (_QgsProviderRegistry.WidgetMode = QgsProviderRegistry.WidgetMode.Standalone_) - The widget mode.
```

--------------------------------

### QgsMapLayerStore Constructor

Source: https://qgis.org/pyqgis/master/core/QgsMapLayerStore.html

Initializes a new instance of the QgsMapLayerStore class.

```APIDOC
## __init__

### Description
Constructor for QgsMapLayerStore.

### Parameters
* **parent** (QObject | None) - Optional parent object.
```

--------------------------------

### get

Source: https://qgis.org/pyqgis/master/core/QgsBlockingNetworkRequest.html

Performs a GET operation on the specified request, with options for caching, feedback, and request flags.

```APIDOC
## get

### Description
Performs a “get” operation on the specified `request`. If `forceRefresh` is `False` then previously cached replies may be used for the request. If it is set to `True` then a new query is always performed. If an `authCfg()` has been set, then any authentication configuration required will automatically be applied to `request`. The optional `feedback` argument can be used to abort ongoing requests. The optional `requestFlags` argument can be used to modify the behavior.

### Parameters
#### Path Parameters
* None
#### Query Parameters
* **request** (QNetworkRequest) - The network request to perform.
* **forceRefresh** (bool) - If True, forces a new query instead of using cached replies. Defaults to False.
* **feedback** (Optional[QgsFeedback]) - An optional feedback object to abort ongoing requests. Defaults to None.
* **requestFlags** (QgsBlockingNetworkRequest.RequestFlag) - Optional flags to modify the behavior of the request. Defaults to QgsBlockingNetworkRequest.RequestFlags().

### Returns
- QgsBlockingNetworkRequest.ErrorCode: NoError if the operation was successful, otherwise a specific ErrorCode.

### See Also
`post()`
```

--------------------------------

### QgsProviderRegistry.pluginList()

Source: https://qgis.org/pyqgis/master/core/QgsProviderRegistry.html

Returns a list of available provider plugins, optionally formatted as HTML.

```APIDOC
## QgsProviderRegistry.pluginList()

### Description
Returns list of provider plugins found.

### Parameters
* **asHtml** (_bool = False_) - If True, returns the list formatted as HTML.

### Return Type
str - A string containing the list of provider plugins.
```

--------------------------------

### Constructor

Source: https://qgis.org/pyqgis/master/gui/QgsAnnotationItemAbstractGuiMetadata.html

Initializes a new instance of QgsAnnotationItemAbstractGuiMetadata.

```APIDOC
def __init__(self, _type: str | None = None, _visibleName: str | None = None, _groupId: str | None = '', _flags: Qgis.AnnotationItemGuiFlag = Qgis.AnnotationItemGuiFlags()):
    """
    Constructor for QgsAnnotationItemAbstractGuiMetadata with the specified class `type`.
    `visibleName` should be set to a translated, user visible name identifying the corresponding annotation item.
    An optional `groupId` can be set, which allows grouping of related annotation item classes. See `QgsAnnotationItemGuiMetadata` for details.

    Parameters:
        type (Optional[str]): The unique type code for the annotation item class.
        visibleName (Optional[str]): A translated, user-visible name for the annotation item.
        groupId (Optional[str]): An optional group ID for grouping related item classes.
        flags (Qgis.AnnotationItemGuiFlag): Flags controlling the GUI behavior of the annotation item.
    """
    pass

def __init__(self, _a0: QgsAnnotationItemAbstractGuiMetadata):
    """
    Constructor for QgsAnnotationItemAbstractGuiMetadata by copying another instance.

    Parameters:
        a0 (QgsAnnotationItemAbstractGuiMetadata): The instance to copy.
    """
    pass
```

--------------------------------

### setVisible

Source: https://qgis.org/pyqgis/master/core/QgsLayoutGuideCollection.html

Sets whether the guide lines should be visible. This method controls the drawing of guide lines within the layout.

```APIDOC
## setVisible

### Description
Sets whether the guide lines should be visible.

### Method
`setVisible(_self_, visible: bool)`

### Parameters
* **visible** (bool) - Determines if the guide lines are visible.
```

--------------------------------

### QgsConnectionRegistry.__init__

Source: https://qgis.org/pyqgis/master/core/QgsConnectionRegistry.html

Constructor for QgsConnectionRegistry.

```APIDOC
## Method: __init__

### Description
Constructor for QgsConnectionRegistry.

### Parameters
* **parent** (_Optional_ _[__QObject_ _]__= None_)
    The parent object.
```

--------------------------------

### Set Start Color

Source: https://qgis.org/pyqgis/master/gui/QgsGradientColorRampDialog.html

Sets the starting color for the gradient ramp. Accepts QColor, Qt.GlobalColor, or an integer representation.

```python
setColor1(_self_ , _color : QColor | Qt.GlobalColor | int_)
```

--------------------------------

### QgsStacController.__init__

Source: https://qgis.org/pyqgis/master/core/QgsStacController.html

Default constructor for QgsStacController.

```APIDOC
## QgsStacController.__init__

### Description
Default constructor for QgsStacController.

### Method
__init__

### Parameters
None
```

--------------------------------

### startField

Source: https://qgis.org/pyqgis/master/core/QgsVectorDataProviderTemporalCapabilities.html

Returns the name of the start datetime field, which contains the start time for the feature's time spans.

```APIDOC
## startField

### Description
Returns the name of the start datetime field, which contains the start time for the feature's time spans.
If `mode()` is ProviderStoresFeatureDateTimeInstantInField, then this field stores both the start AND end times.

See also `setStartField()`
See also `endField()`

### Return Type
str
```

--------------------------------

### Constructor

Source: https://qgis.org/pyqgis/master/gui/QgsProcessingAlgorithmWidgetBase.html

Initializes a new instance of the QgsProcessingAlgorithmWidgetBase class.

```APIDOC
### __init__ (_self_, _parentWindow : QMainWindow | None_, _mode : QgsProcessingAlgorithmWidgetBase.WidgetMode = QgsProcessingAlgorithmWidgetBase.WidgetMode.Single_, _flags : QgsProcessingAlgorithmWidgetBase.WidgetFlag = QgsProcessingAlgorithmWidgetBase.WidgetFlags()_, _initialState : Qgis.DockableWidgetInitialState = Qgis.DockableWidgetInitialState.RestorePreviousState_)

Constructor for QgsProcessingAlgorithmWidgetBase.

Parameters:
    
  * **parentWindow** (_Optional_ _[__QMainWindow_ _]_) 
  * **mode** (_QgsProcessingAlgorithmWidgetBase.WidgetMode = QgsProcessingAlgorithmWidgetBase.WidgetMode.Single_) 
  * **flags** (_QgsProcessingAlgorithmWidgetBase.WidgetFlag = QgsProcessingAlgorithmWidgetBase.WidgetFlags_ _(__)_) 
  * **initialState** (_Qgis.DockableWidgetInitialState = Qgis.DockableWidgetInitialState.RestorePreviousState_)
```

--------------------------------

### setStartField

Source: https://qgis.org/pyqgis/master/core/QgsVectorDataProviderTemporalCapabilities.html

Sets the name of the start datetime field, which stores the start time for the feature's time spans.

```APIDOC
## setStartField

### Description
Sets the name of the start datetime `field`, which stores the start time for the feature's time spans.
If `mode()` is ModeFeatureDateTimeInstantFromField, then this field stores both the start AND end times.

See also `startField()`
See also `setEndField()`

### Parameters
#### Parameters
- **field** (str | None) - Optional - The name of the start datetime field.
```

--------------------------------

### setReferencePoint1IsCentroid

Source: https://qgis.org/pyqgis/master/core/QgsGradientFillSymbolLayer.html

Sets whether the starting point for the gradient is taken from the feature centroid. If true, the gradient starts from the center of the feature.

```APIDOC
## setReferencePoint1IsCentroid

### Description
Sets whether the starting point for the gradient is taken from the feature centroid.

### Method
`setReferencePoint1IsCentroid(_self_, _isCentroid: bool_)`

### Parameters
* **isCentroid** (_bool_) - True to use the feature centroid as the starting point, false otherwise.
```

--------------------------------

### QgsMeshTerrainSettings Static Methods

Source: https://qgis.org/pyqgis/master/_3d/QgsMeshTerrainSettings.html

Details on static methods for QgsMeshTerrainSettings, specifically the `create` method for instantiating the class.

```APIDOC
## Static Methods

`create() -> QgsAbstractTerrainSettings | None`
    Creates a new instance of a `QgsMeshTerrainSettings` object.
    Return type:
        Optional[QgsAbstractTerrainSettings]
```

--------------------------------

### update

Source: https://qgis.org/pyqgis/master/core/QgsLayoutGuideCollection.html

Updates the position and visibility of all guide line items within the collection. This should be called after any changes to guide positions or visibility settings.

```APIDOC
## update

### Description
Updates the position (and visibility) of all guide line items.

### Method
`update(_self_)
```

--------------------------------

### pluginHelpMenu

Source: https://qgis.org/pyqgis/master/gui/QgisInterface-all-members.html

Returns the plugin help menu.

```APIDOC
## pluginHelpMenu()

### Description
Returns the plugin help menu.

### Method
APIDOC

### Endpoint
APIDOC

### Parameters
APIDOC

### Request Example
APIDOC

### Response
APIDOC

#### Success Response (200)
APIDOC

#### Response Example
APIDOC
```

--------------------------------

### Getting the inscribed radius of a QgsTriangle

Source: https://qgis.org/pyqgis/master/core/QgsTriangle.html

Demonstrates how to get the radius of the inscribed circle for a QgsTriangle. An empty triangle returns a radius of 0.0.

```python
tri = QgsTriangle( QgsPoint( 0, 0 ), QgsPoint( 0, 5 ), QgsPoint( 5, 5 ) )
tri.inscribedRadius()
# 1.4644660940672622
QgsTriangle().inscribedRadius()
# 0.0
```

--------------------------------

### Constructor

Source: https://qgis.org/pyqgis/master/gui/QgsProviderConnectionComboBox.html

Initializes a new instance of the QgsProviderConnectionComboBox class.

```APIDOC
class qgis.gui.QgsProviderConnectionComboBox(provider: str | None = None, parent: QWidget | None = None)

Constructor for QgsProviderConnectionComboBox, for the specified `provider`.
Warning
The provider must support the connection API methods in its `QgsProviderMetadata` implementation in order for the model to work correctly.
```

--------------------------------

### Constructor

Source: https://qgis.org/pyqgis/master/gui/QgsBrowserTreeView.html

Initializes a new instance of the QgsBrowserTreeView class.

```APIDOC
## __init__

### Description
Constructor for QgsBrowserTreeView.

### Parameters
* **parent** (_Optional_[QWidget]) - The parent widget for this view.
```

--------------------------------

### Getting the circumscribed radius of a QgsTriangle

Source: https://qgis.org/pyqgis/master/core/QgsTriangle.html

Demonstrates how to get the radius of the circumscribed circle for a QgsTriangle. An empty triangle returns a radius of 0.0.

```python
tri = QgsTriangle( QgsPoint( 0, 0 ), QgsPoint( 0, 5 ), QgsPoint( 5, 5 ) )
tri.circumscribedRadius()
# 3.5355339059327378
QgsTriangle().circumscribedRadius()
# 0.0
```

--------------------------------

### create

Source: https://qgis.org/pyqgis/master/core/QgsProcessingAlgorithm.html

Creates a copy of the algorithm, ready for execution. Allows passing configuration settings to dynamically adjust initialized parameters and outputs.

```APIDOC
## create(configuration: dict[Optional[str], Any] = {})

### Description
Creates a copy of the algorithm, ready for execution. This method returns a new, preinitialized copy of the algorithm, ready for executing. The `configuration` argument allows passing of a map of configuration settings to the algorithm, allowing it to dynamically adjust its initialized parameters and outputs according to this configuration. This is generally used only for algorithms in a model, allowing them to adjust their behavior at run time according to some user configuration.

### Parameters
* **configuration** (dict[Optional[str], Any]) - A map of configuration settings to the algorithm.

### Return Type
Optional[QgsProcessingAlgorithm]

### Raises
QgsProcessingException: If a new algorithm instance could not be created.
```

--------------------------------

### Get Bounding Box

Source: https://qgis.org/pyqgis/master/core/QgsRenderedItemDetails.html

Retrieves the bounding box of the rendered item in map units. Use this to get the spatial extent of the item.

```python
bbox = details.boundingBox()
```

--------------------------------

### Initialize QgsPageSizeRegistry

Source: https://qgis.org/pyqgis/master/core/QgsPageSizeRegistry.html

Creates a new registry and populates it with predefined page sizes. This is usually done internally by QGIS.

```python
registry = QgsPageSizeRegistry()
```

--------------------------------

### ValueMap Configuration Example

Source: https://qgis.org/pyqgis/master/core/QgsValueMapFieldFormatter.html

This is an example of how to configure a ValueMap for a field. The 'map' key defines the mapping between numerical values and their string representations.

```json
{
  "map": { 1: "one", 2: "two", 3: "three" }
}
```

--------------------------------

### WKT Example for WGS84

Source: https://qgis.org/pyqgis/master/core/QgsCoordinateReferenceSystem.html

Well-Known Text (WKT) is an OGC standard for defining CRS. This example shows the WKT definition for WGS84.

```plaintext
GEOGCS["WGS 84",
       DATUM["WGS_1984",
         SPHEROID["WGS 84",6378137,298.257223563,AUTHORITY["EPSG","7030"]],
         AUTHORITY["EPSG","6326"]],
       PRIMEM["Greenwich",0,AUTHORITY["EPSG","8901"]],
       UNIT["degree",0.0174532925199433,AUTHORITY["EPSG","9122"]],
       AUTHORITY["EPSG","4326"]]
```

--------------------------------

### Initialize QgsProjectFileTransform

Source: https://qgis.org/pyqgis/master/core/QgsProjectFileTransform.html

Creates an instance of QgsProjectFileTransform using a QDomDocument and a specified project version.

```python
QgsProjectFileTransform(_domDocument : QDomDocument_, _version : QgsProjectVersion_)
```

```python
QgsProjectFileTransform(_a0 : QgsProjectFileTransform_)
```

--------------------------------

### PROJ String Example

Source: https://qgis.org/pyqgis/master/core/QgsCoordinateReferenceSystem.html

PROJ strings are used by the underlying proj library to define CRS. This example shows the definition for WGS84.

```plaintext
+proj=longlat +datum=WGS84 +no_defs
```

--------------------------------

### Constructor

Source: https://qgis.org/pyqgis/master/gui/QgsBrowserDockWidget.html

Initializes a new instance of the QgsBrowserDockWidget.

```APIDOC
## __init__

### Description
Constructor for QgsBrowserDockWidget.

### Parameters
* **name** (_Optional_ _[__str_ _]_) – name of the widget
* **browserModel** (_Optional_ _[__QgsBrowserGuiModel_ _]_) – instance of the (shared) browser model
* **parent** (_Optional_ _[__QWidget_ _]__= None_) – parent widget
```

--------------------------------

### Set and Get Orientation

Source: https://qgis.org/pyqgis/master/gui/QgsColorRampWidget.html

Configure the direction of the color ramp. Use `setOrientation()` to set it to `Horizontal` or `Vertical`, and `orientation()` to get the current setting.

```python
widget.setOrientation(QgsColorRampWidget.Vertical)
current_orientation = widget.orientation()
```

--------------------------------

### startUpload

Source: https://qgis.org/pyqgis/master/core/QgsFileUploader.html

Initiates the file upload process. This method should be called if `delayStart` was set to True during initialization.

```APIDOC
## startUpload

### Description
Called to start the upload
```

--------------------------------

### Get Certificate Info Widget

Source: https://qgis.org/pyqgis/master/gui/QgsAuthCertInfoDialog.html

Gets access to the embedded certificate information widget. This widget provides detailed views of the certificate and its trust chain.

```python
info_widget = dialog.certInfoWidget()
```

--------------------------------

### Constructor

Source: https://qgis.org/pyqgis/master/gui/QgsColorBrewerColorRampWidget.html

Initializes a new instance of the QgsColorBrewerColorRampWidget class.

```APIDOC
class qgis.gui.QgsColorBrewerColorRampWidget
__init__(_ramp : QgsColorBrewerColorRamp_, _parent : QWidget | None = None_)

Constructor for QgsColorBrewerColorRampWidget.

Parameters:
    
  * **ramp** (_QgsColorBrewerColorRamp_) – initial ramp to show in dialog
  * **parent** (_Optional_ _[__QWidget_ _]__= None_) – parent widget
```

--------------------------------

### initialize

Source: https://qgis.org/pyqgis/master/core/QgsBookmarkManager.html

Initializes the bookmark manager, typically by specifying a file path for storing bookmarks.

```APIDOC
## initialize

### Description
Initializes the bookmark manager.

### Parameters
* **filePath** (_Optional_ _[__str_ _]_) - The path to the file where bookmarks will be stored or loaded from.
```

--------------------------------

### QgsServerQueryStringParameter Methods

Source: https://qgis.org/pyqgis/master/server/QgsServerQueryStringParameter.html

Provides methods to get and set parameter properties such as description, hidden status, and name, as well as a static method to get the type name.

```APIDOC
## Methods for QgsServerQueryStringParameter

### `description()`
Returns parameter description.

### `hidden()`
Returns `True` if the parameter is hidden from the schema. Hidden parameters can be useful to implement legacy parameters or parameters that can be accepted without being advertised.

### `name()`
Returns the name of the parameter.

### `setDescription(description: str | None)`
Sets validator description.

### `setHidden(hidden: bool)`
Set the parameter’s `hidden` status, parameters are not hidden by default.

### `static typeName(type: QgsServerQueryStringParameter.Type) -> str`
Returns the name of the `type`.
```

--------------------------------

### QgsApplication static method

Source: https://qgis.org/pyqgis/master/genindex.html

Static method to get the endianness of the system.

```APIDOC
## endian()
### Description
Returns the endianness of the system.
### Method
static method
### Class
qgis.core.QgsApplication
```

--------------------------------

### Constructor

Source: https://qgis.org/pyqgis/master/core/QgsLayoutItemMapOverview.html

Initializes a new QgsLayoutItemMapOverview instance.

```APIDOC
class qgis.core.QgsLayoutItemMapOverview
__init__(_name : str | None_, _map : QgsLayoutItemMap | None_)

Constructor for QgsLayoutItemMapOverview.

Parameters:
    
  * **name** (_Optional_ _[__str_ _]_) – friendly display name for overview
  * **map** (_Optional_ _[__QgsLayoutItemMap_ _]_) – `QgsLayoutItemMap` the overview is attached to
```

--------------------------------

### Widget Registration (Checked)

Source: https://qgis.org/pyqgis/master/gui/QgsPropertyOverrideButton.html

Registers a sibling widget that gets checked when the property is active. If `natural` is `False`, the widget gets unchecked when the property is active. This should be called after `init()`.

```APIDOC
### registerCheckedWidget(_self_ , _widget : QWidget | None_, _natural : bool = True_)

Register a sibling `widget` that gets checked when the property is active. if `natural` is `False`, widget gets unchecked when the property is active.
Note
this should be called after calling `init()` to be correctly initialized. 

Parameters:
    
  * **widget** (_Optional_ _[__QWidget_ _]_) 
  * **natural** (_bool = True_)
```

--------------------------------

### QgsOnlineDemTerrainSettings Static Methods

Source: https://qgis.org/pyqgis/master/_3d/QgsOnlineDemTerrainSettings.html

This section details the static methods available for the QgsOnlineDemTerrainSettings class, specifically the `create` method for instantiating the class.

```APIDOC
### Static Methods

`create() -> QgsAbstractTerrainSettings | None`

Creates a new instance of a `QgsOnlineDemTerrainSettings` object.

### Returns

* `Optional[QgsAbstractTerrainSettings]` - A new instance of `QgsOnlineDemTerrainSettings` or None if creation fails.
```

--------------------------------

### Constructor

Source: https://qgis.org/pyqgis/master/core/QgsTiledSceneWireframeRenderer.html

Initializes a new instance of QgsTiledSceneWireframeRenderer.

```APIDOC
## __init__

### Description
Constructor for QgsTiledSceneWireframeRenderer.

### Method
__init__()
```

--------------------------------

### Abstract Method: Start Rubber Band Creation

Source: https://qgis.org/pyqgis/master/gui/QgsLayoutViewRubberBand.html

Called when a rubber band should be initiated at a specific starting position in layout coordinates. Subclasses must implement this to begin the rubber band drawing process.

```python
def start(self, position: QPointF, modifiers: Qt.KeyboardModifier):
```

--------------------------------

### Constructor

Source: https://qgis.org/pyqgis/master/gui/QgsModelGraphicsScene.html

Initializes a new instance of the QgsModelGraphicsScene class.

```APIDOC
## __init__

### Description
Constructor for QgsModelGraphicsScene with the specified `parent` object.

### Parameters
* **parent** (_Optional_ _[__QObject_ _]_) - The parent object.
```

--------------------------------

### SVG with Parameter Replacement Example

Source: https://qgis.org/pyqgis/master/core/QgsSvgCache.html

This example demonstrates how to use parameter replacement within an SVG file for fill color, stroke color, and stroke width. The parameters are defined using the 'param()' syntax.

```html
<circle fill="param(fill-color red)" stroke="param(pen-color black)" stroke-width="param(outline-width 1)"

```

--------------------------------

### panelTitle

Source: https://qgis.org/pyqgis/master/gui/QgsPanelWidget.html

Gets the title of the panel.

```APIDOC
## panelTitle

### Description
The title of the panel.

### Method
panelTitle() → str
```

--------------------------------

### editorWidgetSetup()

Source: https://qgis.org/pyqgis/master/gui/QgsEditorWidgetAutoConfPlugin-all-members.html

This method is part of the QgsEditorWidgetAutoConfPlugin class. It is likely involved in the setup process for editor widgets within the QGIS environment.

```APIDOC
## editorWidgetSetup()

### Description
Sets up the editor widget configuration.

### Method
(Implicitly called by QGIS)

### Parameters
None

### Response
None (modifies internal state or UI)
```
Tokens:
Raw