schema.kmljavadocs.xml Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of javaapiforkml Show documentation
Show all versions of javaapiforkml Show documentation
This is JavaApiForKml, Micromata's library for use with applications that want to parse, generate and
operate on KML. It is an implementation of the OGC KML 2.2 standard. It is written entirely in Java and makes
heavy use of JAXB. Now being maintained by @urbancamo.
The newest version!
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ns2:JaxbJavaDocElements xmlns:ns2="http://www.opengis.net/kml/2.2">
<elements>
<className>targethref</className>
<javaDoc><targethref> (required)
<p>
A URL that specifies the .kml or .kmz file whose data (within Google Earth) is to
be modified by an <Update> element. This KML file must already have been loaded
via a <NetworkLink>. In that file, the element to be modified must already have
an explicit id attribute defined for it.
</p>
<p>
Specifies the texture file to be fetched by Google Earth. This reference can be
a relative reference to an image file within the .kmz archive, or it can be an absolute
reference to the file (for example, a URL).
</p>
</javaDoc>
</elements>
<elements>
<className>stylestate</className>
<javaDoc>StyleState
<p>
normal, highlight
</p>
See Also:
See <StyleMap>
</javaDoc>
</elements>
<elements>
<className>liststyle</className>
<javaDoc><ListStyle>
<p>
Specifies how a Feature is displayed in the list view. The list view is a hierarchy
of containers and children; in Google Earth, this is the Places panel.
</p>
Syntax:
<pre><strong>&lt;ListStyle id="ID"&gt;</strong>
&lt;!-- specific to ListStyle --&gt;
&lt;listItemType&gt;check&lt;/listItemType&gt; &lt;!-- kml:listItemTypeEnum:check,
checkOffOnly,checkHideChildren,
radioFolder --&gt;
&lt;bgColor&gt;ffffffff&lt;/bgColor&gt; &lt;!-- kml:color --&gt;
&lt;ItemIcon&gt; &lt;!-- 0 or more ItemIcon elements --&gt;
&lt;state&gt;open&lt;/state&gt;
&lt;!-- kml:itemIconModeEnum:open, closed, error, fetching0, fetching1, <em>or</em> fetching2 --&gt;
&lt;href&gt;...&lt;/href&gt; &lt;!-- anyURI --&gt;
&lt;/ItemIcon&gt;
<strong>&lt;/ListStyle&gt;</strong></pre>
Extends:
@see: <Object>
Contained By:
@see: <Style>
</javaDoc>
</elements>
<elements>
<className>lookat</className>
<javaDoc><LookAt>
<p>
Defines a virtual camera that is associated with any element derived from Feature.
The LookAt element positions the "camera" in relation to the object that is being
viewed. In Google Earth, the view "flies to" this LookAt viewpoint when the user
double-clicks an item in the Places panel or double-clicks an icon in the 3D viewer.
</p>
Syntax:
<pre><strong>&lt;LookAt id="ID"&gt;</strong>
&lt;!-- inherited from AbstractView element --&gt;
<em>&lt;TimePrimitive&gt;...&lt;/TimePrimitive&gt;</em> &lt;!-- gx:TimeSpan or gx:TimeStamp --&gt;
&lt;!-- specific to LookAt --&gt;
&lt;longitude&gt;0&lt;/longitude&gt; &lt;!-- kml:angle180 --&gt;
&lt;latitude&gt;0&lt;/latitude&gt; &lt;!-- kml:angle90 --&gt;
&lt;altitude&gt;0&lt;/altitude&gt; &lt;!-- double --&gt;
&lt;heading&gt;0&lt;/heading&gt; &lt;!-- kml:angle360 --&gt;
&lt;tilt&gt;0&lt;/tilt&gt; &lt;!-- kml:anglepos90 --&gt;
&lt;range&gt;&lt;/range&gt; &lt;!-- double --&gt;
&lt;altitudeMode&gt;clampToGround&lt;/altitudeMode&gt;
&lt;!--kml:altitudeModeEnum:clampToGround, relativeToGround, absolute --&gt;
&lt;!-- or, gx:altitudeMode can be substituted: clampToSeaFloor, relativeToSeaFloor --&gt;
<strong>&lt;/LookAt&gt;</strong></pre>
Extends:
@see: <AbstractView>
Contained By:
@see: <Feature>
@see: <NetworkLinkControl>
</javaDoc>
</elements>
<elements>
<className>region</className>
<javaDoc><Region>
<p>
A region contains a bounding box (<LatLonAltBox>) that describes an area of interest
defined by geographic coordinates and altitudes. In addition, a Region contains
an LOD (level of detail) extent (<Lod>) that defines a validity range of the associated
Region in terms of projected screen size. A Region is said to be "active" when the
bounding box is within the user's view and the LOD requirements are met. Objects
associated with a Region are drawn only when the Region is active. When the <viewRefreshMode>
is onRegion, the Link or Icon is loaded only when the Region is active. See the
"Topics in KML" page on Regions for more details. In a Container or NetworkLink
hierarchy, this calculation uses the Region that is the closest ancestor in the
hierarchy.
</p>
<p>
Features and geometry associated with a Region are drawn only when the Region is
active. See <Region>.
</p>
Syntax:
<pre><strong>&lt;Region id="ID"&gt; </strong>
&lt;LatLonAltBox&gt;
&lt;north&gt;&lt;/north&gt; &lt;!-- required; kml:angle90 --&gt;
&lt;south&gt;&lt;/south&gt; &lt;!-- required; kml:angle90 --&gt;
&lt;east&gt;&lt;/east&gt; &lt;!-- required; kml:angle180 --&gt;
&lt;west&gt;&lt;/west&gt; &lt;!-- required; kml:angle180 --&gt;
&lt;minAltitude&gt;0&lt;/minAltitude&gt; &lt;!-- float --&gt;
&lt;maxAltitude&gt;0&lt;/maxAltitude&gt; &lt;!-- float --&gt;
&lt;altitudeMode&gt;clampToGround&lt;/altitudeMode&gt;
&lt;!-- kml:altitudeModeEnum: clampToGround, relativeToGround, or absolute --&gt;
&lt;!-- or, substitute gx:altitudeMode: clampToSeaFloor, relativeToSeaFloor --&gt;
&lt;/LatLonAltBox&gt;
&lt;Lod&gt;
&lt;minLodPixels&gt;0&lt;/minLodPixels&gt; &lt;!-- float --&gt;
&lt;maxLodPixels&gt;-1&lt;/maxLodPixels&gt; &lt;!-- float --&gt;
&lt;minFadeExtent&gt;0&lt;/minFadeExtent&gt; &lt;!-- float --&gt;
&lt;maxFadeExtent&gt;0&lt;/maxFadeExtent&gt; &lt;!-- float --&gt;
&lt;/Lod&gt;
<strong>&lt;/Region&gt; </strong></pre>
Extends:
@see: <Object>
Contained By:
@see: <Feature>
</javaDoc>
</elements>
<elements>
<className>screenoverlay</className>
<javaDoc><ScreenOverlay>
<p>
The <href> child of <Icon> specifies the image to be used as the overlay. This file
can be either on a local file system or on a web server. If this element is omitted
or contains no <href>, a rectangle is drawn using the color and size defined by
the screen overlay.
</p>
<p>
This element draws an image overlay fixed to the screen. Sample uses for ScreenOverlays
are compasses, logos, and heads-up displays. ScreenOverlay sizing is determined
by the <size> element. Positioning of the overlay is handled by mapping a point
in the image specified by <overlayXY> to a point on the screen specified by <screenXY>.
Then the image is rotated by <rotation> degrees about a point relative to the screen
specified by <rotationXY>.
</p>
<p>
This element draws an image overlay fixed to the screen. Sample uses for ScreenOverlays
are compasses, logos, and heads-up displays. ScreenOverlay sizing is determined
by the <size> element. Positioning of the overlay is handled by mapping a point
in the image specified by <overlayXY> to a point on the screen specified by <screenXY>.
Then the image is rotated by <rotation> degrees about a point relative to the screen
specified by <rotationXY>.
</p>
Syntax:
<pre><strong>&lt;ScreenOverlay id="ID"&gt;</strong>
&lt;!-- inherited from <em>Feature</em> element --&gt;
&lt;name&gt;<em>...</em>&lt;/name&gt; &lt;!-- string --&gt;
&lt;visibility&gt;1&lt;/visibility&gt; &lt;!-- boolean --&gt;
&lt;open&gt;0&lt;/open&gt; &lt;!-- boolean --&gt;
<span>&lt;atom:author&gt;...&lt;atom:author&gt; &lt;!-- xmlns:atom --&gt;
&lt;atom:link&gt;...&lt;/atom:link&gt;</span><span> &lt;!-- xmlns:atom --&gt;</span>
&lt;address&gt;<em>...</em>&lt;/address&gt; &lt;!-- string --&gt;
&lt;xal:AddressDetails&gt;...&lt;/xal:AddressDetails&gt; &lt;!-- xmlns:xal --&gt;<br> &lt;phoneNumber&gt;...&lt;/phoneNumber&gt; &lt;!-- string --&gt;<br> &lt;Snippet maxLines="2"&gt;<em>...</em>&lt;/Snippet&gt; &lt;!-- string --&gt;
&lt;description&gt;<em>...</em>&lt;/description&gt; &lt;!-- string --&gt;
<span><em>&lt;AbstractView&gt;...&lt;/AbstractView&gt;</em> &lt;!-- Camera <em>or</em> LookAt --&gt;</span>
&lt;<em>TimePrimitive</em>&gt;...&lt;/<em>TimePrimitive</em>&gt;
&lt;styleUrl&gt;<em>...</em>&lt;/styleUrl&gt; &lt;!-- anyURI --&gt;
&lt;<em>StyleSelector&gt;...&lt;/StyleSelector&gt;</em>
&lt;Region&gt;...&lt;/Region&gt;
<span>&lt;Metadata&gt;...&lt;/Metadata&gt; &lt;!-- deprecated in KML 2.2 --&gt;
&lt;ExtendedData&gt;...&lt;/ExtendedData&gt; &lt;!-- new in KML 2.2 --&gt;
</span>&lt;!-- inherited from <em>Overlay</em> element --&gt;
&lt;color&gt;ffffffff&lt;/color&gt; &lt;!-- kml:color --&gt;
&lt;drawOrder&gt;0&lt;/drawOrder&gt; &lt;!-- int --&gt;
&lt;Icon&gt;...&lt;/Icon&gt;
&lt;!-- specific to ScreenOverlay --&gt;
&lt;overlayXY x="double" y="double" xunits="fraction" yunits="fraction"/&gt;
&lt;!-- vec2 --&gt;
&lt;!-- xunits and yunits can be one of: fraction, pixels, <em>or</em> insetPixels --&gt;
&lt;screenXY x="double" y="double" xunits="fraction" yunits="fraction"<em>/</em>&gt;
&lt;!-- vec2 --&gt;
&lt;rotationXY x="double" y="double" xunits="fraction" yunits"fraction"<em>/</em>&gt;
&lt;!-- vec2 --&gt;
&lt;size x="double" y="double" xunits="fraction" yunits="fraction"<em>/</em>&gt;
&lt;!-- vec2 --&gt;
&lt;rotation&gt;0&lt;/rotation&gt; &lt;!-- float --&gt;
<strong>&lt;/ScreenOverlay&gt;</strong></pre>
Extends:
@see: <Feature>
@see: <Overlay>
Contained By:
@see: <Document>
@see: <Folder>
</javaDoc>
</elements>
<elements>
<className>fill</className>
<javaDoc><fill>
<p>
Boolean value. Specifies whether to fill the polygon.
</p>
</javaDoc>
</elements>
<elements>
<className>placemark</className>
<javaDoc><Placemark>
<p>
A Placemark is a Feature with associated Geometry. In Google Earth, a Placemark
appears as a list item in the Places panel. A Placemark with a Point has an icon
associated with it that marks a point on the Earth in the 3D viewer. (In the Google
Earth 3D viewer, a Point Placemark is the only object you can click or roll over.
Other Geometry objects do not have an icon in the 3D viewer. To give the user something
to click in the 3D viewer, you would need to create a MultiGeometry object that
contains both a Point and the other Geometry object.)
</p>
Syntax:
<pre><strong>&lt;Placemark id="ID"&gt;</strong>
&lt;!-- inherited from <em>Feature</em> element --&gt;
&lt;name&gt;<em>...</em>&lt;/name&gt; &lt;!-- string --&gt;
&lt;visibility&gt;1&lt;/visibility&gt; &lt;!-- boolean --&gt;
&lt;open&gt;0&lt;/open&gt; &lt;!-- boolean --&gt;
<span>&lt;atom:author&gt;...&lt;atom:author&gt; &lt;!-- xmlns:atom --&gt;
&lt;atom:link&gt;...&lt;/atom:link&gt;</span><span> &lt;!-- xmlns:atom --&gt;</span>
&lt;address&gt;<em>...</em>&lt;/address&gt; &lt;!-- string --&gt;
&lt;xal:AddressDetails&gt;...&lt;/xal:AddressDetails&gt; &lt;!-- xmlns:xal --&gt;<br> &lt;phoneNumber&gt;...&lt;/phoneNumber&gt; &lt;!-- string --&gt;<br> &lt;Snippet maxLines="2"&gt;<em>...</em>&lt;/Snippet&gt; &lt;!-- string --&gt;
&lt;description&gt;<em>...</em>&lt;/description&gt; &lt;!-- string --&gt;
<span><em>&lt;AbstractView&gt;...&lt;/AbstractView&gt;</em> &lt;!-- Camera <em>or</em> LookAt --&gt;</span>
&lt;<em>TimePrimitive</em>&gt;...&lt;/<em>TimePrimitive</em>&gt;
&lt;styleUrl&gt;<em>...</em>&lt;/styleUrl&gt; &lt;!-- anyURI --&gt;
&lt;<em>StyleSelector&gt;...&lt;/StyleSelector&gt;</em>
&lt;Region&gt;...&lt;/Region&gt;
<span>&lt;Metadata&gt;...&lt;/Metadata&gt; &lt;!-- deprecated in KML 2.2 --&gt;
&lt;ExtendedData&gt;...&lt;/ExtendedData&gt; &lt;!-- new in KML 2.2 --&gt;</span><br>
&lt;!-- specific to Placemark element --&gt;
<em>&lt;Geometry&gt;...&lt;/Geometry&gt;</em>
<strong>&lt;/Placemark&gt;</strong></pre>
Extends:
@see: <Feature>
Contained By:
@see: <Document>
@see: <Folder>
See Also:
<Icon>
</javaDoc>
</elements>
<elements>
<className>maxsessionlength</className>
<javaDoc><maxsessionlength>
<p>
Specified in seconds, <maxSessionLength> is the maximum amount of time for which
the client NetworkLink can remain connected. The default value of -1 indicates not
to terminate the session explicitly.
</p>
</javaDoc>
</elements>
<elements>
<className>displayname</className>
<javaDoc><displayname>
<p>
An optional formatted version of name, to be used for display purposes.
</p>
</javaDoc>
</elements>
<elements>
<className>stylemap</className>
<javaDoc><StyleMap>
<p>
A <StyleMap> maps between two different Styles. Typically a <StyleMap> element is
used to provide separate normal and highlighted styles for a placemark, so that
the highlighted version appears when the user mouses over the icon in Google Earth.
</p>
Syntax:
<pre><strong>&lt;StyleMap id="ID"&gt;</strong>
&lt;!-- extends <em>StyleSelector</em> --&gt;
&lt;!-- elements specific to StyleMap --&gt;
&lt;Pair id="ID"&gt;
&lt;key&gt;normal&lt;/key&gt; &lt;!-- kml:styleStateEnum: normal<em> or</em> highlight --&gt;
&lt;styleUrl&gt;<em>...</em>&lt;/styleUrl&gt; or &lt;Style&gt;...&lt;/Style&gt;
&lt;/Pair&gt;
<strong>&lt;/StyleMap&gt;</strong></pre>
Extends:
@see: <StyleSelector>
Contained By:
@see: <Feature>
</javaDoc>
</elements>
<elements>
<className>lod</className>
<javaDoc><lod>
<p>
<minLodPixels> (required) Measurement in screen pixels that represents the minimum
limit of the visibility range for a given Region. Google Earth calculates the size
of the Region when projected onto screen space. Then it computes the square root
of the Region's area (if, for example, the Region is square and the viewpoint is
directly above the Region, and the Region is not tilted, this measurement is equal
to the width of the projected Region). If this measurement falls within the limits
defined by <minLodPixels> and <maxLodPixels> (and if the <LatLonAltBox> is in view),
the Region is active. If this limit is not reached, the associated geometry is considered
to be too far from the user's viewpoint to be drawn. <maxLodPixels> Measurement
in screen pixels that represents the maximum limit of the visibility range for a
given Region. A value of −1, the default, indicates "active to infinite size." <minFadeExtent>
Distance over which the geometry fades, from fully opaque to fully transparent.
This ramp value, expressed in screen pixels, is applied at the minimum end of the
LOD (visibility) limits. <maxFadeExtent> Distance over which the geometry fades,
from fully transparent to fully opaque. This ramp value, expressed in screen pixels,
is applied at the maximum end of the LOD (visibility) limits.
</p>
</javaDoc>
</elements>
<elements>
<className>styleurl</className>
<javaDoc><styleurl>
<p>
URL of a <Style> or <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 <styleUrl>#myIconStyleID</styleUrl> <styleUrl>http://someserver.com/somestylefile.xml#restaurant</styleUrl>
<styleUrl>eateries.kml#my-lunch-spot</styleUrl>
</p>
</javaDoc>
</elements>
<elements>
<className>tilt</className>
<javaDoc><tilt>
<p>
Angle between the direction of the LookAt position and the normal to the surface
of the earth. (See diagram below.) Values range from 0 to 90 degrees. Values for
<tilt> cannot be negative. A <tilt> value of 0 degrees indicates viewing from directly
above. A <tilt> value of 90 degrees indicates viewing along the horizon.
</p>
<p>
Rotation about the x axis. A positive rotation is clockwise around the x axis and
specified in degrees from 0 to 360.
</p>
<p>
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 <tilt> 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 <tilt> are
clamped at +180 degrees.
</p>
</javaDoc>
</elements>
<elements>
<className>object</className>
<javaDoc><Object>
<p>
This is an abstract base class and cannot be used directly in a KML file. It provides
the id attribute, which allows unique identification of a KML element, and the targetId
attribute, which is used to reference objects that have already been loaded into
Google Earth. The id attribute must be assigned if the <Update> mechanism is to
be used.
</p>
Syntax:
<pre>&lt;!-- abstract element; do not create --&gt;<strong>
&lt;!-- <em>Object</em> id="ID" targetId="NCName" --&gt;
&lt;!-- /<em>Object</em>&gt; --&gt;</strong></pre>
</javaDoc>
</elements>
<elements>
<className>west</className>
<javaDoc><west> (required)
<p>
Specifies the longitude of the west edge of the bounding box, in decimal degrees
from 0 to ±180.
</p>
</javaDoc>
</elements>
<elements>
<className>open</className>
<javaDoc><open>
<p>
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
<ListStyle>. This element applies only to Document, Folder, and NetworkLink.
</p>
</javaDoc>
</elements>
<elements>
<className>scale</className>
<javaDoc><scale>
<p>
Note: The <geomScale> tag has been deprecated. Use <scale> instead.
</p>
<p>
Resizes the icon.
</p>
<p>
Scales a model along the x, y, and z axes in the model's coordinate space. <Scale>
<x>2.5</x> <y>2.5</y> <z>3.5</z> </Scale>
</p>
</javaDoc>
</elements>
<elements>
<className>snippet</className>
<javaDoc><snippet maxlines="2" >
<p>
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 <description> are used. In Google Earth, if a Placemark
contains both a description and a Snippet, the <Snippet> appears beneath the Placemark
in the Places panel, and the <description> appears in the Placemark's description
balloon. This tag does not support HTML markup. <Snippet> has a maxLines attribute,
an integer that specifies the maximum number of lines to display.
</p>
</javaDoc>
</elements>
<elements>
<className>multigeometry</className>
<javaDoc><MultiGeometry>
<p>
A container for zero or more geometry primitives associated with the same feature.
</p>
<p>
Note: The <GeometryCollection> tag has been deprecated. Use <MultiGeometry> instead.
</p>
Syntax:
<pre><strong>&lt;MultiGeometry id="ID"&gt;</strong>
&lt;!-- specific to MultiGeometry --&gt;
&lt;!-- 0 or more <em>Geometry</em> elements --&gt;
<strong>&lt;/MultiGeometry&gt;</strong></pre>
Extends:
@see: <Geometry>
Contained By:
@see: <MultiGeometry>
@see: <Placemark>
</javaDoc>
</elements>
<elements>
<className>polygon</className>
<javaDoc><Polygon>
<p>
A Polygon is defined by an outer boundary and 0 or more inner boundaries. The boundaries,
in turn, are defined by LinearRings. When a Polygon is extruded, its boundaries
are connected to the ground to form additional polygons, which gives the appearance
of a building or a box. Extruded Polygons use <PolyStyle> for their color, color
mode, and fill.
</p>
<p>
Note: In Google Earth, a Polygon with an <altitudeMode> of clampToGround follows
the great circle; however, a LinearRing (by itself) with an <altitudeMode> of clampToGround
follows lines of constant latitude.
</p>
<p>
The <coordinates> for polygons must be specified in counterclockwise order. Polygons
follow the "right-hand rule," which states that if you place the fingers of your
right hand in the direction in which the coordinates are specified, your thumb points
in the general direction of the geometric normal for the polygon. (In 3D graphics,
the geometric normal is used for lighting and points away from the front face of
the polygon.) Since Google Earth fills only the front face of polygons, you will
achieve the desired effect only when the coordinates are specified in the proper
order. Otherwise, the polygon will be gray.
</p>
Syntax:
<pre><strong>&lt;Polygon id="ID"&gt;</strong>
&lt;!-- specific to Polygon --&gt;
&lt;extrude&gt;0&lt;/extrude&gt; &lt;!-- boolean --&gt;
&lt;tessellate&gt;0&lt;/tessellate&gt; &lt;!-- boolean --&gt;
&lt;altitudeMode&gt;clampToGround&lt;/altitudeMode&gt;
&lt;!-- kml:altitudeModeEnum: clampToGround, relativeToGround, or absolute --&gt;
&lt;!-- or, substitute gx:altitudeMode: clampToSeaFloor, relativeToSeaFloor --&gt;
&lt;outerBoundaryIs&gt;
&lt;LinearRing&gt;
&lt;coordinates&gt;...&lt;/coordinates&gt; &lt;!-- lon,lat[,alt] --&gt;
&lt;/LinearRing&gt;
&lt;/outerBoundaryIs&gt;
&lt;innerBoundaryIs&gt;
&lt;LinearRing&gt;
&lt;coordinates&gt;...&lt;/coordinates&gt; &lt;!-- lon,lat[,alt] --&gt;
&lt;/LinearRing&gt;
&lt;/innerBoundaryIs&gt;
<strong>&lt;/Polygon&gt;</strong></pre>
Extends:
@see: <Geometry>
Contained By:
@see: <MultiGeometry>
@see: <Placemark>
</javaDoc>
</elements>
<elements>
<className>outline</className>
<javaDoc><outline>
<p>
Boolean value. Specifies whether to outline the polygon. Polygon outlines use the
current LineStyle.
</p>
</javaDoc>
</elements>
<elements>
<className>location</className>
<javaDoc><location>
<p>
Specifies the exact coordinates of the Model's origin in latitude, longitude, and
altitude. Latitude and longitude measurements are standard lat-lon projection with
WGS84 datum. Altitude is distance above the earth's surface, in meters, and is interpreted
according to <altitudeMode> or <gx:altitudeMode>. <Location> <longitude>39.55375305703105</longitude>
<latitude>-118.9813220168456</latitude> <altitude>1223</altitude> </Location>
</p>
</javaDoc>
</elements>
<elements>
<className>viewrefreshtime</className>
<javaDoc><viewrefreshtime>
<p>
After camera movement stops, specifies the number of seconds to wait before refreshing
the view. (See <viewRefreshMode> and onStop above.)
</p>
</javaDoc>
</elements>
<elements>
<className>styleselector</className>
<javaDoc><StyleSelector>
<p>
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 <BalloonStyle>,
<ListStyle>, <StyleSelector>, and the styles derived from <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 <Document> 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 <Document>. 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.
</p>
Syntax:
<pre>&lt;!-- abstract element; do not create --&gt;
<strong>&lt;!-- <em>StyleSelector</em> id="ID" --&gt; </strong> &lt;!-- Style,StyleMap --&gt;<strong>
&lt;!-- /<em>StyleSelector</em> --&gt;</strong></pre>
Extends:
@see: <Object>
Extended By:
@see: <Style>
@see: <StyleMap>
</javaDoc>
</elements>
<elements>
<className>phonenumber</className>
<javaDoc><phonenumber>
</javaDoc>
</elements>
<elements>
<className>viewrefreshmode</className>
<javaDoc>ViewRefreshMode
<p>
never, onRequest, onStop, onRegion
</p>
See Also:
See <Link>
</javaDoc>
</elements>
<elements>
<className>maxfadeextent</className>
<javaDoc><maxfadeextent>
<p>
Distance over which the geometry fades, from fully transparent to fully opaque.
This ramp value, expressed in screen pixels, is applied at the maximum end of the
LOD (visibility) limits.
</p>
<p>
In the following diagram, if P=the calculated projected pixel size, the circled
numbers indicate the following: if (P < minLodPixels) opacity=0 //#1 in diagram
else if(P < minLodPixels + minFadeExtent) opacity=(P - minLodPixels)/minFadeExtent
//#2 in diagram else if (P < maxLodPixels - maxFadeExtent) opacity=1 //#3 in diagram
else if (P < maxLodPixels) opacity=(maxLodPixels-P)/maxFadeExtent //#4 in diagram
else opacity=0 //#5 in diagram
</p>
</javaDoc>
</elements>
<elements>
<className>tilesize</className>
<javaDoc><tilesize>
<p>
Size of the tiles, in pixels. Tiles must be square, and <tileSize> must be a power
of 2. A tile size of 256 (the default) or 512 is recommended. The original image
is divided into tiles of this size, at varying resolutions.
</p>
</javaDoc>
</elements>
<elements>
<className>latlonaltbox</className>
<javaDoc><latlonaltbox>(required)
<p>
A bounding box that describes an area of interest defined by geographic coordinates
and altitudes. Default values and required fields are as follows:
</p>
</javaDoc>
</elements>
<elements>
<className>outerboundaryis</className>
<javaDoc><outerboundaryis> (required)
<p>
Contains a <LinearRing> element.
</p>
</javaDoc>
</elements>
<elements>
<className>textcolor</className>
<javaDoc><textcolor>
<p>
Foreground color for text. The default is black (ff000000).
</p>
</javaDoc>
</elements>
<elements>
<className>tessellate</className>
<javaDoc><tessellate>
<p>
Boolean value. Specifies whether to allow the LineString to follow the terrain.
To enable tessellation, the altitude mode must be clampToGround or clampToSeaFloor.
Very large LineStrings should enable tessellation so that they follow the curvature
of the earth (otherwise, they may go underground and be hidden).
</p>
<p>
Boolean value. Specifies whether to allow the LinearRing to follow the terrain.
To enable tessellation, the value for <altitudeMode> must be clampToGround or clampToSeaFloor.
Very large LinearRings should enable tessellation so that they follow the curvature
of the earth (otherwise, they may go underground and be hidden).
</p>
<p>
Boolean value. Specifies whether to allow the Polygon to follow the terrain. To
enable tessellation, the Polygon must have an altitude mode of clampToGround or
clampToSeaFloor. Very large Polygons should enable tessellation so that they follow
the curvature of the earth (otherwise, they may go underground and be hidden).
</p>
</javaDoc>
</elements>
<elements>
<className>schema</className>
<javaDoc><Schema>
<p>
Specifies a custom KML schema that is used to add custom data to KML Features. The
"id" attribute is required and must be unique within the KML file. <Schema> is always
a child of <Document>.
</p>
Syntax:
<pre>&lt;Schema name="string" id="ID"&gt;
&lt;SimpleField type="string" name="string"&gt;
&lt;displayName&gt;...&lt;/displayName&gt; &lt;!-- string --&gt;
&lt;/SimpleField&gt;
&lt;/Schema&gt;</pre>
Extends:
@see: This is a root element.
Contained By:
@see: <Document>
See Also:
<SchemaData>
</javaDoc>
</elements>
<elements>
<className>linksnippet</className>
<javaDoc><linksnippet maxlines="2" >
<p>
You can control the snippet for the network link from the server, so that changes
made to the snippet on the client side are overridden by the server. <linkSnippet>
has a maxLines attribute, an integer that specifies the maximum number of lines
to display.
</p>
</javaDoc>
</elements>
<elements>
<className>screenxy</className>
<javaDoc><screenxy>
<p>
Center the image:
</p>
<p>
Center the image: <ScreenOverlay> <overlayXY x="0.5" y="0.5" xunits="fraction" yunits="fraction"/>
<screenXY x="0.5" y="0.5" xunits="fraction" yunits="fraction"/> </ScreenOverlay>
Place the image on the top left: <ScreenOverlay> <overlayXY x="0" y="1" xunits="fraction"
yunits="fraction"/> <screenXY x="0" y="1" xunits="fraction" yunits="fraction"/>
</ScreenOverlay> Place the image at the right of the screen: <ScreenOverlay> <overlayXY
x="1" y="1" xunits="fraction" yunits="fraction"/> <screenXY x="1" y="1" xunits="fraction"
yunits="fraction"/> </ScreenOverlay>
</p>
<p>
For example, <screenXY x=".5" y=".5" xunits="fraction" yunits="fraction"/> indicates
a point in the middle of the screen.
</p>
<p>
Here are some examples:
</p>
<p>
Place the image at the right of the screen:
</p>
<p>
Place the image on the top left:
</p>
<p>
Specifies a point relative to the screen origin that the overlay image is mapped
to. The x and y values can be specified in three different ways: as pixels ("pixels"),
as fractions of the screen ("fraction"), or as inset pixels ("insetPixels"), which
is an offset in pixels from the upper right corner of the screen. The x and y positions
can be specified in different ways—for example, x can be in pixels and y can be
a fraction. The origin of the coordinate system is in the lower left corner of the
screen. x - Either the number of pixels, a fractional component of the screen, or
a pixel inset indicating the x component of a point on the screen. y - Either the
number of pixels, a fractional component of the screen, or a pixel inset indicating
the y component of a point on the screen. xunits - Units in which the x value is
specified. A value of "fraction" indicates the x value is a fraction of the screen.
A value of "pixels" indicates the x value in pixels. A value of "insetPixels" indicates
the indent from the right edge of the screen. yunits - Units in which the y value
is specified. A value of fraction indicates the y value is a fraction of the screen.
A value of "pixels" indicates the y value in pixels. A value of "insetPixels" indicates
the indent from the top edge of the screen.
</p>
</javaDoc>
</elements>
<elements>
<className>camera</className>
<javaDoc><Camera>
<p>
<Camera> can also contain a TimePrimitive (<gx:TimeSpan> or <gx:TimeStamp>). Time
values in Camera affect historical imagery, sunlight, and the display of time-stamped
features. For more information, read Time with AbstractViews in the Time and Animation
chapter of the Developer's Guide.
</p>
<p>
<Camera> 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.
</p>
<p>
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 <longitude>, <latitude>, <altitude>,
and either <altitudeMode> or <gx:altitudeMode>. The viewing direction of the camera
is defined by <heading>, <tilt>, and <roll>. <Camera> can be a child element of
any Feature or of <NetworkLinkControl>. A parent element cannot contain both a <Camera>
and a <LookAt> at the same time.
</p>
<p>
Defining a View
</p>
<p>
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.
</p>
<p>
The following diagram shows the X, Y, and Z axes, which are attached to the virtual
camera.
</p>
<p>
Within a Feature or <NetworkLinkControl>, use either a <Camera> or a <LookAt> object
(but not both in the same object). The <Camera> object defines the viewpoint in
terms of the viewer's position and orientation. The <Camera> object allows you to
specify a view that is not on the Earth's surface. The <LookAt> object defines the
viewpoint in terms of what is being viewed. The <LookAt> object is more limited
in scope than <Camera> and generally requires that the view direction intersect
the Earth's surface.
</p>
Syntax:
<pre><strong>&lt;Camera id="ID"&gt;</strong>
&lt;!-- inherited from AbstractView element --&gt;
<em>&lt;TimePrimitive&gt;...&lt;/TimePrimitive&gt;</em> &lt;!-- gx:TimeSpan or gx:TimeStamp --&gt;
&lt;!-- specific to Camera --&gt;
&lt;longitude&gt;0&lt;/longitude&gt; &lt;!-- kml:angle180 --&gt;
&lt;latitude&gt;0&lt;/latitude&gt; &lt;!-- kml:angle90 --&gt;
&lt;altitude&gt;0&lt;/altitude&gt; &lt;!-- double --&gt;
&lt;heading&gt;0&lt;/heading&gt; &lt;!-- kml:angle360 --&gt;
&lt;tilt&gt;0&lt;/tilt&gt; &lt;!-- kml:anglepos180 --&gt;
&lt;roll&gt;0&lt;/roll&gt; &lt;!-- kml:angle180 --&gt;
&lt;altitudeMode&gt;clampToGround&lt;/altitudeMode&gt;
&lt;!-- kml:altitudeModeEnum: relativeToGround, clampToGround, or absolute --&gt;
&lt;!-- or, gx:altitudeMode can be substituted: clampToSeaFloor, relativeToSeaFloor --&gt;
<strong>&lt;/Camera&gt;</strong> </pre>
Extends:
@see: <AbstractView>
Contained By:
@see: <Feature>
@see: <NetworkLinkControl>
</javaDoc>
</elements>
<elements>
<className>overlay</className>
<javaDoc><Overlay>
<p>
This is an abstract element and cannot be used directly in a KML file. <Overlay>
is the base type for image overlays drawn on the planet surface or on the screen.
<Icon> specifies the image to use and can be configured to reload images based on
a timer or by camera changes. This element also includes specifications for stacking
order of multiple overlays and for adding color and transparency values to the base
image.
</p>
Syntax:
<pre>&lt;!-- abstract element; do not create --&gt;
<strong>&lt;!-- <em>Overlay</em> id="ID" --&gt;</strong> &lt;!-- GroundOverlay,ScreenOverlay --&gt;
&lt;!-- inherited from <em>Feature</em> element --&gt;
&lt;name&gt;<em>...</em>&lt;/name&gt; &lt;!-- string --&gt;
&lt;visibility&gt;1&lt;/visibility&gt; &lt;!-- boolean --&gt;
&lt;open&gt;0&lt;/open&gt; &lt;!-- boolean --&gt;
<span>&lt;atom:author&gt;...&lt;atom:author&gt; &lt;!-- xmlns:atom --&gt;
&lt;atom:link&gt;...&lt;/atom:link&gt;</span><span> &lt;!-- xmlns:atom --&gt;</span>
&lt;address&gt;<em>...</em>&lt;/address&gt; &lt;!-- string --&gt;
&lt;xal:AddressDetails&gt;...&lt;/xal:AddressDetails&gt; &lt;!-- xmlns:xal --&gt;<br> &lt;phoneNumber&gt;...&lt;/phoneNumber&gt; &lt;!-- string --&gt;<br> &lt;Snippet maxLines="2"&gt;<em>...</em>&lt;/Snippet&gt; &lt;!-- string --&gt;
&lt;description&gt;<em>...</em>&lt;/description&gt; &lt;!-- string --&gt;
<span><em>&lt;AbstractView&gt;...&lt;/AbstractView&gt;</em> &lt;!-- Camera <em>or</em> LookAt --&gt;</span>
&lt;<em>TimePrimitive</em>&gt;...&lt;/<em>TimePrimitive</em>&gt;
&lt;styleUrl&gt;<em>...</em>&lt;/styleUrl&gt; &lt;!-- anyURI --&gt;
&lt;<em>StyleSelector&gt;...&lt;/StyleSelector&gt;</em>
&lt;Region&gt;...&lt;/Region&gt;
<span>&lt;Metadata&gt;...&lt;/Metadata&gt; &lt;!-- deprecated in KML 2.2 --&gt;
&lt;ExtendedData&gt;...&lt;/ExtendedData&gt; &lt;!-- new in KML 2.2 --&gt;</span>
&lt;!-- specific to <em>Overlay</em> --&gt;
&lt;color&gt;ffffffff&lt;/color&gt; &lt;!-- kml:color --&gt;
&lt;drawOrder&gt;0&lt;/drawOrder&gt; &lt;!-- int --&gt;
&lt;Icon&gt;
&lt;href&gt;...&lt;/href&gt;
&lt;/Icon&gt;
<strong>&lt;!-- /<em>Overlay --</em>&gt;</strong></pre>
Extends:
@see: <Feature>
Extended By:
@see: <GroundOverlay>
@see: <PhotoOverlay
@see: <ScreenOverlay>
@see: Syntax
</javaDoc>
</elements>
<elements>
<className>photooverlay</className>
<javaDoc><PhotoOverlay>
<p>
Because <PhotoOverlay> is derived from <Feature>, it can contain one of the two
elements derived from <AbstractView>—either <Camera> or <LookAt>. The Camera (or
LookAt) specifies a viewpoint and a viewing direction (also referred to as a view
vector). The PhotoOverlay is positioned in relation to the viewpoint. Specifically,
the plane of a 2D rectangular image is orthogonal (at right angles to) the view
vector. The normal of this plane—that is, its front, which is the part with the
photo—is oriented toward the viewpoint.
</p>
<p>
For more information, see the "Topics in KML" page on PhotoOverlay.
</p>
<p>
The <PhotoOverlay> element allows you to geographically locate a photograph on the
Earth and to specify viewing parameters for this PhotoOverlay. The PhotoOverlay
can be a simple 2D rectangle, a partial or full cylinder, or a sphere (for spherical
panoramas). The overlay is placed at the specified location and oriented toward
the viewpoint.
</p>
<p>
The URL for the PhotoOverlay image is specified in the <Icon> tag, which is inherited
from <Overlay>. The <Icon> tag must contain an <href> element that specifies the
image file to use for the PhotoOverlay. In the case of a very large image, the <href>
is a special URL that indexes into a pyramid of images of varying resolutions (see
ImagePyramid).
</p>
Extends:
@see: <Overlay>
Contained By:
@see: <Document>
@see: <Folder>
@see: <kml>
</javaDoc>
</elements>
<elements>
<className>state</className>
<javaDoc><state>
<p>
Specifies the current state of the NetworkLink or Folder. Possible values are open,
closed, error, fetching0, fetching1, and fetching2. These values can be combined
by inserting a space between two values (no comma).
</p>
</javaDoc>
</elements>
<elements>
<className>heading</className>
<javaDoc><heading>
<p>
Direction (azimuth) of the camera, in degrees. Default=0 (true North). (See diagram.)
Values range from 0 to 360 degrees.
</p>
<p>
Direction (that is, North, South, East, West), in degrees. Default=0 (North). (See
diagram below.) Values range from 0 to 360 degrees.
</p>
<p>
Direction (that is, North, South, East, West), in degrees. Default=0 (North). (See
diagram.) Values range from 0 to 360 degrees.
</p>
<p>
Rotation about the z axis (normal to the Earth's surface). A value of 0 (the default)
equals North. A positive rotation is clockwise around the z axis and specified in
degrees from 0 to 360.
</p>
</javaDoc>
</elements>
<elements>
<className>viewboundscale</className>
<javaDoc><viewboundscale>
<p>
Scales the BBOX parameters before sending them to the server. A value less than
1 specifies to use less than the full view (screen). A value greater than 1 specifies
to fetch an area that extends beyond the edges of the current view.
</p>
</javaDoc>
</elements>
<elements>
<className>x</className>
<javaDoc><x>, <y>, <w>, <h>
<p>
Use of these elements within <Icon> has been deprecated.
</p>
</javaDoc>
</elements>
<elements>
<className>coordinates</className>
<javaDoc><coordinates> (required)
<p>
A single tuple consisting of floating point values for longitude, latitude, and
altitude (in that order). Longitude and latitude values are in degrees, where longitude
≥ −180 and <= 180 latitude ≥ −90 and ≤ 90 altitude values (optional) are in meters
above sea level
</p>
<p>
Do not include spaces between the three values that describe a coordinate.
</p>
<p>
Two or more coordinate tuples, each consisting of floating point values for longitude,
latitude, and altitude. The altitude component is optional. Insert a space between
tuples. Do not include spaces within a tuple.
</p>
</javaDoc>
</elements>
<elements>
<className>update</className>
<javaDoc><Update>
<p>
Specifies an addition, change, or deletion to KML data that has already been loaded
using the specified URL. The <targetHref> specifies the .kml or .kmz file whose
data (within Google Earth) is to be modified. <Update> is always contained in a
NetworkLinkControl. Furthermore, the file containing the NetworkLinkControl must
have been loaded by a NetworkLink. See the "Topics in KML" page on Updates for a
detailed example of how Update works.
</p>
<p>
With <Update>, you can specify any number of Change, Create, and Delete tags for
a .kml file or .kmz archive that has previously been loaded with a network link.
See <Update>.
</p>
Syntax:
<pre><strong>&lt;Update&gt;
</strong>&lt;targetHref&gt;...&lt;targetHref&gt; &lt;!-- URL --&gt;
&lt;Change&gt;...&lt;/Change&gt;
&lt;Create&gt;...&lt;/Create&gt;
&lt;Delete&gt;...&lt;/Delete&gt;
<strong>&lt;/Update&gt;</strong></pre>
Contained By:
@see: <NetworkLinkControl>
@see: Note: This element was deprecated in KML Release 2.1 and is replaced by <Link>, which provides the additional functionality of Regions. The <Url> tag will still work in Google Earth, but use of the newer <Link> tag is encouraged.
@see: Use this element to set the location of the link to the KML file, to define the refresh options for the server and viewer changes, and to populate a variable to return useful client information to the server.
</javaDoc>
</elements>
<elements>
<className>leftfov</className>
<javaDoc><leftfov>
<p>
Angle, in degrees, between the camera's viewing direction and the left side of the
view volume.
</p>
</javaDoc>
</elements>
<elements>
<className>altitudemode</className>
<javaDoc>AltitudeMode
<p>
clampToGround, relativeToGround, absolute
</p>
See Also:
See <LookAt> and <Region>
</javaDoc>
</elements>
<elements>
<className>shape</className>
<javaDoc>Shape
<p>
rectangle, cylinder, sphere
</p>
See Also:
See <PhotoOverlay>
</javaDoc>
</elements>
<elements>
<className>message</className>
<javaDoc><message>
<p>
You can deliver a pop-up message, such as usage guidelines for your network link.
The message appears when the network link is first loaded into Google Earth, or
when it is changed in the network link control.
</p>
</javaDoc>
</elements>
<elements>
<className>linkname</className>
<javaDoc><linkname>
<p>
You can control the name of the network link from the server, so that changes made
to the name on the client side are overridden by the server.
</p>
</javaDoc>
</elements>
<elements>
<className>groundoverlay</className>
<javaDoc><GroundOverlay>
<p>
This element draws an image overlay draped onto the terrain. The <href> child of
<Icon> specifies the image to be used as the overlay. This file can be either on
a local file system or on a web server. If this element is omitted or contains no
<href>, a rectangle is drawn using the color and LatLonBox bounds defined by the
ground overlay.
</p>
Syntax:
<pre><strong>&lt;GroundOverlay id="ID"&gt;</strong>
&lt;!-- inherited from <em>Feature</em> element --&gt;
&lt;name&gt;<em>...</em>&lt;/name&gt; &lt;!-- string --&gt;
&lt;visibility&gt;1&lt;/visibility&gt; &lt;!-- boolean --&gt;
&lt;open&gt;0&lt;/open&gt; &lt;!-- boolean --&gt;
<span>&lt;atom:author&gt;...&lt;atom:author&gt; &lt;!-- xmlns:atom --&gt;
&lt;atom:link&gt;...&lt;/atom:link&gt;</span><span> &lt;!-- xmlns:atom --&gt;</span>
&lt;address&gt;<em>...</em>&lt;/address&gt; &lt;!-- string --&gt;
&lt;xal:AddressDetails&gt;...&lt;/xal:AddressDetails&gt; &lt;!-- xmlns:xal --&gt;<br> &lt;phoneNumber&gt;...&lt;/phoneNumber&gt; &lt;!-- string --&gt;<br> &lt;Snippet maxLines="2"&gt;<em>...</em>&lt;/Snippet&gt; &lt;!-- string --&gt;
&lt;description&gt;<em>...</em>&lt;/description&gt; &lt;!-- string --&gt;
<span><em>&lt;AbstractView&gt;...&lt;/AbstractView&gt;</em> &lt;!-- Camera <em>or</em> LookAt --&gt;</span>
&lt;<em>TimePrimitive</em>&gt;...&lt;/<em>TimePrimitive</em>&gt;
&lt;styleUrl&gt;<em>...</em>&lt;/styleUrl&gt; &lt;!-- anyURI --&gt;
&lt;<em>StyleSelector&gt;...&lt;/StyleSelector&gt;</em>
&lt;Region&gt;...&lt;/Region&gt;
<span>&lt;Metadata&gt;...&lt;/Metadata&gt; &lt;!-- deprecated in KML 2.2 --&gt;
&lt;ExtendedData&gt;...&lt;/ExtendedData&gt; &lt;!-- new in KML 2.2 --&gt;</span>
&lt;!-- inherited from <em>Overlay</em> element --&gt;
&lt;color&gt;ffffffff&lt;/color&gt; &lt;!-- kml:color --&gt;
&lt;drawOrder&gt;0&lt;/drawOrder&gt; &lt;!-- int --&gt;
&lt;Icon&gt;...&lt;/Icon&gt;
&lt;!-- specific to GroundOverlay --&gt;
&lt;altitude&gt;0&lt;/altitude&gt; &lt;!-- double --&gt;
&lt;altitudeMode&gt;clampToGround&lt;/altitudeMode&gt;
&lt;!-- kml:altitudeModeEnum: clampToGround or absolute --&gt;
&lt;!-- or, substitute gx:altitudeMode: clampToSeaFloor or relativeToSeaFloor --&gt;
&lt;LatLonBox&gt;
&lt;north&gt;...&lt;/north&gt; &lt;! kml:angle90 --&gt;
&lt;south&gt;<em>...</em>&lt;/south&gt; &lt;! kml:angle90 --&gt;
&lt;east&gt;<em>...</em>&lt;/east&gt; &lt;! kml:angle180 --&gt;
&lt;west&gt;<em>...</em>&lt;/west&gt; &lt;! kml:angle180 --&gt;
&lt;rotation&gt;0&lt;/rotation&gt; &lt;! kml:angle180 --&gt;
&lt;/LatLonBox&gt;
<strong>&lt;/GroundOverlay&gt;</strong></pre>
Extends:
@see: <Feature>
@see: <Overlay>
Contained By:
@see: <Document>
@see: <Folder>
</javaDoc>
</elements>
<elements>
<className>minaltitude</className>
<javaDoc><minaltitude>
<p>
Specified in meters (and is affected by the altitude mode specification).
</p>
</javaDoc>
</elements>
<elements>
<className>networklinkcontrol</className>
<javaDoc><NetworkLinkControl>
<p>
Controls the behavior of files fetched by a <NetworkLink>.
</p>
Syntax:
<pre><strong>&lt;NetworkLinkControl&gt;</strong>
&lt;minRefreshPeriod&gt;0&lt;/minRefreshPeriod&gt; &lt;!-- float --&gt;
<span class="style2">&lt;maxSessionLength&gt;-1&lt;/maxSessionLength&gt; &lt;!-- float --&gt; </span>
&lt;cookie&gt;<em>...</em>&lt;/cookie&gt; &lt;!-- string --&gt;
&lt;message&gt;<em>...</em>&lt;/message&gt; &lt;!-- string --&gt;
&lt;linkName&gt;<em>...</em>&lt;/linkName&gt; &lt;!-- string --&gt;
&lt;linkDescription&gt;<em>...</em>&lt;/linkDescription&gt; &lt;!-- string --&gt;
&lt;linkSnippet maxLines="2"&gt;<em>...</em>&lt;/linkSnippet&gt; &lt;!-- string --&gt;
&lt;expires&gt;...&lt;/expires&gt; &lt;!-- kml:dateTime --&gt;
&lt;Update&gt;...&lt;/Update&gt; &lt;!-- Change,Create,Delete --&gt;
<span><em>&lt;AbstractView&gt;...&lt;/AbstractView&gt;</em> &lt;!-- LookAt <em>or</em> Camera --&gt;</span>
<strong>&lt;/NetworkLinkControl&gt;</strong></pre>
See Also:
<NetworkLink>
<Update>
</javaDoc>
</elements>
<elements>
<className>iconstyle</className>
<javaDoc><IconStyle>
<p>
Specifies how icons for point Placemarks are drawn, both in the Places panel and
in the 3D viewer of Google Earth. The <Icon> element specifies the icon image. The
<scale> element specifies the x, y scaling of the icon. The color specified in the
<color> element of <IconStyle> is blended with the color of the <Icon>.
</p>
Syntax:
<pre><strong>&lt;IconStyle id="ID"&gt;</strong>
&lt;!-- inherited from <em>ColorStyle</em> --&gt;
&lt;color&gt;ffffffff&lt;/color&gt; &lt;!-- kml:color --&gt;
&lt;colorMode&gt;normal&lt;/colorMode&gt; &lt;!-- kml:colorModeEnum:normal <em>or</em> random --&gt;
&lt;!-- specific to IconStyle --&gt;
&lt;scale&gt;1&lt;/scale&gt; &lt;!-- float --&gt;
&lt;heading&gt;0&lt;/heading&gt; &lt;!-- float --&gt;
&lt;Icon&gt;
&lt;href&gt;...&lt;/href&gt;
&lt;/Icon&gt;
&lt;hotSpot x="0.5" y="0.5"
xunits="fraction" yunits="fraction"/&gt; &lt;!-- kml:vec2 --&gt;
<strong>&lt;/IconStyle&gt;</strong></pre>
Extends:
@see: <ColorStyle>
Contains:
@see: <Icon>
@see: <href>
Contained By:
@see: <Style>
</javaDoc>
</elements>
<elements>
<className>hotspot</className>
<javaDoc><hotspot x="0.5" y="0.5" xunits="fraction" yunits="fraction">
<p>
Specifies the position within the Icon that is "anchored" to the <Point> specified
in the Placemark. The x and y values can be specified in three different ways: as
pixels ("pixels"), as fractions of the icon ("fraction"), or as inset pixels ("insetPixels"),
which is an offset in pixels from the upper right corner of the icon. The x and
y positions can be specified in different ways—for example, x can be in pixels and
y can be a fraction. The origin of the coordinate system is in the lower left corner
of the icon. x - Either the number of pixels, a fractional component of the icon,
or a pixel inset indicating the x component of a point on the icon. y - Either the
number of pixels, a fractional component of the icon, or a pixel inset indicating
the y component of a point on the icon. xunits - Units in which the x value is specified.
A value of fraction indicates the x value is a fraction of the icon. A value of
pixels indicates the x value in pixels. A value of insetPixels indicates the indent
from the right edge of the icon. yunits - Units in which the y value is specified.
A value of fraction indicates the y value is a fraction of the icon. A value of
pixels indicates the y value in pixels. A value of insetPixels indicates the indent
from the top edge of the icon.
</p>
</javaDoc>
</elements>
<elements>
<className>gridorigin</className>
<javaDoc>GridOrigin
<p>
lowerLeft, upperLeft
</p>
See Also:
See <PhotoOverlay>
</javaDoc>
</elements>
<elements>
<className>rotation</className>
<javaDoc><rotation>
<p>
Adjusts how the photo is placed inside the field of view. This element is useful
if your photo has been rotated and deviates slightly from a desired horizontal view.
</p>
<p>
Indicates the angle of rotation of the parent object. A value of 0 means no rotation.
The value is an angle in degrees counterclockwise starting from north. Use ±180
to indicate the rotation of the parent object from 0. The center of the <rotation>,
if not (.5,.5), is specified in <rotationXY>.
</p>
</javaDoc>
</elements>
<elements>
<className>balloonstyle</className>
<javaDoc><BalloonStyle>
<p>
Specifies how the description balloon for placemarks is drawn. The <bgColor>, if
specified, is used as the background color of the balloon. See <Feature> for a diagram
illustrating how the default description balloon appears in Google Earth.
</p>
Syntax:
<pre><strong>&lt;BalloonStyle id="ID"&gt;</strong>
&lt;!-- specific to BalloonStyle --&gt;
&lt;bgColor&gt;ffffffff&lt;/bgColor&gt; &lt;!-- kml:color --&gt;
&lt;textColor&gt;ff000000&lt;/textColor&gt; &lt;!-- kml:color --&gt;
&lt;text&gt;<em>...</em>&lt;/text&gt; &lt;!-- string --&gt;
<span>&lt;displayMode&gt;default&lt;/displayMode&gt;<strong> </strong>&lt;!-- kml:displayModeEnum --&gt;</span><strong>
&lt;/BalloonStyle&gt;</strong></pre>
Extends:
@see: <ColorStyle>
Contained By:
@see: <Style>
</javaDoc>
</elements>
<elements>
<className>icon</className>
<javaDoc><icon> see also <icon>.
<p>
<Icon> <href>Sunset.jpg</href> </Icon>
</p>
<p>
A custom Icon. In <IconStyle>, the only child element of <Icon> is <href>: <href>:
An HTTP address or a local file specification used to load an icon.
</p>
<p>
Defines an image associated with an Icon style or overlay. <Icon> has the same child
elements as <Link>. The required <href> child element defines the location of the
image to be used as the overlay or as the icon for the placemark. This location
can either be on a local file system or a remote web server.
</p>
<p>
Defines the image associated with the Overlay. The <href> element defines the location
of the image to be used as the Overlay. This location can be either on a local file
system or on a web server. If this element is omitted or contains no <href>, a rectangle
is drawn using the color and size defined by the ground or screen overlay. <Icon>
<href>icon.jpg</href> </Icon>
</p>
Syntax:
<pre><strong>&lt;Icon id="ID"&gt;</strong>
&lt;!-- specific to Icon --&gt;
&lt;href&gt;<em>...</em>&lt;/href&gt; &lt;!-- anyURI --&gt;
&lt;refreshMode&gt;onChange&lt;/refreshMode&gt;
&lt;!-- kml:refreshModeEnum: onChange, onInterval, <em>or</em> onExpire --&gt;
&lt;refreshInterval&gt;4&lt;/refreshInterval&gt; &lt;!-- float --&gt;
&lt;viewRefreshMode&gt;never&lt;/viewRefreshMode&gt;
&lt;!-- kml:viewRefreshModeEnum: never, onStop, onRequest, onRegion --&gt;
&lt;viewRefreshTime&gt;4&lt;/viewRefreshTime&gt; &lt;!-- float --&gt;
&lt;viewBoundScale&gt;1&lt;/viewBoundScale&gt; &lt;!-- float --&gt;
&lt;viewFormat&gt;...&lt;/viewFormat&gt; &lt;!-- string --&gt;
&lt;httpQuery&gt;...&lt;/httpQuery&gt; &lt;!-- string --&gt;
<strong>&lt;/Icon&gt;</strong></pre>
Contained By:
@see: <GroundOverlay>
@see: <IconStyle>
@see: <ScreenOverlay>
</javaDoc>
</elements>
<elements>
<className>angle180</className>
<javaDoc>Angle180
<p>
a value >=-180 and <=180
</p>
See Also:
See <longitude> in <Model>
</javaDoc>
</elements>
<elements>
<className>url</className>
<javaDoc><Url>
</javaDoc>
</elements>
<elements>
<className>bgcolor</className>
<javaDoc><bgcolor>
<p>
Background color for the Snippet. Color and opacity 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: <color>7fff0000</color>, where alpha=0x7f,
blue=0xff, green=0x00, and red=0x00.
</p>
<p>
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: <bgColor>7fff0000</bgColor>,
where alpha=0x7f, blue=0xff, green=0x00, and red=0x00. The default is opaque white
(ffffffff).
</p>
<p>
Note: The use of the <color> element within <BalloonStyle> has been deprecated.
Use <bgColor> instead.
</p>
</javaDoc>
</elements>
<elements>
<className>innerboundaryis</className>
<javaDoc><innerboundaryis>
<p>
Contains a <LinearRing> element. A Polygon can contain multiple <innerBoundaryIs>
elements, which create multiple cut-outs inside the Polygon.
</p>
</javaDoc>
</elements>
<elements>
<className>point</className>
<javaDoc><Point>
<p>
A geographic location defined by longitude, latitude, and (optional) altitude. When
a Point is contained by a Placemark, the point itself determines the position of
the Placemark's name and icon. When a Point is extruded, it is connected to the
ground with a line. This "tether" uses the current LineStyle.
</p>
<p>
The <Point> element acts as a <Point> inside a <Placemark> element. It draws an
icon to mark the position of the PhotoOverlay. The icon drawn is specified by the
<styleUrl> and <StyleSelector> fields, just as it is for <Placemark>.
</p>
Syntax:
<pre><strong>&lt;Point id="ID"&gt;</strong>
&lt;!-- specific to Point --&gt;
&lt;extrude&gt;0&lt;/extrude&gt; &lt;!-- boolean --&gt;
&lt;altitudeMode&gt;clampToGround&lt;/altitudeMode&gt;
&lt;!-- kml:altitudeModeEnum: clampToGround, relativeToGround, or absolute --&gt;
&lt;!-- or, substitute gx:altitudeMode: clampToSeaFloor, relativeToSeaFloor --&gt;
&lt;coordinates&gt;<em>...</em>&lt;/coordinates&gt;<span class="style1"><em> </em></span>&lt;!-- lon,lat[,alt] --&gt;
<strong>&lt;/Point&gt;</strong></pre>
Extends:
@see: <Geometry>
Contained By:
@see: <MultiGeometry>
@see: <Placemark>
</javaDoc>
</elements>
<elements>
<className>name</className>
<javaDoc><name>
<p>
User-defined text displayed in the 3D viewer as the label for the object (for example,
for a Placemark, Folder, or NetworkLink).
</p>
</javaDoc>
</elements>
<elements>
<className>geometry</className>
<javaDoc><Geometry>
<p>
This is an abstract element and cannot be used directly in a KML file. It provides
a placeholder object for all derived Geometry objects.
</p>
Syntax:
<pre>&lt;!-- abstract element; do not create --&gt;
<strong>&lt;!<em>-- Geometry</em> id="ID" --&gt; &lt;!-- Point,LineString,LinearRing,
Polygon,MultiGeometry,Model --&gt;</strong>
<strong>&lt;!-- /<em>Geometry --</em>&gt;</strong></pre>
Extends:
@see: <Object>
Extended By:
@see: <LineString>
@see: <LinearRing>
@see: <Model>
@see: <Point>
@see: MultiGeometry
@see: Polygon
</javaDoc>
</elements>
<elements>
<className>maxlodpixels</className>
<javaDoc><maxlodpixels>
<p>
Measurement in screen pixels that represents the maximum limit of the visibility
range for a given Region. A value of −1, the default, indicates "active to infinite
size."
</p>
</javaDoc>
</elements>
<elements>
<className>value</className>
<javaDoc><value>
<p>
<Placemark> <name>Club house</name> <ExtendedData> <Data name="holeNumber"> <value>1</value>
</Data> <Data name="holeYardage"> <value>234</value> </Data> <Data name="holePar">
<value>4</value> </Data> </ExtendedData> </Placemark>
</p>
<p>
<displayName> An optional formatted version of name, to be used for display purposes.
<value> Value of the data pair. <Placemark> <name>Club house</name> <ExtendedData>
<Data name="holeNumber"> <value>1</value> </Data> <Data name="holeYardage"> <value>234</value>
</Data> <Data name="holePar"> <value>4</value> </Data> </ExtendedData> </Placemark>
</p>
<p>
Value of the data pair.
</p>
</javaDoc>
</elements>
<elements>
<className>href</className>
<javaDoc><href>
<p>
A URL (either an HTTP address or a local file specification). When the parent of
<Link> is a NetworkLink, <href> is a KML file. When the parent of <Link> is a Model,
<href> is a COLLADA file. When the parent of <Icon> (same fields as <Link>) is an
Overlay, <href> is an image. Relative URLs can be used in this tag and are evaluated
relative to the enclosing KML file.
</p>
<p>
An HTTP address or a local file specification used to load an icon.
</p>
<p>
Specifies the URI of the image used in the List View for the Feature.
</p>
</javaDoc>
</elements>
<elements>
<className>labelstyle</className>
<javaDoc><LabelStyle>
<p>
Note: The <labelColor> tag is deprecated. Use <LabelStyle> instead.
</p>
<p>
Specifies how the <name> of a Feature is drawn in the 3D viewer. A custom color,
color mode, and scale for the label (name) can be specified.
</p>
Syntax:
<pre><strong>&lt;LabelStyle id="ID"&gt;</strong>
&lt;!-- inherited from <em>ColorStyle</em> --&gt;
&lt;color&gt;ffffffff&lt;/color&gt; &lt;!-- kml:color --&gt;
&lt;colorMode&gt;normal&lt;/colorMode&gt; &lt;!-- kml:colorModeEnum: normal <em>or</em> random --&gt;
&lt;!-- specific to LabelStyle --&gt;
&lt;scale&gt;1&lt;/scale&gt; &lt;!-- float --&gt;
<strong>&lt;/LabelStyle&gt;</strong></pre>
Extends:
@see: <ColorStyle>
Contained By:
@see: <Style>
</javaDoc>
</elements>
<elements>
<className>pair</className>
<javaDoc><pair> (required)
<p>
Defines a key/value pair that maps a mode (normal or highlight) to the predefined
<styleUrl>. <Pair> contains two elements (both are required): <key>, which identifies
the key <styleUrl> or <Style>, which references the style. In <styleUrl>, for referenced
style elements that are local to the KML document, a simple # referencing is used.
For styles that are contained in external files, use a full URL along with # referencing.
For example: <Pair> <key>normal</key> <styleUrl>http://myserver.com/populationProject.xml#example_style_off</styleUrl>
</Pair>
</p>
</javaDoc>
</elements>
<elements>
<className>itemicon</className>
<javaDoc><itemicon>
<p>
<state> Specifies the current state of the NetworkLink or Folder. Possible values
are open, closed, error, fetching0, fetching1, and fetching2. These values can be
combined by inserting a space between two values (no comma). <href> Specifies the
URI of the image used in the List View for the Feature.
</p>
<p>
Icon used in the List view that reflects the state of a Folder or Link fetch. Icons
associated with the open and closed modes are used for Folders and Network Links.
Icons associated with the error and fetching0, fetching1, and fetching2 modes are
used for Network Links. The following screen capture illustrates the Google Earth
icons for these states:
</p>
</javaDoc>
</elements>
<elements>
<className>tourprimitive</className>
<javaDoc><gx:TourPrimitive>
<p>
Elements extended from gx:TourPrimitive provide instructions to KML browsers during
tours, including points to fly to and the duration of those flights, pauses, updates
to KML features, and sound files to play.
</p>
<p>
These elements must be contained within a <gx:Playlist> element, which in turn is
contained with a <gx:Tour> element.
</p>
<p>
This is an abstract element and cannot be used directly in a KML file. This element
is extended by the <gx:FlyTo>, <gx:AnimatedUpdate>, <gx:TourControl>, <gx:Wait>,
and <gx:SoundCue> elements.
</p>
Syntax:
<pre>&lt;gx:Tour&gt;
&lt;gx:Playlist&gt;
&lt;!-- abstract element; do not create --&gt;
<strong>&lt;!-- gx:TourPrimitive --&gt;</strong> &lt;!-- gx:AnimatedUpdate, gx:FlyTo, gx:TourControl, gx:SoundCue, gx:Wait --&gt;
&lt;!-- extends <strong>Object</strong> --&gt;
<strong>&lt;!-- /gx:TourPrimitive --&gt;</strong>
&lt;/gx:Playlist&gt;
&lt;/gx:Tour&gt;
</pre>
Extends:
@see: <Object>
Extended By:
@see: <gx:AnimatedUpdate>
@see: <gx:FlyTo>
@see: <gx:SoundCue>
@see: <gx:TourControl>
@see: <gx:Wait>
Contained By:
@see: <gx:Playlist>
</javaDoc>
</elements>
<elements>
<className>delete</className>
<javaDoc><delete>
<p>
Child elements for <Delete>, which are the only elements that can be deleted, are
Document, Folder, GroundOverlay, Placemark, and ScreenOverlay.
</p>
<p>
Deletes features from a complex element that has already been loaded via a <NetworkLink>.
The <targetHref> element in <Update> specifies the .kml or .kmz file containing
the data to be deleted. Within that file, the element to be deleted must already
have an explicit id defined for it. The <Delete> element references this id in the
targetId attribute.
</p>
</javaDoc>
</elements>
<elements>
<className>link</className>
<javaDoc><link> (required). see <link>.
<p>
<Link> specifies the location of any of the following:
</p>
<p>
If the file specified in <href> is a local file, the <viewFormat> and <httpQuery>
elements are not used.
</p>
<p>
KML files fetched by network links Image files used in any Overlay (the <Icon> element
specifies the image in an Overlay; <Icon> has the same fields as <Link>) Model files
used in the <Model> element
</p>
<p>
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 that follows).
</p>
<p>
Specifies the file to load and optional refresh parameters. See <Link>.
</p>
<p>
The <Link> element replaces the <Url> element of <NetworkLink> contained in earlier
KML releases and adds functionality for the <Region> element (introduced in KML
2.1). In Google Earth releases 3.0 and earlier, the <Link> element is ignored.
</p>
<p>
The file is conditionally loaded and refreshed, depending on the refresh parameters
supplied here. Two different sets of refresh parameters can be specified: one set
is based on time (<refreshMode> and <refreshInterval>) and one is based on the current
"camera" view (<viewRefreshMode> and <viewRefreshTime>). In addition, Link specifies
whether to scale the bounding box parameters that are sent to the server (<viewBoundScale>
and provides a set of optional viewing parameters that can be sent to the server
(<viewFormat>) as well as a set of optional parameters containing version and language
information.
</p>
<p>
Tip: To display the top-level Folder or Document within a Network Link in the List
View, assign an ID to the Folder or Document. Without this ID, only the child object
names are displayed in the List View.
</p>
<p>
When a file is fetched, the URL that is sent to the server is composed of three
pieces of information:
</p>
<p>
the href (Hypertext Reference) that specifies the file to load. an arbitrary format
string that is created from (a) parameters that you specify in the <viewFormat>
element or (b) bounding box parameters (this is the default and is used if no <viewFormat>
element is included in the file). a second format string that is specified in the
<httpQuery> element.
</p>
Syntax:
<pre><strong>&lt;Link id="ID"&gt;</strong>
&lt;!-- specific to Link --&gt;
&lt;href&gt;<em>...</em>&lt;/href&gt; &lt;!-- <span>string</span> --&gt;
&lt;refreshMode&gt;onChange&lt;/refreshMode&gt;
&lt;!-- refreshModeEnum: onChange, onInterval, <em>or</em> onExpire --&gt;
&lt;refreshInterval&gt;4&lt;/refreshInterval&gt; &lt;!-- float --&gt;
&lt;viewRefreshMode&gt;never&lt;/viewRefreshMode&gt;
&lt;!-- viewRefreshModeEnum: never, onStop, onRequest, onRegion --&gt;
&lt;viewRefreshTime&gt;4&lt;/viewRefreshTime&gt; &lt;!-- float --&gt;
&lt;viewBoundScale&gt;1&lt;/viewBoundScale&gt; &lt;!-- float --&gt;
&lt;viewFormat&gt;BBOX=[bboxWest],[bboxSouth],[bboxEast],[bboxNorth]&lt;<strong>/</strong>viewFormat&gt;
&lt;!-- string --&gt;
&lt;httpQuery&gt;...&lt;/httpQuery&gt; &lt;!-- string --&gt;
<strong>&lt;/Link&gt;</strong></pre>
Extends:
@see: <Object>
Contained By:
@see: <Model>
@see: <NetworkLink>
See Also:
<NetworkLinkControl>
<Region>
</javaDoc>
</elements>
<elements>
<className>near</className>
<javaDoc><near>
<p>
<leftFov> Angle, in degrees, between the camera's viewing direction and the left
side of the view volume. <rightFov> Angle, in degrees, between the camera's viewing
direction and the right side of the view volume. <bottomFov> Angle, in degrees,
between the camera's viewing direction and the bottom side of the view volume. <topFov>
Angle, in degrees, between the camera's viewing direction and the top side of the
view volume. <near> Measurement in meters along the viewing direction from the camera
viewpoint to the PhotoOverlay shape.
</p>
<p>
Measurement in meters along the viewing direction from the camera viewpoint to the
PhotoOverlay shape.
</p>
<p>
The field of view for a PhotoOverlay is defined by four planes, each of which is
specified by an angle relative to the view vector. These four planes define the
top, bottom, left, and right sides of the field of view, which has the shape of
a truncated pyramid, as shown here:
</p>
<p>
The following diagrams show the four field-of-view angles within this pyramid:
</p>
<p>
The following diagrams show the four field-of-view angles within this pyramid:
</p>
</javaDoc>
</elements>
<elements>
<className>change</className>
<javaDoc><change>
<p>
Children of this element are the element(s) to be modified, which are identified
by the targetId attribute.
</p>
<p>
Modifies the values in an element that has already been loaded with a <NetworkLink>.
Within the Change element, the child to be modified must include a targetId attribute
that references the original element's id.
</p>
<p>
This update can be considered a "sparse update": in the modified element, only the
values listed in <Change> are replaced; all other values remained untouched. When
<Change> is applied to a set of coordinates, the new coordinates replace the current
coordinates.
</p>
</javaDoc>
</elements>
<elements>
<className>animatedupdate</className>
<javaDoc><gx:AnimatedUpdate>
<p>
<gx:AnimatedUpdate> controls changes during a tour to KML features, using <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.
</p>
<p>
<gx:AnimatedUpdate> should also contain a <gx:duration> 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.
</p>
<p>
Refer to Tour timelines in the Touring chapter of the KML Developer's Guide for
information about <gx:AnimatedUpdate> and the tour timeline.
</p>
Syntax:
<pre>&lt;gx:AnimatedUpdate&gt;
&lt;gx:duration&gt;0.0&lt;/gx:duration&gt; &lt;!-- double, specifies time in seconds --&gt;
&lt;Update&gt;
&lt;targetHref&gt;...&lt;/targetHref&gt; &lt;!-- required; can contain a URL or be left blank --&gt;
&lt;!-- (to target elements within the same file --&gt;
&lt;Change&gt;...&lt;/Change&gt;
&lt;Create&gt;...&lt;/Create&gt;
&lt;Delete&gt;...&lt;/Delete&gt;
&lt;/Update&gt;
&lt;/gx:AnimatedUpdate&gt;</pre>
Extends:
@see: <gx:TourPrimitive>
Contains:
@see: <Update>
@see: <gx:duration>
</javaDoc>
</elements>
<elements>
<className>colorstyle</className>
<javaDoc><ColorStyle>
<p>
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.
</p>
Syntax:
<pre>&lt;!-- abstract element; do not create --&gt;
<strong>&lt;!<em>-- ColorStyle</em> id="ID" --&gt;</strong> &lt;!-- IconStyle,LabelStyle,LineStyle,PolyStyle --&gt;
&lt;color&gt;ffffffff&lt;/color&gt; &lt;!-- kml:color --&gt;
&lt;colorMode&gt;normal&lt;/colorMode&gt; &lt;!-- kml:colorModeEnum: normal <em>or</em> random --&gt;
<strong>&lt;!-- /<em>ColorStyle</em> --&gt;</strong></pre>
Extends:
@see: <Object>
Extended By:
@see: <IconStyle>
@see: <LabelStyle>
@see: <LineStyle>
@see: PolyStyle
</javaDoc>
</elements>
<elements>
<className>kml</className>
<javaDoc><kml>
<p>
<kml xmlns="http://www.opengis.net/kml/2.2"> <NetworkLinkControl> ... </NetworkLinkControl>
<!-- 0 or 1 Feature elements --> </kml>
</p>
<p>
A basic <kml> element contains 0 or 1 Feature and 0 or 1 NetworkLinkControl:
</p>
<p>
The <kml> element may also include the namespace for any external XML schemas that
are referenced within the file.
</p>
<p>
The root element of a KML file. This element is required. It follows the xml declaration
at the beginning of the file. The hint attribute is used as a signal to Google Earth
to display the file as celestial data.
</p>
Syntax:
<pre>&lt;kml xmlns="http://www.opengis.net/kml/2.2" <span>hint="target=sky"</span>&gt; ... &lt;/kml&gt;</pre>
</javaDoc>
</elements>
<elements>
<className>data</className>
<javaDoc><data name ="string">
<p>
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 <text> element of <BalloonStyle>, the notation
$[name:displayName] is replaced with <displayName>. If you substitute the value
of the name attribute of the <Data> element in this format (for example, $[holeYardage],
the attribute value is replaced with <value>. By default, the Placemark's balloon
displays the name/value pairs associated with it.
</p>
</javaDoc>
</elements>
<elements>
<className>linestyle</className>
<javaDoc><LineStyle>
<p>
Specifies the drawing style (color, color mode, and line width) for all line geometry.
Line geometry includes the outlines of outlined polygons and the extruded "tether"
of Placemark icons (if extrusion is enabled).
</p>
Syntax:
<pre><strong>&lt;LineStyle id="ID"&gt;</strong>
&lt;!-- inherited from <em>ColorStyle</em> --&gt;
&lt;color&gt;ffffffff&lt;/color&gt; &lt;!-- kml:color --&gt;
&lt;colorMode&gt;normal&lt;/colorMode&gt; &lt;!-- colorModeEnum: normal <em>or</em> random --&gt;
&lt;!-- specific to LineStyle --&gt;
&lt;width&gt;1&lt;/width&gt; &lt;!-- float --&gt;
<strong>&lt;/LineStyle&gt;</strong></pre>
Extends:
@see: <ColorStyle>
Contained By:
@see: <Style>
</javaDoc>
</elements>
<elements>
<className>networklink</className>
<javaDoc><NetworkLink>
<p>
References a KML file or KMZ archive on a local or remote network. Use the <Link>
element to specify the location of the KML file. Within that element, you can define
the refresh options for updating the file, based on time and camera change. NetworkLinks
can be used in combination with Regions to handle very large datasets efficiently.
</p>
Syntax:
<pre><strong>&lt;NetworkLink id="ID"&gt;</strong>
&lt;!-- inherited from <em>Feature</em> element --&gt;&lt;name&gt;<em>...</em>&lt;/name&gt; &lt;!-- string --&gt;
&lt;visibility&gt;1&lt;/visibility&gt; &lt;!-- boolean --&gt;
&lt;open&gt;0&lt;/open&gt; &lt;!-- boolean --&gt;
<span>&lt;atom:author&gt;...&lt;atom:author&gt; &lt;!-- xmlns:atom --&gt;
&lt;atom:link&gt;...&lt;/atom:link&gt;</span><span> &lt;!-- xmlns:atom --&gt;</span>
&lt;address&gt;<em>...</em>&lt;/address&gt; &lt;!-- string --&gt;
&lt;xal:AddressDetails&gt;...&lt;/xal:AddressDetails&gt; &lt;!-- xmlns:xal --&gt;<br> &lt;phoneNumber&gt;...&lt;/phoneNumber&gt; &lt;!-- string --&gt;<br> &lt;Snippet maxLines="2"&gt;<em>...</em>&lt;/Snippet&gt; &lt;!-- string --&gt;
&lt;description&gt;<em>...</em>&lt;/description&gt; &lt;!-- string --&gt;
<span><em>&lt;AbstractView&gt;...&lt;/AbstractView&gt;</em> &lt;!-- Camera <em>or</em> LookAt --&gt;</span>
&lt;<em>TimePrimitive</em>&gt;...&lt;/<em>TimePrimitive</em>&gt;
&lt;styleUrl&gt;<em>...</em>&lt;/styleUrl&gt; &lt;!-- anyURI --&gt;
&lt;<em>StyleSelector&gt;...&lt;/StyleSelector&gt;</em>
&lt;Region&gt;...&lt;/Region&gt;
<span>&lt;Metadata&gt;...&lt;/Metadata&gt; &lt;!-- deprecated in KML 2.2 --&gt;
&lt;ExtendedData&gt;...&lt;/ExtendedData&gt; &lt;!-- new in KML 2.2 --&gt;</span>
&lt;!-- specific to NetworkLink --&gt;
&lt;refreshVisibility&gt;0&lt;/refreshVisibility&gt; &lt;!-- boolean --&gt;
&lt;flyToView&gt;0&lt;/flyToView&gt; &lt;!-- boolean --&gt;
&lt;Link&gt;...&lt;/Link&gt;
<strong>&lt;/NetworkLink&gt;</strong></pre>
Extends:
@see: <Feature>
Contained By:
@see: <Container>
</javaDoc>
</elements>
<elements>
<className>model</className>
<javaDoc><Model>
<p>
A 3D object described in a COLLADA file (referenced in the <Link> tag). COLLADA
files have a .dae file extension. Models are created in their own coordinate space
and then located, positioned, and scaled in Google Earth. See the "Topics in KML"
page on Regions for more detail.
</p>
<p>
Google Earth supports only triangles and lines as primitive types. The maximum number
of triangles allowed is 21845. Google Earth does not support animation or skinning.
Google Earth does not support external geometry references.
</p>
<p>
Google Earth supports the COLLADA common profile, with the following exceptions:
</p>
Syntax:
<pre><strong>&lt;Model id="ID"&gt;</strong>
&lt;!-- specific to Model --&gt;
&lt;altitudeMode&gt;clampToGround&lt;/altitudeMode&gt;
&lt;!-- kml:altitudeModeEnum: clampToGround,relativeToGround,<em>or</em> absolute --&gt;
&lt;!-- or, substitute gx:altitudeMode: clampToSeaFloor, relativeToSeaFloor --&gt;
&lt;Location&gt;
&lt;longitude&gt;&lt;/longitude&gt; &lt;!-- kml:angle180 --&gt;
&lt;latitude&gt;&lt;/latitude&gt; &lt;!-- kml:angle90 --&gt;
&lt;altitude&gt;0&lt;/altitude&gt; &lt;!-- double --&gt;
&lt;/Location&gt;
&lt;Orientation&gt;
&lt;heading&gt;0&lt;/heading&gt; &lt;!-- kml:angle360 --&gt;
&lt;tilt&gt;0&lt;/tilt&gt; &lt;!-- kml:angle360 --&gt;
&lt;roll&gt;0&lt;/roll&gt; &lt;!-- kml:angle360 --&gt;
&lt;/Orientation&gt;
&lt;Scale&gt;
&lt;x&gt;1&lt;/x&gt; &lt;!-- double --&gt;
&lt;y&gt;1&lt;/y&gt; &lt;!-- double --&gt;
&lt;z&gt;1&lt;/z&gt; &lt;!-- double --&gt;
&lt;/Scale&gt;
&lt;Link&gt;...&lt;/Link&gt;
<span>&lt;ResourceMap&gt;
&lt;Alias&gt;
&lt;targetHref&gt;...&lt;/targetHref&gt; &lt;!-- anyURI --&gt;
&lt;sourceHref&gt;...&lt;/sourceHref&gt; &lt;!-- anyURI --&gt;
&lt;/Alias&gt;
&lt;/ResourceMap&gt;</span>
<strong>&lt;/Model&gt;</strong></pre>
Extends:
@see: <Geometry>
Contained By:
@see: <MultiGeometry>
@see: <Placemark>
</javaDoc>
</elements>
<elements>
<className>overlayxy</className>
<javaDoc><overlayxy>
<p>
Specifies a point on (or outside of) the overlay image that is mapped to the screen
coordinate (<screenXY>). It requires x and y values, and the units for those values.
</p>
<p>
The x and y values can be specified in three different ways: as pixels ("pixels"),
as fractions of the image ("fraction"), or as inset pixels ("insetPixels"), which
is an offset in pixels from the upper right corner of the image. The x and y positions
can be specified in different ways—for example, x can be in pixels and y can be
a fraction. The origin of the coordinate system is in the lower left corner of the
image. x - Either the number of pixels, a fractional component of the image, or
a pixel inset indicating the x component of a point on the overlay image. y - Either
the number of pixels, a fractional component of the image, or a pixel inset indicating
the y component of a point on the overlay image. xunits - Units in which the x value
is specified. A value of "fraction" indicates the x value is a fraction of the image.
A value of "pixels" indicates the x value in pixels. A value of "insetPixels" indicates
the indent from the right edge of the image. yunits - Units in which the y value
is specified. A value of "fraction" indicates the y value is a fraction of the image.
A value of "pixels" indicates the y value in pixels. A value of "insetPixels" indicates
the indent from the top edge of the image.
</p>
</javaDoc>
</elements>
<elements>
<className>visibility</className>
<javaDoc><visibility>
<p>
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 <visibility> 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.
</p>
</javaDoc>
</elements>
<elements>
<className>resourcemap</className>
<javaDoc><resourcemap>
</javaDoc>
</elements>
<elements>
<className>minfadeextent</className>
<javaDoc><minfadeextent>
<p>
Distance over which the geometry fades, from fully opaque to fully transparent.
This ramp value, expressed in screen pixels, is applied at the minimum end of the
LOD (visibility) limits.
</p>
</javaDoc>
</elements>
<elements>
<className>width</className>
<javaDoc><width>
<p>
Width of the line, in pixels.
</p>
</javaDoc>
</elements>
<elements>
<className>addressdetails</className>
<javaDoc><xal:addressdetails>
<p>
A structured address, formatted as xAL, or eXtensible Address Language, an international
standard for address formatting. <xal:AddressDetails> is used by KML for geocoding
in Google Maps only. For details, see the Google Maps API documentation. Currently,
Google Earth does not use this element; use <address> 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"
</p>
<p>
A structured address, formatted as xAL, or eXtensible Address Language, an international
standard for address formatting. <xal:AddressDetails> is used by KML for geocoding
in Google Maps only. For details, see the Google Maps API documentation. Currently,
Google Earth does not use this element; use <address> 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"
</p>
</javaDoc>
</elements>
<elements>
<className>httpquery</className>
<javaDoc><httpquery>
<p>
Appends information to the query string, based on the parameters specified. (Google
Earth substitutes the appropriate current value at the time it creates the query
string.) The following parameters are supported: [clientVersion] [kmlVersion] [clientName]
[language]
</p>
</javaDoc>
</elements>
<elements>
<className>timespan</className>
<javaDoc><gx:TimeSpan> and <gx:TimeStamp>
<p>
If <begin> or <end> is missing, then that end of the period is unbounded (see Example
below).
</p>
<p>
Represents an extent in time bounded by begin and end dateTimes.
</p>
<p>
The dateTime is defined according to XML Schema time (see XML Schema Part 2: Datatypes
Second Edition). The value can be expressed as yyyy-mm-ddThh:mm:sszzzzzz, where
T is the separator between the date and the time, and the time zone is either Z
(for UTC) or zzzzzz, which represents ±hh:mm in relation to UTC. Additionally, the
value can be expressed as a date only. See <TimeStamp> for examples.
</p>
Syntax:
<pre><strong>&lt;TimeSpan id="ID"&gt;</strong>
&lt;begin&gt;<em>...</em>&lt;/begin&gt; &lt;!-- kml:dateTime --&gt;
&lt;end&gt;<em>...</em>&lt;/end&gt; &lt;!-- kml:dateTime --&gt;
<strong>&lt;/TimeSpan&gt;</strong></pre>
Extends:
@see: <TimePrimitive>
Contained By:
@see: <Feature>
</javaDoc>
</elements>
<elements>
<className>units</className>
<javaDoc>Units
<p>
fraction, pixels, insetPixels
</p>
See Also:
See <hotSpot> in <IconStyle>, <ScreenOverlay>
</javaDoc>
</elements>
<elements>
<className>roll</className>
<javaDoc><roll>
<p>
<heading> Rotation about the z axis (normal to the Earth's surface). A value of
0 (the default) equals North. A positive rotation is clockwise around the z axis
and specified in degrees from 0 to 360. <tilt> Rotation about the x axis. A positive
rotation is clockwise around the x axis and specified in degrees from 0 to 360.
<roll> Rotation about the y axis. A positive rotation is clockwise around the y
axis and specified in degrees from 0 to 360. This diagram illustrates the typical
orientation of a model's axes:
</p>
<p>
Rotation about the y axis. A positive rotation is clockwise around the y axis and
specified in degrees from 0 to 360.
</p>
<p>
Rotation, in degrees, of the camera around the Z axis. Values range from −180 to
+180 degrees.
</p>
<p>
This diagram illustrates the typical orientation of a model's axes:
</p>
</javaDoc>
</elements>
<elements>
<className>linestring</className>
<javaDoc><LineString>
<p>
Defines a connected set of line segments. Use <LineStyle> to specify the color,
color mode, and width of the line. When a LineString is extruded, the line is extended
to the ground, forming a polygon that looks somewhat like a wall or fence. For extruded
LineStrings, the line itself uses the current LineStyle, and the extrusion uses
the current PolyStyle. See the KML Tutorial for examples of LineStrings (or paths).
</p>
Syntax:
<pre><strong>&lt;LineString id="ID"&gt;</strong>
&lt;!-- specific to LineString --&gt;
&lt;extrude&gt;0&lt;/extrude&gt; &lt;!-- boolean --&gt;
&lt;tessellate&gt;0&lt;/tessellate&gt; &lt;!-- boolean --&gt;
&lt;altitudeMode&gt;clampToGround&lt;/altitudeMode&gt;
&lt;!-- kml:altitudeModeEnum: clampToGround, relativeToGround, or absolute --&gt;
&lt;!-- or, substitute gx:altitudeMode: clampToSeaFloor, relativeToSeaFloor --&gt;
&lt;!-- or, substitute gx:altitudeMode: clampToSeaFloor, relativeToSeaFloor --&gt;
&lt;coordinates&gt;<em>...</em>&lt;/coordinates&gt; &lt;!<em>-- </em>lon,lat[,alt] --&gt;
<strong>&lt;/LineString&gt;</strong></pre>
Extends:
@see: <Geometry>
Contained By:
@see: <MultiGeometry>
@see: <Placemark>
</javaDoc>
</elements>
<elements>
<className>north</className>
<javaDoc><north> (required)
<p>
Specifies the latitude of the north edge of the bounding box, in decimal degrees
from 0 to ±90.
</p>
</javaDoc>
</elements>
<elements>
<className>topfov</className>
<javaDoc><topfov>
<p>
Angle, in degrees, between the camera's viewing direction and the top side of the
view volume.
</p>
</javaDoc>
</elements>
<elements>
<className>container</className>
<javaDoc><Container>
<p>
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.
</p>
Syntax:
<pre>&lt;!-- abstract element; do not create --&gt;
<strong>&lt;!-- <em>Container</em> id="ID" --&gt;</strong> &lt;!-- Document,Folder --&gt;
&lt;!-- inherited from <em>Feature</em> element --&gt;
&lt;name&gt;<em>...</em>&lt;/name&gt; &lt;!-- string --&gt;
&lt;visibility&gt;1&lt;/visibility&gt; &lt;!-- boolean --&gt;
&lt;open&gt;0&lt;/open&gt; &lt;!-- boolean --&gt;
&lt;address&gt;<em>...</em>&lt;/address&gt; &lt;!-- string --&gt;
&lt;AddressDetails xmlns="urn:oasis:names:tc:ciq:xsdschema:xAL:2.0"&gt;...<br> &lt;/AddressDetails&gt; &lt;!-- string --&gt;
&lt;phoneNumber&gt;...&lt;/phoneNumber&gt; &lt;!-- string --&gt;<br> &lt;Snippet maxLines="2"&gt;<em>...</em>&lt;/Snippet&gt; &lt;!-- string --&gt;
&lt;description&gt;<em>...</em>&lt;/description&gt; &lt;!-- string --&gt;
<span><em>&lt;AbstractView&gt;...&lt;/AbstractView&gt;</em> &lt;!-- LookAt <em>or</em> Camera --&gt;</span>
&lt;<em>TimePrimitive</em>&gt;...&lt;/<em>TimePrimitive</em>&gt;
&lt;styleUrl&gt;<em>...</em>&lt;/styleUrl&gt; &lt;!-- anyURI --&gt;
&lt;<em>StyleSelector&gt;...&lt;/StyleSelector&gt;</em>
&lt;Region&gt;...&lt;/Region&gt;
&lt;Metadata&gt;...&lt;/Metadata&gt;
<span>&lt;atom:author&gt;...&lt;atom:author&gt; &lt;!-- xmlns:atom="http://www.w3.org/2005/Atom" --&gt;
&lt;atom:link&gt;...&lt;/atom:link&gt;</span>
&lt;!-- specific to <em>Container</em> --&gt; <br> &lt;!-- 0 or more Features --&gt;
<strong>&lt;!-- /<em>Container --</em>&gt;</strong></pre>
Extends:
@see: <Feature>
Extended By:
@see: <Document>
@see: <Folder>
</javaDoc>
</elements>
<elements>
<className>flyto</className>
<javaDoc><gx:FlyTo>
<p>
<gx:FlyTo> specifies a point in space to which the browser will fly during a tour.
It must contain one AbstractView, and should contain <gx:duration> and <gx:flyToMode>
elements, which specify the time it takes to fly to the defined point from the current
point, and the method of flight, respectively.
</p>
Syntax:
<pre>&lt;gx:FlyTo&gt;
&lt;gx:duration&gt;0.0&lt;/gx:duration&gt; &lt;!-- double --&gt;
&lt;gx:flyToMode&gt;bounce&lt;/gx:duration&gt; &lt;!-- <em>smooth</em> or <em>bounce</em> --&gt;
&lt;!-- AbstractView --&gt; &lt;!-- <em>Camera</em> or <em>LookAt</em> --&gt;
...
&lt;!-- /AbstractView --&gt;
&lt;/gx:FlyTo&gt;</pre>
Extends:
@see: <gx:TourPrimitive>
Contains:
@see: <AbstractView>
@see: <gx:duration>
@see: <gx:flyToMode>
</javaDoc>
</elements>
<elements>
<className>rightfov</className>
<javaDoc><rightfov>
<p>
Angle, in degrees, between the camera's viewing direction and the right side of
the view volume.
</p>
</javaDoc>
</elements>
<elements>
<className>style</className>
<javaDoc><Style>
<p>
A Style defines an addressable style group that can be referenced by StyleMaps and
Features. Styles affect how Geometry is presented in the 3D viewer and how Features
appear in the Places panel of the List view. Shared styles are collected in a <Document>
and must have an id defined for them so that they can be referenced by the individual
Features that use them.
</p>
<p>
A Style defines an addressable style group that can be referenced by StyleMaps and
Features. Styles affect how Geometry is presented in the 3D viewer and how Features
appear in the Places panel of the List view. Shared styles are collected in a <Document>
and must have an id defined for them so that they can be referenced by the individual
Features that use them.
</p>
<p>
Use an id to refer to the style from a <styleUrl>.
</p>
Syntax:
<pre><strong>&lt;Style id="ID"&gt;
</strong>&lt;!-- extends StyleSelector --&gt;
&lt;!-- specific to Style --&gt;
&lt;IconStyle&gt;...&lt;/IconStyle&gt;
&lt;LabelStyle&gt;...&lt;/LabelStyle&gt;
&lt;LineStyle&gt;...&lt;/LineStyle&gt;
&lt;PolyStyle&gt;...&lt;/PolyStyle&gt;
&lt;BalloonStyle&gt;...&lt;/BalloonStyle&gt;
&lt;ListStyle&gt;<strong>...</strong>&lt;/ListStyle&gt;<strong>
&lt;/Style&gt;</strong></pre>
Extends:
@see: <StyleSelector>
Contained By:
@see: <Feature>
</javaDoc>
</elements>
<elements>
<className>size</className>
<javaDoc><size>
<p>
For example:
</p>
<p>
Specifies the size of the image for the screen overlay, as follows: A value of −1
indicates to use the native dimension A value of 0 indicates to maintain the aspect
ratio A value of n sets the value of the dimension
</p>
<p>
To force the image to resize to 100px by 500px:
</p>
<p>
To force the image to retain its horizontal dimension, but to take up 20 percent
of the vertical screen space:
</p>
<p>
To force the image to retain its original x and y dimensions, set the values to
−1:
</p>
<p>
To force the image to retain its original x and y dimensions, set the values to
−1: <size x="-1" y="-1" xunits="fraction" yunits="fraction"/> To force the image
to retain its horizontal dimension, but to take up 20 percent of the vertical screen
space: <size x="-1" y="0.2" xunits="fraction" yunits="fraction"/> To force the image
to resize to 100px by 500px: <size x="100" y="500" xunits="pixels" yunits="pixels"/>
</p>
</javaDoc>
</elements>
<elements>
<className>timestamp</className>
<javaDoc><TimeStamp>
<p>
Represents a single moment in time. This is a simple element and contains no children.
Its value is a dateTime, specified in XML time (see XML Schema Part 2: Datatypes
Second Edition). The precision of the TimeStamp is dictated by the dateTime value
in the <when> element.
</p>
Syntax:
<pre><strong>&lt;TimeStamp id=ID&gt;</strong>
&lt;when&gt;...&lt;/when&gt; &lt;!-- kml:dateTime --&gt;
<strong>&lt;/TimeStamp&gt;</strong> </pre>
Extends:
@see: <TimePrimitive>
Contained By:
@see: <Feature>
@see: A copy of the <TimeSpan> and <TimeStamp> elements, in the extension namespace. This allows for the inclusion of time values in AbstractViews (<Camera> and <LookAt>). Time values are used to control historical imagery, sunlight, and visibility of time-stamped Features.
</javaDoc>
</elements>
<elements>
<className>feature</className>
<javaDoc><Feature>
<p>
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.
</p>
Syntax:
<pre>&lt;!-- abstract element; do not create --&gt;
<strong>&lt;!--<em> Feature</em> id="ID" --&gt;</strong> &lt;!-- Document,Folder,
NetworkLink,Placemark,
GroundOverlay,PhotoOverlay,ScreenOverlay --&gt;
&lt;name&gt;<em>...</em>&lt;/name&gt; &lt;!-- string --&gt;
&lt;visibility&gt;1&lt;/visibility&gt; &lt;!-- boolean --&gt;
&lt;open&gt;0&lt;/open&gt; &lt;!-- boolean --&gt;
<span>&lt;atom:author&gt;...&lt;atom:author&gt; &lt;!-- xmlns:atom --&gt;
&lt;atom:link&gt;...&lt;/atom:link&gt;</span><span> &lt;!-- xmlns:atom --&gt;</span>
&lt;address&gt;<em>...</em>&lt;/address&gt; &lt;!-- string --&gt;
&lt;xal:AddressDetails&gt;...&lt;/xal:AddressDetails&gt; &lt;!-- xmlns:xal --&gt;<br> &lt;phoneNumber&gt;...&lt;/phoneNumber&gt; &lt;!-- string --&gt;<br> &lt;Snippet maxLines="2"&gt;<em>...</em>&lt;/Snippet&gt; &lt;!-- string --&gt;
&lt;description&gt;<em>...</em>&lt;/description&gt; &lt;!-- string --&gt;
<span><em>&lt;AbstractView&gt;...&lt;/AbstractView&gt;</em> &lt;!-- Camera <em>or</em> LookAt --&gt;</span>
&lt;<em>TimePrimitive</em>&gt;...&lt;/<em>TimePrimitive</em>&gt; &lt;!-- TimeStamp or TimeSpan --&gt;
&lt;styleUrl&gt;<em>...</em>&lt;/styleUrl&gt; &lt;!-- anyURI --&gt;
&lt;<em>StyleSelector&gt;...&lt;/StyleSelector&gt;</em>
&lt;Region&gt;...&lt;/Region&gt;
<span>&lt;Metadata&gt;...&lt;/Metadata&gt; &lt;!-- deprecated in KML 2.2 --&gt;
&lt;ExtendedData&gt;...&lt;/ExtendedData&gt; &lt;!-- new in KML 2.2 --&gt;<br></span>&lt;-- /<em>Feature</em> --&gt;</pre>
Extends:
@see: <Object>
Extended By:
@see: <Container>
@see: <NetworkLink>
@see: <Overlay>
@see: <Placemark>
@see: <gx:Tour>
</javaDoc>
</elements>
<elements>
<className>refreshinterval</className>
<javaDoc><refreshinterval>
<p>
Indicates to refresh the file every n seconds.
</p>
</javaDoc>
</elements>
<elements>
<className>viewvolume</className>
<javaDoc><viewvolume>
<p>
Defines how much of the current scene is visible. Specifying the field of view is
analogous to specifying the lens opening in a physical camera. A small field of
view, like a telephoto lens, focuses on a small part of the scene. A large field
of view, like a wide-angle lens, focuses on a large part of the scene.
</p>
</javaDoc>
</elements>
<elements>
<className>extrude</className>
<javaDoc><extrude>
<p>
Boolean value. Specifies whether to connect the LineString to the ground. To extrude
a LineString, the altitude mode must be either relativeToGround, relativeToSeaFloor,
or absolute. The vertices in the LineString are extruded toward the center of the
Earth's sphere.
</p>
<p>
Boolean value. Specifies whether to connect the LinearRing to the ground. To extrude
this geometry, the altitude mode must be either relativeToGround, relativeToSeaFloor,
or absolute. Only the vertices of the LinearRing are extruded, not the center of
the geometry. The vertices are extruded toward the center of the Earth's sphere.
</p>
<p>
Boolean value. Specifies whether to connect the Polygon to the ground. To extrude
a Polygon, the altitude mode must be either relativeToGround, relativeToSeaFloor,
or absolute. Only the vertices are extruded, not the geometry itself (for example,
a rectangle turns into a box with five faces. The vertices of the Polygon are extruded
toward the center of the Earth's sphere.
</p>
<p>
Boolean value. Specifies whether to connect the point to the ground with a line.
To extrude a Point, the value for <altitudeMode> must be either relativeToGround,
relativeToSeaFloor, or absolute. The point is extruded toward the center of the
Earth's sphere.
</p>
</javaDoc>
</elements>
<elements>
<className>east</className>
<javaDoc><east> (required)
</javaDoc>
</elements>
<elements>
<className>schemadata</className>
<javaDoc><schemadata schemaurl="anyuri">
<p>
The <schemaURL> 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:
</p>
<p>
The Schema element is always a child of Document. The ExtendedData element is a
child of the Feature that contains the custom data.
</p>
<p>
This element is used in conjunction with <Schema> 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.
</p>
</javaDoc>
</elements>
<elements>
<className>orientation</className>
<javaDoc><orientation>
<p>
Describes rotation of a 3D model's coordinate system to position the object in Google
Earth. See diagram below. <Orientation> <heading>45.0</heading> <tilt>10.0</tilt>
<roll>0.0</roll> </Orientation>
</p>
</javaDoc>
</elements>
<elements>
<className>cookie</className>
<javaDoc><cookie>
<p>
Use this element to append a string to the URL query on the next refresh of the
network link. You can use this data in your script to provide more intelligent handling
on the server side, including version querying and conditional file delivery.
</p>
</javaDoc>
</elements>
<elements>
<className>range</className>
<javaDoc><range> (required)
<p>
Distance in meters from the point specified by <longitude>, <latitude>, and <altitude>
to the LookAt position. (See diagram below.)
</p>
</javaDoc>
</elements>
<elements>
<className>simpledata</className>
<javaDoc><simpledata name="string">
<p>
<SimpleData name="string"> 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 <Schema> element. Here is an example of defining two custom data
elements: <Placemark> <name>Easy trail</name> <ExtendedData> <SchemaData schemaUrl="#TrailHeadTypeId">
<SimpleData name="TrailHeadName">Pi in the sky</SimpleData> <SimpleData name="TrailLength">3.14159</SimpleData>
<SimpleData name="ElevationGain">10</SimpleData> </SchemaData> </ExtendedData> <Point>
<coordinates>-122.000,37.002</coordinates> </Point> </Placemark> <Placemark> <name>Difficult
trail</name> <ExtendedData> <SchemaData schemaUrl="#TrailHeadTypeId"> <SimpleData
name="TrailHeadName">Mount Everest</SimpleData> <SimpleData name="TrailLength">347.45</SimpleData>
<SimpleData name="ElevationGain">10000</SimpleData> </SchemaData> </ExtendedData>
<Point> <coordinates>-122.000,37.002</coordinates> </Point> </Placemark>
</p>
<p>
Here is an example of defining two custom data elements:
</p>
<p>
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 <Schema> element.
</p>
</javaDoc>
</elements>
<elements>
<className>maxwidth</className>
<javaDoc><maxwidth>
<p>
Width in pixels of the original image.
</p>
</javaDoc>
</elements>
<elements>
<className>text</className>
<javaDoc><text>
<p>
For example, in the following KML excerpt, $[name] and $[description] fields will
be replaced by the <name> and <description> fields found in the Feature elements
that use this BalloonStyle: <text>This is $[name], whose description is:<br/>$[description]</text>
</p>
<p>
Text displayed in the balloon. If no text is specified, Google Earth draws the default
balloon (with the Feature <name> in boldface, the Feature <description>, links for
driving directions, a white background, and a tail that is attached to the point
coordinates of the Feature, if specified).
</p>
<p>
You can add entities to the <text> 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 <text> element with some content,
or with $[description] to substitute the basic Feature <description>.
</p>
</javaDoc>
</elements>
<elements>
<className>datetime</className>
<javaDoc>DateTime
<p>
dateTime, date, gYearMonth, gYear
</p>
See Also:
See <TimeSpan> and <TimeStamp>
</javaDoc>
</elements>
<elements>
<className>listitemtype</className>
<javaDoc><listitemtype>
<p>
Specifies how a Feature is displayed in the list view. Possible values are: check
(default) - The Feature's visibility is tied to its item's checkbox. radioFolder
- When specified for a Container, only one of the Container's items is visible at
a time checkOffOnly - When specified for a Container or Network Link, prevents all
items from being made visible at once—that is, the user can turn everything in the
Container or Network Link off but cannot turn everything on at the same time. This
setting is useful for Containers or Network Links containing large amounts of data.
checkHideChildren - Use a normal checkbox for visibility but do not display the
Container or Network Link's children in the list view. A checkbox allows the user
to toggle visibility of the child objects in the viewer.
</p>
</javaDoc>
</elements>
<elements>
<className>rotationxy</className>
<javaDoc><rotationxy>
<p>
Point relative to the screen about which the screen overlay is rotated.
</p>
</javaDoc>
</elements>
<elements>
<className>latitude</className>
<javaDoc><latitude>
<p>
Latitude of the point the camera is looking at. Degrees north or south of the Equator
(0 degrees). Values range from −90 degrees to 90 degrees.
</p>
<p>
Latitude of the virtual camera. Degrees north or south of the Equator (0 degrees).
Values range from −90 degrees to 90 degrees.
</p>
</javaDoc>
</elements>
<elements>
<className>latlonquad</className>
<javaDoc><gx:LatLonQuad>
<p>
Allows non-rectangular quadrilateral ground overlays.
</p>
<p>
If a third value is inserted into any tuple (representing altitude) it will be ignored.
Altitude is set using <altitude> and <altitudeMode> (or <gx:altitudeMode>) extending
<GroundOverlay>. Allowed altitude modes are absolute, clampToGround, and clampToSeaFloor.
</p>
<p>
Specifies the coordinates of the four corner points of a quadrilateral defining
the overlay area. Exactly four coordinate tuples have to be provided, each consisting
of floating point values for longitude and latitude. Insert a space between tuples.
Do not include spaces within a tuple. The coordinates must be specified in counter-clockwise
order with the first coordinate corresponding to the lower-left corner of the overlayed
image. The shape described by these corners must be convex.
</p>
Syntax:
<pre>&lt;GroundOverlay id="ID"&gt;
...
&lt;Icon&gt;...&lt;/Icon&gt;
&lt;altitude&gt;0&lt;/altitude&gt;
&lt;altitudeMode&gt;clampToGround&lt;/altitudeMode&gt; &lt;!-- or <em>absolute</em> --&gt;
&lt;!-- can substitute <em>&lt;gx:altitudeMode&gt;clampToSeaFloor&lt;/gx:altitudeMode&gt;</em> --&gt;
<strong>&lt;gx:LatLonQuad&gt;
&lt;coordinates&gt;...&lt;/coordinates&gt; &lt;!-- four lon,lat tuples --&gt;
&lt;/gx:LatLonQuad&gt;</strong>
&lt;/GroundOverlay&gt;</pre>
Extends:
@see: <Object>
Contained By:
@see: <GroundOverlay>
</javaDoc>
</elements>
<elements>
<className>expires</className>
<javaDoc><expires>
<p>
You can specify a date/time at which the link should be refreshed. This specification
takes effect only if the <refreshMode> in <Link> has a value of onExpire. See <refreshMode>
</p>
</javaDoc>
</elements>
<elements>
<className>author</className>
<javaDoc><atom:author>
<p>
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:
</p>
<p>
The <atom:author> element is the parent element for <atom:name>, which specifies
the author of the KML feature.
</p>
<p>
These elements are defined in the Atom Syndication Format. The complete specification
is found at http://atompub.org. (see the sample that follows).
</p>
<p>
These elements are defined in the Atom Syndication Format. The complete specification
is found at http://atompub.org. (see the sample that follows).
</p>
</javaDoc>
</elements>
<elements>
<className>duration</className>
<javaDoc><gx:duration>
<p>
<gx:AnimatedUpdate> <gx:duration>5.0</gx:duration> <Update> .... </Update> </gx:AnimatedUpdate>
</p>
<p>
<gx:FlyTo> <gx:flyToMode>bounce</gx:flyToMode> <gx:duration>10.2</gx:duration> <!--
AbstractView --> ... <!-- /AbstractView --> </gx:FlyTo>
</p>
<p>
<gx:duration> extends gx:TourPrimitive by specifying a time-span for events. The
time is written as seconds using XML's double datatype.
</p>
<p>
Duration and <gx:AnimatedUpdate>
</p>
<p>
Duration and <gx:FlyTo>
</p>
<p>
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.
</p>
<p>
When a duration is included within a <gx:FlyTo> element, it specifies the length
of time that the browser takes to fly from the previous point to the specified point.
</p>
Syntax:
<pre>&lt;gx:duration&gt;0.0&lt;/gx:duration&gt; &lt;!-- double --&gt;
</pre>
</javaDoc>
</elements>
<elements>
<className>altitude</className>
<javaDoc><altitude>
<p>
Distance from the earth's surface, in meters. Interpreted according to the LookAt's
altitude mode.
</p>
<p>
Distance of the camera from the earth's surface, in meters. Interpreted according
to the Camera's <altitudeMode> or <gx:altitudeMode>.
</p>
<p>
Specifies the distance above the earth's surface, in meters, and is interpreted
according to the altitude mode.
</p>
</javaDoc>
</elements>
<elements>
<className>minrefreshperiod</className>
<javaDoc><minrefreshperiod>
<p>
Specified in seconds, <minRefreshPeriod> is the minimum allowed time between fetches
of the file. This parameter allows servers to throttle fetches of a particular file
and to tailor refresh rates to the expected rate of change to the data. For example,
a user might set a link refresh to 5 seconds, but you could set your minimum refresh
period to 3600 to limit refresh updates to once every hour.
</p>
</javaDoc>
</elements>
<elements>
<className>when</className>
<javaDoc><when>
<p>
Specifies a single moment in time. The value is a dateTime, which can be one of
the following: dateTime gives second resolution date gives day resolution gYearMonth
gives month resolution gYear gives year resolution
</p>
</javaDoc>
</elements>
<elements>
<className>anglepos90</className>
<javaDoc>Anglepos90
<p>
a value >=0 and <=90
</p>
See Also:
See <tilt> in <LookAt>
</javaDoc>
</elements>
<elements>
<className>tour</className>
<javaDoc><gx:Tour>
<p>
<gx:Tour> can contain a single <gx:Playlist> element, which in turn contains an
ordered list of gx:TourPrimitive elements that define a tour in any KML browser.
Learn more about tours.
</p>
Syntax:
<pre>&lt;gx:Tour&gt;
&lt;name&gt;...&lt;/name&gt;
&lt;description&gt;...&lt;/description&gt;
&lt;gx:Playlist&gt;
&lt;!-- any number of <em>gx:TourPrimitive</em> elements --&gt;
&lt;/gx:Playlist&gt;
&lt;/gx:Tour&gt;</pre>
Contains:
@see: <gx:Playlist>
@see: <gx:Tour>
@see: <gx:Tour> <gx:Playlist> <!-- gx:TourPrimitive --> ... <!-- /gx:TourPrimitive --> <!--- Any number of gx:TourPrimitive elements can be included ---> </gx:Playlist> </gx:Tour>
@see: gx:Playlist
@see: gx:TourPrimitive
</javaDoc>
</elements>
<elements>
<className>end</className>
<javaDoc><end>
<p>
Describes the ending instant of a time period. If absent, the end of the period
is unbounded.
</p>
</javaDoc>
</elements>
<elements>
<className>angle90</className>
<javaDoc>Angle90
<p>
a value >=-90 and <=90
</p>
See Also:
See <latitude> in <Model>
</javaDoc>
</elements>
<elements>
<className>address</className>
<javaDoc><address>
<p>
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 <address> tag to specify
the location of a point instead of using latitude and longitude coordinates. (However,
if a <Point> is provided, it takes precedence over the <address>.) To find out which
locales are supported for this tag in Google Earth, go to the Google Maps Help.
</p>
</javaDoc>
</elements>
<elements>
<className>south</className>
<javaDoc><south> (required)
<p>
Specifies the latitude of the south edge of the bounding box, in decimal degrees
from 0 to ±90.
</p>
</javaDoc>
</elements>
<elements>
<className>metadata</className>
<javaDoc><metadata> (deprecated in kml 2.2; use <extendeddata> instead)
</javaDoc>
</elements>
<elements>
<className>flytoview</className>
<javaDoc><flytoview>
<p>
Boolean value. A value of 1 causes Google Earth to fly to the view of the LookAt
or Camera in the NetworkLinkControl (if it exists). If the NetworkLinkControl does
not contain an AbstractView element, Google Earth flies to the LookAt or Camera
element in the Feature child within the <kml> element in the refreshed file. If
the <kml> element does not have a LookAt or Camera specified, the view is unchanged.
For example, Google Earth would fly to the <LookAt> view of the parent Document,
not the <LookAt> of the Placemarks contained within the Document.
</p>
</javaDoc>
</elements>
<elements>
<className>folder</className>
<javaDoc><Folder>
<p>
A Folder is used to arrange other Features hierarchically (Folders, Placemarks,
NetworkLinks, or Overlays). A Feature is visible only if it and all its ancestors
are visible.
</p>
<p>
A Folder is used to arrange other Features hierarchically (Folders, Placemarks,
NetworkLinks, or Overlays). A Feature is visible only if it and all its ancestors
are visible.
</p>
Syntax:
<pre><strong>&lt;Folder id="ID"&gt;</strong>
&lt;!-- inherited from <em>Feature</em> element --&gt;
&lt;name&gt;<em>...</em>&lt;/name&gt; &lt;!-- string --&gt;
&lt;visibility&gt;1&lt;/visibility&gt; &lt;!-- boolean --&gt;
&lt;open&gt;0&lt;/open&gt; &lt;!-- boolean --&gt;
<span>&lt;atom:author&gt;...&lt;atom:author&gt; &lt;!-- xmlns:atom --&gt;
&lt;atom:link&gt;...&lt;/atom:link&gt;</span><span> &lt;!-- xmlns:atom --&gt;</span>
&lt;address&gt;<em>...</em>&lt;/address&gt; &lt;!-- string --&gt;
&lt;xal:AddressDetails&gt;...&lt;/xal:AddressDetails&gt; &lt;!-- xmlns:xal --&gt;<br> &lt;phoneNumber&gt;...&lt;/phoneNumber&gt; &lt;!-- string --&gt;<br> &lt;Snippet maxLines="2"&gt;<em>...</em>&lt;/Snippet&gt; &lt;!-- string --&gt;
&lt;description&gt;<em>...</em>&lt;/description&gt; &lt;!-- string --&gt;
<span><em>&lt;AbstractView&gt;...&lt;/AbstractView&gt;</em> &lt;!-- Camera <em>or</em> LookAt --&gt;</span>
&lt;<em>TimePrimitive</em>&gt;...&lt;/<em>TimePrimitive</em>&gt;
&lt;styleUrl&gt;<em>...</em>&lt;/styleUrl&gt; &lt;!-- anyURI --&gt;
&lt;<em>StyleSelector&gt;...&lt;/StyleSelector&gt;</em>
&lt;Region&gt;...&lt;/Region&gt;
<span>&lt;Metadata&gt;...&lt;/Metadata&gt; &lt;!-- deprecated in KML 2.2 --&gt;
&lt;ExtendedData&gt;...&lt;/ExtendedData&gt; &lt;!-- new in KML 2.2 --&gt;
</span>&lt;!-- specific to Folder --&gt;
&lt;!-- 0 or more <em>Feature</em> elements --&gt;
<strong>&lt;/Folder</strong>&gt;
</pre>
Extends:
@see: <Container>
Contains:
@see: <Feature>
</javaDoc>
</elements>
<elements>
<className>polystyle</className>
<javaDoc><PolyStyle>
Syntax:
<pre><strong>&lt;PolyStyle id="ID"&gt;</strong>
&lt;!-- inherited from <em>ColorStyle</em> --&gt;
&lt;color&gt;ffffffff&lt;/color&gt; &lt;!-- kml:color --&gt;
&lt;colorMode&gt;normal&lt;/colorMode&gt; &lt;!-- kml:colorModeEnum: normal <em>or</em> random --&gt;
&lt;!-- specific to PolyStyle --&gt;
&lt;fill&gt;1&lt;/fill&gt; &lt;!-- boolean --&gt;
&lt;outline&gt;1&lt;/outline&gt; &lt;!-- boolean --&gt;
<strong>&lt;/PolyStyle&gt;</strong></pre>
Extends:
@see: <ColorStyle>
Contained By:
@see: <Style>
</javaDoc>
</elements>
<elements>
<className>vec2</className>
<javaDoc>Vec2
<p>
x=double xunits=kml:unitsEnum y=double yunits=kml:unitsEnum
</p>
See Also:
See <hotSpot> in <IconStyle>, <ScreenOverlay>
</javaDoc>
</elements>
<elements>
<className>alias</className>
<javaDoc><alias> contains a mapping from a <sourcehref> to a <targethref>:
<p>
<targetHref> Specifies the texture file to be fetched by Google Earth. This reference
can be a relative reference to an image file within the .kmz archive, or it can
be an absolute reference to the file (for example, a URL). <sourceHref> Is the path
specified for the texture file in the Collada .dae file.
</p>
</javaDoc>
</elements>
<elements>
<className>refreshvisibility</className>
<javaDoc><refreshvisibility>
<p>
Boolean value. A value of 0 leaves the visibility of features within the control
of the Google Earth user. Set the value to 1 to reset the visibility of features
each time the NetworkLink is refreshed. For example, suppose a Placemark within
the linked KML file has <visibility> set to 1 and the NetworkLink has <refreshVisibility>
set to 1. When the file is first loaded into Google Earth, the user can clear the
check box next to the item to turn off display in the 3D viewer. However, when the
NetworkLink is refreshed, the Placemark will be made visible again, since its original
visibility state was TRUE.
</p>
</javaDoc>
</elements>
<elements>
<className>minlodpixels</className>
<javaDoc><minlodpixels> (required)
<p>
Measurement in screen pixels that represents the minimum limit of the visibility
range for a given Region. Google Earth calculates the size of the Region when projected
onto screen space. Then it computes the square root of the Region's area (if, for
example, the Region is square and the viewpoint is directly above the Region, and
the Region is not tilted, this measurement is equal to the width of the projected
Region). If this measurement falls within the limits defined by <minLodPixels> and
<maxLodPixels> (and if the <LatLonAltBox> is in view), the Region is active. If
this limit is not reached, the associated geometry is considered to be too far from
the user's viewpoint to be drawn.
</p>
</javaDoc>
</elements>
<elements>
<className>longitude</className>
<javaDoc><longitude>
<p>
Longitude of the point the camera is looking at. 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.
</p>
<p>
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.
</p>
</javaDoc>
</elements>
<elements>
<className>displaymode</className>
<javaDoc>DisplayMode
<p>
default, hide
</p>
See Also:
See <BalloonStyle>
</javaDoc>
</elements>
<elements>
<className>linkdescription</className>
<javaDoc><linkdescription>
<p>
You can control the description of the network link from the server, so that changes
made to the description on the client side are overridden by the server.
</p>
</javaDoc>
</elements>
<elements>
<className>maxheight</className>
<javaDoc><maxheight>
<p>
Height in pixels of the original image.
</p>
</javaDoc>
</elements>
<elements>
<className>create</className>
<javaDoc><create>
<p>
Adds new elements to a Folder or Document that has already been loaded via a <NetworkLink>.
The <targetHref> element in <Update> specifies the URL of the .kml or .kmz file
that contained the original Folder or Document. Within that file, the Folder or
Document that is to contain the new data must already have an explicit id defined
for it. This id is referenced as the targetId attribute of the Folder or Document
within <Create> that contains the element to be added.
</p>
<p>
Once an object has been created and loaded into Google Earth, it takes on the URL
of the original parent Document of Folder. To perform subsequent updates to objects
added with this Update/Create mechanism, set <targetHref> to the URL of the original
Document or Folder (not the URL of the file that loaded the intervening updates).
</p>
</javaDoc>
</elements>
<elements>
<className>extendeddata</className>
<javaDoc><extendeddata>
<p>
Adding untyped data/value pairs using the <Data> element (basic) Declaring new typed
fields using the <Schema> element and then instancing them using the <SchemaData>
element (advanced) Referring to XML elements defined in other namespaces by referencing
the external namespace within the KML file (basic)
</p>
<p>
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.
</p>
<p>
For more information, see Adding Custom Data in "Topics in KML."
</p>
<p>
The ExtendedData element offers three techniques for adding custom data to a KML
Feature (NetworkLink, Placemark, GroundOverlay, PhotoOverlay, ScreenOverlay, Document,
Folder). These techniques are
</p>
<p>
These techniques can be combined within a single KML file or Feature for different
pieces of data.
</p>
Syntax:
<pre>&lt;ExtendedData&gt;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<br> &lt;Data name="string"&gt;<br>&nbsp; &lt;displayName&gt;...&lt;/displayName&gt;&nbsp;&nbsp;&nbsp; &lt;!-- string --&gt;<br> &nbsp;&nbsp; &lt;value&gt;...&lt;/value&gt;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; &lt;!-- string --&gt;<br> &lt;/Data&gt;
&lt;SchemaData schemaUrl="<em>anyURI</em>"&gt;<br> &lt;SimpleData name=""&gt; ... &lt;/SimpleData&gt;&nbsp;&nbsp; &lt;!-- string --&gt;<br> &lt;/SchemaData&gt;
&lt;namespace_prefix:other&gt;...&lt;/namespace_prefix:other&gt;
&lt;/ExtendedData&gt;</pre>
Contained By:
@see: <Feature>
See Also:
Schema
</javaDoc>
</elements>
<elements>
<className>viewformat</className>
<javaDoc><viewformat>
<p>
BBOX=[bboxWest],[bboxSouth],[bboxEast],[bboxNorth]
</p>
<p>
If you specify a <viewRefreshMode> of onStop and do not include the <viewFormat>
tag in the file, the following information is automatically appended to the query
string:
</p>
<p>
If you specify an empty <viewFormat> tag, no information is appended to the query
string.
</p>
<p>
Specifies the format of the query string that is appended to the Link's <href> before
the file is fetched.(If the <href> specifies a local file, this element is ignored.)
</p>
<p>
This information matches the Web Map Service (WMS) bounding box specification.
</p>
<p>
You can also specify a custom set of viewing parameters to add to the query string.
If you supply a format string, it is used instead of the BBOX information. If you
also want the BBOX information, you need to add those parameters along with the
custom parameters.
</p>
<p>
You can use any of the following parameters in your format string (and Google Earth
will substitute the appropriate current value at the time it creates the query string):
[lookatLon], [lookatLat] - longitude and latitude of the point that <LookAt> is
viewing [lookatRange], [lookatTilt], [lookatHeading] - values used by the <LookAt>
element (see descriptions of <range>, <tilt>, and <heading> in <LookAt>) [lookatTerrainLon],
[lookatTerrainLat], [lookatTerrainAlt] - point on the terrain in degrees/meters
that <LookAt> is viewing [cameraLon], [cameraLat], [cameraAlt] - degrees/meters
of the eyepoint for the camera [horizFov], [vertFov] - horizontal, vertical field
of view for the camera [horizPixels], [vertPixels] - size in pixels of the 3D viewer
[terrainEnabled] - indicates whether the 3D viewer is showing terrain
</p>
</javaDoc>
</elements>
<elements>
<className>sourcehref</className>
<javaDoc><sourcehref>
<p>
<targetHref> Specifies the texture file to be fetched by Google Earth. This reference
can be a relative reference to an image file within the .kmz archive, or it can
be an absolute reference to the file (for example, a URL). <sourceHref> Is the path
specified for the texture file in the Collada .dae file.
</p>
<p>
In Google Earth, if this mapping is not supplied, the following rules are used to
locate the textures referenced in the Collada (.dae) file: No path: If the texture
name does not include a path, Google Earth looks for the texture in the same directory
as the .dae file that references it. Relative path: If the texture name includes
a relative path (for example, ../images/mytexture.jpg), Google Earth interprets
the path as being relative to the .dae file that references it. Absolute path: If
the texture name is an absolute path (c:\mytexture.jpg) or a network path (for example,
http://myserver.com/mytexture.jpg), Google Earth looks for the file in the specified
location, regardless of where the .dae file is located.
</p>
<p>
Is the path specified for the texture file in the Collada .dae file.
</p>
<p>
Is the path specified for the texture file in the Collada .dae file.
</p>
</javaDoc>
</elements>
<elements>
<className>latlonbox</className>
<javaDoc><latlonbox>
<p>
Specifies where the top, bottom, right, and left sides of a bounding box for the
ground overlay are aligned. <north> Specifies the latitude of the north edge of
the bounding box, in decimal degrees from 0 to ±90. <south> Specifies the latitude
of the south edge of the bounding box, in decimal degrees from 0 to ±90. <east>
Specifies the longitude of the east edge of the bounding box, in decimal degrees
from 0 to ±180. (For overlays that overlap the meridian of 180° longitude, values
can extend beyond that range.) <west> Specifies the longitude of the west edge of
the bounding box, in decimal degrees from 0 to ±180. (For overlays that overlap
the meridian of 180° longitude, values can extend beyond that range.) <rotation>
Specifies a rotation of the overlay about its center, in degrees. Values can be
±180. The default is 0 (north). Rotations are specified in a counterclockwise direction.
<LatLonBox> <north>48.25475939255556</north> <south>48.25207367852141</south> <east>-90.86591508839973</east>
<west>-90.8714285289695</west> <rotation>39.37878630116985</rotation> </LatLonBox>
</p>
</javaDoc>
</elements>
<elements>
<className>colormode</className>
<javaDoc>ColorMode
<p>
normal, random
</p>
See Also:
See any element that extends <ColorStyle>
</javaDoc>
</elements>
<elements>
<className>document</className>
<javaDoc><Document>
<p>
<Document> <Style id="myPrettyDocument"> <ListStyle> ... </ListStyle> </Style> <styleUrl#myPrettyDocument">
... </Document>
</p>
<p>
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:
</p>
<p>
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 <styleUrl> element.
</p>
<p>
Do not put shared styles within a Folder.
</p>
<p>
Each Feature must explicitly reference the styles it uses in a <styleUrl> element.
For a Style that applies to a Document (such as ListStyle), the Document itself
must explicitly reference the <styleUrl>. For example:
</p>
<p>
Note that shared styles are not inherited by the Features in the Document.
</p>
<p>
The following example illustrates use of a shared style.
</p>
Syntax:
<pre><strong>&lt;Document id="ID"&gt;</strong>
&lt;!-- inherited from <em>Feature</em> element --&gt;
&lt;name&gt;<em>...</em>&lt;/name&gt; &lt;!-- string --&gt;
&lt;visibility&gt;1&lt;/visibility&gt; &lt;!-- boolean --&gt;
&lt;open&gt;0&lt;/open&gt; &lt;!-- boolean --&gt;
<span>&lt;atom:author&gt;...&lt;atom:author&gt; &lt;!-- xmlns:atom --&gt;
&lt;atom:link&gt;...&lt;/atom:link&gt;</span><span> &lt;!-- xmlns:atom --&gt;</span>
&lt;address&gt;<em>...</em>&lt;/address&gt; &lt;!-- string --&gt;
&lt;xal:AddressDetails&gt;...&lt;/xal:AddressDetails&gt; &lt;!-- xmlns:xal --&gt;<br> &lt;phoneNumber&gt;...&lt;/phoneNumber&gt; &lt;!-- string --&gt;<br> &lt;Snippet maxLines="2"&gt;<em>...</em>&lt;/Snippet&gt; &lt;!-- string --&gt;
&lt;description&gt;<em>...</em>&lt;/description&gt; &lt;!-- string --&gt;
<span><em>&lt;AbstractView&gt;...&lt;/AbstractView&gt;</em> &lt;!-- Camera <em>or</em> LookAt --&gt;</span>
&lt;<em>TimePrimitive</em>&gt;...&lt;/<em>TimePrimitive</em>&gt;
&lt;styleUrl&gt;<em>...</em>&lt;/styleUrl&gt; &lt;!-- anyURI --&gt;
&lt;<em>StyleSelector&gt;...&lt;/StyleSelector&gt;</em>
&lt;Region&gt;...&lt;/Region&gt;
<span>&lt;Metadata&gt;...&lt;/Metadata&gt; &lt;!-- deprecated in KML 2.2 --&gt;
&lt;ExtendedData&gt;...&lt;/ExtendedData&gt; &lt;!-- new in KML 2.2 --&gt;</span>
&lt;!-- specific to Document --&gt;
&lt;!-- 0 or more Schema elements --&gt;
&lt;!-- 0 or more <em>Feature</em> elements --&gt;
<strong>&lt;/Document&gt;</strong></pre>
Extends:
@see: <Container>
Contains:
@see: <Feature>
@see: <Schema>
@see: <StyleSelector>
</javaDoc>
</elements>
<elements>
<className>abstractview</className>
<javaDoc><abstractview>
<p>
Defines a viewpoint associated with any element derived from Feature. See <Camera>
and <LookAt>.
</p>
<p>
This is an abstract element and cannot be used directly in a KML file. This element
is extended by the <Camera> and <LookAt> elements.
</p>
Syntax:
<pre>&lt;!-- abstract element; do not create --&gt;
<strong>&lt;!--<em> AbstractView</em> --&gt;</strong> &lt;!-- Camera, LookAt --&gt;
&lt;!-- extends <span class="style1">Object</span> --&gt;
<em>&lt;TimePrimitive&gt;...&lt;/TimePrimitive&gt;</em> &lt;!-- gx:TimeSpan or gx:TimeStamp --&gt;
<strong>&lt;-- /<em>AbstractView</em> --&gt;</strong></pre>
Extends:
@see: <Object>
Extended By:
@see: <Camera>
@see: <LookAt>
</javaDoc>
</elements>
<elements>
<className>draworder</className>
<javaDoc><draworder>
<p>
This element defines the stacking order for the images in overlapping overlays.
Overlays with higher <drawOrder> values are drawn on top of overlays with lower
<drawOrder> values.
</p>
</javaDoc>
</elements>
<elements>
<className>angle360</className>
<javaDoc>Angle360
<p>
a value >=-360 and <=360
</p>
See Also:
See <heading>, <tilt>, and <roll> in <Orientation>
</javaDoc>
</elements>
<elements>
<className>linearring</className>
<javaDoc><LinearRing>
<p>
Defines a closed line string, typically the outer boundary of a Polygon. Optionally,
a LinearRing can also be used as the inner boundary of a Polygon to create holes
in the Polygon. A Polygon can contain multiple <LinearRing> elements used as inner
boundaries.
</p>
<p>
Note: In Google Earth, a Polygon with an <altitudeMode> of clampToGround follows
the great circle; however, a LinearRing (by itself) with an <altitudeMode> of clampToGround
follows lines of constant latitude.
</p>
Syntax:
<pre><strong>&lt;LinearRing id="ID"&gt;</strong>
&lt;!-- specific to LinearRing --&gt;
&lt;extrude&gt;0&lt;/extrude&gt; &lt;!-- boolean --&gt;
&lt;tessellate&gt;0&lt;/tessellate&gt; &lt;!-- boolean --&gt;
&lt;altitudeMode&gt;clampToGround&lt;/altitudeMode&gt;
&lt;!-- kml:altitudeModeEnum: clampToGround, relativeToGround, <em>or</em> absolute --&gt;
&lt;!-- or, substitute gx:altitudeMode: clampToSeaFloor, relativeToSeaFloor --&gt;
&lt;coordinates&gt;<em>...</em>&lt;/coordinates&gt; &lt;!-- lon,lat[,alt] tuples --&gt;
<strong>&lt;/LinearRing&gt;</strong></pre>
Extends:
@see: <Geometry>
Contained By:
@see: <MultiGeometry>
@see: <Placemark>
@see: <innerBoundaryIs>
@see: <outerBoundaryIs>
</javaDoc>
</elements>
<elements>
<className>imagepyramid</className>
<javaDoc><imagepyramid>
<p>
For very large images, you'll need to construct an image pyramid, which is a hierarchical
set of images, each of which is an increasingly lower resolution version of the
original image. Each image in the pyramid is subdivided into tiles, so that only
the portions in view need to be loaded. Google Earth calculates the current viewpoint
and loads the tiles that are appropriate to the user's distance from the image.
As the viewpoint moves closer to the PhotoOverlay, Google Earth loads higher resolution
tiles. Since all the pixels in the original image can't be viewed on the screen
at once, this preprocessing allows Google Earth to achieve maximum performance because
it loads only the portions of the image that are in view, and only the pixel details
that can be discerned by the user at the current viewpoint.
</p>
<p>
When you specify an image pyramid, you also modify the <href> in the <Icon> element
to include specifications for which tiles to load.
</p>
</javaDoc>
</elements>
<elements>
<className>balloonvisibility</className>
<javaDoc><gx:balloonVisibility>
<p>
Toggles visibility of a description balloon. The balloon to be updated must be identified
by the object's XML ID (e.g. <Placemark targetId="xxx">).
</p>
Syntax:
<pre>&lt;gx:balloonVisibility&gt;0&lt;/gx:balloonVisibility&gt; &lt;!-- <em>0 </em>(not visible) or <em>1 </em>(visible) --&gt;</pre>
Extends:
@see: <Feature>
</javaDoc>
</elements>
<elements>
<className>timeprimitive</className>
<javaDoc><TimePrimitive>
<p>
Associates this Feature with a period of time (<TimeSpan>) or a point in time (<TimeStamp>).
</p>
<p>
This is an abstract element and cannot be used directly in a KML file. This element
is extended by the <TimeSpan> and <TimeStamp> elements.
</p>
Syntax:
<pre>&lt;!-- abstract element; do not create --&gt;
<strong>&lt;!-- TimePrimitive id="ID" --&gt; &lt;!-- TimeSpan,TimeStamp --&gt;
</strong> &lt;!-- extends Object --&gt;<strong>
&lt;!-- /TimePrimitive --&gt;</strong></pre>
Extends:
@see: <Object>
Extended By:
@see: <TimeSpan>
@see: <TimeStamp>
</javaDoc>
</elements>
<elements>
<className>refreshmode</className>
<javaDoc>RefreshMode
<p>
onChange, onInterval, onExpire
</p>
See Also:
See <Link>
</javaDoc>
</elements>
<elements>
<className>color</className>
<javaDoc><color>
<p>
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: <color>7fff0000</color>, where alpha=0x7f, blue=0xff, green=0x00,
and red=0x00.
</p>
<p>
Color values are expressed in hexadecimal notation, including opacity (alpha) values.
The order of expression is alpha, blue, green, red (aabbggrr). The range of values
for any one color is 0 to 255 (00 to ff). For opacity, 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: <color>7fff0000</color>
</p>
<p>
Note: The <geomColor> element has been deprecated. Use <color> instead.
</p>
</javaDoc>
</elements>
<elements>
<className>bottomfov</className>
<javaDoc><bottomfov>
<p>
Angle, in degrees, between the camera's viewing direction and the bottom side of
the view volume.
</p>
</javaDoc>
</elements>
<elements>
<className>description</className>
<javaDoc><description>
<p>
The supported content for the <description> 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.
</p>
<p>
User-supplied content that appears in the description balloon.
</p>
<p>
User-supplied content that appears in the description balloon. The supported content
for the <description> 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 supports plain text content, as well as full HTML and
JavaScript, within description balloons. Contents of the description tag are rendered
by the WebKit 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 placemark balloons to access local files and personal data. Links to image
files on the local filesystem are always allowed, if contained within an <img> tag.
Content that has been compressed into a KMZ file can be accessed, even if on the
local filesystem. Cookies are completely disabled, including cookies set or read
by content contained within a iFrame. There are no exceptions to this rule. Doctype
declarations are ignored.
</p>
</javaDoc>
</elements>
<elements>
<className>maxaltitude</className>
<javaDoc><maxaltitude>
<p>
Specified in meters (and is affected by the altitude mode specification).
</p>
</javaDoc>
</elements>
<elements>
<className>begin</className>
<javaDoc><begin>
<p>
Describes the beginning instant of a time period. If absent, the beginning of the
period is unbounded.
</p>
</javaDoc>
</elements>
</ns2:JaxbJavaDocElements>