Create and save KML file

View inQMLC++
View on GitHub
Sample viewer app

Construct a KML document and save it as a KMZ file.

screenshot

Use case

If you need to create and save data on the fly, you can use KML to create points, lines, and polygons and then serializing them as KML nodes in a KML Document. Once complete, you can share the KML data with others that are using a KML reading application, such as ArcGIS Earth.

How to use the sample

Application opens to a view of the Southwestern United States. Click on the "Save KMZ file" button to save the active KML document as a .kmz file on your system.

How it works

  1. Create a Point, Polyline, and Polygon.
  2. Create a Graphic for each and add it to the GraphicsOverlay
  3. Create a KmlGeometry object using the Geometry from the point, line, and polygon.
  4. Create a KmlPlacemark for each kml geometry.
  5. Set a KmlStyle for each placemark.
  6. Add all three kml placemarks to the KmlDocument.
  7. Save the kml document to a file using the saveAs function.

Relevant API

  • KmlDocument
  • KmlGeometry
  • KmlIcon
  • KmlIconStyle
  • KmlLineStyle
  • KmlNode.saveAs
  • KmlPlacemark
  • KmlPolygonStyle
  • KmlStyle

Tags

Keyhole, KML, KMZ, OGC

Sample Code

CreateAndSaveKmlFile.qml
                                                                                                                                                                                                    
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
// [WriteFile Name=CreateAndSaveKmlFile, Category=Layers]
// [Legal]
// Copyright 2019 Esri.

// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
// http://www.apache.org/licenses/LICENSE-2.0

// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
// [Legal]

import QtQuick 2.6
import QtQuick.Controls 2.12
import Qt.labs.platform 1.1 as Dialogs
import Esri.ArcGISRuntime 100.11
import Esri.ArcGISExtras 1.1

Rectangle {
    id: rootRectangle
    clip: true
    width: 800
    height: 600

    MapView {
        id: mapView
        anchors.fill: parent

        Map {
            Basemap {
                initStyle: Enums.BasemapStyleArcGISDarkGray
            }

            // add a KML Layer
            KmlLayer {
                KmlDataset {
                    id: kmlDataset
                    KmlDocument {
                        id: kmlDocument
                        name: qsTr("KML Sample Document")
                        onSaveStatusChanged: {
                            if (saveStatus === Enums.TaskStatusErrored) {
                                console.log(`Error: ${error.message} - ${error.additionalMessage}`);
                            }
                            else if (saveStatus === Enums.TaskStatusCompleted) {
                                saveCompleteDialog.open();
                            }
                        }
                    }
                }
            }

            // set initial extent
            ViewpointExtent {
                Envelope {
                    id: myViewpoint
                    xMin: -123.0
                    yMin: 33.5
                    xMax: -101.0
                    yMax: 42.0
                    spatialReference: SpatialReference { wkid: 4326 }
                }
            }
        }

    }

    Button {
        anchors{
            left: parent.left
            top: parent.top
            margins: 3
        }
        text: qsTr("Save kmz file")

        onClicked: {
            fileDialog.open();
        }
    }

    PolygonBuilder {
        id: polygonBuilder
        spatialReference: SpatialReference { wkid: 4326 }
    }

    PolylineBuilder {
        id: polylineBuilder
        spatialReference: SpatialReference { wkid: 4326 }
    }

    Point {
        id: point
        x: -117.195800
        y: 34.056295
        spatialReference: SpatialReference { wkid: 4326 }
    }

    BusyIndicator {
        id: busy
        anchors.centerIn: parent
        visible: kmlDocument.saveStatus === Enums.TaskStatusInProgress
    }

    Dialogs.FileDialog {
        id: fileDialog
        defaultSuffix: "kmz"
        fileMode: Dialogs.FileDialog.SaveFile
        nameFilters: ["Kml files (*.kmz *.kml)"]
        onAccepted: {
            // Write the KML document to the chosen path.
            kmlDocument.saveAs(currentFile);
            close();
        }

        onRejected: {
            close();
        }
    }

    Dialog {
        id: saveCompleteDialog
        anchors.centerIn: parent
        modal: true
        standardButtons: Dialog.Ok
        Text {
            id:textLabel
            anchors.centerIn: parent
            text: qsTr("Item saved.")
        }
    }

    KmlStyle {
        id: kmlStyleWithPointStyle
        KmlIconStyle {
            KmlIcon {
                url: "https://static.arcgis.com/images/Symbols/Shapes/BlueStarLargeB.png"
            }
            scale: 1
        }
    }

    KmlStyle {
        id: kmlStyleWithLineStyle
        KmlLineStyle {
            color: "red"
            width: 2
        }
    }

    KmlStyle {
        id: kmlStyleWithPolygonStyle
        KmlPolygonStyle {
            color: "yellow"
        }
    }

    Component.onCompleted: {
        createPolygon();
        createPolyline();
        createPoint();
    }

    function createPoint() {
        addToKmlDocument(point, kmlStyleWithPointStyle);
    }

    function createPolygon() {
        polygonBuilder.addPointXY(-109.048, 40.998);
        polygonBuilder.addPointXY(-102.047, 40.998);
        polygonBuilder.addPointXY(-102.037, 36.989);
        polygonBuilder.addPointXY(-109.048, 36.998);
        addToKmlDocument(polygonBuilder.geometry, kmlStyleWithPolygonStyle);
    }

    function createPolyline() {
        polylineBuilder.addPointXY(-119.992, 41.989);
        polylineBuilder.addPointXY(-119.994, 38.994);
        polylineBuilder.addPointXY(-114.620, 35.0);
        addToKmlDocument(polylineBuilder.geometry, kmlStyleWithLineStyle);
    }

    function addToKmlDocument(geometry, kmlStyle) {
        const kmlGeometry = ArcGISRuntimeEnvironment.createObject("KmlGeometry", {
                                                                      geometry: geometry,
                                                                      altitudeMode: Enums.KmlAltitudeModeClampToGround
                                                                  });
        const kmlPlacemark = ArcGISRuntimeEnvironment.createObject("KmlPlacemark");
        kmlPlacemark.geometriesListModel.append(kmlGeometry);
        kmlPlacemark.style = kmlStyle;
        kmlDocument.childNodesListModel.append(kmlPlacemark);
    }
}

Your browser is no longer supported. Please upgrade your browser for the best experience. See our browser deprecation post for more details.