QGIS API Documentation  3.18.1-Zürich (202f1bf7e5)
Public Types | Public Member Functions | Public Attributes | List of all members
QgsVectorLayerServerProperties::WmsDimensionInfo Struct Reference

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

#include <qgsvectorlayerserverproperties.h>

Public Types

enum  DefaultDisplay { AllValues = 0 , MinValue = 1 , MaxValue = 2 , ReferenceValue = 3 }
 Selection behavior for QGIS Server WMS Dimension default display. More...
 

Public Member Functions

 WmsDimensionInfo (const QString &dimName, const QString &dimFieldName, const QString &dimEndFieldName=QString(), const QString &dimUnits=QString(), const QString &dimUnitSymbol=QString(), const int &dimDefaultDisplayType=QgsVectorLayerServerProperties::WmsDimensionInfo::AllValues, const QVariant &dimReferenceValue=QVariant())
 Constructor for WmsDimensionInfo. More...
 

Public Attributes

int defaultDisplayType
 
QString endFieldName
 
QString fieldName
 
QString name
 
QVariant referenceValue
 
QString units
 
QString unitSymbol
 

Detailed Description

Setting to define QGIS Server WMS Dimension.

Since
QGIS 3.10

Definition at line 60 of file qgsvectorlayerserverproperties.h.

Member Enumeration Documentation

◆ DefaultDisplay

Selection behavior for QGIS Server WMS Dimension default display.

Since
QGIS 3.10
Enumerator
AllValues 

Display all values of the dimension.

MinValue 

Add selection to current selection.

MaxValue 

Modify current selection to include only select features which match.

ReferenceValue 

Remove from current selection.

Definition at line 67 of file qgsvectorlayerserverproperties.h.

Constructor & Destructor Documentation

◆ WmsDimensionInfo()

QgsVectorLayerServerProperties::WmsDimensionInfo::WmsDimensionInfo ( const QString &  dimName,
const QString &  dimFieldName,
const QString &  dimEndFieldName = QString(),
const QString &  dimUnits = QString(),
const QString &  dimUnitSymbol = QString(),
const int &  dimDefaultDisplayType = QgsVectorLayerServerProperties::WmsDimensionInfo::AllValues,
const QVariant &  dimReferenceValue = QVariant() 
)
inlineexplicit

Constructor for WmsDimensionInfo.

Definition at line 78 of file qgsvectorlayerserverproperties.h.

Member Data Documentation

◆ defaultDisplayType

int QgsVectorLayerServerProperties::WmsDimensionInfo::defaultDisplayType

Definition at line 98 of file qgsvectorlayerserverproperties.h.

◆ endFieldName

QString QgsVectorLayerServerProperties::WmsDimensionInfo::endFieldName

Definition at line 95 of file qgsvectorlayerserverproperties.h.

◆ fieldName

QString QgsVectorLayerServerProperties::WmsDimensionInfo::fieldName

Definition at line 94 of file qgsvectorlayerserverproperties.h.

◆ name

QString QgsVectorLayerServerProperties::WmsDimensionInfo::name

Definition at line 93 of file qgsvectorlayerserverproperties.h.

◆ referenceValue

QVariant QgsVectorLayerServerProperties::WmsDimensionInfo::referenceValue

Definition at line 99 of file qgsvectorlayerserverproperties.h.

◆ units

QString QgsVectorLayerServerProperties::WmsDimensionInfo::units

Definition at line 96 of file qgsvectorlayerserverproperties.h.

◆ unitSymbol

QString QgsVectorLayerServerProperties::WmsDimensionInfo::unitSymbol

Definition at line 97 of file qgsvectorlayerserverproperties.h.


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