QGIS API Documentation  3.9.0-Master (2406837650)
Classes | Public Types | Public Member Functions | Static Public Member Functions | List of all members
QgsVectorLayerServerProperties Class Reference

Manages QGIS Server properties for a vector layer. More...

#include <qgsvectorlayerserverproperties.h>

Classes

struct  WmsDimensionInfo
 Setting to define QGIS Server WMS Dimension. More...
 

Public Types

enum  PredefinedWmsDimensionName { TIME, ELEVATION }
 Predefined/Restricted WMS Dimension name. More...
 

Public Member Functions

 QgsVectorLayerServerProperties (QgsVectorLayer *layer=nullptr)
 Constructor - Creates a Vector Layer QGIS Server Properties. More...
 
bool addWmsDimension (const QgsVectorLayerServerProperties::WmsDimensionInfo &wmsDimInfo)
 Adds a QGIS Server WMS Dimension. More...
 
void readXml (const QDomNode &layer_node)
 Reads server properties from project file. More...
 
bool removeWmsDimension (const QString &wmsDimName)
 Removes a QGIS Server WMS Dimension. More...
 
const QList< QgsVectorLayerServerProperties::WmsDimensionInfowmsDimensions () const
 Returns the QGIS Server WMS Dimension list. More...
 
void writeXml (QDomNode &layer_node, QDomDocument &document) const
 Saves server properties to xml under the layer node. More...
 

Static Public Member Functions

static QMap< int, QString > wmsDimensionDefaultDisplayLabels ()
 Returns WMS Dimension default display labels. More...
 

Detailed Description

Manages QGIS Server properties for a vector layer.

Since
QGIS 3.10

Definition at line 38 of file qgsvectorlayerserverproperties.h.

Member Enumeration Documentation

◆ PredefinedWmsDimensionName

Predefined/Restricted WMS Dimension name.

Since
QGIS 3.10
Enumerator
TIME 
ELEVATION 

Definition at line 48 of file qgsvectorlayerserverproperties.h.

Constructor & Destructor Documentation

◆ QgsVectorLayerServerProperties()

QgsVectorLayerServerProperties::QgsVectorLayerServerProperties ( QgsVectorLayer layer = nullptr)

Constructor - Creates a Vector Layer QGIS Server Properties.

Parameters
layerThe vector layer

Definition at line 23 of file qgsvectorlayerserverproperties.cpp.

Member Function Documentation

◆ addWmsDimension()

bool QgsVectorLayerServerProperties::addWmsDimension ( const QgsVectorLayerServerProperties::WmsDimensionInfo wmsDimInfo)

Adds a QGIS Server WMS Dimension.

Parameters
wmsDimInfoQGIS Server WMS Dimension object with, name, field, etc
Returns
true if QGIS Server WMS Dimension has been successfully added
Since
QGIS 3.10

Definition at line 38 of file qgsvectorlayerserverproperties.cpp.

◆ readXml()

void QgsVectorLayerServerProperties::readXml ( const QDomNode &  layer_node)

Reads server properties from project file.

Since
QGIS 3.10

Definition at line 69 of file qgsvectorlayerserverproperties.cpp.

◆ removeWmsDimension()

bool QgsVectorLayerServerProperties::removeWmsDimension ( const QString &  wmsDimName)

Removes a QGIS Server WMS Dimension.

Returns
true if QGIS Server WMS Dimension was found and successfully removed
Since
QGIS 3.10

Definition at line 51 of file qgsvectorlayerserverproperties.cpp.

◆ wmsDimensionDefaultDisplayLabels()

QMap< int, QString > QgsVectorLayerServerProperties::wmsDimensionDefaultDisplayLabels ( )
static

Returns WMS Dimension default display labels.

Since
QGIS 3.10

Definition at line 28 of file qgsvectorlayerserverproperties.cpp.

◆ wmsDimensions()

const QList< QgsVectorLayerServerProperties::WmsDimensionInfo > QgsVectorLayerServerProperties::wmsDimensions ( ) const

Returns the QGIS Server WMS Dimension list.

Since
QGIS 3.10

Definition at line 64 of file qgsvectorlayerserverproperties.cpp.

◆ writeXml()

void QgsVectorLayerServerProperties::writeXml ( QDomNode &  layer_node,
QDomDocument &  document 
) const

Saves server properties to xml under the layer node.

Since
QGIS 3.10

Definition at line 114 of file qgsvectorlayerserverproperties.cpp.


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