QGIS API Documentation 3.40.0-Bratislava (b56115d8743)
|
Helper utilities for working with JSON and GeoJSON conversions. More...
#include <qgsjsonutils.h>
Static Public Member Functions | |
static void | addCrsInfo (json &value, const QgsCoordinateReferenceSystem &crs) |
Add crs information entry in json object regarding old GeoJSON specification format if it differs from OGC:CRS84 or EPSG:4326. | |
static Q_INVOKABLE QString | encodeValue (const QVariant &value) |
Encodes a value to a JSON string representation, adding appropriate quotations and escaping where required. | |
static QString | exportAttributes (const QgsFeature &feature, QgsVectorLayer *layer=nullptr, const QVector< QVariant > &attributeWidgetCaches=QVector< QVariant >()) |
Exports all attributes from a QgsFeature as a JSON map type. | |
static json | exportAttributesToJsonObject (const QgsFeature &feature, QgsVectorLayer *layer=nullptr, const QVector< QVariant > &attributeWidgetCaches=QVector< QVariant >(), bool useFieldFormatters=true) |
Exports all attributes from a QgsFeature as a json object. | |
static QgsGeometry | geometryFromGeoJson (const json &geometry) |
Parses a GeoJSON "geometry" value to a QgsGeometry object. | |
static QgsGeometry | geometryFromGeoJson (const QString &geometry) |
Parses a GeoJSON "geometry" value to a QgsGeometry object. | |
static json | jsonFromVariant (const QVariant &v) |
Converts a QVariant v to a json object. | |
static QVariant | jsonToVariant (const json &value) |
Converts a JSON value to a QVariant, in case of parsing error an invalid QVariant is returned. | |
static Q_INVOKABLE QVariantList | parseArray (const QString &json, QMetaType::Type type=QMetaType::Type::UnknownType) |
Parse a simple array (depth=1) | |
Q_INVOKABLE static Q_DECL_DEPRECATED QVariantList | parseArray (const QString &json, QVariant::Type type) |
Parse a simple array (depth=1) | |
static QVariant | parseJson (const QString &jsonString) |
Converts JSON jsonString to a QVariant, in case of parsing error an invalid QVariant is returned. | |
static QVariant | parseJson (const std::string &jsonString) |
Converts JSON jsonString to a QVariant, in case of parsing error an invalid QVariant is returned and an error is logged to the message log. | |
static QVariant | parseJson (const std::string &jsonString, QString &error) |
Converts JSON jsonString to a QVariant, in case of parsing error an invalid QVariant is returned and the error argument is populated accordingly. | |
static QgsFeatureList | stringToFeatureList (const QString &string, const QgsFields &fields=QgsFields(), QTextCodec *encoding SIP_PYARGREMOVE6=nullptr) |
Attempts to parse a GeoJSON string to a collection of features. | |
static QgsFields | stringToFields (const QString &string, QTextCodec *encoding SIP_PYARGREMOVE6=nullptr) |
Attempts to retrieve the fields from a GeoJSON string representing a collection of features. | |
Helper utilities for working with JSON and GeoJSON conversions.
Definition at line 320 of file qgsjsonutils.h.
|
static |
Add crs information entry in json object regarding old GeoJSON specification format if it differs from OGC:CRS84 or EPSG:4326.
According to new specification RFC 7946, coordinate reference system for all GeoJSON coordinates is assumed to be OGC:CRS84 but when user specifically request a different CRS, this method adds this information in the JSON output
Definition at line 924 of file qgsjsonutils.cpp.
|
static |
Encodes a value to a JSON string representation, adding appropriate quotations and escaping where required.
value | value to encode |
Definition at line 284 of file qgsjsonutils.cpp.
|
static |
Exports all attributes from a QgsFeature as a JSON map type.
feature | feature to export |
layer | optional associated vector layer. If specified, this allows richer export utilising settings like the layer's fields widget configuration. |
attributeWidgetCaches | optional widget configuration cache. Can be used to speed up exporting the attributes for multiple features from the same layer. |
Definition at line 321 of file qgsjsonutils.cpp.
|
static |
Exports all attributes from a QgsFeature as a json object.
feature | feature to export |
layer | optional associated vector layer. If specified, this allows richer export utilising settings like the layer's fields widget configuration. |
attributeWidgetCaches | optional widget configuration cache. Can be used to speed up exporting the attributes for multiple features from the same layer. |
useFieldFormatters | Whether field formatters should be used (since QGIS 3.40) |
Definition at line 904 of file qgsjsonutils.cpp.
|
static |
Parses a GeoJSON "geometry" value to a QgsGeometry object.
Returns a null geometry if the geometry could not be parsed.
Definition at line 697 of file qgsjsonutils.cpp.
|
static |
Parses a GeoJSON "geometry" value to a QgsGeometry object.
Returns a null geometry if the geometry could not be parsed.
Definition at line 708 of file qgsjsonutils.cpp.
|
static |
Converts a QVariant v to a json object.
Definition at line 722 of file qgsjsonutils.cpp.
|
static |
Converts a JSON value to a QVariant, in case of parsing error an invalid QVariant is returned.
Definition at line 805 of file qgsjsonutils.cpp.
|
static |
Parse a simple array (depth=1)
json | the JSON to parse |
type | optional variant type of the elements, if specified (and not Invalid), the array items will be converted to the type, and discarded if the conversion is not possible. |
Definition at line 345 of file qgsjsonutils.cpp.
|
static |
Parse a simple array (depth=1)
json | the JSON to parse |
type | optional variant type of the elements, if specified (and not Invalid), the array items will be converted to the type, and discarded if the conversion is not possible. |
Definition at line 414 of file qgsjsonutils.cpp.
|
static |
Converts JSON jsonString to a QVariant, in case of parsing error an invalid QVariant is returned.
Definition at line 899 of file qgsjsonutils.cpp.
|
static |
Converts JSON jsonString to a QVariant, in case of parsing error an invalid QVariant is returned and an error is logged to the message log.
Definition at line 777 of file qgsjsonutils.cpp.
|
static |
Converts JSON jsonString to a QVariant, in case of parsing error an invalid QVariant is returned and the error argument is populated accordingly.
Definition at line 790 of file qgsjsonutils.cpp.
|
static |
Attempts to parse a GeoJSON string to a collection of features.
It is possible to specify fields to parse specific fields, if not provided, no fields will be included. An encoding can be specified which defaults to UTF-8 if it is nullptr
.
Definition at line 268 of file qgsjsonutils.cpp.
|
static |
Attempts to retrieve the fields from a GeoJSON string representing a collection of features.
An encoding can be specified which defaults to UTF-8 if it is nullptr
.
Definition at line 276 of file qgsjsonutils.cpp.