|
QGIS API Documentation 3.28.0-Firenze (ed3ad0430f)
|
Options to pass to writeAsVectorFormat() More...
#include <qgsvectorfilewriter.h>
Public Member Functions | |
| SaveVectorOptions () | |
| Constructor. More... | |
| virtual | ~SaveVectorOptions ()=default |
Public Attributes | |
| QgsVectorFileWriter::ActionOnExistingFile | actionOnExistingFile = CreateOrOverwriteFile |
| Action on existing file. More... | |
| QgsAttributeList | attributes |
| Attributes to export (empty means all unless skipAttributeCreation is set) More... | |
| QStringList | attributesExportNames |
| Attributes export names. More... | |
| QgsCoordinateTransform | ct |
| Transform to reproject exported geometries with, or invalid transform for no transformation. More... | |
| QStringList | datasourceOptions |
| List of OGR data source creation options. More... | |
| QString | driverName |
| OGR driver to use. More... | |
| QgsFeedback * | feedback = nullptr |
| Optional feedback object allowing cancellation of layer save. More... | |
| FieldNameSource | fieldNameSource = Original |
| Source for exported field names. More... | |
| QgsVectorFileWriter::FieldValueConverter * | fieldValueConverter = nullptr |
| Field value converter. More... | |
| QString | fileEncoding |
| Encoding to use. More... | |
| QgsRectangle | filterExtent |
| If not empty, only features intersecting the extent will be saved. More... | |
| bool | forceMulti = false |
Sets to true to force creation of multi* geometries. More... | |
| bool | includeZ = false |
Sets to true to include z dimension in output. This option is only valid if overrideGeometryType is set. More... | |
| QgsLayerMetadata | layerMetadata |
| Layer metadata to save for the exported vector file. More... | |
| QString | layerName |
| Layer name. If let empty, it will be derived from the filename. More... | |
| QStringList | layerOptions |
| List of OGR layer creation options. More... | |
| bool | onlySelectedFeatures = false |
| Write only selected features of layer. More... | |
| QgsWkbTypes::Type | overrideGeometryType = QgsWkbTypes::Unknown |
| Set to a valid geometry type to override the default geometry type for the layer. More... | |
| bool | saveMetadata = false |
Set to true to save layer metadata for the exported vector file. More... | |
| bool | skipAttributeCreation = false |
| Only write geometries. More... | |
| QgsVectorFileWriter::SymbologyExport | symbologyExport = NoSymbology |
| Symbology to export. More... | |
| double | symbologyScale = 1.0 |
| Scale of symbology. More... | |
Options to pass to writeAsVectorFormat()
Definition at line 458 of file qgsvectorfilewriter.h.
| QgsVectorFileWriter::SaveVectorOptions::SaveVectorOptions | ( | ) |
Constructor.
Definition at line 2997 of file qgsvectorfilewriter.cpp.
|
virtualdefault |
| QgsVectorFileWriter::ActionOnExistingFile QgsVectorFileWriter::SaveVectorOptions::actionOnExistingFile = CreateOrOverwriteFile |
Action on existing file.
Definition at line 473 of file qgsvectorfilewriter.h.
| QgsAttributeList QgsVectorFileWriter::SaveVectorOptions::attributes |
Attributes to export (empty means all unless skipAttributeCreation is set)
Definition at line 497 of file qgsvectorfilewriter.h.
| QStringList QgsVectorFileWriter::SaveVectorOptions::attributesExportNames |
Attributes export names.
Definition at line 500 of file qgsvectorfilewriter.h.
| QgsCoordinateTransform QgsVectorFileWriter::SaveVectorOptions::ct |
Transform to reproject exported geometries with, or invalid transform for no transformation.
Definition at line 482 of file qgsvectorfilewriter.h.
| QStringList QgsVectorFileWriter::SaveVectorOptions::datasourceOptions |
List of OGR data source creation options.
Definition at line 488 of file qgsvectorfilewriter.h.
| QString QgsVectorFileWriter::SaveVectorOptions::driverName |
OGR driver to use.
Definition at line 467 of file qgsvectorfilewriter.h.
| QgsFeedback* QgsVectorFileWriter::SaveVectorOptions::feedback = nullptr |
Optional feedback object allowing cancellation of layer save.
Definition at line 532 of file qgsvectorfilewriter.h.
| FieldNameSource QgsVectorFileWriter::SaveVectorOptions::fieldNameSource = Original |
Source for exported field names.
Definition at line 539 of file qgsvectorfilewriter.h.
| QgsVectorFileWriter::FieldValueConverter* QgsVectorFileWriter::SaveVectorOptions::fieldValueConverter = nullptr |
Field value converter.
Ownership is not transferred and callers must ensure that the lifetime of fieldValueConverter exceeds the lifetime of the QgsVectorFileWriter object.
Definition at line 529 of file qgsvectorfilewriter.h.
| QString QgsVectorFileWriter::SaveVectorOptions::fileEncoding |
Encoding to use.
Definition at line 476 of file qgsvectorfilewriter.h.
| QgsRectangle QgsVectorFileWriter::SaveVectorOptions::filterExtent |
If not empty, only features intersecting the extent will be saved.
Definition at line 509 of file qgsvectorfilewriter.h.
| bool QgsVectorFileWriter::SaveVectorOptions::forceMulti = false |
Sets to true to force creation of multi* geometries.
Definition at line 518 of file qgsvectorfilewriter.h.
| bool QgsVectorFileWriter::SaveVectorOptions::includeZ = false |
Sets to true to include z dimension in output. This option is only valid if overrideGeometryType is set.
Definition at line 521 of file qgsvectorfilewriter.h.
| QgsLayerMetadata QgsVectorFileWriter::SaveVectorOptions::layerMetadata |
Layer metadata to save for the exported vector file.
This will only be used if saveMetadata is true.
Definition at line 555 of file qgsvectorfilewriter.h.
| QString QgsVectorFileWriter::SaveVectorOptions::layerName |
Layer name. If let empty, it will be derived from the filename.
Definition at line 470 of file qgsvectorfilewriter.h.
| QStringList QgsVectorFileWriter::SaveVectorOptions::layerOptions |
List of OGR layer creation options.
Definition at line 491 of file qgsvectorfilewriter.h.
| bool QgsVectorFileWriter::SaveVectorOptions::onlySelectedFeatures = false |
Write only selected features of layer.
Definition at line 485 of file qgsvectorfilewriter.h.
| QgsWkbTypes::Type QgsVectorFileWriter::SaveVectorOptions::overrideGeometryType = QgsWkbTypes::Unknown |
Set to a valid geometry type to override the default geometry type for the layer.
This parameter allows for conversion of geometryless tables to null geometries, etc.
Definition at line 515 of file qgsvectorfilewriter.h.
| bool QgsVectorFileWriter::SaveVectorOptions::saveMetadata = false |
Set to true to save layer metadata for the exported vector file.
Definition at line 547 of file qgsvectorfilewriter.h.
| bool QgsVectorFileWriter::SaveVectorOptions::skipAttributeCreation = false |
Only write geometries.
Definition at line 494 of file qgsvectorfilewriter.h.
| QgsVectorFileWriter::SymbologyExport QgsVectorFileWriter::SaveVectorOptions::symbologyExport = NoSymbology |
Symbology to export.
Definition at line 503 of file qgsvectorfilewriter.h.
| double QgsVectorFileWriter::SaveVectorOptions::symbologyScale = 1.0 |
Scale of symbology.
Definition at line 506 of file qgsvectorfilewriter.h.
1.9.4