QGIS API Documentation  3.9.0-Master (04f0879ed5)
Public Member Functions | Public Attributes | List of all members
QgsVectorLayer::LayerOptions Struct Reference

Setting options for loading vector layers. More...

#include <qgsvectorlayer.h>

Public Member Functions

 LayerOptions (bool loadDefaultStyle=true, bool readExtentFromXml=false)
 Constructor for LayerOptions. More...
 
 LayerOptions (const QgsCoordinateTransformContext &transformContext, bool loadDefaultStyle=true, bool readExtentFromXml=false)
 Constructor for LayerOptions. More...
 

Public Attributes

QgsCoordinateReferenceSystem fallbackCrs
 Fallback layer coordinate reference system. More...
 
QgsWkbTypes::Type fallbackWkbType = QgsWkbTypes::Unknown
 Fallback geometry type. More...
 
bool loadDefaultStyle = true
 Set to true if the default layer style should be loaded. More...
 
bool readExtentFromXml = false
 If true, the layer extent will be read from XML (i.e. More...
 
QgsCoordinateTransformContext transformContext = QgsCoordinateTransformContext()
 Coordinate transform context. More...
 

Detailed Description

Setting options for loading vector layers.

Since
QGIS 3.0

Definition at line 401 of file qgsvectorlayer.h.

Constructor & Destructor Documentation

◆ LayerOptions() [1/2]

QgsVectorLayer::LayerOptions::LayerOptions ( bool  loadDefaultStyle = true,
bool  readExtentFromXml = false 
)
inlineexplicit

Constructor for LayerOptions.

Definition at line 407 of file qgsvectorlayer.h.

◆ LayerOptions() [2/2]

QgsVectorLayer::LayerOptions::LayerOptions ( const QgsCoordinateTransformContext transformContext,
bool  loadDefaultStyle = true,
bool  readExtentFromXml = false 
)
inlineexplicit

Constructor for LayerOptions.

Since
QGIS 3.8

Definition at line 417 of file qgsvectorlayer.h.

Member Data Documentation

◆ fallbackCrs

QgsCoordinateReferenceSystem QgsVectorLayer::LayerOptions::fallbackCrs

Fallback layer coordinate reference system.

This may be set for layers where the coordinate reference system is known in advance, and where the layer path may not be initially resolvable. (E.g. layers with a URI pointing to a non-existent file). It is only ever used if the layer cannot be resolved, otherwise the actual layer CRS will be detected and used for the layer.

See also
fallbackWkbType
Since
QGIS 3.8

Definition at line 465 of file qgsvectorlayer.h.

◆ fallbackWkbType

QgsWkbTypes::Type QgsVectorLayer::LayerOptions::fallbackWkbType = QgsWkbTypes::Unknown

Fallback geometry type.

This may be set for layers where the geometry type is known in advance, and where the layer path may not be initially resolvable. (E.g. layers with a URI pointing to a non-existent file). It is only ever used if the layer cannot be resolved, otherwise the actual layer geometry type will be detected and used for the layer.

See also
fallbackCrs
Since
QGIS 3.8

Definition at line 452 of file qgsvectorlayer.h.

◆ loadDefaultStyle

bool QgsVectorLayer::LayerOptions::loadDefaultStyle = true

Set to true if the default layer style should be loaded.

Definition at line 427 of file qgsvectorlayer.h.

◆ readExtentFromXml

bool QgsVectorLayer::LayerOptions::readExtentFromXml = false

If true, the layer extent will be read from XML (i.e.

stored in the project file). If false, the extent will be determined by the provider on layer load.

Definition at line 433 of file qgsvectorlayer.h.

◆ transformContext

QgsCoordinateTransformContext QgsVectorLayer::LayerOptions::transformContext = QgsCoordinateTransformContext()

Coordinate transform context.

Since
QGIS 3.8

Definition at line 439 of file qgsvectorlayer.h.


The documentation for this struct was generated from the following file: