QGIS API Documentation
3.16.0-Hannover (43b64b13f3)
|
Go to the documentation of this file.
32 const QVariant::Type type,
33 const QVariant defaultValue )
62 const QString msg = QString(
"%1 ('%2') cannot be converted into a list of geometries" ).arg(
name(
mName ),
toString() );
76 const QString msg = QString(
"%1 ('%2') cannot be converted into a rectangle" ).arg(
name(
mName ),
toString() );
99 const QUrl url =
toUrl();
106 const QString msg = QString(
"%1 request error for %2" ).arg(
name(
mName ), url.toString() );
146 const QString msg = QString(
"%1 ('%2') cannot be converted into a list of colors" ).arg(
name(
mName ),
toString() );
160 const QString msg = QString(
"%1 ('%2') cannot be converted into a list of int" ).arg(
name(
mName ),
toString() );
174 const QString msg = QString(
"%1 ('%2') cannot be converted into a list of float" ).arg(
name(
mName ),
toString() );
201 const QMetaEnum metaEnum( QMetaEnum::fromType<QgsWmsParameter::Name>() );
202 return metaEnum.valueToKey(
name );
207 const QMetaEnum metaEnum( QMetaEnum::fromType<QgsWmsParameter::Name>() );
265 save( pIcLabelSpace );
268 save( pItFontFamily );
278 save( pItFontItalic );
287 QVariant(
"black" ) );
288 save( pItFontColor );
291 save( pHighlightGeom );
296 save( pShowFeatureCount );
299 save( pHighlightSymbol );
302 save( pHighlightLabel );
306 QVariant(
"black" ) );
307 save( pHighlightColor );
310 save( pHighlightFontSize );
313 save( pHighlightFontWeight );
316 save( pHighlightFont );
320 QVariant(
"black" ) );
321 save( pHighlightBufferColor );
324 save( pHighlightBufferSize );
409 save( pQueryLayers );
414 save( pFeatureCount );
422 save( pLayerFtFamily );
427 save( pLayerFtBold );
432 save( pLayerFtItalic );
437 save( pLayerFtSize );
441 QVariant(
"black" ) );
442 save( pLayerFtColor );
480 save( pWmsPrecision );
485 save( pTransparent );
489 QVariant(
"white" ) );
521 save( pWithGeometry );
532 QVariant::StringList );
546 if ( !sld.isEmpty() )
558 return mWmsParameters[name];
563 mWmsParameters[name].mValue =
value;
566 bool QgsWmsParameters::loadParameter(
const QString &key,
const QString &value )
570 const QRegExp composerParamRegExp( QStringLiteral(
"^MAP\\d+:" ), Qt::CaseInsensitive );
571 if ( key.contains( composerParamRegExp ) )
573 const int mapId = key.midRef( 3, key.indexOf(
':' ) - 3 ).toInt();
574 const QString theKey = key.mid( key.indexOf(
':' ) + 1 );
597 mWmsParameters[name].mValue =
value;
598 if ( ! mWmsParameters[name].isValid() )
600 mWmsParameters[name].raiseError();
607 int separator = key.indexOf( QLatin1Char(
':' ) );
608 if ( separator >= 1 )
610 QString
id = key.left( separator );
611 QString param = key.right( key.length() - separator - 1 );
612 mExternalWMSParameters[id].insert( param,
value );
624 log( QStringLiteral(
"WMS Request parameters:" ) );
625 for (
auto parameter : mWmsParameters.toStdMap() )
627 const QString
value = parameter.second.toString();
629 if ( !
value.isEmpty() )
633 if ( parameter.second.mId >= 0 )
635 name = QStringLiteral(
"%1:%2" ).arg( QString::number( parameter.second.mId ), name );
638 log( QStringLiteral(
" - %1 : %2" ).arg( name,
value ) );
643 log( QStringLiteral(
" - VERSION : %1" ).arg(
version() ) );
646 void QgsWmsParameters::save(
const QgsWmsParameter ¶meter,
bool multi )
650 mWmsParameters.insertMulti( parameter.
mName, parameter );
654 mWmsParameters[ parameter.
mName ] = parameter;
681 if ( !srs.isEmpty() &&
crs.isEmpty() )
683 else if ( srs.isEmpty() && !
crs.isEmpty() )
685 else if ( !srs.isEmpty() && !
crs.isEmpty() )
758 const QString vStr =
version();
762 if ( vStr.isEmpty() )
786 const QMetaEnum metaEnum( QMetaEnum::fromType<QgsWmsParameters::Format>() );
787 return metaEnum.valueToKey(
format );
795 if ( fStr.compare( QLatin1String(
"image/png" ), Qt::CaseInsensitive ) == 0 ||
796 fStr.compare( QLatin1String(
"png" ), Qt::CaseInsensitive ) == 0 )
800 else if ( fStr.compare( QLatin1String(
"jpg" ), Qt::CaseInsensitive ) == 0
801 || fStr.compare( QLatin1String(
"jpeg" ), Qt::CaseInsensitive ) == 0
802 || fStr.compare( QLatin1String(
"image/jpeg" ), Qt::CaseInsensitive ) == 0 )
806 else if ( fStr.compare( QLatin1String(
"image/svg" ), Qt::CaseInsensitive ) == 0 ||
807 fStr.compare( QLatin1String(
"image/svg+xml" ), Qt::CaseInsensitive ) == 0 ||
808 fStr.compare( QLatin1String(
"svg" ), Qt::CaseInsensitive ) == 0 )
812 else if ( fStr.compare( QLatin1String(
"application/pdf" ), Qt::CaseInsensitive ) == 0 ||
813 fStr.compare( QLatin1String(
"pdf" ), Qt::CaseInsensitive ) == 0 )
817 else if ( fStr.compare( QLatin1String(
"application/json" ), Qt::CaseInsensitive ) == 0 ||
818 fStr.compare( QLatin1String(
"json" ), Qt::CaseInsensitive ) == 0 )
840 if ( fStr.isEmpty() )
843 if ( fStr.startsWith( QLatin1String(
"text/xml" ), Qt::CaseInsensitive ) )
845 else if ( fStr.startsWith( QLatin1String(
"text/html" ), Qt::CaseInsensitive ) )
847 else if ( fStr.startsWith( QLatin1String(
"text/plain" ), Qt::CaseInsensitive ) )
849 else if ( fStr.startsWith( QLatin1String(
"application/vnd.ogc.gml" ), Qt::CaseInsensitive ) )
851 else if ( fStr.startsWith( QLatin1String(
"application/json" ), Qt::CaseInsensitive )
852 || fStr.startsWith( QLatin1String(
"application/geo+json" ), Qt::CaseInsensitive ) )
866 if ( fStr.startsWith( QLatin1String(
"application/vnd.ogc.gml/3" ), Qt::CaseInsensitive ) )
1180 font.fromString(
"" );
1196 font.fromString(
"" );
1347 QStringList results;
1349 while ( pos < filter.size() )
1351 if ( pos + 1 < filter.size() && filter[pos] ==
'(' && filter[pos + 1] ==
'<' )
1354 int posEnd = filter.indexOf(
"Filter>)", pos );
1357 posEnd = filter.size();
1359 results.append( filter.mid( pos + 1, posEnd - pos + 6 ) );
1362 else if ( pos + 1 < filter.size() && filter[pos] ==
'(' && filter[pos + 1] ==
')' )
1365 results.append(
"" );
1368 else if ( filter[pos] ==
'<' )
1371 results.append( filter.mid( pos ) );
1377 int posEnd = filter.indexOf(
';', pos + 1 );
1380 posEnd = filter.size();
1382 results.append( filter.mid( pos, posEnd - pos ) );
1413 return layer << layers;
1425 return style << styles;
1428 QMultiMap<QString, QgsWmsParametersFilter> QgsWmsParameters::layerFilters(
const QStringList &layers )
const
1430 const QString nsWfs2 = QStringLiteral(
"http://www.opengis.net/fes/2.0" );
1431 const QString prefixWfs2 = QStringLiteral(
"<fes:" );
1433 const QStringList rawFilters =
filters();
1434 QMultiMap<QString, QgsWmsParametersFilter>
filters;
1435 for (
int i = 0;
i < rawFilters.size();
i++ )
1437 const QString f = rawFilters[
i];
1438 if ( f.startsWith( QLatin1Char(
'<' ) ) \
1439 && f.endsWith( QLatin1String(
"Filter>" ) ) \
1440 &&
i < layers.size() )
1447 if ( filter.
mFilter.contains( nsWfs2 ) \
1448 || filter.
mFilter.contains( prefixWfs2 ) )
1453 filters.insert( layers[
i], filter );
1455 else if ( !f.isEmpty() )
1459 const int colonIndex = f.indexOf(
':' );
1460 if ( colonIndex != -1 )
1462 const QString layers = f.section(
':', 0, 0 );
1463 const QString filter = f.section(
':', 1 );
1464 const QStringList layersList = layers.split(
',' );
1465 for (
const QString &layer : layersList )
1467 QgsWmsParametersFilter parametersFilter;
1468 parametersFilter.
mFilter = filter;
1470 filters.insert( layer, parametersFilter );
1476 raiseError( QStringLiteral(
"FILTER ('" ) + filterStr + QStringLiteral(
"') is not properly formatted" ) );
1485 bool force2D =
false;
1488 if ( options.contains( DxfFormatOption::FORCE_2D ) )
1490 force2D = QVariant( options[ DxfFormatOption::FORCE_2D ] ).toBool();
1501 if ( options.contains( DxfFormatOption::NO_MTEXT ) )
1503 noMText = QVariant( options[ DxfFormatOption::NO_MTEXT ] ).toBool();
1515 const QMultiMap<QString, QgsWmsParametersFilter>
filters = layerFilters( layers );
1519 QMultiMap<QString, QString> layerSelections;
1520 for (
const QString &s : selection )
1522 const QStringList splits = s.split(
':' );
1523 if ( splits.size() == 2 )
1525 layerSelections.insert( splits[0], splits[1] );
1530 raiseError( QStringLiteral(
"SELECTION ('" ) + selStr + QStringLiteral(
"') is not properly formatted" ) );
1534 QList<QgsWmsParametersLayer> parameters;
1535 for (
int i = 0;
i < layers.size();
i++ )
1537 QString layer = layers[
i];
1542 if ( isExternalLayer( layer ) )
1550 if (
i < styles.count() )
1556 if (
filters.contains( layer ) )
1558 auto it =
filters.find( layer );
1559 while ( it !=
filters.end() && it.key() == layer )
1561 param.
mFilter.append( it.value() );
1566 if ( layerSelections.contains( layer ) )
1568 QMultiMap<QString, QString>::const_iterator it;
1569 it = layerSelections.constFind( layer );
1570 while ( it != layerSelections.constEnd() && it.key() == layer )
1578 parameters.append( param );
1586 QList<QgsWmsParametersHighlightLayer> params;
1597 int nLayers = std::min( geoms.size(), slds.size() );
1598 for (
int i = 0;
i < nLayers;
i++ )
1601 param.
mName = QStringLiteral(
"highlight_" ) + QString::number(
i );
1603 param.
mSld = slds[
i];
1605 if (
i < labels.count() )
1608 if (
i < colors.count() )
1611 if (
i < sizes.count() )
1614 if (
i < weights.count() )
1617 if (
i < fonts.count() )
1618 param.
mFont = fonts[
i ];
1620 if (
i < bufferColors.count() )
1623 if (
i < bufferSizes.count() )
1626 params.append( param );
1634 auto notExternalLayer = [](
const QString & name ) {
return ! QgsWmsParameters::isExternalLayer( name ); };
1636 QList<QgsWmsParametersExternalLayer> externalLayers;
1639 QStringList::iterator rit = std::remove_if( layers.begin(), layers.end(), notExternalLayer );
1641 for ( QStringList::iterator it = layers.begin(); it != rit; ++it )
1643 externalLayers << externalLayerParameter( *it );
1646 return externalLayers;
1678 if ( extentStr.isEmpty() )
1683 QString pMapId = QStringLiteral(
"MAP" ) + QString::number( mapId );
1713 double gridx( -1 ), gridy( -1 );
1727 if ( gridx != -1 && gridy != -1 )
1734 QStringList allLayers;
1743 QList<QgsWmsParametersExternalLayer> eParams;
1745 for (
const auto &layer : qgis::as_const( allLayers ) )
1747 if ( isExternalLayer( layer ) )
1750 layers << extParam.
mName;
1765 QList<QgsWmsParametersLayer> lParams;
1766 for (
int i = 0;
i < layers.size();
i++ )
1768 QString layer = layers[
i];
1772 if (
i < styles.count() )
1775 lParams.append( lParam );
1780 QList<QgsWmsParametersHighlightLayer> hParams;
1782 QList<QgsGeometry> geoms;
1810 QList<QColor> colors;
1831 QList<QColor> bufferColors;
1838 QList<double> bufferSizes;
1845 int nHLayers = std::min( geoms.size(), slds.size() );
1846 for (
int i = 0;
i < nHLayers;
i++ )
1849 hParam.
mName = pMapId + QStringLiteral(
"_highlight_" ) + QString::number(
i );
1851 hParam.
mSld = slds[
i];
1853 if (
i < labels.count() )
1856 if (
i < colors.count() )
1859 if (
i < sizes.count() )
1862 if (
i < weights.count() )
1865 if (
i < fonts.count() )
1866 hParam.
mFont = fonts[
i ];
1868 if (
i < bufferColors.count() )
1871 if (
i < bufferSizes.count() )
1874 hParams.append( hParam );
1883 if ( !mExternalWMSParameters.contains(
id ) )
1889 const QMap<QString, QString> ¶mMap = mExternalWMSParameters[ id ];
1890 QMap<QString, QString>::const_iterator paramIt = paramMap.constBegin();
1891 for ( ; paramIt != paramMap.constEnd(); ++paramIt )
1893 QString paramName = paramIt.key().toLower();
1894 if ( paramName == QLatin1String(
"layers" ) || paramName == QLatin1String(
"styles" ) )
1896 const QStringList values = paramIt.value().split(
',' );
1897 for (
const QString &
value : values )
1902 wmsUri.
setParam( paramName, paramIt.value() );
1923 void QgsWmsParameters::log(
const QString &msg )
const
1928 void QgsWmsParameters::raiseError(
const QString &msg )
const
1933 QgsWmsParameter QgsWmsParameters::idParameter(
const QgsWmsParameter::Name name,
const int id )
const
1937 for (
const auto ¶m : mWmsParameters.values( name ) )
1939 if ( param.
mId ==
id )
1948 QgsWmsParametersExternalLayer QgsWmsParameters::externalLayerParameter(
const QString &name )
const
1950 QgsWmsParametersExternalLayer param;
1959 bool QgsWmsParameters::isExternalLayer(
const QString &name )
1966 QStringList attributes;
1969 if ( options.contains( DxfFormatOption::LAYERATTRIBUTES ) )
1971 attributes = options[ DxfFormatOption::LAYERATTRIBUTES ].split(
',' );
1982 if ( options.contains( DxfFormatOption::USE_TITLE_AS_LAYERNAME ) )
1984 use = QVariant( options[ DxfFormatOption::USE_TITLE_AS_LAYERNAME ] ).toBool();
1995 if ( options.contains( DxfFormatOption::SCALE ) )
1997 scale = options[ DxfFormatOption::SCALE ].toDouble();
2009 if ( ! options.contains( DxfFormatOption::MODE ) )
2014 const QString mode = options[ DxfFormatOption::MODE ];
2015 if ( mode.compare( QLatin1String(
"SymbolLayerSymbology" ), Qt::CaseInsensitive ) == 0 )
2019 else if ( mode.compare( QLatin1String(
"FeatureSymbology" ), Qt::CaseInsensitive ) == 0 )
2029 QString codec = QStringLiteral(
"ISO-8859-1" );
2041 QMap<QgsWmsParameters::DxfFormatOption, QString> options;
2043 const QMetaEnum metaEnum( QMetaEnum::fromType<QgsWmsParameters::DxfFormatOption>() );
2046 for (
auto it = opts.constBegin(); it != opts.constEnd(); ++it )
2048 const int equalIdx = it->indexOf(
':' );
2049 if ( equalIdx > 0 && equalIdx < ( it->length() - 1 ) )
2051 const QString name = it->left( equalIdx ).toUpper();
2054 const QString
value = it->right( it->length() - equalIdx - 1 );
2055 options.insert( option,
value );
2064 QMap<QString, QString> dimValues;
2065 const QMetaEnum pnMetaEnum( QMetaEnum::fromType<QgsVectorLayerServerProperties::PredefinedWmsDimensionName>() );
2067 for (
const QString &key : unmanagedNames )
2069 if ( key.startsWith( QLatin1String(
"DIM_" ) ) )
2073 else if ( pnMetaEnum.keyToValue( key.toUpper().toStdString().c_str() ) != -1 )
QString layerFontBold() const
Returns LAYERFONTBOLD parameter or an empty string if not defined.
QStringList highlightGeom() const
Returns HIGHLIGHT_GEOM as a list of string in WKT.
QString transparent() const
Returns TRANSPARENT parameter or an empty string if not defined.
QgsRectangle toRectangle() const
Converts the parameter into a rectangle.
QString loadUrl() const
Loads the data associated to the parameter converted into an url.
@ QGIS_InvalidParameterValue
QString srcHeight() const
Returns SRCHEIGHT parameter or an empty string if not defined.
Provides an interface to retrieve and manipulate WMS parameters received from the client.
QgsWmsParameter::Name mName
double layerTitleSpaceAsDouble() const
Returns LAYERTITLESPACE as a double.
QString name() const
Returns the name of the parameter.
void set(QgsWmsParameter::Name name, const QVariant &value)
Sets a parameter value thanks to its name.
Class for storing the component parts of a RDBMS data source URI (e.g.
bool infoFormatIsImage() const
Checks if INFO_FORMAT parameter is one of the image formats (PNG, JPG).
int wmsPrecisionAsInt() const
Returns WMS_PRECISION parameter as an int or its default value if not defined.
QStringList opacities() const
Returns the list of opacities found in OPACITIES parameter.
QString symbolWidth() const
Returns SYMBOLWIDTH parameter or an empty string if not defined.
static void raiseError(const QString &msg)
Raises an exception in case of an invalid parameters.
int toInt() const
Converts the parameter into an integer.
bool layerFontItalicAsBool() const
Returns LAYERFONTITALIC as a boolean or its default value if not defined.
bool showFeatureCountAsBool() const
Returns SHOWFEATURECOUNT as a bool.
QList< int > toIntList(const char delimiter=',') const
Converts the parameter into a list of integers.
QString wmtver() const
Returns WMTVER parameter or an empty string if not defined.
int heightAsInt() const
Returns HEIGHT parameter as an int or its default value if not defined.
void setSymbolSize(QSizeF s)
Sets the default symbol size (in millimeters) used for legend items.
int infoFormatVersion() const
Returns the infoFormat version for GML.
int srcHeightAsInt() const
Returns SRCHEIGHT parameter as an int or its default value if not defined.
void setFont(const QFont &font)
Sets the font used for rendering this legend component.
QList< QgsWmsParametersLayer > mLayers
QList< QgsWmsParametersHighlightLayer > mHighlightLayers
QString wmsPrecision() const
Returns WMS_PRECISION parameter or an empty string if not defined.
QString crs() const
Returns CRS or an empty string if none is defined.
Format
Output format for the response.
void load(const QUrlQuery &query)
Loads new parameters.
QString layerFontSize() const
Returns LAYERFONTSIZE parameter or an empty string if not defined.
QgsLegendSettings legendSettings() const
Returns legend settings.
QString iconLabelSpace() const
Returns ICONLABELSPACE parameter or an empty string if not defined.
QgsWmsParameter operator[](QgsWmsParameter::Name name) const
Returns the parameter corresponding to name.
QString bbox() const
Returns BBOX if defined or an empty string.
QString infoFormatAsString() const
Returns INFO_FORMAT parameter as a string.
int featureCountAsInt() const
Returns FEATURE_COUNT as an integer.
void setMargin(Side side, double margin)
Sets the margin (in mm) for the specified side of the component.
QString i() const
Returns I parameter or an empty string if not defined.
QStringList highlightLabelWeight() const
Returns HIGHLIGHT_LABELWEIGHT as a list of string.
QString boxSpace() const
Returns BOXSPACE parameter or an empty string if not defined.
void setBoxSpace(double s)
Sets the legend box space (in millimeters), which is the empty margin around the inside of the legend...
bool itemFontBoldAsBool() const
Returns ITEMFONTBOLD as a boolean or its default value if not defined.
QList< double > highlightLabelBufferSizeAsFloat() const
Returns HIGHLIGHT_LABELBUFFERSIZE as a list of float.
bool transparentAsBool() const
Returns TRANSPARENT parameter as a bool or its default value if not defined.
QString layerTitleSpace() const
Returns LAYERTITLESPACE parameter or an empty string if not defined.
QColor itemFontColorAsColor() const
Returns ITEMFONTCOLOR as a color.
QString dpi() const
Returns DPI parameter or an empty string if not defined.
QString featureCount() const
Returns FEATURE_COUNT parameter or an empty string if none is defined.
QString itemFontItalic() const
Returns ITEMFONTITALIC parameter or an empty string if not defined.
QString symbolSpace() const
Returns SYMBOLSPACE parameter or an empty string if not defined.
QString value(const QString &key) const
Returns the value of a parameter.
void raiseError() const
Raises an error in case of an invalid conversion.
double toDouble(bool &ok) const
Converts the parameter into a double.
QStringList toStringList(char delimiter=',', bool skipEmptyParts=true) const
Converts the parameter into a list of strings.
QString loadUrl(bool &ok) const
Loads the data associated to the parameter converted into an url.
A rectangle specified with double values.
QString itemFontSize() const
Returns ITEMFONTSIZE parameter or an empty string if not defined.
QList< int > highlightLabelWeightAsInt() const
Returns HIGHLIGHT_LABELWEIGHT as a list of int.
QString itemFontBold() const
Returns ITEMFONTBOLD parameter or an empty string if not defined.
QStringList highlightLabelFont() const
Returns HIGHLIGHT_LABELFONT.
bool withMapTip() const
withMapTip
QString imageQuality() const
Returns IMAGE_QUALITY parameter or an empty string if not defined.
QList< int > opacitiesAsInt() const
Returns the list of opacities found in OPACITIES parameter as integers.
QStringList highlightLabelBufferSize() const
Returns HIGHLIGHT_LABELBUFFERSIZE.
QStringList highlightLabelBufferColor() const
Returns HIGHLIGHT_LABELBUFFERCOLOR as a list of string.
QString srcWidth() const
Returns SRCWIDTH parameter or an empty string if not defined.
QString version() const
Returns VERSION parameter as a string or an empty string if not defined.
QString height() const
Returns HEIGHT parameter or an empty string if not defined.
QString symbolHeight() const
Returns SYMBOLHEIGHT parameter or an empty string if not defined.
QStringList queryLayersNickname() const
Returns nickname of layers found in QUERY_LAYERS parameter.
QString sldBody() const
Returns SLD_body if defined or an empty string.
QMap< QString, QString > mUnmanagedParameters
int widthAsInt() const
Returns WIDTH parameter as an int or its default value if not defined.
QString layerFontFamily() const
Returns LAYERFONTFAMILY parameter or an empty string if not defined.
@ HIGHLIGHT_LABELBUFFERCOLOR
QUrl toUrl(bool &ok) const
Converts the parameter into an url.
QColor toColor() const
Converts the parameter into a color.
int polygonToleranceAsInt() const
Returns FI_POLYGON_TOLERANCE parameter as an integer.
QString itemFontColor() const
Returns ITEMFONTCOLOR parameter or an empty string if not defined.
QString x() const
Returns X parameter or an empty string if not defined.
QgsProjectVersion versionAsNumber() const
Returns VERSION parameter if defined or its default value.
const QString EXTERNAL_LAYER_PREFIX
void setTitle(const QString &t)
Sets the title for the legend, which will be rendered above all legend items.
QString lineTolerance() const
Returns FI_LINE_TOLERANCE parameter or an empty string if not defined.
int yAsInt() const
Returns Y parameter as an int or its default value if not defined.
QFont layerFont() const
Returns the layer font (built thanks to the LAYERFONTFAMILY, LAYERFONTSIZE, LAYERFONTBOLD,...
QStringList highlightLabelColor() const
Returns HIGHLIGHT_LABELCOLOR as a list of string.
Definition of a parameter with basic conversion methods.
QgsWmsParametersFilter::Type mType
QgsWmsParameter(const QgsWmsParameter::Name name=QgsWmsParameter::UNKNOWN, const QVariant::Type type=QVariant::String, const QVariant defaultValue=QVariant(""))
Constructor for QgsWmsParameter.
QList< double > toDoubleList(const char delimiter=',') const
Converts the parameter into a list of doubles.
double layerFontSizeAsDouble() const
Returns LAYERFONTSIZE as a double.
QString backgroundColor() const
Returns BGCOLOR parameter or an empty string if not defined.
double symbolSpaceAsDouble() const
Returns SYMBOLSPACE as a double or its default value if not defined.
bool ruleLabelAsBool() const
Returns RULELABEL as a bool.
void setParam(const QString &key, const QString &value)
Sets a generic parameter value on the URI.
QStringList highlightSymbol() const
Returns HIGHLIGHT_SYMBOL as a list of string.
int lineToleranceAsInt() const
Returns FI_LINE_TOLERANCE parameter as an integer.
QString tiled() const
Returns TILED parameter or an empty string if not defined.
double toDouble() const
Converts the parameter into a double.
int xAsInt() const
Returns X parameter as an int or its default value if not defined.
double dpiAsDouble() const
Returns DPI parameter as an int or its default value if not defined.
The QgsLegendSettings class stores the appearance and layout settings for legend drawing with QgsLege...
QString toString(bool defaultValue=false) const
Converts the parameter into a string.
QgsOgcUtils::FilterVersion mVersion
QList< QgsWmsParametersLayer > layersParameters() const
Returns parameters for each layer found in LAYER/LAYERS.
double itemFontSizeAsDouble() const
Returns ITEMFONTSIZE as a double.
QgsRectangle bboxAsRectangle() const
Returns BBOX as a rectangle if defined and valid.
QString j() const
Returns J parameter or an empty string if not defined.
QUrl toUrl() const
Converts the parameter into an url.
int pointToleranceAsInt() const
Returns FI_POINT_TOLERANCE parameter as an integer.
QColor toColor(bool &ok) const
Converts the parameter into a color.
QString filterGeom() const
Returns the filter geometry found in FILTER_GEOM parameter.
QString showFeatureCount() const
Returns SHOWFEATURECOUNT parameter or an empty string if none is defined.
QString layerTitle() const
Returns LAYERTITLE parameter or an empty string if not defined.
bool itemFontItalicAsBool() const
Returns ITEMFONTITALIC as a boolean or its default value if not defined.
Format format() const
Returns format.
QFont itemFont() const
Returns the item font (built thanks to the ITEMFONTFAMILY, ITEMFONTSIZE, ITEMFONTBOLD,...
QList< QgsWmsParametersExternalLayer > externalLayersParameters() const
Returns parameters for each external layer.
QgsWmsParametersComposerMap composerMapParameters(int mapId) const
Returns the requested parameters for a composer map parameter.
double scaleAsDouble() const
Returns SCALE as a double.
QMap< DxfFormatOption, QString > dxfFormatOptions() const
Returns a map of DXF options defined within FORMAT_OPTIONS parameter.
QgsWmsParameters()
Constructor for WMS parameters with default values only.
QString composerTemplate() const
Returns TEMPLATE parameter or an empty string if not defined.
Median cut implementation.
int toInt(bool &ok) const
Converts the parameter into an integer.
QStringList allStyles() const
Returns styles found in STYLE and STYLES parameters.
QColor backgroundColorAsColor() const
Returns BGCOLOR parameter as a QColor or its default value if not defined.
QList< QgsGeometry > toGeomList(const char delimiter=',') const
Converts the parameter into a list of geometries.
QString layerFontItalic() const
Returns LAYERFONTITALIC parameter or an empty string if not defined.
void setFontColor(const QColor &c)
Sets the font color used for legend items.
QByteArray encodedUri() const
Returns the complete encoded URI as a byte array.
QString layerSpace() const
Returns LAYERSPACE parameter or an empty string if not defined.
QList< int > highlightLabelSizeAsInt() const
Returns HIGHLIGHT_LABELSIZE as a list of int An exception is raised if an invalid size is found.
QString layoutParameter(const QString &id, bool &ok) const
Returns a layout parameter thanks to its id.
QStringList atlasPk() const
Returns the ATLAS_PK parameter.
bool layerTitleAsBool() const
Returns LAYERTITLE as a bool or its default value if not defined.
QList< QColor > highlightLabelColorAsColor() const
Returns HIGHLIGHT_LABELCOLOR as a list of color.
virtual bool isValid() const
Returns true if the parameter is valid, false otherwise.
double iconLabelSpaceAsDouble() const
Returns ICONLABELSPACE as a double or its default value if not defined.
QString scale() const
Returns SCALE parameter or an empty string if none is defined.
QString rule() const
Returns RULE parameter or an empty string if none is defined.
bool layerFontBoldAsBool() const
Returns LAYERFONTBOLD as a boolean or its default value if not defined.
bool isValid() const override
Returns true if the parameter is valid, false otherwise.
QString polygonTolerance() const
Returns FI_POLYGON_TOLERANCE parameter or an empty string if not defined.
@ HIGHLIGHT_LABELBUFFERSIZE
QStringList toStyleList(const char delimiter=',') const
Converts the parameter into a list of strings and keeps empty parts Default style value is an empty s...
static void logMessage(const QString &message, const QString &tag=QString(), Qgis::MessageLevel level=Qgis::Warning, bool notifyUser=true)
Adds a message to the log instance (and creates it if necessary).
bool withGeometry() const
Returns if the client wants the feature info response with geometry information.
int jAsInt() const
Returns J parameter as an int or its default value if not defined.
QUrlQuery urlQuery() const
Returns a url query with underlying parameters.
QStringList dxfLayerAttributes() const
Returns the DXF LAYERATTRIBUTES parameter.
QString itemFontFamily() const
Returns ITEMFONTFAMILY parameter or an empty string if not defined.
QgsDxfExport::SymbologyExport dxfMode() const
Returns the DXF MODE parameter.
QString y() const
Returns Y parameter or an empty string if not defined.
bool tiledAsBool() const
Returns TILED parameter as a boolean.
QString layerFontColor() const
Returns LAYERFONTCOLOR parameter or an empty string if not defined.
WMS parameter received from the client.
void setLayerFontColor(const QColor &fontColor)
Sets layer font color to fontColor Overrides fontColor()
QString externalWMSUri(const QString &id) const
Returns the external WMS uri.
QgsServerParameters provides an interface to retrieve and manipulate global parameters received from ...
QList< QColor > toColorList(const char delimiter=',') const
Converts the parameter into a list of colors.
QString formatAsString() const
Returns FORMAT parameter as a string.
QgsLegendStyle & rstyle(QgsLegendStyle::Style s)
Returns modifiable reference to the style for a legend component.
int iAsInt() const
Returns I parameter as an int or its default value if not defined.
Format infoFormat() const
Returns infoFormat.
bool versionIsValid(const QString version) const
Returns true if version is valid, false otherwise.
QString typeName() const
Returns the type of the parameter as a string.
QList< QgsGeometry > highlightGeomAsGeom() const
Returns HIGHLIGHT_GEOM as a list of geometries.
QList< QgsGeometry > toGeomList(bool &ok, char delimiter=',') const
Converts the parameter into a list of geometries.
QStringList filters() const
Returns the list of filters found in FILTER parameter.
@ SymbolLayerSymbology
Exports one feature per symbol layer (considering symbol levels)
QList< int > toIntList(bool &ok, char delimiter=',') const
Converts the parameter into a list of integers.
bool dxfUseLayerTitleAsName() const
Returns the DXF USE_TITLE_AS_LAYERNAME parameter.
QString pointTolerance() const
Returns FI_POINT_TOLERANCE parameter or an empty string if not defined.
@ NoSymbology
Export only data.
QStringList highlightLabelString() const
Returns HIGHLIGHT_LABELSTRING as a list of string.
void dump() const
Dumps parameters.
@ FeatureSymbology
Keeps the number of features and export symbology per feature (using the first symbol level)
Exception thrown in case of malformed request.
int imageQualityAsInt() const
Returns IMAGE_QUALITY parameter as an integer.
QString dxfCodec() const
Returns the DXF CODEC parameter.
QStringList selections() const
Returns the list of feature selection found in SELECTION parameter.
QStringList highlightLabelSize() const
Returns HIGHLIGHT_LABELSIZE as a list of string.
bool isEmpty() const
Returns true if the rectangle is empty.
Name
Available parameters for WMS requests.
double layerSpaceAsDouble() const
Returns LAYERSPACE as a double or its default value if not defined.
double symbolHeightAsDouble() const
Returns SYMBOLHEIGHT as a double or its default value if not defined.
double boxSpaceAsDouble() const
Returns BOXSPACE as a double or its default value if not defined.
QList< QgsWmsParametersHighlightLayer > highlightLayersParameters() const
Returns parameters for each highlight layer.
DxfFormatOption
Options for DXF format.
QMap< QString, QString > dimensionValues() const
Returns the dimensions parameter.
QString width() const
Returns WIDTH parameter or an empty string if not defined.
QList< double > toDoubleList(bool &ok, char delimiter=',') const
Converts the parameter into a list of doubles.
A class to describe the version of a project.
int srcWidthAsInt() const
Returns SRCWIDTH parameter as an int or its default value if not defined.
QStringList allLayersNickname() const
Returns nickname of layers found in LAYER and LAYERS parameters.
QList< QgsWmsParametersFilter > mFilter
QList< QColor > highlightLabelBufferColorAsColor() const
Returns HIGHLIGHT_LABELBUFFERCOLOR as a list of colors.
QString ruleLabel() const
Returns RULELABEL parameter or an empty string if none is defined.
double dxfScale() const
Returns the DXF SCALE parameter.
QgsRectangle toRectangle(bool &ok) const
Converts the parameter into a rectangle.
QList< QColor > toColorList(bool &ok, char delimiter=',') const
Converts the parameter into a list of colors.
double symbolWidthAsDouble() const
Returns SYMBOLWIDTH as a double or its default value if not defined.
QColor layerFontColorAsColor() const
Returns LAYERFONTCOLOR as a color or its defined value if not defined.