This section contains an alphabetical reference for all KML elements defined in KML Version 2.2, as well as elements in the [Google extension namespace](https://developers.google.com/kml/documentation/kmlreference#kmlextensions). The class tree for KML elements is shown below. In this diagram, elements to the right on a particular branch in the tree are *extensions* of the elements to their left. For example, Placemark is a special kind of *Feature* . It contains all of the elements that belong to *Feature*, and it adds some elements that are specific to the Placemark element.
KML is an open standard officially named the OpenGIS® KML Encoding Standard (OGC KML). It is maintained by the Open Geospatial Consortium, Inc. (OGC). The complete specification for OGC KML can be found at .
The complete XML schema for KML is located at .
**Note:** Click an element name in this diagram to jump to its entry in the reference section.
Note that abstract elements (shown in boxes in the diagram) are not actually used in KML files. They are a useful way for a single element to serve as the programmatic foundation for multiple similar (but different) derived elements. Understanding this object-oriented hierarchy is also a good way for you to learn KML, since you can easily see groupings of related elements.
All elements derived from *Object* can have an **id** assigned to them. This **id** is used by the KML update mechanism (see [\](https://developers.google.com/kml/documentation/kmlreference#update)) for files loaded with a NetworkLink. It is also used by shared styles (see [\](https://developers.google.com/kml/documentation/kmlreference#style)). The **id** is a standard [XML ID](http://www.w3.org/TR/xmlschema11-2/#ID).
Because KML is an XML grammar and file format, tag names are case-sensitive and must appear exactly as shown here. If you're familiar with XML, you will also be interested in the [KML 2.2 Schema](http://schemas.opengis.net/kml/). When you are editing KML text files, you can load this Schema into any XML editor and validate your KML code with it.
**Tip: Viewing KML for Google Earth Features**
Here is a handy feature of Google Earth that makes it easy to view the KML file for any Feature. In Google Earth, you can right-click a Feature in the Places panel and copy it. To view the corresponding KML for the copied object, open your favorite text editor and paste the selection into it.
**Compatibility**
KML versions have a double numbering system: `majorVersion.minorVersion`. All versions with the same `majorVersion` are compatible. For this reason, if you change the namespace to "2.2" (that is, `xmlns="http://www.opengis.net/kml/2.2"`), all KML 2.1 files validate in the [KML 2.2 schema](http://schemas.opengis.net/kml/).
## About this reference
Each reference entry includes a Syntax section that lists the elements contained in the main element. This Syntax section is an informal listing and uses simple shorthand to summarize the elements. This section also contains the following:
- *default values* for each element (or ellipses if it is a complex element or if there is no default value)
- the *type* of the value (see [KML Fields](https://developers.google.com/kml/documentation/kmlreference#kmlfields))
The Syntax section can be copied and used as a template for any non-abstract element in a KML file.
## KML Extension Namespace and the gx prefix
The [OGC KML standard](http://www.opengeospatial.org/standards/kml/) provides a mechanism for extensions - additional elements that contain information beyond what is available in the standard ([learn more about XML namespaces](http://www.w3.org/TR/REC-xml-names/) at w3.org). With the launch of Google Earth 5.0, Google has provided extensions to KML to support a number of new features. These extensions use the **gx** prefix and the following namespace URI:
`xmlns:gx="http://www.google.com/kml/ext/2.2"`
This namespace URI must be added to the `` element in any KML file using **gx-**prefixed elements:
```
```
Extensions to KML may not be supported in all geo-browsers. If your browser doesn't support particular extensions, the data in those extensions should be silently ignored, and the rest of the KML file should load without errors.
Elements that currently use the **gx** prefix are:
- [gx:altitudeMode](https://developers.google.com/kml/documentation/kmlreference#gxaltitudemode)
- [gx:altitudeOffset](https://developers.google.com/kml/documentation/kmlreference#gxaltitudeoffset)
- [gx:angles](https://developers.google.com/kml/documentation/kmlreference#gxangles)
- [gx:AnimatedUpdate](https://developers.google.com/kml/documentation/kmlreference#gxanimatedupdate)
- [gx:balloonVisibility](https://developers.google.com/kml/documentation/kmlreference#gxballoonvisibility)
- [gx:coord](https://developers.google.com/kml/documentation/kmlreference#gxcoord)
- [gx:delayedStart](https://developers.google.com/kml/documentation/kmlreference#gxdelayedstart)
- [gx:drawOrder](https://developers.google.com/kml/documentation/kmlreference#gxdraworder)
- [gx:duration](https://developers.google.com/kml/documentation/kmlreference#gxduration)
- [gx:FlyTo](https://developers.google.com/kml/documentation/kmlreference#gxflyto)
- [gx:flyToMode](https://developers.google.com/kml/documentation/kmlreference#gxflytomode)
- [gx:h](https://developers.google.com/kml/documentation/kmlreference#gxh)
- [gx:horizFov](https://developers.google.com/kml/documentation/kmlreference#gxhorizfov)
- [gx:interpolate](https://developers.google.com/kml/documentation/kmlreference#gxinterpolate)
- [gx:labelVisibility](https://developers.google.com/kml/documentation/kmlreference#gxlabelvisibility)
- [gx:LatLonQuad](https://developers.google.com/kml/documentation/kmlreference#gxlatlonquad)
- [gx:MultiTrack](https://developers.google.com/kml/documentation/kmlreference#gxmultitrack)
- [gx:vieweroptions](https://developers.google.com/kml/documentation/kmlreference#gxoption)
- [gx:outerColor](https://developers.google.com/kml/documentation/kmlreference#gxoutercolor)
- [gx:outerWidth](https://developers.google.com/kml/documentation/kmlreference#gxouterwidth)
- [gx:physicalWidth](https://developers.google.com/kml/documentation/kmlreference#gxphysicalwidth)
- [gx:Playlist](https://developers.google.com/kml/documentation/kmlreference#gxplaylist)
- [gx:playMode](https://developers.google.com/kml/documentation/kmlreference#gxtourcontrol)
- [gx:SoundCue](https://developers.google.com/kml/documentation/kmlreference#gxsoundcue)
- [gx:TimeSpan](https://developers.google.com/kml/documentation/kmlreference#gxtimespan)
- [gx:TimeStamp](https://developers.google.com/kml/documentation/kmlreference#gxtimestamp)
- [gx:Tour](https://developers.google.com/kml/documentation/kmlreference#gxtour)
- [gx:TourControl](https://developers.google.com/kml/documentation/kmlreference#gxtourcontrol)
- [gx:TourPrimitive](https://developers.google.com/kml/documentation/kmlreference#gxtourprimitive)
- [gx:Track](https://developers.google.com/kml/documentation/kmlreference#gxtrack)
- [gx:ViewerOptions](https://developers.google.com/kml/documentation/kmlreference#gxvieweroptions)
- [gx:w](https://developers.google.com/kml/documentation/kmlreference#gxw)
- [gx:Wait](https://developers.google.com/kml/documentation/kmlreference#gxwait)
- [gx:x](https://developers.google.com/kml/documentation/kmlreference#gxx)
- [gx:y](https://developers.google.com/kml/documentation/kmlreference#gxy)
The complete XML schema for elements in this extension namespace is located at [http://developers.google.com/kml/schema/kml22gx.xsd](https://developers.google.com/static/kml/schema/kml22gx.xsd).
## KML fields
KML uses common XML types such as *boolean, string, double, float,* and *int*. In addition, it defines a number of field element types. The following table lists some of the most commonly used types defined in KML and links to sample elements that use them:
| ***Field Type*** | ***Value*** | ***Example Use*** |
|---|---|---|
| **altitudeModeEnum** | clampToGround, relativeToGround, absolute | See [\](https://developers.google.com/kml/documentation/kmlreference#lookat) and [\](https://developers.google.com/kml/documentation/kmlreference#region) |
| **angle90** | a value ≥−90 and ≤90 | See [\](https://developers.google.com/kml/documentation/kmlreference#latitude) in \ |
| **anglepos90** | a value ≥0 and ≤90 | See [\](https://developers.google.com/kml/documentation/kmlreference#tilt) in \ |
| **angle180** | a value ≥−180 and ≤180 | See [\](https://developers.google.com/kml/documentation/kmlreference#longitude) in \ |
| **angle360** | a value ≥−360 and ≤360 | See \ in [\](https://developers.google.com/kml/documentation/kmlreference#orientation) |
| **color** | hexBinary value:*aabbggrr* | See any element that extends [*\*](https://developers.google.com/kml/documentation/kmlreference#colorstyle) |
| **colorModeEnum** | normal, random | See any element that extends [*\*](https://developers.google.com/kml/documentation/kmlreference#colorstyle) |
| **dateTime** | *dateTime, date, gYearMonth, gYear* | See [\](https://developers.google.com/kml/documentation/kmlreference#timespan) and [\](https://developers.google.com/kml/documentation/kmlreference#timestamp) |
| **displayModeEnum** | default, hide | See [\](https://developers.google.com/kml/documentation/kmlreference#balloonstyle) |
| **gridOrigin** | lowerLeft, upperLeft | See [\](https://developers.google.com/kml/documentation/kmlreference#photooverlay) |
| **refreshModeEnum** | onChange, onInterval, onExpire | See [\](https://developers.google.com/kml/documentation/kmlreference#Link) |
| **shapeEnum** | rectangle, cylinder, sphere | See [\](https://developers.google.com/kml/documentation/kmlreference#photooverlay) |
| **styleStateEnum** | normal, highlight | See [\](https://developers.google.com/kml/documentation/kmlreference#stylemap) |
| **unitsEnum** | fraction, pixels, insetPixels | See [\](https://developers.google.com/kml/documentation/kmlreference#hotspot) in \, [\](https://developers.google.com/kml/documentation/kmlreference#screenoverlay) |
| **vec2** | x=*double* xunits=*kml:unitsEnum* y=*double* yunits=*kml:unitsEnum* | See [\](https://developers.google.com/kml/documentation/kmlreference#hotspot) in \, [\](https://developers.google.com/kml/documentation/kmlreference#screenoverlay) |
| **viewRefreshEnum** | never, onRequest, onStop, onRegion | See [\](https://developers.google.com/kml/documentation/kmlreference#Link) |
## *\*
### Syntax
```
...
<-- /AbstractView -->
```
### Description
This is an abstract element and cannot be used directly in a KML file. This element is extended by the [\](https://developers.google.com/kml/documentation/kmlreference#camera) and [\](https://developers.google.com/kml/documentation/kmlreference#lookat) elements.
### Extends
- [\](https://developers.google.com/kml/documentation/kmlreference#object)
### Elements Specific to AbstractView
\
: This element enables special viewing modes in Google Earth 6.0 and later. It has one or more `` child elements. The `` element has a `name` attribute and an `enabled` attribute. The `name` specifies one of the following: Street View imagery ("streetview"), historical imagery ("historicalimagery"), and sunlight effects for a given time of day ("sunlight"). The `enabled` attribute is used to turn a given viewing mode on or off.
\
: Defines the horizontal field of view of the AbstractView **during
a tour** . This element has no effect on AbstractViews outside of a
tour. `` is inserted automatically by the
Google Earth client (versions 6.1+) during tour recording. Regular
AbstractViews are assigned a value of **60** ; views within
Street View are assigned a value of **85** to match the
standard Street View field of view in Google Earth. Once set, the value
will be applied to subsequent views, until a new value is specified.
### Extended By
- [\](https://developers.google.com/kml/documentation/kmlreference#camera)
- [\](https://developers.google.com/kml/documentation/kmlreference#lookat)
## \
|---|
| This element is an extension of the [OGC KML 2.2 standard](http://www.opengeospatial.org/standards/kml/) and is supported in Google Earth 5.0 and later. [Learn more](https://developers.google.com/kml/documentation/kmlreference#kmlextensions) |
### Syntax
```
clampToGround
```
### Description
Can be used instead of the OGC KML standard `` element, and accepts the following values in addition to the standard altitudeMode values:
- **relativeToSeaFloor** - Interprets the altitude as a value in meters above the sea floor. If the KML feature is above land rather than sea, the altitude will be interpreted as being above the ground.
- **clampToSeaFloor** - The altitude specification is ignored, and the KML feature will be positioned on the sea floor. If the KML feature is on land rather than at sea, **clampToSeaFloor** will instead clamp to ground.
As with ``, `` affects:
- the altitude coordinate within the `` element
- `` and `` within ``
- `` within ``, ``, and `AbstractView` (`` and ``).
More information about altitude modes is available in the [Altitude Modes](https://developers.google.com/kml/documentation/altitudemode) chapter of the **KML Developer's Guide**.
### Example
 [altitudemode_reference.kml](https://developers.google.com/static/kml/documentation/kmlfiles/altitudemode_reference.kml)
```
gx:altitudeMode Example146.80612.219-60706300relativeToSeaFloor1relativeToSeaFloor
146.825,12.233,400
146.820,12.222,400
146.812,12.212,400
146.796,12.209,400
146.788,12.205,400
```
## \
|---|
| This element is an extension of the [OGC KML 2.2 standard](http://www.opengeospatial.org/standards/kml/) and is supported in Google Earth 5.0 and later. [Learn more](https://developers.google.com/kml/documentation/kmlreference#kmlextensions) |
### Syntax
```
0.0............0
```
### Description
`` controls changes during a tour to KML features, using `https://developers.google.com/kml/documentation/kmlreference#update`. Changes to KML features will not modify the DOM - that is, any changes will be reverted when the tour is over, and will not be saved in the KML at any time.
`` should also contain a `` value to specify the length of time in seconds over which the update takes place. Integer, float, and color fields are smoothly animated from original to new value across the duration; boolean, string, and other values that don't lend to interpolation are updated at the end of the duration.
Refer to [Tour timelines](https://developers.google.com/kml/documentation/touring#tourtimelines) in the **Touring** chapter of the **KML Developer's Guide** for information about `` and the tour timeline.
\
: Specifies the length of time, in seconds, over which the update takes place.
\
: Specifies the number of seconds to wait (after the inline start position) before starting the update.
### Example
The example below demonstrates a change in icon size. This change will be animated over a 5-second duration.
 [animatedupdate_example.kml](https://developers.google.com/static/kml/documentation/kmlfiles/animatedupdate_example.kml)
```
gx:AnimatedUpdate examplePin on a mountaintop#pushpin170.1435558771009,-43.60505741890396,0Play me!bounce3170.157-43.6719700-6.33333.5510.05
```
### Extends
- [\](https://developers.google.com/kml/documentation/kmlreference#gxtourprimitive)
### Contains
- [\](https://developers.google.com/kml/documentation/kmlreference#gxduration)
- [\](https://developers.google.com/kml/documentation/kmlreference#update)
## \
### Syntax
```
ffffffffff000000...default
```
### Description
Specifies how the description balloon for placemarks is drawn. The \, if specified, is used as the background color of the balloon. See [\<*Feature*\>](https://developers.google.com/kml/documentation/kmlreference#feature) for a diagram illustrating how the default description balloon appears in Google Earth.
### Elements Specific to BalloonStyle
\
: Background color of the balloon (optional). Color and opacity (alpha) values are expressed in hexadecimal notation. The range of values for any one color is 0 to 255 (`00` to `ff`). The order of expression is *aabbggrr,* where *aa=alpha* (00 to ff); *bb=blue* (00 to ff); *gg=green* (00 to ff); *rr=red* (00 to ff). For alpha, `00` is fully transparent and `ff` is fully opaque. For example, if you want to apply a blue color with 50 percent opacity to an overlay, you would specify the following: `7fff0000`, where *alpha* =0x7f, *blue* =0xff, *green* =0x00, and *red*=0x00. The default is opaque white (ffffffff).
\
: Foreground color for text. The default is black (ff000000).
\
: Text displayed in the balloon. If no text is specified, Google Earth draws the default balloon (with the Feature \ in boldface, the Feature \, links for driving directions, a white background, and a tail that is attached to the point coordinates of the Feature, if specified).
: You can add entities to the \ tag using the following format to refer to a child element of Feature: **$\[name\]** , **$\[description\]** , **$\[address\]** , **$\[id\]** , **$\[Snippet\]** . Google Earth looks in the current Feature for the corresponding string entity and substitutes that information in the balloon. To include *To* *here - From here* driving directions in the balloon, use the **$\[geDirections\]** tag. To prevent the driving directions links from appearing in a balloon, include the \ element with some content, or with $\[description\] to substitute the basic Feature \.
: For example, in the following KML excerpt, **$\[name\]** and **$\[description\]** fields will be replaced by the \ and \ fields found in the Feature elements that use this BalloonStyle:
```
This is $[name], whose description is: $[description]
```
**\**
: If \ is *default* , Google Earth uses the information supplied in \ to create a balloon . If \ is *hide*, Google Earth does not display the balloon. In Google Earth, clicking the List View icon for a Placemark whose balloon's \ is *hide* causes Google Earth to fly to the Placemark.
### Example
```
BalloonStyle.kml1BalloonStyleAn example of BalloonStyle#exampleBalloonStyle-122.370533,37.823842,0
```
### Extends
- [\<*ColorStyle*\>](https://developers.google.com/kml/documentation/kmlreference#colorstyle)
### Contained By
- [\](https://developers.google.com/kml/documentation/kmlreference#style)
[Back to top](https://developers.google.com/kml/documentation/kmlreference#top)
## \
|---|
| This element is an extension of the [OGC KML 2.2 standard](http://www.opengeospatial.org/standards/kml/) and is supported in Google Earth 5.0 and later. [Learn more](https://developers.google.com/kml/documentation/kmlreference#kmlextensions) |
### Syntax
```
0
```
### Description
Toggles visibility of a description balloon. The balloon to be updated must be identified by the object's XML ID (e.g. ``).
### Examples
The first example shows `` with a Placemark. When the placemark is loaded, the description balloon is opened.
 [balloonvisibility_example.kml](https://developers.google.com/static/kml/documentation/kmlfiles/balloonvisibility_example.kml)
```
Eiffel Tower
Located in Paris, France.
This description balloon opens
when the Placemark is loaded.
12.294785,48.858093,0
```
The second example shows the use of `` within a tour. A number of balloons are opened and closed during the tour, providing information to the viewer.
 [balloonvisibility_tourexample.kml](https://developers.google.com/static/kml/documentation/kmlfiles/balloonvisibility_tourexample.kml)
```
balloonVisibility Example1Play me8.0bounce-119.74858433.7362660-9.29592684.09574504469.850414relativeToSeaFloor0.014.00.003smooth-119.78263033.8628550-9.31485884.1173176792.665540relativeToSeaFloor0.014.00.003smooth-119.84957833.9685150-173.94893523.0633923733.666023relativeToGround0.014.0Underwater off the California Coast
The tour begins near the Santa Cruz Canyon,
off the coast of California, USA.
clampToSeaFloor-119.749531,33.715059,0Still swimming...We're about to leave the ocean, and visit the coast...clampToSeaFloor-119.779550,33.829268,0The end
1
to show description balloons.]]>
-119.849578,33.968515,0
```
### Extends
- [\](https://developers.google.com/kml/documentation/kmlreference#feature)
## \
### Syntax
```
...000000clampToGround
```
### Description
Defines the virtual camera that views the scene. This element defines the position of the camera relative to the Earth's surface as well as the *viewing direction* of the camera. The camera *position* is defined by \, \, \, and either \ or \. The *viewing direction* of the camera is defined by \, \, and \. \ can be a child element of any Feature or of \. A parent element cannot contain both a \ and a \ at the same time.
\ provides full six-degrees-of-freedom control over the view, so you can position the Camera in space and then rotate it around the *X* , *Y* , and *Z* axes. Most importantly, you can tilt the camera view so that you're looking above the horizon into the sky.
\ can also contain a TimePrimitive (\ or \). Time values in Camera affect historical imagery, sunlight, and the display of time-stamped features. For more information, read [Time with AbstractViews](https://developers.google.com/kml/documentation/time#abstractviews) in the **Time and Animation** chapter of the Developer's Guide.
#### Defining a View
Within a Feature or \, use either a \ or a \ object (but not both in the same object). The \ object defines the viewpoint in terms of the viewer's position and orientation. The \ object allows you to specify a view that is not on the Earth's surface. The \ object defines the viewpoint in terms of what is being viewed. The \ object is more limited in scope than \ and generally requires that the view direction intersect the Earth's surface.
The following diagram shows the *X* , *Y* , and *Z* axes, which are attached to the virtual camera.
- The *X* axis points toward the right of the camera and is called the *right vector*.
- The *Y* axis defines the "up" direction relative to the screen and is called the *up vector*.
- The *Z* axis points from the center of the screen toward the eye point. The camera looks down the *−Z* axis, which is called the *view vector*.
### Order of Transformations
The order of rotation is important. By default, the camera is looking straight down the −Z axis toward the Earth. Before rotations are performed, the camera is translated along the *Z* axis to \. The order of transformations is as follows:
1. **\** - translate along the *Z* axis to \
2. **\** - rotate around the *Z* axis.
3. **\** - rotate around the *X* axis.
4. **\** - rotate around the *Z* axis (again).
Note that each time a rotation is applied, two of the camera axes change their orientation.
### Elements Specific to Camera
\
: Longitude of the virtual camera (eye point). Angular distance in degrees, relative to the Prime Meridian. Values west of the Meridian range from −180 to 0 degrees. Values east of the Meridian range from 0 to 180 degrees.
\
: Latitude of the virtual camera. Degrees north or south of the Equator (0 degrees). Values range from −90 degrees to 90 degrees.
\
: Distance of the camera from the earth's surface, in meters. Interpreted according to the Camera's \ or \.
\
: Direction (azimuth) of the camera, in degrees. Default=0 (true North). ([See diagram](https://developers.google.com/kml/documentation/kmlreference#headingdiagram).) Values range from 0 to 360 degrees.
\
: Rotation, in degrees, of the camera around the *X* axis. A value of 0 indicates that the view is aimed straight down toward the earth (the most common case). A value for 90 for \ indicates that the view is aimed toward the horizon. Values greater than 90 indicate that the view is pointed up into the sky. Values for \ are clamped at +180 degrees.
\
: Rotation, in degrees, of the camera around the Z axis. Values range from −180 to +180 degrees.
\
: Specifies how the \ specified for the Camera is interpreted. Possible values are as follows:
- **relativeToGround** - (default) Interprets the \ as a value in meters above the ground. If the point is over water, the \ will be interpreted as a value in meters above sea level. See [\](https://developers.google.com/kml/documentation/kmlreference#gxaltitudemode) below to specify points relative to the sea floor.
- **clampToGround** - For a camera, this setting also places the camera **relativeToGround**, since putting the camera exactly at terrain height would mean that the eye would intersect the terrain (and the view would be blocked).
- **absolute**- Interprets the \ as a value in meters above sea level.
\
: A KML extension in the [Google extension namespace](https://developers.google.com/kml/documentation/kmlreference#kmlextensions), allowing altitudes relative to the sea floor. Values are:
- **relativeToSeaFloor** - Interprets the \ as a value in meters above the sea floor. If the point is above land rather than sea, the \ will be interpreted as being above the ground.
- **clampToSeaFloor** - The \ specification is ignored, and the Camera will be positioned on the sea floor. If the point is on land rather than at sea, the Camera will be positioned on the ground.
### Extends
- [\<*AbstractView*\>](https://developers.google.com/kml/documentation/kmlreference#abstractview)
### Contained By
- Any element derived from [\<*Feature*\>](https://developers.google.com/kml/documentation/kmlreference#feature)
- [\](https://developers.google.com/kml/documentation/kmlreference#networklinkcontrol)
[Back to top](https://developers.google.com/kml/documentation/kmlreference#top)
## \<*ColorStyle*\>
### Syntax
```
ffffffffnormal
```
### Description
This is an abstract element and cannot be used directly in a KML file. It provides elements for specifying the color and color mode of extended style types.
### Elements Specific to ColorStyle
\
: Color and opacity (alpha) values are expressed in hexadecimal notation. The range of values for any one color is 0 to 255 (`00` to `ff`). For alpha, `00` is fully transparent and `ff` is fully opaque. The order of expression is *aabbggrr,* where *aa=alpha* (00 to ff); *bb=blue* (00 to ff); *gg=green* (00 to ff); *rr=red* (00 to ff). For example, if you want to apply a blue color with 50 percent opacity to an overlay, you would specify the following: `7fff0000`, where *alpha* =0x7f, *blue* =0xff, *green* =0x00, and *red*=0x00.
\
: Values for \ are **normal** (no effect) and **random** . A value of **random** applies a random linear scale to the base \ as follows.
- To achieve a truly random selection of colors, specify a base \ of white (ffffffff).
- If you specify a single color component (for example, a value of ff0000ff for *red* ), random color values for that one component (red) will be selected. In this case, the values would range from 00 (*black* ) to ff (*full red*).
- If you specify values for two or for all three color components, a random linear scale is applied to each color component, with results ranging from black to the maximum values specified for each component.
- The opacity of a color comes from the alpha component of \ and is never randomized.
### Extends
- [\<*Object*\>](https://developers.google.com/kml/documentation/kmlreference#object)
### Extended By
- [\](https://developers.google.com/kml/documentation/kmlreference#iconstyle)
- [\](https://developers.google.com/kml/documentation/kmlreference#labelstyle)
- [\](https://developers.google.com/kml/documentation/kmlreference#linestyle)
- \<[PolyStyle](https://developers.google.com/kml/documentation/kmlreference#polystyle)\>
[Back to top](https://developers.google.com/kml/documentation/kmlreference#top)
## \<*Container*\>
### Syntax
```
...10
...
...
.........
\...\..................
```
### Description
This is an abstract element and cannot be used directly in a KML file. A Container element holds one or more Features and allows the creation of nested hierarchies.
### Extends
- [\<*Feature*\>](https://developers.google.com/kml/documentation/kmlreference#feature)
### Extended By
- [\](https://developers.google.com/kml/documentation/kmlreference#document)
- [\](https://developers.google.com/kml/documentation/kmlreference#folder)
[Back to top](https://developers.google.com/kml/documentation/kmlreference#top)
## \
### Syntax
```
...10...
...
.................................
```
### Description
A Document is a container for features and styles. This element is required if your KML file uses *shared styles*. It is recommended that you use shared styles, which require the following steps:
- Define all Styles in a Document. Assign a unique **ID** to each Style.
- Within a given Feature or StyleMap, reference the Style's ID using a \ element.
Note that shared styles are not inherited by the Features in the Document.
Each Feature must explicitly reference the styles it uses in a \ element. For a Style that applies to a Document (such as ListStyle), the Document itself must explicitly reference the \. For example:
```
...
```
Do not put shared styles within a Folder.
The following example illustrates use of a shared style.
### Example
```
Document.kml1Document Feature 1#exampleStyleDocument-122.371,37.816,0Document Feature 2#exampleStyleDocument-122.370,37.817,0
```
### Extends
- [\<*Container*\>](https://developers.google.com/kml/documentation/kmlreference#container)
### Contains
- 0 or more elements derived from [\<*Feature*\>](https://developers.google.com/kml/documentation/kmlreference#feature)
- 0 or more elements derived from [\<*StyleSelector*\>](https://developers.google.com/kml/documentation/kmlreference#styleselector)
- 0 or more elements derived from [\](https://developers.google.com/kml/documentation/kmlreference#schema)
[Back to top](https://developers.google.com/kml/documentation/kmlreference#top)
## \
|---|
| This element is an extension of the [OGC KML 2.2 standard](http://www.opengeospatial.org/standards/kml/) and is supported in Google Earth 5.0 and later. [Learn more](https://developers.google.com/kml/documentation/kmlreference#kmlextensions) |
### Syntax
```
0.0
```
### Description
`` extends `gx:TourPrimitive` by specifying a time-span for events. The time is written as seconds using XML's [double](https://developers.google.com/kml/documentation/kmlreference#tbd) datatype.
#### Duration and \
When a duration is included within a `` element, it specifies the length of time that the browser takes to fly from the previous point to the specified point.
```
bounce10.2
...
```
#### Duration and \
Specifies the length of time over which the update takes place. Integer, float, and color fields are smoothly animated from original to new value across the duration; boolean, string, and other values that don't lend to interpolation are updated at the end of the duration.
```
5.0
....
```
## \
### Syntax
```
...... ... ...
```
### Description
The ExtendedData element offers three techniques for adding custom data to a KML Feature (NetworkLink, Placemark, GroundOverlay, PhotoOverlay, ScreenOverlay, Document, Folder). These techniques are
- Adding untyped data/value pairs using the \ element (basic)
- Declaring new typed fields using the \ element and then instancing them using the \ element (advanced)
- Referring to XML elements defined in other namespaces by referencing the external namespace within the KML file (basic)
These techniques can be combined within a single KML file or Feature for different pieces of data.
For more information, see [Adding Custom Data](https://developers.google.com/kml/documentation/extendeddata) in "Topics in KML."
### Elements Specific to ExtendedData
\
: Creates an untyped *name/value* pair. The name can have two versions: *name* and *displayName* . The *name* attribute is used to identify the data pair within the KML file. The *displayName* element is used when a properly formatted name, with spaces and HTML formatting, is displayed in Google Earth. In the \ element of \, the notation**$\[name/displayName\]** is replaced with \. If you substitute the value of the *name* attribute of the \ element in this format (for example, $\[holeYardage\], the attribute value is replaced with \. By default, the Placemark's balloon displays the name/value pairs associated with it.
:
\
: An optional formatted version of *name*, to be used for display purposes.
\
: Value of the data pair.
:
```
Club house12344
```
\
: This element is used in conjunction with \ to add typed custom data to a KML Feature. The Schema element (identified by the *schemaUrl* attribute) declares the custom data type. The actual data objects ("instances" of the custom data) are defined using the SchemaData element.
: The \ can be a full URL, a reference to a Schema ID defined in an external KML file, or a reference to a Schema ID defined in the same KML file. All of the following specifications are acceptable:
: The Schema element is always a child of Document. The ExtendedData element is a child of the Feature that contains the custom data.
:
\
: This element assigns a value to the custom data field identified by the *name* attribute. The type and name of this custom data field are declared in the \ element.
: Here is an example of defining two custom data elements:
\<*namespace_prefix:other\>*
: This element allows you to add untyped custom data. Be sure to reference the namespace prefix in the \ element of your file or as an attribute of the \ element and to prefix the name of each data element with the namespace prefix. Custom data added in this manner is preserved in the KML file but is not used by Google Earth in any way. It is always saved along with the file.
: The following example shows using the "camp" namespace prefix:
### Contained By
- Any element derived from [\<*Feature*\>](https://developers.google.com/kml/documentation/kmlreference#feature)
### See Also
- [Schema](https://developers.google.com/kml/documentation/kmlreference#schema)
## \<*Feature*\>
### Syntax
```
...10...
...
............
\...\..................
<-- /Feature -->
```
### Description
This is an abstract element and cannot be used directly in a KML file. The following diagram shows how some of a Feature's elements appear in Google Earth.
### Elements Specific to Feature
\
: User-defined text displayed in the 3D viewer as the label for the object (for example, for a Placemark, Folder, or NetworkLink).
\
: Boolean value. Specifies whether the feature is drawn in the 3D viewer when it is initially loaded. In order for a feature to be visible, the \ tag of all its ancestors must also be set to 1. In the Google Earth List View, each Feature has a checkbox that allows the user to control visibility of the Feature.
\
: Boolean value. Specifies whether a Document or Folder appears closed or open when first loaded into the Places panel. 0=collapsed (the default), 1=expanded. See also [\](https://developers.google.com/kml/documentation/kmlreference#liststyle). This element applies only to Document, Folder, and NetworkLink.
**\**
: KML 2.2 supports new elements for including data about the author and related website in your KML file. This information is displayed in geo search results, both in Earth browsers such as Google Earth, and in other applications such as Google Maps. The ascription elements used in KML are as follows:
- **atom:author** element - parent element for atom:name
- **atom:name** element - the name of the author
- **atom:link** element - contains the *href* attribute
- **href** attribute - URL of the web page containing the KML/KMZ file
These elements are defined in the Atom Syndication Format. The complete specification is found at [http://atompub.org.](http://www.w3.org/2005/Atom) (see the [sample](https://developers.google.com/kml/documentation/kmlreference#sampleattribution)that follows).
The \ element is the parent element for \, which specifies the author of the KML feature.
**\**
: Specifies the URL of the website containing this KML or KMZ file. Be sure to include the namespace for this element in any KML file that uses it: `xmlns:atom="http://www.w3.org/2005/Atom"` (see the [sample](https://developers.google.com/kml/documentation/kmlreference#sampleattribution)that follows).
\
: A string value representing an unstructured address written as a standard street, city, state address, and/or as a postal code. You can use the \ tag to specify the location of a point instead of using latitude and longitude coordinates. (However, if a \ is provided, it takes precedence over the \.) To find out which locales are supported for this tag in Google Earth, go to the [Google Maps Help](http://maps.google.com/support/bin/answer.py?answer=16634).
\
: A structured address, formatted as xAL, or [eXtensible Address Language](http://www.oasis-open.org/committees/ciq/ciq.html#6), an international standard for address formatting. \ is used by KML for geocoding in Google Maps only. For details, see the [Google Maps API documentation](http://www.google.com/apis/maps/documentation/#Geocoding_Etc). Currently, Google Earth does not use this element; use \ instead. Be sure to include the namespace for this element in any KML file that uses it: `xmlns:xal="urn:oasis:names:tc:ciq:xsdschema:xAL:2.0"`
\
: A string value representing a telephone number. This element is used by Google Maps Mobile only. The industry standard for Java-enabled cellular phones is RFC2806.
For more information, see
[http://www.ietf.org/rfc /rfc2806.txt](http://www.google.com/url?sa=D&q=http://www.ietf.org/rfc/rfc2806.txt).
\
: A short description of the feature. In Google Earth, this description is displayed in the Places panel under the name of the feature. If a Snippet is not supplied, the first two lines of the \ are used. In Google Earth, if a Placemark contains both a description and a Snippet, the \ appears beneath the Placemark in the Places panel, and the \ appears in the Placemark's description balloon. This tag does not support HTML markup. \ has a **maxLines** attribute, an integer that specifies the maximum number of lines to display.
\
: User-supplied content that appears in the description balloon.
The supported content for the \ element changed from Google Earth 4.3 to 5.0. Specific information for each version is listed out below, followed by information common to both.
**Google Earth 5.0**
Google Earth 5.0 (and later) supports plain text content, as well as full HTML and JavaScript, within description balloons. Contents of the description tag are rendered by the [WebKit](http://webkit.org/) open source web browser engine, and are displayed as they would be in any WebKit-based browser.
**General restrictions**
Links to local files are generally not allowed. This prevents malicious code from damaging your system or accessing your data. Should you wish to allow access to your local filesystem, select **Preferences** \> **Allow access to local files and personal data**. Links to image files on the local filesystem are always allowed, if contained within an \ tag.
Content that has been compressed into a KMZ file can be accessed, even if on the local filesystem.
Cookies are enabled, but for the purposes of the same-origin policy, local content does not share a domain with any other content (including other local content).
: **HTML**
HTML is mostly rendered as it would be in any WebKit browser.
Targets are ignored when included in HTML written directly into the KML; all such links are opened as if the target is set to _blank. Any specified targets are ignored.
HTML that is contained in an iFrame, however, or dynamically generated with JavaScript or DHTML, will use target="_self" as the default. Other targets can be specified and are supported.
The contents of KMZ files, local anchor links, and `;flyto` methods cannot be targeted from HTML contained within an iFrame.
If the user specifies `width="100%"` for the width of an iFrame, then the iFrame's width will be dependent on all the other content in the balloon---it should essentially be ignored while calculating layout size. This rule applies to any other block element inside the balloon as well.
**JavaScript**
Most JavaScript is supported. Dialog boxes can not be created - functions such as alert() and prompt() will not be displayed. They will, however, be written to the system console, as will other errors and exceptions.
**CSS**
CSS is allowed. As with CSS in a regular web browser, CSS can be used to style text, page elements, and to control the size and appearance of the description balloon.
**Google Earth 4.3**
The \ element supports plain text as well as a subset of HTML formatting elements, including tables (see [KML example](https://developers.google.com/kml/documentation/kmlreference#descriptionexample) below). It does not support other web-based technology, such as dynamic page markup (PHP, JSP, ASP), scripting languages (VBScript, Javascript), nor application languages (Java, Python). In Google Earth release 4.2, video is supported. (See [Example](https://developers.google.com/kml/documentation/kmlreference#samplevideo) below.)
**Common information**
If your description contains no HTML markup, Google Earth attempts to format it, replacing newlines with \ and wrapping URLs with anchor tags. A valid URL string for the World Wide Web is automatically converted to a hyperlink to that URL (e.g., *http://www.google.com* ). Consequently, you do not need to surround a URL with the \\ tags in order to achieve a simple link.
When using HTML to create a hyperlink around a specific word, or when including images in the HTML, you must use HTML entity references or the CDATA element to escape angle brackets, apostrophes, and other special characters. The CDATA element tells the XML parser to ignore special characters used within the brackets. This element takes the form of:
```
```
If you prefer not to use the CDATA element, you can use entity references to replace all the special characters.
```
]]>
```
*Other Behavior Specified Through Use of the \ Element*
KML supports the use of two attributes within the \ element: **href** and **type**.
The anchor element \ contains an *href* attribute that specifies a URL.
If the *href* is a KML file and has a *.kml* or *.kmz* file extension, Google Earth loads that file directly when the user clicks it. If the URL ends with an extension not known to Google Earth (for example, *.html*), the URL is sent to the browser.
: The *href* can be a fragment URL (that is, a URL with a # sign followed by a KML identifier). When the user clicks a link that includes a fragment URL, by default the browser flies to the Feature whose ID matches the fragment. If the Feature has a LookAt or Camera element, the Feature is viewed from the specified viewpoint.
The behavior can be further specified by appending one of the following three strings to the fragment URL:
- *;flyto* (default) - fly to the Feature
- *;balloon* - open the Feature's balloon but do not fly to the Feature
- *;balloonFlyto* - open the Feature's balloon and fly to the Feature
For example, the following code indicates to open the file *CraftsFairs.kml*, fly to the Placemark whose ID is "Albuquerque," and open its balloon:
```
One of the Best Art Shows in the West
]]>
```
The *type* attribute is used within the \ element when the *href* does not end in *.kml* or *.kmz*, but the reference needs to be interpreted in the context of KML. Specify the following:
```
type="application/vnd.google-earth.kml+xml"
```
For example, the following URL uses the `type` attribute to notify Google Earth that it should attempt to load the file, even though the file extension is *.php*:
```
```
:
***\***
: Defines a viewpoint associated with any element derived from Feature. See [\](https://developers.google.com/kml/documentation/kmlreference#camera) and [\](https://developers.google.com/kml/documentation/kmlreference#lookat).
***\***
: Associates this Feature with a period of time ([\](https://developers.google.com/kml/documentation/kmlreference#timespan)) or a point in time ([\](https://developers.google.com/kml/documentation/kmlreference#timestamp)).
\
: URL of a [\](https://developers.google.com/kml/documentation/kmlreference#style) or [\](https://developers.google.com/kml/documentation/kmlreference#stylemap) defined in a Document. If the style is in the same file, use a **#** reference. If the style is defined in an external file, use a full URL along with # referencing. Examples are
```
#myIconStyleID
```
```
http://someserver.com/somestylefile.xml#restaurant
```
```
eateries.kml#my-lunch-spot
```
\<*StyleSelector*\>
: One or more Styles and StyleMaps can be defined to customize the appearance of any element derived from Feature or of the Geometry in a Placemark. (See [\](https://developers.google.com/kml/documentation/kmlreference#balloonstyle), [\](https://developers.google.com/kml/documentation/kmlreference#liststyle), [\](https://developers.google.com/kml/documentation/kmlreference#styleselector), [](https://developers.google.com/kml/documentation/kmlreference#balloonstyle)and the styles derived from [\](https://developers.google.com/kml/documentation/kmlreference#colorstyle).) A style defined within a Feature is called an "inline style" and applies only to the Feature that contains it. A style defined as the child of a \ is called a "shared style." A shared style must have an *id* defined for it. This id is referenced by one or more Features within the \. In cases where a style element is defined both in a shared style and in an inline style for a Feature---that is, a Folder, GroundOverlay, NetworkLink, Placemark, or ScreenOverlay---the value for the Feature's inline style takes precedence over the value for the shared style.
\
: Features and geometry associated with a Region are drawn only when the Region is active. See [\](https://developers.google.com/kml/documentation/kmlreference#region).
\
**[\](https://developers.google.com/kml/documentation/kmlreference#extendeddata)**
: Allows you to add custom data to a KML file. This data can be (1) data that references an external XML schema, (2) untyped data/value pairs, or (3) typed data. A given KML Feature can contain a combination of these types of custom data.
### Sample Use of HTML Elements within a Description
This example illustrates the complete set of HTML elements supported by the \ element **in Google Earth 4.3**. Google Earth 5.0 and later supports full HTML and JavaScript.
```
Feature.kml
The snippet is a way of
providing an alternative
description that will be
shown in the List view.
Italics, Bold, Underlined,
Strike Out, subscriptsubscript,
superscriptsuperscript,
Big, Small, Typewriter,
Emphasized, Strong, Code
Fonts:
red by name,
leaf green by hexadecimal RGB,
size 1, size 2,
size 3, size 4,
size 5, size 6,
size 7,
Times,
Verdana,
Arial
Links:
QT Rich Text Rendering
Alignment:
and we have a link http://www.google.com.]]>