QGIS API Documentation  2.18.21-Las Palmas (9fba24a)
Public Member Functions | Public Attributes | List of all members
QgsVectorFileWriter::SaveVectorOptions Class Reference

Options to pass to writeAsVectorFormat() More...

#include <qgsvectorfilewriter.h>

Public Member Functions

 SaveVectorOptions ()
 Constructor. More...
 
virtual ~SaveVectorOptions ()
 Destructor. More...
 

Public Attributes

ActionOnExistingFile actionOnExistingFile
 Action on existing file. More...
 
QgsAttributeList attributes
 Attributes to export (empty means all unless skipAttributeCreation is set) More...
 
const QgsCoordinateTransformct
 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...
 
FieldValueConverterfieldValueConverter
 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
 Set to true to force creation of multi* geometries. More...
 
bool includeZ
 Set to true to include z dimension in output. More...
 
QString layerName
 Layer name. More...
 
QStringList layerOptions
 List of OGR layer creation options. More...
 
bool onlySelectedFeatures
 Write only selected features of layer. More...
 
QgsWKBTypes::Type overrideGeometryType
 Set to a valid geometry type to override the default geometry type for the layer. More...
 
bool skipAttributeCreation
 Only write geometries. More...
 
SymbologyExport symbologyExport
 Symbology to export. More...
 
double symbologyScale
 Scale of symbology. More...
 

Detailed Description

Options to pass to writeAsVectorFormat()

Note
Added in QGIS 2.18

Definition at line 333 of file qgsvectorfilewriter.h.

Constructor & Destructor Documentation

◆ SaveVectorOptions()

QgsVectorFileWriter::SaveVectorOptions::SaveVectorOptions ( )

Constructor.

Definition at line 2375 of file qgsvectorfilewriter.cpp.

◆ ~SaveVectorOptions()

QgsVectorFileWriter::SaveVectorOptions::~SaveVectorOptions ( )
virtual

Destructor.

Definition at line 2395 of file qgsvectorfilewriter.cpp.

Member Data Documentation

◆ actionOnExistingFile

ActionOnExistingFile QgsVectorFileWriter::SaveVectorOptions::actionOnExistingFile

Action on existing file.

Definition at line 349 of file qgsvectorfilewriter.h.

◆ attributes

QgsAttributeList QgsVectorFileWriter::SaveVectorOptions::attributes

Attributes to export (empty means all unless skipAttributeCreation is set)

Definition at line 371 of file qgsvectorfilewriter.h.

◆ ct

const QgsCoordinateTransform* QgsVectorFileWriter::SaveVectorOptions::ct

Transform to reproject exported geometries with, or invalid transform for no transformation.

Definition at line 356 of file qgsvectorfilewriter.h.

◆ datasourceOptions

QStringList QgsVectorFileWriter::SaveVectorOptions::datasourceOptions

List of OGR data source creation options.

Definition at line 362 of file qgsvectorfilewriter.h.

◆ driverName

QString QgsVectorFileWriter::SaveVectorOptions::driverName

OGR driver to use.

Definition at line 343 of file qgsvectorfilewriter.h.

◆ fieldValueConverter

FieldValueConverter* QgsVectorFileWriter::SaveVectorOptions::fieldValueConverter

Field value converter.

Definition at line 393 of file qgsvectorfilewriter.h.

◆ fileEncoding

QString QgsVectorFileWriter::SaveVectorOptions::fileEncoding

Encoding to use.

Definition at line 352 of file qgsvectorfilewriter.h.

◆ filterExtent

QgsRectangle QgsVectorFileWriter::SaveVectorOptions::filterExtent

If not empty, only features intersecting the extent will be saved.

Definition at line 380 of file qgsvectorfilewriter.h.

◆ forceMulti

bool QgsVectorFileWriter::SaveVectorOptions::forceMulti

Set to true to force creation of multi* geometries.

Definition at line 387 of file qgsvectorfilewriter.h.

◆ includeZ

bool QgsVectorFileWriter::SaveVectorOptions::includeZ

Set to true to include z dimension in output.

This option is only valid if overrideGeometryType is set

Definition at line 390 of file qgsvectorfilewriter.h.

◆ layerName

QString QgsVectorFileWriter::SaveVectorOptions::layerName

Layer name.

If let empty, it will be derived from the filename

Definition at line 346 of file qgsvectorfilewriter.h.

◆ layerOptions

QStringList QgsVectorFileWriter::SaveVectorOptions::layerOptions

List of OGR layer creation options.

Definition at line 365 of file qgsvectorfilewriter.h.

◆ onlySelectedFeatures

bool QgsVectorFileWriter::SaveVectorOptions::onlySelectedFeatures

Write only selected features of layer.

Definition at line 359 of file qgsvectorfilewriter.h.

◆ overrideGeometryType

QgsWKBTypes::Type QgsVectorFileWriter::SaveVectorOptions::overrideGeometryType

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 384 of file qgsvectorfilewriter.h.

◆ skipAttributeCreation

bool QgsVectorFileWriter::SaveVectorOptions::skipAttributeCreation

Only write geometries.

Definition at line 368 of file qgsvectorfilewriter.h.

◆ symbologyExport

SymbologyExport QgsVectorFileWriter::SaveVectorOptions::symbologyExport

Symbology to export.

Definition at line 374 of file qgsvectorfilewriter.h.

◆ symbologyScale

double QgsVectorFileWriter::SaveVectorOptions::symbologyScale

Scale of symbology.

Definition at line 377 of file qgsvectorfilewriter.h.


The documentation for this class was generated from the following files: