QGIS API Documentation 3.39.0-Master (3783037d301)
|
Provides an interface to retrieve and manipulate WMS parameters received from the client. More...
#include <qgswmsparameters.h>
Public Types | |
enum | DxfFormatOption { SCALE , MODE , LAYERATTRIBUTES , USE_TITLE_AS_LAYERNAME , CODEC , NO_MTEXT , FORCE_2D , EXPORT_LINES_WITH_ZERO_WIDTH } |
Options for DXF format. More... | |
enum | Format { NONE , JPG , PNG , SVG , PDF , TEXT , XML , HTML , GML , JSON } |
Output format for the response. More... | |
enum | PdfFormatOption { RASTERIZE_WHOLE_IMAGE , FORCE_VECTOR_OUTPUT , APPEND_GEOREFERENCE , EXPORT_METADATA , TEXT_RENDER_FORMAT , SIMPLIFY_GEOMETRY , WRITE_GEO_PDF , USE_ISO_32000_EXTENSION_FORMAT_GEOREFERENCING , USE_OGC_BEST_PRACTICE_FORMAT_GEOREFERENCING , INCLUDE_GEO_PDF_FEATURES , EXPORT_THEMES , PREDEFINED_MAP_SCALES , LOSSLESS_IMAGE_COMPRESSION , DISABLE_TILED_RASTER_RENDERING } |
Public Member Functions | |
QgsWmsParameters () | |
Constructor for WMS parameters with default values only. | |
QgsWmsParameters (const QgsServerParameters ¶meters) | |
Constructor for WMS parameters with specific values. | |
virtual | ~QgsWmsParameters () override=default |
bool | addLayerGroups () const |
Returns true if layer groups shall be added to GetLegendGraphic results. | |
QStringList | allLayersNickname () const |
Returns nickname of layers found in LAYER and LAYERS parameters. | |
QStringList | allStyles () const |
Returns styles found in STYLE and STYLES parameters. | |
QStringList | atlasPk () const |
Returns the ATLAS_PK parameter. | |
QString | backgroundColor () const |
Returns BGCOLOR parameter or an empty string if not defined. | |
QColor | backgroundColorAsColor () const |
Returns BGCOLOR parameter as a QColor or its default value if not defined. | |
QString | bbox () const |
Returns BBOX if defined or an empty string. | |
QgsRectangle | bboxAsRectangle () const |
Returns BBOX as a rectangle if defined and valid. | |
QString | boxSpace () const |
Returns BOXSPACE parameter or an empty string if not defined. | |
double | boxSpaceAsDouble () const |
Returns BOXSPACE as a double or its default value if not defined. | |
QgsWmsParametersComposerMap | composerMapParameters (int mapId) const |
Returns the requested parameters for a composer map parameter. | |
QString | composerTemplate () const |
Returns TEMPLATE parameter or an empty string if not defined. | |
QString | crs () const |
Returns CRS or an empty string if none is defined. | |
QMap< QString, QString > | dimensionValues () const |
Returns the dimensions parameter. | |
QString | dpi () const |
Returns DPI parameter or an empty string if not defined. | |
double | dpiAsDouble () const |
Returns DPI parameter as an int or its default value if not defined. | |
void | dump () const |
Dumps parameters. | |
QString | dxfCodec () const |
Returns the DXF CODEC parameter. | |
QStringList | dxfLayerAttributes () const |
Returns the DXF LAYERATTRIBUTES parameter. | |
Qgis::FeatureSymbologyExport | dxfMode () const |
Returns the DXF MODE parameter. | |
double | dxfScale () const |
Returns the DXF SCALE parameter. | |
bool | dxfUseLayerTitleAsName () const |
Returns the DXF USE_TITLE_AS_LAYERNAME parameter. | |
bool | exportLinesWithZeroWidth () const |
QList< QgsWmsParametersExternalLayer > | externalLayersParameters () const |
Returns parameters for each external layer. | |
QString | externalWMSUri (const QString &id) const |
Returns the external WMS uri. | |
QString | featureCount () const |
Returns FEATURE_COUNT parameter or an empty string if none is defined. | |
int | featureCountAsInt () const |
Returns FEATURE_COUNT as an integer. | |
QString | filterGeom () const |
Returns the filter geometry found in FILTER_GEOM parameter. | |
QStringList | filters () const |
Returns the list of filters found in FILTER parameter. | |
Format | format () const |
Returns format. | |
QString | formatAsString () const |
Returns FORMAT parameter as a string. | |
template<typename T > | |
QMap< T, QString > | formatOptions () const |
Returns the format options for an output format. | |
QString | height () const |
Returns HEIGHT parameter or an empty string if not defined. | |
int | heightAsInt () const |
Returns HEIGHT parameter as an int or its default value if not defined. | |
QStringList | highlightGeom () const |
Returns HIGHLIGHT_GEOM as a list of string in WKT. | |
QList< QgsGeometry > | highlightGeomAsGeom () const |
Returns HIGHLIGHT_GEOM as a list of geometries. | |
QStringList | highlightLabelBufferColor () const |
Returns HIGHLIGHT_LABELBUFFERCOLOR as a list of string. | |
QList< QColor > | highlightLabelBufferColorAsColor () const |
Returns HIGHLIGHT_LABELBUFFERCOLOR as a list of colors. | |
QStringList | highlightLabelBufferSize () const |
Returns HIGHLIGHT_LABELBUFFERSIZE. | |
QList< double > | highlightLabelBufferSizeAsFloat () const |
Returns HIGHLIGHT_LABELBUFFERSIZE as a list of float. | |
QStringList | highlightLabelColor () const |
Returns HIGHLIGHT_LABELCOLOR as a list of string. | |
QList< QColor > | highlightLabelColorAsColor () const |
Returns HIGHLIGHT_LABELCOLOR as a list of color. | |
QList< double > | highlightLabelDistance () const |
Returns HIGHLIGHT_LABEL_DISTANCE as a list of double. | |
QStringList | highlightLabelFont () const |
Returns HIGHLIGHT_LABELFONT. | |
QStringList | highlightLabelHorizontalAlignment () const |
Returns HIGHLIGHT_LABEL_HORIZONTAL_ALIGNMENT as a list of string. | |
QList< double > | highlightLabelRotation () const |
Returns HIGHLIGHT_LABEL_ROTATION as a list of double. | |
QStringList | highlightLabelSize () const |
Returns HIGHLIGHT_LABELSIZE as a list of string. | |
QList< int > | highlightLabelSizeAsInt () const |
Returns HIGHLIGHT_LABELSIZE as a list of int An exception is raised if an invalid size is found. | |
QStringList | highlightLabelString () const |
Returns HIGHLIGHT_LABELSTRING as a list of string. | |
QStringList | highlightLabelVerticalAlignment () const |
Returns HIGHLIGHT_LABEL_VERTICAL_ALIGNMENT as a list of string. | |
QStringList | highlightLabelWeight () const |
Returns HIGHLIGHT_LABELWEIGHT as a list of string. | |
QList< int > | highlightLabelWeightAsInt () const |
Returns HIGHLIGHT_LABELWEIGHT as a list of int. | |
QList< QgsWmsParametersHighlightLayer > | highlightLayersParameters () const |
Returns parameters for each highlight layer. | |
QStringList | highlightSymbol () const |
Returns HIGHLIGHT_SYMBOL as a list of string. | |
bool | htmlInfoOnlyMapTip () const |
Returns true if only maptip information is requested for HTML feature info response. | |
QString | i () const |
Returns I parameter or an empty string if not defined. | |
int | iAsInt () const |
Returns I parameter as an int or its default value if not defined. | |
QString | iconLabelSpace () const |
Returns ICONLABELSPACE parameter or an empty string if not defined. | |
double | iconLabelSpaceAsDouble () const |
Returns ICONLABELSPACE as a double or its default value if not defined. | |
QString | imageQuality () const |
Returns IMAGE_QUALITY parameter or an empty string if not defined. | |
int | imageQualityAsInt () const |
Returns IMAGE_QUALITY parameter as an integer. | |
Format | infoFormat () const |
Returns infoFormat. | |
QString | infoFormatAsString () const |
Returns INFO_FORMAT parameter as a string. | |
bool | infoFormatIsImage () const |
Checks if INFO_FORMAT parameter is one of the image formats (PNG, JPG). | |
int | infoFormatVersion () const |
Returns the infoFormat version for GML. | |
bool | isForce2D () const |
QFont | itemFont () const |
Returns the item font (built thanks to the ITEMFONTFAMILY, ITEMFONTSIZE, ITEMFONTBOLD, ... parameters). | |
QString | itemFontBold () const |
Returns ITEMFONTBOLD parameter or an empty string if not defined. | |
bool | itemFontBoldAsBool () const |
Returns ITEMFONTBOLD as a boolean or its default value if not defined. | |
QString | itemFontColor () const |
Returns ITEMFONTCOLOR parameter or an empty string if not defined. | |
QColor | itemFontColorAsColor () const |
Returns ITEMFONTCOLOR as a color. | |
QString | itemFontFamily () const |
Returns ITEMFONTFAMILY parameter or an empty string if not defined. | |
QString | itemFontItalic () const |
Returns ITEMFONTITALIC parameter or an empty string if not defined. | |
bool | itemFontItalicAsBool () const |
Returns ITEMFONTITALIC as a boolean or its default value if not defined. | |
QString | itemFontSize () const |
Returns ITEMFONTSIZE parameter or an empty string if not defined. | |
double | itemFontSizeAsDouble () const |
Returns ITEMFONTSIZE as a double. | |
QString | j () const |
Returns J parameter or an empty string if not defined. | |
int | jAsInt () const |
Returns J 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, ... parameters). | |
QString | layerFontBold () const |
Returns LAYERFONTBOLD parameter or an empty string if not defined. | |
bool | layerFontBoldAsBool () const |
Returns LAYERFONTBOLD as a boolean or its default value if not defined. | |
QString | layerFontColor () const |
Returns LAYERFONTCOLOR parameter or an empty string if not defined. | |
QColor | layerFontColorAsColor () const |
Returns LAYERFONTCOLOR as a color or its defined value if not defined. | |
QString | layerFontFamily () const |
Returns LAYERFONTFAMILY parameter or an empty string if not defined. | |
QString | layerFontItalic () const |
Returns LAYERFONTITALIC parameter or an empty string if not defined. | |
bool | layerFontItalicAsBool () const |
Returns LAYERFONTITALIC as a boolean or its default value if not defined. | |
QString | layerFontSize () const |
Returns LAYERFONTSIZE parameter or an empty string if not defined. | |
double | layerFontSizeAsDouble () const |
Returns LAYERFONTSIZE as a double. | |
QString | layerSpace () const |
Returns LAYERSPACE parameter or an empty string if not defined. | |
double | layerSpaceAsDouble () const |
Returns LAYERSPACE as a double or its default value if not defined. | |
QList< QgsWmsParametersLayer > | layersParameters () const |
Returns parameters for each layer found in LAYER/LAYERS. | |
QString | layerTitle () const |
Returns LAYERTITLE parameter or an empty string if not defined. | |
bool | layerTitleAsBool () const |
Returns LAYERTITLE as a bool or its default value if not defined. | |
QString | layerTitleSpace () const |
Returns LAYERTITLESPACE parameter or an empty string if not defined. | |
double | layerTitleSpaceAsDouble () const |
Returns LAYERTITLESPACE as a double. | |
QString | layoutParameter (const QString &id, bool &ok) const |
Returns a layout parameter thanks to its id. | |
QgsLegendSettings | legendSettings () const |
Returns legend settings. | |
QString | lineTolerance () const |
Returns FI_LINE_TOLERANCE parameter or an empty string if not defined. | |
int | lineToleranceAsInt () const |
Returns FI_LINE_TOLERANCE parameter as an integer. | |
bool | noMText () const |
QStringList | opacities () const |
Returns the list of opacities found in OPACITIES parameter. | |
QList< int > | opacitiesAsInt () const |
Returns the list of opacities found in OPACITIES parameter as integers. | |
QgsWmsParameter | operator[] (QgsWmsParameter::Name name) const |
Returns the parameter corresponding to name. | |
bool | pdfAppendGeoreference () const |
Returns true if georeference info shall be added to the pdf. | |
bool | pdfDisableTiledRasterRendering () const |
Returns true if rasters shall be untiled in the pdf. | |
QStringList | pdfExportMapThemes () const |
Returns map themes for geospatial PDF export. | |
bool | pdfExportMetadata () const |
Returns true if metadata shall be added to the pdf. | |
bool | pdfForceVectorOutput () const |
Returns if pdf should be exported as vector. | |
bool | pdfLosslessImageCompression () const |
Returns true if images embedded in pdf must be compressed using a lossless algorithm. | |
QVector< qreal > | pdfPredefinedMapScales () const |
Returns list of map scales. | |
bool | pdfSimplifyGeometries () const |
Returns if geometries shall to be simplified. | |
Qgis::TextRenderFormat | pdfTextRenderFormat () const |
Returns text render format for pdf export. | |
bool | pdfUseIso32000ExtensionFormatGeoreferencing () const |
Returns true, if Iso32000 georeferencing shall be used. | |
bool | pdfUseOgcBestPracticeFormatGeoreferencing () const |
Returns true if OGC best practice georeferencing shall be used. | |
QString | pointTolerance () const |
Returns FI_POINT_TOLERANCE parameter or an empty string if not defined. | |
int | pointToleranceAsInt () const |
Returns FI_POINT_TOLERANCE parameter as an integer. | |
QString | polygonTolerance () const |
Returns FI_POLYGON_TOLERANCE parameter or an empty string if not defined. | |
int | polygonToleranceAsInt () const |
Returns FI_POLYGON_TOLERANCE parameter as an integer. | |
QStringList | queryLayersNickname () const |
Returns nickname of layers found in QUERY_LAYERS parameter. | |
QString | request () const override |
Returns REQUEST parameter as a string or an empty string if not defined. | |
QString | rule () const |
Returns RULE parameter or an empty string if none is defined. | |
QString | ruleLabel () const |
Returns RULELABEL parameter or an empty string if none is defined. | |
bool | ruleLabelAsBool () const |
Returns RULELABEL as a bool. | |
QString | scale () const |
Returns SCALE parameter or an empty string if none is defined. | |
double | scaleAsDouble () const |
Returns SCALE as a double. | |
QStringList | selections () const |
Returns the list of feature selection found in SELECTION parameter. | |
void | set (QgsWmsParameter::Name name, const QVariant &value) |
Sets a parameter value thanks to its name. | |
QString | showFeatureCount () const |
Returns SHOWFEATURECOUNT parameter or an empty string if none is defined. | |
bool | showFeatureCountAsBool () const |
Returns SHOWFEATURECOUNT as a bool. | |
bool | showRuleDetailsAsBool () const |
Returns SHOWRULEDETAILS as a bool. | |
QString | sldBody () const |
Returns SLD_body if defined or an empty string. | |
QString | srcHeight () const |
Returns SRCHEIGHT parameter or an empty string if not defined. | |
int | srcHeightAsInt () const |
Returns SRCHEIGHT parameter as an int or its default value if not defined. | |
QString | srcWidth () const |
Returns SRCWIDTH parameter or an empty string if not defined. | |
int | srcWidthAsInt () const |
Returns SRCWIDTH parameter as an int or its default value if not defined. | |
QString | symbolHeight () const |
Returns SYMBOLHEIGHT parameter or an empty string if not defined. | |
double | symbolHeightAsDouble () const |
Returns SYMBOLHEIGHT as a double or its default value if not defined. | |
QString | symbolSpace () const |
Returns SYMBOLSPACE parameter or an empty string if not defined. | |
double | symbolSpaceAsDouble () const |
Returns SYMBOLSPACE as a double or its default value if not defined. | |
QString | symbolWidth () const |
Returns SYMBOLWIDTH parameter or an empty string if not defined. | |
double | symbolWidthAsDouble () const |
Returns SYMBOLWIDTH as a double or its default value if not defined. | |
QString | tiled () const |
Returns TILED parameter or an empty string if not defined. | |
bool | tiledAsBool () const |
Returns TILED parameter as a boolean. | |
QString | transparent () const |
Returns TRANSPARENT parameter or an empty string if not defined. | |
bool | transparentAsBool () const |
Returns TRANSPARENT parameter as a bool or its default value if not defined. | |
QString | version () const override |
Returns VERSION parameter as a string or an empty string if not defined. | |
QgsProjectVersion | versionAsNumber () const |
Returns VERSION parameter if defined or its default value. | |
bool | versionIsValid (const QString version) const |
Returns true if version is valid, false otherwise. | |
QString | width () const |
Returns WIDTH parameter or an empty string if not defined. | |
int | widthAsInt () const |
Returns WIDTH parameter as an int or its default value if not defined. | |
bool | withDisplayName () const |
withDisplayName | |
bool | withGeometry () const |
Returns if the client wants the feature info response with geometry information. | |
bool | withMapTip () const |
withMapTip | |
QString | withMapTipAsString () const |
withMapTipAsString | |
QString | wmsPrecision () const |
Returns WMS_PRECISION parameter or an empty string if not defined. | |
int | wmsPrecisionAsInt () const |
Returns WMS_PRECISION parameter as an int or its default value if not defined. | |
QString | wmtver () const |
Returns WMTVER parameter or an empty string if not defined. | |
bool | writeGeospatialPdf () const |
Returns if a geospatial PDF shall be exported. | |
QString | x () const |
Returns X parameter or an empty string if not defined. | |
int | xAsInt () const |
Returns X parameter as an int or its default value if not defined. | |
QString | y () const |
Returns Y parameter or an empty string if not defined. | |
int | yAsInt () const |
Returns Y parameter as an int or its default value if not defined. | |
Public Member Functions inherited from QgsServerParameters | |
QgsServerParameters () | |
Constructor. | |
QgsServerParameters (const QUrlQuery &query) | |
Constructor. | |
virtual | ~QgsServerParameters ()=default |
void | add (const QString &key, const QString &value) |
Adds a parameter. | |
void | clear () |
Removes all parameters. | |
QString | fileName () const |
Returns FILE_NAME parameter as a string or an empty string if not defined. | |
void | load (const QUrlQuery &query) |
Loads new parameters. | |
QString | map () const |
Returns MAP parameter as a string or an empty string if not defined. | |
void | remove (const QString &key) |
Removes a parameter. | |
void | remove (QgsServerParameter::Name name) |
Removes a parameter. | |
QString | service () const |
Returns SERVICE parameter as a string or an empty string if not defined. | |
QMap< QString, QString > | toMap () const |
Returns all parameters in a map. | |
QUrlQuery | urlQuery () const |
Returns a url query with underlying parameters. | |
QString | value (const QString &key) const |
Returns the value of a parameter. | |
Static Public Member Functions | |
static QString | formatAsString (Format format) |
Returns format parameter as a string. | |
Additional Inherited Members | |
Protected Attributes inherited from QgsServerParameters | |
QMap< QString, QString > | mUnmanagedParameters |
Provides an interface to retrieve and manipulate WMS parameters received from the client.
Definition at line 334 of file qgswmsparameters.h.
Options for DXF format.
Enumerator | |
---|---|
SCALE | |
MODE | |
LAYERATTRIBUTES | |
USE_TITLE_AS_LAYERNAME | |
CODEC | |
NO_MTEXT | |
FORCE_2D | |
EXPORT_LINES_WITH_ZERO_WIDTH |
Definition at line 357 of file qgswmsparameters.h.
Output format for the response.
Enumerator | |
---|---|
NONE | |
JPG | |
PNG | |
SVG | |
TEXT | |
XML | |
HTML | |
GML | |
JSON |
Definition at line 341 of file qgswmsparameters.h.
Definition at line 370 of file qgswmsparameters.h.
QgsWms::QgsWmsParameters::QgsWmsParameters | ( | const QgsServerParameters & | parameters | ) |
Constructor for WMS parameters with specific values.
parameters | Map of parameters where keys are parameters' names. |
Definition at line 569 of file qgswmsparameters.cpp.
QgsWms::QgsWmsParameters::QgsWmsParameters | ( | ) |
Constructor for WMS parameters with default values only.
Definition at line 217 of file qgswmsparameters.cpp.
|
overridevirtualdefault |
bool QgsWms::QgsWmsParameters::addLayerGroups | ( | ) | const |
Returns true if layer groups shall be added to GetLegendGraphic results.
Definition at line 1048 of file qgswmsparameters.cpp.
QStringList QgsWms::QgsWmsParameters::allLayersNickname | ( | ) | const |
Returns nickname of layers found in LAYER and LAYERS parameters.
Definition at line 1493 of file qgswmsparameters.cpp.
QStringList QgsWms::QgsWmsParameters::allStyles | ( | ) | const |
Returns styles found in STYLE and STYLES parameters.
Definition at line 1533 of file qgswmsparameters.cpp.
QStringList QgsWms::QgsWmsParameters::atlasPk | ( | ) | const |
Returns the ATLAS_PK parameter.
Definition at line 1365 of file qgswmsparameters.cpp.
QString QgsWms::QgsWmsParameters::backgroundColor | ( | ) | const |
Returns BGCOLOR parameter or an empty string if not defined.
Definition at line 1793 of file qgswmsparameters.cpp.
QColor QgsWms::QgsWmsParameters::backgroundColorAsColor | ( | ) | const |
Returns BGCOLOR parameter as a QColor or its default value if not defined.
An exception is raised if BGCOLOR is defined and cannot be converted.
QgsBadRequestException |
Definition at line 1798 of file qgswmsparameters.cpp.
QString QgsWms::QgsWmsParameters::bbox | ( | ) | const |
Returns BBOX if defined or an empty string.
Definition at line 735 of file qgswmsparameters.cpp.
QgsRectangle QgsWms::QgsWmsParameters::bboxAsRectangle | ( | ) | const |
Returns BBOX as a rectangle if defined and valid.
An exception is raised if the BBOX string cannot be converted into a rectangle.
QgsBadRequestException |
Definition at line 740 of file qgswmsparameters.cpp.
QString QgsWms::QgsWmsParameters::boxSpace | ( | ) | const |
Returns BOXSPACE parameter or an empty string if not defined.
Definition at line 1073 of file qgswmsparameters.cpp.
double QgsWms::QgsWmsParameters::boxSpaceAsDouble | ( | ) | const |
Returns BOXSPACE as a double or its default value if not defined.
An exception is raised if an invalid parameter is found.
QgsBadRequestException |
Definition at line 1078 of file qgswmsparameters.cpp.
QgsWmsParametersComposerMap QgsWms::QgsWmsParameters::composerMapParameters | ( | int | mapId | ) | const |
Returns the requested parameters for a composer map parameter.
An exception is raised if parameters are defined and cannot be converted like EXTENT, SCALE, ROTATION, GRID_INTERVAL_X and GRID_INTERVAL_Y.
mapId | the composer map id. |
QgsBadRequestException |
Definition at line 1808 of file qgswmsparameters.cpp.
QString QgsWms::QgsWmsParameters::composerTemplate | ( | ) | const |
Returns TEMPLATE parameter or an empty string if not defined.
Definition at line 1803 of file qgswmsparameters.cpp.
QString QgsWms::QgsWmsParameters::crs | ( | ) | const |
Returns CRS or an empty string if none is defined.
Definition at line 712 of file qgswmsparameters.cpp.
QMap< QString, QString > QgsWms::QgsWmsParameters::dimensionValues | ( | ) | const |
Returns the dimensions parameter.
Definition at line 2431 of file qgswmsparameters.cpp.
QString QgsWms::QgsWmsParameters::dpi | ( | ) | const |
Returns DPI parameter or an empty string if not defined.
Definition at line 785 of file qgswmsparameters.cpp.
double QgsWms::QgsWmsParameters::dpiAsDouble | ( | ) | const |
Returns DPI parameter as an int or its default value if not defined.
An exception is raised if DPI is defined and cannot be converted.
QgsBadRequestException |
Definition at line 790 of file qgswmsparameters.cpp.
void QgsWms::QgsWmsParameters::dump | ( | ) | const |
Dumps parameters.
Definition at line 661 of file qgswmsparameters.cpp.
QString QgsWms::QgsWmsParameters::dxfCodec | ( | ) | const |
Returns the DXF CODEC parameter.
Definition at line 2271 of file qgswmsparameters.cpp.
QStringList QgsWms::QgsWmsParameters::dxfLayerAttributes | ( | ) | const |
Returns the DXF LAYERATTRIBUTES parameter.
Definition at line 2208 of file qgswmsparameters.cpp.
Qgis::FeatureSymbologyExport QgsWms::QgsWmsParameters::dxfMode | ( | ) | const |
double QgsWms::QgsWmsParameters::dxfScale | ( | ) | const |
Returns the DXF SCALE parameter.
Definition at line 2234 of file qgswmsparameters.cpp.
bool QgsWms::QgsWmsParameters::dxfUseLayerTitleAsName | ( | ) | const |
Returns the DXF USE_TITLE_AS_LAYERNAME parameter.
Definition at line 2221 of file qgswmsparameters.cpp.
bool QgsWms::QgsWmsParameters::exportLinesWithZeroWidth | ( | ) | const |
Definition at line 1608 of file qgswmsparameters.cpp.
QList< QgsWmsParametersExternalLayer > QgsWms::QgsWmsParameters::externalLayersParameters | ( | ) | const |
Returns parameters for each external layer.
Definition at line 1776 of file qgswmsparameters.cpp.
QString QgsWms::QgsWmsParameters::externalWMSUri | ( | const QString & | id | ) | const |
Returns the external WMS uri.
id | the id of the external wms |
Definition at line 2048 of file qgswmsparameters.cpp.
QString QgsWms::QgsWmsParameters::featureCount | ( | ) | const |
Returns FEATURE_COUNT parameter or an empty string if none is defined.
Definition at line 1063 of file qgswmsparameters.cpp.
int QgsWms::QgsWmsParameters::featureCountAsInt | ( | ) | const |
Returns FEATURE_COUNT as an integer.
An exception is raised if an invalid parameter is found.
QgsBadRequestException |
Definition at line 1068 of file qgswmsparameters.cpp.
QString QgsWms::QgsWmsParameters::filterGeom | ( | ) | const |
Returns the filter geometry found in FILTER_GEOM parameter.
Definition at line 1473 of file qgswmsparameters.cpp.
QStringList QgsWms::QgsWmsParameters::filters | ( | ) | const |
Returns the list of filters found in FILTER parameter.
Definition at line 1465 of file qgswmsparameters.cpp.
QgsWmsParameters::Format QgsWms::QgsWmsParameters::format | ( | ) | const |
Returns format.
If the FORMAT parameter is not used, then the default value is PNG.
Definition at line 866 of file qgswmsparameters.cpp.
QString QgsWms::QgsWmsParameters::formatAsString | ( | ) | const |
Returns FORMAT parameter as a string.
Definition at line 855 of file qgswmsparameters.cpp.
|
static |
Returns format parameter as a string.
Definition at line 860 of file qgswmsparameters.cpp.
|
inline |
Returns the format options for an output format.
Possible template types are QgsWmsParameters::PdfFormatOption or QgsWmsParameters::DxfFormatOption
Definition at line 1501 of file qgswmsparameters.h.
QString QgsWms::QgsWmsParameters::height | ( | ) | const |
Returns HEIGHT parameter or an empty string if not defined.
Definition at line 745 of file qgswmsparameters.cpp.
int QgsWms::QgsWmsParameters::heightAsInt | ( | ) | const |
Returns HEIGHT parameter as an int or its default value if not defined.
An exception is raised if HEIGHT is defined and cannot be converted.
QgsBadRequestException |
Definition at line 755 of file qgswmsparameters.cpp.
QStringList QgsWms::QgsWmsParameters::highlightGeom | ( | ) | const |
Returns HIGHLIGHT_GEOM as a list of string in WKT.
Definition at line 697 of file qgswmsparameters.cpp.
QList< QgsGeometry > QgsWms::QgsWmsParameters::highlightGeomAsGeom | ( | ) | const |
Returns HIGHLIGHT_GEOM as a list of geometries.
An exception is raised if an invalid geometry is found.
QgsBadRequestException |
Definition at line 702 of file qgswmsparameters.cpp.
QStringList QgsWms::QgsWmsParameters::highlightLabelBufferColor | ( | ) | const |
Returns HIGHLIGHT_LABELBUFFERCOLOR as a list of string.
Definition at line 1410 of file qgswmsparameters.cpp.
QList< QColor > QgsWms::QgsWmsParameters::highlightLabelBufferColorAsColor | ( | ) | const |
Returns HIGHLIGHT_LABELBUFFERCOLOR as a list of colors.
An axception is raised if an invalid color is found.
QgsBadRequestException |
Definition at line 1415 of file qgswmsparameters.cpp.
QStringList QgsWms::QgsWmsParameters::highlightLabelBufferSize | ( | ) | const |
Returns HIGHLIGHT_LABELBUFFERSIZE.
Definition at line 1420 of file qgswmsparameters.cpp.
QList< double > QgsWms::QgsWmsParameters::highlightLabelBufferSizeAsFloat | ( | ) | const |
Returns HIGHLIGHT_LABELBUFFERSIZE as a list of float.
An exception is raised if an invalid size is found.
QgsBadRequestException |
Definition at line 1425 of file qgswmsparameters.cpp.
QStringList QgsWms::QgsWmsParameters::highlightLabelColor | ( | ) | const |
Returns HIGHLIGHT_LABELCOLOR as a list of string.
Definition at line 1385 of file qgswmsparameters.cpp.
QList< QColor > QgsWms::QgsWmsParameters::highlightLabelColorAsColor | ( | ) | const |
Returns HIGHLIGHT_LABELCOLOR as a list of color.
An exception is raised if an invalid color is found.
QgsBadRequestException |
Definition at line 1390 of file qgswmsparameters.cpp.
QList< double > QgsWms::QgsWmsParameters::highlightLabelDistance | ( | ) | const |
Returns HIGHLIGHT_LABEL_DISTANCE as a list of double.
Definition at line 1435 of file qgswmsparameters.cpp.
QStringList QgsWms::QgsWmsParameters::highlightLabelFont | ( | ) | const |
Returns HIGHLIGHT_LABELFONT.
Definition at line 1405 of file qgswmsparameters.cpp.
QStringList QgsWms::QgsWmsParameters::highlightLabelHorizontalAlignment | ( | ) | const |
Returns HIGHLIGHT_LABEL_HORIZONTAL_ALIGNMENT as a list of string.
Definition at line 1440 of file qgswmsparameters.cpp.
QList< double > QgsWms::QgsWmsParameters::highlightLabelRotation | ( | ) | const |
Returns HIGHLIGHT_LABEL_ROTATION as a list of double.
Definition at line 1430 of file qgswmsparameters.cpp.
QStringList QgsWms::QgsWmsParameters::highlightLabelSize | ( | ) | const |
Returns HIGHLIGHT_LABELSIZE as a list of string.
Definition at line 1375 of file qgswmsparameters.cpp.
QList< int > QgsWms::QgsWmsParameters::highlightLabelSizeAsInt | ( | ) | const |
Returns HIGHLIGHT_LABELSIZE as a list of int An exception is raised if an invalid size is found.
QgsBadRequestException |
Definition at line 1380 of file qgswmsparameters.cpp.
QStringList QgsWms::QgsWmsParameters::highlightLabelString | ( | ) | const |
Returns HIGHLIGHT_LABELSTRING as a list of string.
Definition at line 1370 of file qgswmsparameters.cpp.
QStringList QgsWms::QgsWmsParameters::highlightLabelVerticalAlignment | ( | ) | const |
Returns HIGHLIGHT_LABEL_VERTICAL_ALIGNMENT as a list of string.
Definition at line 1445 of file qgswmsparameters.cpp.
QStringList QgsWms::QgsWmsParameters::highlightLabelWeight | ( | ) | const |
Returns HIGHLIGHT_LABELWEIGHT as a list of string.
Definition at line 1395 of file qgswmsparameters.cpp.
QList< int > QgsWms::QgsWmsParameters::highlightLabelWeightAsInt | ( | ) | const |
Returns HIGHLIGHT_LABELWEIGHT as a list of int.
An exception is raised if an invalid weight is found.
QgsBadRequestException |
Definition at line 1400 of file qgswmsparameters.cpp.
QList< QgsWmsParametersHighlightLayer > QgsWms::QgsWmsParameters::highlightLayersParameters | ( | ) | const |
Returns parameters for each highlight layer.
Definition at line 1710 of file qgswmsparameters.cpp.
QStringList QgsWms::QgsWmsParameters::highlightSymbol | ( | ) | const |
Returns HIGHLIGHT_SYMBOL as a list of string.
Definition at line 707 of file qgswmsparameters.cpp.
bool QgsWms::QgsWmsParameters::htmlInfoOnlyMapTip | ( | ) | const |
Returns true
if only maptip information is requested for HTML feature info response.
Definition at line 2147 of file qgswmsparameters.cpp.
QString QgsWms::QgsWmsParameters::i | ( | ) | const |
Returns I parameter or an empty string if not defined.
Definition at line 948 of file qgswmsparameters.cpp.
int QgsWms::QgsWmsParameters::iAsInt | ( | ) | const |
Returns I parameter as an int or its default value if not defined.
An exception is raised if I is defined and cannot be converted.
QgsBadRequestException |
Definition at line 958 of file qgswmsparameters.cpp.
QString QgsWms::QgsWmsParameters::iconLabelSpace | ( | ) | const |
Returns ICONLABELSPACE parameter or an empty string if not defined.
Definition at line 1133 of file qgswmsparameters.cpp.
double QgsWms::QgsWmsParameters::iconLabelSpaceAsDouble | ( | ) | const |
Returns ICONLABELSPACE as a double or its default value if not defined.
An exception is raised if an invalid parameter is found.
QgsBadRequestException |
Definition at line 1138 of file qgswmsparameters.cpp.
QString QgsWms::QgsWmsParameters::imageQuality | ( | ) | const |
Returns IMAGE_QUALITY parameter or an empty string if not defined.
Definition at line 1028 of file qgswmsparameters.cpp.
int QgsWms::QgsWmsParameters::imageQualityAsInt | ( | ) | const |
Returns IMAGE_QUALITY parameter as an integer.
QgsBadRequestException |
Definition at line 1033 of file qgswmsparameters.cpp.
QgsWmsParameters::Format QgsWms::QgsWmsParameters::infoFormat | ( | ) | const |
Returns infoFormat.
If the INFO_FORMAT parameter is not used, then the default value is text/plain.
Definition at line 911 of file qgswmsparameters.cpp.
QString QgsWms::QgsWmsParameters::infoFormatAsString | ( | ) | const |
Returns INFO_FORMAT parameter as a string.
Definition at line 901 of file qgswmsparameters.cpp.
bool QgsWms::QgsWmsParameters::infoFormatIsImage | ( | ) | const |
Checks if INFO_FORMAT parameter is one of the image formats (PNG, JPG).
true
if the INFO_FORMAT is an image format Definition at line 906 of file qgswmsparameters.cpp.
int QgsWms::QgsWmsParameters::infoFormatVersion | ( | ) | const |
Returns the infoFormat version for GML.
If the INFO_FORMAT is not GML, then the default value is -1.
Definition at line 936 of file qgswmsparameters.cpp.
bool QgsWms::QgsWmsParameters::isForce2D | ( | ) | const |
Definition at line 1595 of file qgswmsparameters.cpp.
QFont QgsWms::QgsWmsParameters::itemFont | ( | ) | const |
Returns the item font (built thanks to the ITEMFONTFAMILY, ITEMFONTSIZE, ITEMFONTBOLD, ... parameters).
Definition at line 1279 of file qgswmsparameters.cpp.
QString QgsWms::QgsWmsParameters::itemFontBold | ( | ) | const |
Returns ITEMFONTBOLD parameter or an empty string if not defined.
Definition at line 1163 of file qgswmsparameters.cpp.
bool QgsWms::QgsWmsParameters::itemFontBoldAsBool | ( | ) | const |
Returns ITEMFONTBOLD as a boolean or its default value if not defined.
An exception is raised if an invalid parameter is found.
QgsBadRequestException |
Definition at line 1198 of file qgswmsparameters.cpp.
QString QgsWms::QgsWmsParameters::itemFontColor | ( | ) | const |
Returns ITEMFONTCOLOR parameter or an empty string if not defined.
Definition at line 1253 of file qgswmsparameters.cpp.
QColor QgsWms::QgsWmsParameters::itemFontColorAsColor | ( | ) | const |
Returns ITEMFONTCOLOR as a color.
An exception is raised if an invalid parameter is found.
QgsBadRequestException |
Definition at line 1258 of file qgswmsparameters.cpp.
QString QgsWms::QgsWmsParameters::itemFontFamily | ( | ) | const |
Returns ITEMFONTFAMILY parameter or an empty string if not defined.
Definition at line 1148 of file qgswmsparameters.cpp.
QString QgsWms::QgsWmsParameters::itemFontItalic | ( | ) | const |
Returns ITEMFONTITALIC parameter or an empty string if not defined.
Definition at line 1213 of file qgswmsparameters.cpp.
bool QgsWms::QgsWmsParameters::itemFontItalicAsBool | ( | ) | const |
Returns ITEMFONTITALIC as a boolean or its default value if not defined.
An exception is raised if an invalid parameter is found.
QgsBadRequestException |
Definition at line 1218 of file qgswmsparameters.cpp.
QString QgsWms::QgsWmsParameters::itemFontSize | ( | ) | const |
Returns ITEMFONTSIZE parameter or an empty string if not defined.
Definition at line 1243 of file qgswmsparameters.cpp.
double QgsWms::QgsWmsParameters::itemFontSizeAsDouble | ( | ) | const |
Returns ITEMFONTSIZE as a double.
An exception is raised if an invalid parameter is found.
QgsBadRequestException |
Definition at line 1248 of file qgswmsparameters.cpp.
QString QgsWms::QgsWmsParameters::j | ( | ) | const |
Returns J parameter or an empty string if not defined.
Definition at line 953 of file qgswmsparameters.cpp.
int QgsWms::QgsWmsParameters::jAsInt | ( | ) | const |
Returns J parameter as an int or its default value if not defined.
An exception is raised if J is defined and cannot be converted.
QgsBadRequestException |
Definition at line 963 of file qgswmsparameters.cpp.
QFont QgsWms::QgsWmsParameters::layerFont | ( | ) | const |
Returns the layer font (built thanks to the LAYERFONTFAMILY, LAYERFONTSIZE, LAYERFONTBOLD, ... parameters).
Definition at line 1263 of file qgswmsparameters.cpp.
QString QgsWms::QgsWmsParameters::layerFontBold | ( | ) | const |
Returns LAYERFONTBOLD parameter or an empty string if not defined.
Definition at line 1153 of file qgswmsparameters.cpp.
bool QgsWms::QgsWmsParameters::layerFontBoldAsBool | ( | ) | const |
Returns LAYERFONTBOLD as a boolean or its default value if not defined.
An exception is raised if an invalid parameter is found.
QgsBadRequestException |
Definition at line 1158 of file qgswmsparameters.cpp.
QString QgsWms::QgsWmsParameters::layerFontColor | ( | ) | const |
Returns LAYERFONTCOLOR parameter or an empty string if not defined.
Definition at line 1233 of file qgswmsparameters.cpp.
QColor QgsWms::QgsWmsParameters::layerFontColorAsColor | ( | ) | const |
Returns LAYERFONTCOLOR as a color or its defined value if not defined.
An exception is raised if an invalid parameter is found.
QgsBadRequestException |
Definition at line 1238 of file qgswmsparameters.cpp.
QString QgsWms::QgsWmsParameters::layerFontFamily | ( | ) | const |
Returns LAYERFONTFAMILY parameter or an empty string if not defined.
Definition at line 1143 of file qgswmsparameters.cpp.
QString QgsWms::QgsWmsParameters::layerFontItalic | ( | ) | const |
Returns LAYERFONTITALIC parameter or an empty string if not defined.
Definition at line 1203 of file qgswmsparameters.cpp.
bool QgsWms::QgsWmsParameters::layerFontItalicAsBool | ( | ) | const |
Returns LAYERFONTITALIC as a boolean or its default value if not defined.
An exception is raised if an invalid parameter is found.
QgsBadRequestException |
Definition at line 1208 of file qgswmsparameters.cpp.
QString QgsWms::QgsWmsParameters::layerFontSize | ( | ) | const |
Returns LAYERFONTSIZE parameter or an empty string if not defined.
Definition at line 1223 of file qgswmsparameters.cpp.
double QgsWms::QgsWmsParameters::layerFontSizeAsDouble | ( | ) | const |
Returns LAYERFONTSIZE as a double.
An exception is raised if an invalid parameter is found.
QgsBadRequestException |
Definition at line 1228 of file qgswmsparameters.cpp.
QString QgsWms::QgsWmsParameters::layerSpace | ( | ) | const |
Returns LAYERSPACE parameter or an empty string if not defined.
Definition at line 1083 of file qgswmsparameters.cpp.
double QgsWms::QgsWmsParameters::layerSpaceAsDouble | ( | ) | const |
Returns LAYERSPACE as a double or its default value if not defined.
An exception is raised if an invalid parameter is found.
QgsBadRequestException |
Definition at line 1088 of file qgswmsparameters.cpp.
QList< QgsWmsParametersLayer > QgsWms::QgsWmsParameters::layersParameters | ( | ) | const |
Returns parameters for each layer found in LAYER/LAYERS.
Definition at line 1635 of file qgswmsparameters.cpp.
QString QgsWms::QgsWmsParameters::layerTitle | ( | ) | const |
Returns LAYERTITLE parameter or an empty string if not defined.
Definition at line 1296 of file qgswmsparameters.cpp.
bool QgsWms::QgsWmsParameters::layerTitleAsBool | ( | ) | const |
Returns LAYERTITLE as a bool or its default value if not defined.
An exception is raised if an invalid parameter is found.
QgsBadRequestException |
Definition at line 1301 of file qgswmsparameters.cpp.
QString QgsWms::QgsWmsParameters::layerTitleSpace | ( | ) | const |
Returns LAYERTITLESPACE parameter or an empty string if not defined.
Definition at line 1093 of file qgswmsparameters.cpp.
double QgsWms::QgsWmsParameters::layerTitleSpaceAsDouble | ( | ) | const |
Returns LAYERTITLESPACE as a double.
An exception is raised if an invalid parameter is found.
QgsBadRequestException |
Definition at line 1098 of file qgswmsparameters.cpp.
QString QgsWms::QgsWmsParameters::layoutParameter | ( | const QString & | id, |
bool & | ok | ||
) | const |
Returns a layout parameter thanks to its id.
id | Parameter id |
ok | true if the parameter is valid, false otherwise |
Definition at line 1351 of file qgswmsparameters.cpp.
QgsLegendSettings QgsWms::QgsWmsParameters::legendSettings | ( | ) | const |
Returns legend settings.
Definition at line 1306 of file qgswmsparameters.cpp.
QString QgsWms::QgsWmsParameters::lineTolerance | ( | ) | const |
Returns FI_LINE_TOLERANCE parameter or an empty string if not defined.
Definition at line 1173 of file qgswmsparameters.cpp.
int QgsWms::QgsWmsParameters::lineToleranceAsInt | ( | ) | const |
Returns FI_LINE_TOLERANCE parameter as an integer.
QgsBadRequestException |
Definition at line 1188 of file qgswmsparameters.cpp.
bool QgsWms::QgsWmsParameters::noMText | ( | ) | const |
Definition at line 1621 of file qgswmsparameters.cpp.
QStringList QgsWms::QgsWmsParameters::opacities | ( | ) | const |
Returns the list of opacities found in OPACITIES parameter.
Definition at line 1483 of file qgswmsparameters.cpp.
QList< int > QgsWms::QgsWmsParameters::opacitiesAsInt | ( | ) | const |
Returns the list of opacities found in OPACITIES parameter as integers.
If an opacity cannot be converted into an integer, then an exception is raised
QgsBadRequestException |
Definition at line 1488 of file qgswmsparameters.cpp.
QgsWmsParameter QgsWms::QgsWmsParameters::operator[] | ( | QgsWmsParameter::Name | name | ) | const |
Returns the parameter corresponding to name.
Definition at line 585 of file qgswmsparameters.cpp.
bool QgsWms::QgsWmsParameters::pdfAppendGeoreference | ( | ) | const |
Returns true if georeference info shall be added to the pdf.
Definition at line 2305 of file qgswmsparameters.cpp.
bool QgsWms::QgsWmsParameters::pdfDisableTiledRasterRendering | ( | ) | const |
Returns true if rasters shall be untiled in the pdf.
Definition at line 2367 of file qgswmsparameters.cpp.
QStringList QgsWms::QgsWmsParameters::pdfExportMapThemes | ( | ) | const |
Returns map themes for geospatial PDF export.
Definition at line 2400 of file qgswmsparameters.cpp.
bool QgsWms::QgsWmsParameters::pdfExportMetadata | ( | ) | const |
Returns true if metadata shall be added to the pdf.
Definition at line 2327 of file qgswmsparameters.cpp.
bool QgsWms::QgsWmsParameters::pdfForceVectorOutput | ( | ) | const |
Returns if pdf should be exported as vector.
Definition at line 2294 of file qgswmsparameters.cpp.
bool QgsWms::QgsWmsParameters::pdfLosslessImageCompression | ( | ) | const |
Returns true if images embedded in pdf must be compressed using a lossless algorithm.
Definition at line 2356 of file qgswmsparameters.cpp.
QVector< qreal > QgsWms::QgsWmsParameters::pdfPredefinedMapScales | ( | ) | const |
bool QgsWms::QgsWmsParameters::pdfSimplifyGeometries | ( | ) | const |
Returns if geometries shall to be simplified.
Definition at line 2316 of file qgswmsparameters.cpp.
Qgis::TextRenderFormat QgsWms::QgsWmsParameters::pdfTextRenderFormat | ( | ) | const |
Returns text render format for pdf export.
Definition at line 2338 of file qgswmsparameters.cpp.
bool QgsWms::QgsWmsParameters::pdfUseIso32000ExtensionFormatGeoreferencing | ( | ) | const |
Returns true, if Iso32000 georeferencing shall be used.
Definition at line 2378 of file qgswmsparameters.cpp.
bool QgsWms::QgsWmsParameters::pdfUseOgcBestPracticeFormatGeoreferencing | ( | ) | const |
Returns true if OGC best practice georeferencing shall be used.
Definition at line 2389 of file qgswmsparameters.cpp.
QString QgsWms::QgsWmsParameters::pointTolerance | ( | ) | const |
Returns FI_POINT_TOLERANCE parameter or an empty string if not defined.
Definition at line 1178 of file qgswmsparameters.cpp.
int QgsWms::QgsWmsParameters::pointToleranceAsInt | ( | ) | const |
Returns FI_POINT_TOLERANCE parameter as an integer.
QgsBadRequestException |
Definition at line 1193 of file qgswmsparameters.cpp.
QString QgsWms::QgsWmsParameters::polygonTolerance | ( | ) | const |
Returns FI_POLYGON_TOLERANCE parameter or an empty string if not defined.
Definition at line 1168 of file qgswmsparameters.cpp.
int QgsWms::QgsWmsParameters::polygonToleranceAsInt | ( | ) | const |
Returns FI_POLYGON_TOLERANCE parameter as an integer.
QgsBadRequestException |
Definition at line 1183 of file qgswmsparameters.cpp.
QStringList QgsWms::QgsWmsParameters::queryLayersNickname | ( | ) | const |
Returns nickname of layers found in QUERY_LAYERS parameter.
Definition at line 1528 of file qgswmsparameters.cpp.
|
overridevirtual |
Returns REQUEST parameter as a string or an empty string if not defined.
Reimplemented from QgsServerParameters.
Definition at line 832 of file qgswmsparameters.cpp.
QString QgsWms::QgsWmsParameters::rule | ( | ) | const |
Returns RULE parameter or an empty string if none is defined.
Definition at line 988 of file qgswmsparameters.cpp.
QString QgsWms::QgsWmsParameters::ruleLabel | ( | ) | const |
Returns RULELABEL parameter or an empty string if none is defined.
Definition at line 998 of file qgswmsparameters.cpp.
bool QgsWms::QgsWmsParameters::ruleLabelAsBool | ( | ) | const |
Returns RULELABEL as a bool.
An exception is raised if an invalid parameter is found.
QgsBadRequestException |
Definition at line 1003 of file qgswmsparameters.cpp.
QString QgsWms::QgsWmsParameters::scale | ( | ) | const |
Returns SCALE parameter or an empty string if none is defined.
Definition at line 1018 of file qgswmsparameters.cpp.
double QgsWms::QgsWmsParameters::scaleAsDouble | ( | ) | const |
Returns SCALE as a double.
An exception is raised if an invalid parameter is found.
QgsBadRequestException |
Definition at line 1023 of file qgswmsparameters.cpp.
QStringList QgsWms::QgsWmsParameters::selections | ( | ) | const |
Returns the list of feature selection found in SELECTION parameter.
Definition at line 1478 of file qgswmsparameters.cpp.
void QgsWms::QgsWmsParameters::set | ( | QgsWmsParameter::Name | name, |
const QVariant & | value | ||
) |
Sets a parameter value thanks to its name.
Definition at line 590 of file qgswmsparameters.cpp.
QString QgsWms::QgsWmsParameters::showFeatureCount | ( | ) | const |
Returns SHOWFEATURECOUNT parameter or an empty string if none is defined.
Definition at line 1053 of file qgswmsparameters.cpp.
bool QgsWms::QgsWmsParameters::showFeatureCountAsBool | ( | ) | const |
Returns SHOWFEATURECOUNT as a bool.
An exception is raised if an invalid parameter is found.
QgsBadRequestException |
Definition at line 1058 of file qgswmsparameters.cpp.
bool QgsWms::QgsWmsParameters::showRuleDetailsAsBool | ( | ) | const |
Returns SHOWRULEDETAILS as a bool.
An exception is raised if an invalid parameter is found.
Definition at line 993 of file qgswmsparameters.cpp.
QString QgsWms::QgsWmsParameters::sldBody | ( | ) | const |
Returns SLD_body if defined or an empty string.
Definition at line 1460 of file qgswmsparameters.cpp.
QString QgsWms::QgsWmsParameters::srcHeight | ( | ) | const |
Returns SRCHEIGHT parameter or an empty string if not defined.
Definition at line 765 of file qgswmsparameters.cpp.
int QgsWms::QgsWmsParameters::srcHeightAsInt | ( | ) | const |
Returns SRCHEIGHT parameter as an int or its default value if not defined.
An exception is raised if SRCHEIGHT is defined and cannot be converted.
QgsBadRequestException |
Definition at line 775 of file qgswmsparameters.cpp.
QString QgsWms::QgsWmsParameters::srcWidth | ( | ) | const |
Returns SRCWIDTH parameter or an empty string if not defined.
Definition at line 770 of file qgswmsparameters.cpp.
int QgsWms::QgsWmsParameters::srcWidthAsInt | ( | ) | const |
Returns SRCWIDTH parameter as an int or its default value if not defined.
An exception is raised if SRCWIDTH is defined and cannot be converted.
QgsBadRequestException |
Definition at line 780 of file qgswmsparameters.cpp.
QString QgsWms::QgsWmsParameters::symbolHeight | ( | ) | const |
Returns SYMBOLHEIGHT parameter or an empty string if not defined.
Definition at line 1113 of file qgswmsparameters.cpp.
double QgsWms::QgsWmsParameters::symbolHeightAsDouble | ( | ) | const |
Returns SYMBOLHEIGHT as a double or its default value if not defined.
An exception is raised if an invalid parameter is found.
QgsBadRequestException |
Definition at line 1118 of file qgswmsparameters.cpp.
QString QgsWms::QgsWmsParameters::symbolSpace | ( | ) | const |
Returns SYMBOLSPACE parameter or an empty string if not defined.
Definition at line 1103 of file qgswmsparameters.cpp.
double QgsWms::QgsWmsParameters::symbolSpaceAsDouble | ( | ) | const |
Returns SYMBOLSPACE as a double or its default value if not defined.
An exception is raised if an invalid parameter is found.
QgsBadRequestException |
Definition at line 1108 of file qgswmsparameters.cpp.
QString QgsWms::QgsWmsParameters::symbolWidth | ( | ) | const |
Returns SYMBOLWIDTH parameter or an empty string if not defined.
Definition at line 1123 of file qgswmsparameters.cpp.
double QgsWms::QgsWmsParameters::symbolWidthAsDouble | ( | ) | const |
Returns SYMBOLWIDTH as a double or its default value if not defined.
An exception is raised if an invalid parameter is found.
QgsBadRequestException |
Definition at line 1128 of file qgswmsparameters.cpp.
QString QgsWms::QgsWmsParameters::tiled | ( | ) | const |
Returns TILED parameter or an empty string if not defined.
Definition at line 1038 of file qgswmsparameters.cpp.
bool QgsWms::QgsWmsParameters::tiledAsBool | ( | ) | const |
Returns TILED parameter as a boolean.
QgsBadRequestException |
Definition at line 1043 of file qgswmsparameters.cpp.
QString QgsWms::QgsWmsParameters::transparent | ( | ) | const |
Returns TRANSPARENT parameter or an empty string if not defined.
Definition at line 1008 of file qgswmsparameters.cpp.
bool QgsWms::QgsWmsParameters::transparentAsBool | ( | ) | const |
Returns TRANSPARENT parameter as a bool or its default value if not defined.
An exception is raised if TRANSPARENT is defined and cannot be converted.
QgsBadRequestException |
Definition at line 1013 of file qgswmsparameters.cpp.
|
overridevirtual |
Returns VERSION parameter as a string or an empty string if not defined.
Reimplemented from QgsServerParameters.
Definition at line 795 of file qgswmsparameters.cpp.
QgsProjectVersion QgsWms::QgsWmsParameters::versionAsNumber | ( | ) | const |
Returns VERSION parameter if defined or its default value.
Definition at line 845 of file qgswmsparameters.cpp.
bool QgsWms::QgsWmsParameters::versionIsValid | ( | const QString | version | ) | const |
Returns true
if version is valid, false
otherwise.
Definition at line 850 of file qgswmsparameters.cpp.
QString QgsWms::QgsWmsParameters::width | ( | ) | const |
Returns WIDTH parameter or an empty string if not defined.
Definition at line 750 of file qgswmsparameters.cpp.
int QgsWms::QgsWmsParameters::widthAsInt | ( | ) | const |
Returns WIDTH parameter as an int or its default value if not defined.
An exception is raised if WIDTH is defined and cannot be converted.
QgsBadRequestException |
Definition at line 760 of file qgswmsparameters.cpp.
bool QgsWms::QgsWmsParameters::withDisplayName | ( | ) | const |
withDisplayName
true
if the display name is requested for feature info response Definition at line 2157 of file qgswmsparameters.cpp.
bool QgsWms::QgsWmsParameters::withGeometry | ( | ) | const |
Returns if the client wants the feature info response with geometry information.
true
if geometry information is requested for feature info response Definition at line 2124 of file qgswmsparameters.cpp.
bool QgsWms::QgsWmsParameters::withMapTip | ( | ) | const |
withMapTip
true
if maptip information is requested for feature info response Definition at line 2134 of file qgswmsparameters.cpp.
QString QgsWms::QgsWmsParameters::withMapTipAsString | ( | ) | const |
withMapTipAsString
Definition at line 2129 of file qgswmsparameters.cpp.
QString QgsWms::QgsWmsParameters::wmsPrecision | ( | ) | const |
Returns WMS_PRECISION parameter or an empty string if not defined.
Definition at line 1450 of file qgswmsparameters.cpp.
int QgsWms::QgsWmsParameters::wmsPrecisionAsInt | ( | ) | const |
Returns WMS_PRECISION parameter as an int or its default value if not defined.
An exception is raised if WMS_PRECISION is defined and cannot be converted.
QgsBadRequestException |
Definition at line 1455 of file qgswmsparameters.cpp.
QString QgsWms::QgsWmsParameters::wmtver | ( | ) | const |
Returns WMTVER parameter or an empty string if not defined.
Definition at line 2162 of file qgswmsparameters.cpp.
bool QgsWms::QgsWmsParameters::writeGeospatialPdf | ( | ) | const |
Returns if a geospatial PDF shall be exported.
Definition at line 2283 of file qgswmsparameters.cpp.
QString QgsWms::QgsWmsParameters::x | ( | ) | const |
Returns X parameter or an empty string if not defined.
Definition at line 968 of file qgswmsparameters.cpp.
int QgsWms::QgsWmsParameters::xAsInt | ( | ) | const |
Returns X parameter as an int or its default value if not defined.
An exception is raised if X is defined and cannot be converted.
QgsBadRequestException |
Definition at line 978 of file qgswmsparameters.cpp.
QString QgsWms::QgsWmsParameters::y | ( | ) | const |
Returns Y parameter or an empty string if not defined.
Definition at line 973 of file qgswmsparameters.cpp.
int QgsWms::QgsWmsParameters::yAsInt | ( | ) | const |
Returns Y parameter as an int or its default value if not defined.
An exception is raised if Y is defined and cannot be converted.
QgsBadRequestException |
Definition at line 983 of file qgswmsparameters.cpp.