A container for KML nodes and KML styles. More...
| Header: | #include <KmlDocument.h> |
| Since: | Esri::ArcGISRuntime 100.4 |
| Inherits: | Esri::ArcGISRuntime::KmlContainer |
Public Functions
| KmlDocument(QObject *parent = nullptr) | |
| virtual | ~KmlDocument() override |
| bool | containsNonSchemaDataInHierarchy() const |
| bool | containsSchemaDataInHierarchy() const |
| QList<Esri::ArcGISRuntime::KmlSchema *> | schemas() const |
Detailed Description
A KML document contains information about the extended data attributes of the KML nodes in its hierarchy. You can determine whether any of the nodes in the KML document support KML schemas by examining containsSchemaDataInHierarchy. If the value is true, you can obtain a collection of these supported schemas from schemas. If any of the nodes in the KML document supports non-schema data, containsNonSchemaDataInHierarchy will also be true.
Relevant samples:
- Create and save KML file: Construct a KML document and save it as a KMZ file.
- List KML contents: List the contents of a KML file.
Member Function Documentation
[explicit, since Esri::ArcGISRuntime 100.6] KmlDocument::KmlDocument (QObject *parent = nullptr)
Constructs a KmlDocument with an optional parent object.
This function was introduced in Esri::ArcGISRuntime 100.6.
[override virtual] KmlDocument::~KmlDocument ()
Destructor.
[since Esri::ArcGISRuntime 200.5] bool KmlDocument::containsNonSchemaDataInHierarchy () const
Returns true if the KML document contains typed or untyped non-schema extended data within its node hierarchy, false otherwise.
Non-schema data may be contained at the document level or in any of its child nodes. Use this to avoid unnecessarily traversing the node hierarchy and checking each node individually.
This function was introduced in Esri::ArcGISRuntime 200.5.
[since Esri::ArcGISRuntime 200.5] bool KmlDocument::containsSchemaDataInHierarchy () const
Returns true if the KML document contains schema data within its node hierarchy, false otherwise.
If this value is true, you can use schemas collection for faster feature set creation. You can avoid unnecessarily traversing the node hierarchy and checking the schema of each node individually.
This function was introduced in Esri::ArcGISRuntime 200.5.
[since Esri::ArcGISRuntime 200.5] QList<Esri::ArcGISRuntime::KmlSchema *> KmlDocument::schemas() const
Returns the collection of KML schemas for the extended data of the nodes in the KML document.
Each KML document may contain a collection of KML schemas that allows for faster feature set creation. If the KML document does not contain a KML schema, this collection is empty.
This function was introduced in Esri::ArcGISRuntime 200.5.