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
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
|
Quickstart
==========
This quickstart guide will show you how to create a simple KML file from scratch and how
to read a KML file from a string. The example demonstrates organizing geographic data using
nested folders and placemarks - common structures used to group and display locations in
Google Earth and other KML viewers.
Build a KML from Scratch
------------------------
Example how to build a simple KML file from the Python interpreter.
First we import the necessary modules:
.. code-block:: pycon
>>> from fastkml import kml
>>> from pygeoif.geometry import Polygon
Create a KML object:
.. code-block:: pycon
>>> k = kml.KML()
Create a KML Document and add it to the KML root object:
.. code-block:: pycon
>>> d = kml.Document(id="docid", name="doc name", description="doc description")
>>> k.append(d)
Create a KML Folder and add it to the Document:
.. code-block:: pycon
>>> f = kml.Folder(id="fid", name="f name", description="f description")
>>> d.append(f)
Create a KML Folder and nest it in the first Folder:
.. code-block:: pycon
>>> nf = kml.Folder(
... id="nested-fid", name="nested f name", description="nested f description"
... )
>>> f.append(nf)
Create a second KML Folder within the Document:
.. code-block:: pycon
>>> f2 = kml.Folder(id="id2", name="name2", description="description2")
>>> d.append(f2)
Create a KML Placemark with a simple polygon geometry and add it to the second Folder:
.. code-block:: pycon
>>> polygon = Polygon([(0, 0, 0), (1, 1, 0), (1, 0, 1)])
>>> p = kml.Placemark(id="id", name="name", description="description", geometry=polygon)
>>> f2.append(p)
Finally, print out the KML object as a string:
.. code-block:: pycon
>>> print(k.to_string(prettyprint=True, precision=6))
<kml xmlns="http://www.opengis.net/kml/2.2">
<Document id="docid">
<name>doc name</name>
<description>doc description</description>
<Folder id="fid">
<name>f name</name>
<description>f description</description>
<Folder id="nested-fid">
<name>nested f name</name>
<description>nested f description</description>
</Folder>
</Folder>
<Folder id="id2">
<name>name2</name>
<description>description2</description>
<Placemark id="id">
<name>name</name>
<description>description</description>
<Polygon>
<outerBoundaryIs>
<LinearRing>
<coordinates>0.000000,0.000000,0.000000 1.000000,1.000000,0.000000 1.000000,0.000000,1.000000 0.000000,0.000000,0.000000</coordinates>
</LinearRing>
</outerBoundaryIs>
</Polygon>
</Placemark>
</Folder>
</Document>
</kml>
<BLANKLINE>
Read a KML File/String
----------------------
You can create a KML object by reading a KML file from a string
.. code-block:: pycon
>>> doc = """<kml xmlns="http://www.opengis.net/kml/2.2">
... <Document>
... <name>Document.kml</name>
... <open>1</open>
... <Style id="exampleStyleDocument">
... <LabelStyle>
... <color>ff0000cc</color>
... </LabelStyle>
... </Style>
... <Placemark>
... <name>Document Feature 1</name>
... <styleUrl>#exampleStyleDocument</styleUrl>
... <Point>
... <coordinates>-122.371,37.816,0</coordinates>
... </Point>
... </Placemark>
... <Placemark>
... <name>Document Feature 2</name>
... <styleUrl>#exampleStyleDocument</styleUrl>
... <Point>
... <coordinates>-122.370,37.817,0</coordinates>
... </Point>
... </Placemark>
... </Document>
... </kml>"""
Read in the KML string
.. code-block:: pycon
>>> k = kml.KML.from_string(doc)
.. note::
To read a KML file directly, you can use the parse method:
.. code-block:: Python
k = kml.KML.parse("path/to/file.kml")
Next we perform some simple sanity checks, such as checking the number of features.
.. code-block:: pycon
# This corresponds to the single ``Document``
>>> len(k.features)
1
Check the number of Placemarks in the Document:
.. code-block:: pycon
# (The two Placemarks of the Document)
>>> k.features[0].features # doctest: +ELLIPSIS
[fastkml.features.Placemark...
>>> len(k.features[0].features)
2
Check the Placemarks in the Document:
.. code-block:: pycon
# Check specifics of the first Placemark in the Document
>>> k.features[0].features[0] # doctest: +ELLIPSIS
fastkml.features.Placemark(...
>>> k.features[0].features[0].description
>>> k.features[0].features[0].name
'Document Feature 1'
# Check specifics of the second Placemark in the Document
>>> k.features[0].features[1].name
'Document Feature 2'
>>> k.features[0].features[1].name = "ANOTHER NAME"
Finally, print out the KML object as a string:
.. code-block:: pycon
>>> print(k.to_string(prettyprint=True, precision=6))
<kml xmlns="http://www.opengis.net/kml/2.2">
<Document>
<name>Document.kml</name>
<open>1</open>
<Style id="exampleStyleDocument">
<LabelStyle>
<color>ff0000cc</color>
</LabelStyle>
</Style>
<Placemark>
<name>Document Feature 1</name>
<styleUrl>#exampleStyleDocument</styleUrl>
<Point>
<coordinates>-122.371000,37.816000,0.000000</coordinates>
</Point>
</Placemark>
<Placemark>
<name>ANOTHER NAME</name>
<styleUrl>#exampleStyleDocument</styleUrl>
<Point>
<coordinates>-122.370000,37.817000,0.000000</coordinates>
</Point>
</Placemark>
</Document>
</kml>
<BLANKLINE>
.. note::
To save the KML object to a file, you can use the write method:
.. code-block:: Python
k.write("path/to/file.kml")
|
