QGIS API Documentation 4.3.0-Master (09d73a2b827)
Loading...
Searching...
No Matches
QgsServerWmsDimensionProperties::WmsDimensionInfo Struct Reference

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

#include <qgsmaplayerserverproperties.h>

Public Member Functions

 WmsDimensionInfo (const QString &dimName, const QString &dimFieldName, const QString &dimEndFieldName=QString(), const QString &dimUnits=QString(), const QString &dimUnitSymbol=QString(), Qgis::WmsDimensionDefaultDisplay dimDefaultDisplayType=Qgis::WmsDimensionDefaultDisplay::AllValues, const QVariant &dimReferenceValue=QVariant())
 Constructor for WmsDimensionInfo.
bool operator!= (const WmsDimensionInfo &other) const
bool operator== (const WmsDimensionInfo &other) const
QVariant referenceValue () const
 Returns reference value used when default display type is Qgis::WmsDimensionDefaultDisplay::ReferenceValue.
void setReferenceValue (const QVariant &referenceValue)
 Set referenceValue used when default display type is Qgis::WmsDimensionDefaultDisplay::ReferenceValue.

Public Attributes

Qgis::WmsDimensionDefaultDisplay defaultDisplayType
QString endFieldName
QString fieldName
QString name
QString units
QString unitSymbol

Detailed Description

Setting to define QGIS Server WMS Dimension.

Since
QGIS 3.10

Definition at line 159 of file qgsmaplayerserverproperties.h.

Constructor & Destructor Documentation

◆ WmsDimensionInfo()

QgsServerWmsDimensionProperties::WmsDimensionInfo::WmsDimensionInfo ( const QString & dimName,
const QString & dimFieldName,
const QString & dimEndFieldName = QString(),
const QString & dimUnits = QString(),
const QString & dimUnitSymbol = QString(),
Qgis::WmsDimensionDefaultDisplay dimDefaultDisplayType = Qgis::WmsDimensionDefaultDisplay::AllValues,
const QVariant & dimReferenceValue = QVariant() )
inlineexplicit

Constructor for WmsDimensionInfo.

Definition at line 164 of file qgsmaplayerserverproperties.h.

Member Function Documentation

◆ operator!=()

bool QgsServerWmsDimensionProperties::WmsDimensionInfo::operator!= ( const WmsDimensionInfo & other) const

Definition at line 58 of file qgsmaplayerserverproperties.cpp.

◆ operator==()

bool QgsServerWmsDimensionProperties::WmsDimensionInfo::operator== ( const WmsDimensionInfo & other) const

Definition at line 47 of file qgsmaplayerserverproperties.cpp.

◆ referenceValue()

QVariant QgsServerWmsDimensionProperties::WmsDimensionInfo::referenceValue ( ) const
inline

Returns reference value used when default display type is Qgis::WmsDimensionDefaultDisplay::ReferenceValue.

Since
QGIS 4.4

Definition at line 190 of file qgsmaplayerserverproperties.h.

◆ setReferenceValue()

void QgsServerWmsDimensionProperties::WmsDimensionInfo::setReferenceValue ( const QVariant & referenceValue)
inline

Set referenceValue used when default display type is Qgis::WmsDimensionDefaultDisplay::ReferenceValue.

Since
QGIS 4.4

Definition at line 197 of file qgsmaplayerserverproperties.h.

Member Data Documentation

◆ defaultDisplayType

Qgis::WmsDimensionDefaultDisplay QgsServerWmsDimensionProperties::WmsDimensionInfo::defaultDisplayType

Definition at line 205 of file qgsmaplayerserverproperties.h.

◆ endFieldName

QString QgsServerWmsDimensionProperties::WmsDimensionInfo::endFieldName

Definition at line 202 of file qgsmaplayerserverproperties.h.

◆ fieldName

QString QgsServerWmsDimensionProperties::WmsDimensionInfo::fieldName

Definition at line 201 of file qgsmaplayerserverproperties.h.

◆ name

QString QgsServerWmsDimensionProperties::WmsDimensionInfo::name

Definition at line 200 of file qgsmaplayerserverproperties.h.

◆ units

QString QgsServerWmsDimensionProperties::WmsDimensionInfo::units

Definition at line 203 of file qgsmaplayerserverproperties.h.

◆ unitSymbol

QString QgsServerWmsDimensionProperties::WmsDimensionInfo::unitSymbol

Definition at line 204 of file qgsmaplayerserverproperties.h.


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