This is an abstract element and cannot be used directly in a KML file.
is the base type for image overlays drawn on the planet surface or on the screen.
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.
Syntax:
<!-- abstract element; do not create -->
<!-- Overlay id="ID" --> <!-- GroundOverlay,ScreenOverlay -->
<!-- inherited from Feature element -->
<name>... </name> <!-- string -->
<visibility>1</visibility> <!-- boolean -->
<open>0</open> <!-- boolean -->
<atom:author>...<atom:author> <!-- xmlns:atom -->
<atom:link>...</atom:link> <!-- xmlns:atom -->
<address>... </address> <!-- string -->
<xal:AddressDetails>...</xal:AddressDetails> <!-- xmlns:xal --> <phoneNumber>...</phoneNumber> <!-- string --> <Snippet maxLines="2">... </Snippet> <!-- string -->
<description>... </description> <!-- string -->
<AbstractView>...</AbstractView> <!-- Camera or LookAt -->
<TimePrimitive >...</TimePrimitive >
<styleUrl>... </styleUrl> <!-- anyURI -->
<StyleSelector>...</StyleSelector>
<Region>...</Region>
<Metadata>...</Metadata> <!-- deprecated in KML 2.2 -->
<ExtendedData>...</ExtendedData> <!-- new in KML 2.2 -->
<!-- specific to Overlay -->
<color>ffffffff</color> <!-- kml:color -->
<drawOrder>0</drawOrder> <!-- int -->
<Icon>
<href>...</href>
</Icon>
<!-- /Overlay -- >
Extends:
Fields inherited from class de.micromata.opengis.kml.v_2_2_0.Feature
abstractView , address , atomAuthor , atomLink , description , extendedData , featureObjectExtension , featureSimpleExtension , metadata , name , open , phoneNumber , region , snippet , snippetd , styleSelector , styleUrl , timePrimitive , visibility , xalAddressDetails
Methods inherited from class de.micromata.opengis.kml.v_2_2_0.Feature
createAndAddStyle , createAndAddStyleMap , createAndSetAtomAuthor , createAndSetAtomLink , createAndSetCamera , createAndSetExtendedData , createAndSetLookAt , createAndSetMetadata , createAndSetRegion , createAndSetSnippet , createAndSetTimeSpan , createAndSetTimeStamp , createAndSetXalAddressDetails , getAbstractView , getAddress , getAtomAuthor , getAtomLink , getDescription , getExtendedData , getFeatureObjectExtension , getFeatureSimpleExtension , getMetadata , getName , getPhoneNumber , getRegion , getSnippet , getSnippetd , getStyleSelector , getStyleUrl , getTimePrimitive , getXalAddressDetails , isOpen , isVisibility , setAbstractView , setAddress , setAtomAuthor , setAtomLink , setDescription , setExtendedData , setMetadata , setName , setOpen , setPhoneNumber , setRegion , setSnippet , setSnippetd , setStyleUrl , setTimePrimitive , setVisibility , setXalAddressDetails
Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, toString, wait, wait, wait
color
protected java.lang.String color
Color and opacity (alpha) values are expressed in hexadecimal notation. The range
of values for any one color is 0 to 255 (00 to ff). For alpha, 00 is fully transparent
and ff is fully opaque. The order of expression is aabbggrr, where aa=alpha (00
to ff); bb=blue (00 to ff); gg=green (00 to ff); rr=red (00 to ff). For example,
if you want to apply a blue color with 50 percent opacity to an overlay, you would
specify the following: 7fff0000 , where alpha=0x7f, blue=0xff, green=0x00,
and red=0x00.
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: 7fff0000
Note: The element has been deprecated. Use instead.
drawOrder
protected int drawOrder
This element defines the stacking order for the images in overlapping overlays.
Overlays with higher values are drawn on top of overlays with lower
values.
icon
protected Icon icon
see also .
Sunset.jpg
A custom Icon. In , the only child element of is : :
An HTTP address or a local file specification used to load an icon.
Defines an image associated with an Icon style or overlay. has the same child
elements as . The required 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.
Defines the image associated with the Overlay. The 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 , a rectangle
is drawn using the color and size defined by the ground or screen overlay.
icon.jpg
Syntax:
<Icon id="ID">
<!-- specific to Icon -->
<href>... </href> <!-- anyURI -->
<refreshMode>onChange</refreshMode>
<!-- kml:refreshModeEnum: onChange, onInterval, or onExpire -->
<refreshInterval>4</refreshInterval> <!-- float -->
<viewRefreshMode>never</viewRefreshMode>
<!-- kml:viewRefreshModeEnum: never, onStop, onRequest, onRegion -->
<viewRefreshTime>4</viewRefreshTime> <!-- float -->
<viewBoundScale>1</viewBoundScale> <!-- float -->
<viewFormat>...</viewFormat> <!-- string -->
<httpQuery>...</httpQuery> <!-- string -->
</Icon>
Contained By:
overlaySimpleExtension
protected java.util.List<java.lang.Object> overlaySimpleExtension
overlayObjectExtension
protected java.util.List<AbstractObject > overlayObjectExtension
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 mechanism is to
be used.
Syntax:
<!-- abstract element; do not create -->
<!-- Object id="ID" targetId="NCName" -->
<!-- /Object > -->
Overlay
public Overlay ()
getColor
public java.lang.String getColor ()
Returns: possible object is
String
See Also: color
setColor
public void setColor (java.lang.String value)
Parameters: value
- allowed object is
String
See Also: color
getDrawOrder
public int getDrawOrder ()
Returns: possible object is
Integer
See Also: drawOrder
setDrawOrder
public void setDrawOrder (int value)
Parameters: value
- allowed object is
Integer
See Also: drawOrder
getIcon
public Icon getIcon ()
Returns: possible object is
Link
See Also: icon
setIcon
public void setIcon (Icon value)
Parameters: value
- allowed object is
Link
See Also: icon
getOverlaySimpleExtension
public java.util.List<java.lang.Object> getOverlaySimpleExtension ()
See Also: overlaySimpleExtension
getOverlayObjectExtension
public java.util.List<AbstractObject > getOverlayObjectExtension ()
See Also: overlayObjectExtension
hashCode
public int hashCode ()
Overrides: hashCode
in class Feature
equals
public boolean equals (java.lang.Object obj)
Overrides: equals
in class Feature
createAndSetIcon
public Icon createAndSetIcon ()
Creates a new instance of Icon
and set it to icon.
This method is a short version for:
Icon icon = new Icon();
this.setIcon(icon);
setOverlaySimpleExtension
public void setOverlaySimpleExtension (java.util.List<java.lang.Object> overlaySimpleExtension)
Parameters: overlaySimpleExtension
- See Also: overlaySimpleExtension
addToOverlaySimpleExtension
public Overlay addToOverlaySimpleExtension (java.lang.Object overlaySimpleExtension)
add a value to the overlaySimpleExtension property collection
Parameters: overlaySimpleExtension
- Objects of the following type are allowed in the list: Object
Returns: true (as general contract of Collection.add ).
setOverlayObjectExtension
public void setOverlayObjectExtension (java.util.List<AbstractObject > overlayObjectExtension)
Parameters: overlayObjectExtension
- See Also: overlayObjectExtension
addToOverlayObjectExtension
public Overlay addToOverlayObjectExtension (AbstractObject overlayObjectExtension)
add a value to the overlayObjectExtension property collection
Parameters: overlayObjectExtension
- Objects of the following type are allowed in the list: AbstractObject
Returns: true (as general contract of Collection.add ).
setObjectSimpleExtension
public void setObjectSimpleExtension (java.util.List<java.lang.Object> objectSimpleExtension)
Overrides: setObjectSimpleExtension
in class Feature
See Also: objectSimpleExtension
addToObjectSimpleExtension
public Overlay addToObjectSimpleExtension (java.lang.Object objectSimpleExtension)
Description copied from class: AbstractObject
add a value to the objectSimpleExtension property collection
Overrides: addToObjectSimpleExtension
in class Feature
Parameters: objectSimpleExtension
- Objects of the following type are allowed in the list: Object
Returns: true (as general contract of Collection.add ).
setStyleSelector
public void setStyleSelector (java.util.List<StyleSelector > styleSelector)
Overrides: setStyleSelector
in class Feature
See Also: styleSelector
addToStyleSelector
public Overlay addToStyleSelector (StyleSelector styleSelector)
Description copied from class: Feature
add a value to the styleSelector property collection
Overrides: addToStyleSelector
in class Feature
Parameters: styleSelector
- Objects of the following type are allowed in the list: <
StyleSelector
JAXBElement
<
StyleMap
JAXBElement
<
Style
Returns: true (as general contract of Collection.add ).
setFeatureSimpleExtension
public void setFeatureSimpleExtension (java.util.List<java.lang.Object> featureSimpleExtension)
Overrides: setFeatureSimpleExtension
in class Feature
See Also: featureSimpleExtension
addToFeatureSimpleExtension
public Overlay addToFeatureSimpleExtension (java.lang.Object featureSimpleExtension)
Description copied from class: Feature
add a value to the featureSimpleExtension property collection
Overrides: addToFeatureSimpleExtension
in class Feature
Parameters: featureSimpleExtension
- Objects of the following type are allowed in the list: <
Object
JAXBElement
<
Boolean
Returns: true (as general contract of Collection.add ).
setFeatureObjectExtension
public void setFeatureObjectExtension (java.util.List<AbstractObject > featureObjectExtension)
Overrides: setFeatureObjectExtension
in class Feature
See Also: featureObjectExtension
addToFeatureObjectExtension
public Overlay addToFeatureObjectExtension (AbstractObject featureObjectExtension)
Description copied from class: Feature
add a value to the featureObjectExtension property collection
Overrides: addToFeatureObjectExtension
in class Feature
Parameters: featureObjectExtension
- Objects of the following type are allowed in the list: AbstractObject
Returns: true (as general contract of Collection.add ).
withColor
public Overlay withColor (java.lang.String color)
fluent setter
Parameters: color
- required parameterSee Also: setColor(String)
withDrawOrder
public Overlay withDrawOrder (int drawOrder)
fluent setter
Parameters: drawOrder
- required parameterSee Also: setDrawOrder(int)
withIcon
public Overlay withIcon (Icon icon)
fluent setter
Parameters: icon
- required parameterSee Also: setIcon(Icon)
withOverlaySimpleExtension
public Overlay withOverlaySimpleExtension (java.util.List<java.lang.Object> overlaySimpleExtension)
fluent setter
Parameters: overlaySimpleExtension
- required parameterSee Also: #setOverlaySimpleExtension(List)
withOverlayObjectExtension
public Overlay withOverlayObjectExtension (java.util.List<AbstractObject > overlayObjectExtension)
fluent setter
Parameters: overlayObjectExtension
- required parameterSee Also: #setOverlayObjectExtension(List)
withObjectSimpleExtension
public Overlay withObjectSimpleExtension (java.util.List<java.lang.Object> objectSimpleExtension)
Description copied from class: AbstractObject
fluent setter
Overrides: withObjectSimpleExtension
in class Feature
Parameters: objectSimpleExtension
- required parameterSee Also: #setObjectSimpleExtension(List)
withId
public Overlay withId (java.lang.String id)
Description copied from class: AbstractObject
fluent setter
Overrides: withId
in class Feature
Parameters: id
- required parameterSee Also: AbstractObject.setId(String)
withTargetId
public Overlay withTargetId (java.lang.String targetId)
Description copied from class: AbstractObject
fluent setter
Overrides: withTargetId
in class Feature
Parameters: targetId
- required parameterSee Also: AbstractObject.setTargetId(String)
withName
public Overlay withName (java.lang.String name)
Description copied from class: Feature
fluent setter
Overrides: withName
in class Feature
Parameters: name
- required parameterSee Also: Feature.setName(String)
withVisibility
public Overlay withVisibility (java.lang.Boolean visibility)
Description copied from class: Feature
fluent setter
Overrides: withVisibility
in class Feature
Parameters: visibility
- required parameterSee Also: Feature.setVisibility(Boolean)
withOpen
public Overlay withOpen (java.lang.Boolean open)
Description copied from class: Feature
fluent setter
Overrides: withOpen
in class Feature
Parameters: open
- required parameterSee Also: Feature.setOpen(Boolean)
withAtomAuthor
public Overlay withAtomAuthor (Author atomAuthor)
Description copied from class: Feature
fluent setter
Overrides: withAtomAuthor
in class Feature
Parameters: atomAuthor
- required parameterSee Also: Feature.setAtomAuthor(Author)
withAtomLink
public Overlay withAtomLink (Link atomLink)
Description copied from class: Feature
fluent setter
Overrides: withAtomLink
in class Feature
Parameters: atomLink
- required parameterSee Also: Feature.setAtomLink(Link)
withAddress
public Overlay withAddress (java.lang.String address)
Description copied from class: Feature
fluent setter
Overrides: withAddress
in class Feature
Parameters: address
- required parameterSee Also: Feature.setAddress(String)
withXalAddressDetails
public Overlay withXalAddressDetails (AddressDetails xalAddressDetails)
Description copied from class: Feature
fluent setter
Overrides: withXalAddressDetails
in class Feature
Parameters: xalAddressDetails
- required parameterSee Also: Feature.setXalAddressDetails(AddressDetails)
withPhoneNumber
public Overlay withPhoneNumber (java.lang.String phoneNumber)
Description copied from class: Feature
fluent setter
Overrides: withPhoneNumber
in class Feature
Parameters: phoneNumber
- required parameterSee Also: Feature.setPhoneNumber(String)
withSnippet
public Overlay withSnippet (Snippet snippet)
Description copied from class: Feature
fluent setter
Overrides: withSnippet
in class Feature
Parameters: snippet
- required parameterSee Also: Feature.setSnippet(Snippet)
withSnippetd
public Overlay withSnippetd (java.lang.String snippetd)
Description copied from class: Feature
fluent setter
Overrides: withSnippetd
in class Feature
Parameters: snippetd
- required parameterSee Also: Feature.setSnippetd(String)
withDescription
public Overlay withDescription (java.lang.String description)
Description copied from class: Feature
fluent setter
Overrides: withDescription
in class Feature
Parameters: description
- required parameterSee Also: Feature.setDescription(String)
withAbstractView
public Overlay withAbstractView (AbstractView abstractView)
Description copied from class: Feature
fluent setter
Overrides: withAbstractView
in class Feature
Parameters: abstractView
- required parameterSee Also: Feature.setAbstractView(AbstractView)
withTimePrimitive
public Overlay withTimePrimitive (TimePrimitive timePrimitive)
Description copied from class: Feature
fluent setter
Overrides: withTimePrimitive
in class Feature
Parameters: timePrimitive
- required parameterSee Also: Feature.setTimePrimitive(TimePrimitive)
withStyleUrl
public Overlay withStyleUrl (java.lang.String styleUrl)
Description copied from class: Feature
fluent setter
Overrides: withStyleUrl
in class Feature
Parameters: styleUrl
- required parameterSee Also: Feature.setStyleUrl(String)
withStyleSelector
public Overlay withStyleSelector (java.util.List<StyleSelector > styleSelector)
Description copied from class: Feature
fluent setter
Overrides: withStyleSelector
in class Feature
Parameters: styleSelector
- required parameterSee Also: #setStyleSelector(List)
withRegion
public Overlay withRegion (Region region)
Description copied from class: Feature
fluent setter
Overrides: withRegion
in class Feature
Parameters: region
- required parameterSee Also: Feature.setRegion(Region)
withMetadata
public Overlay withMetadata (Metadata metadata)
Description copied from class: Feature
fluent setter
Overrides: withMetadata
in class Feature
Parameters: metadata
- required parameterSee Also: Feature.setMetadata(Metadata)
withExtendedData
public Overlay withExtendedData (ExtendedData extendedData)
Description copied from class: Feature
fluent setter
Overrides: withExtendedData
in class Feature
Parameters: extendedData
- required parameterSee Also: Feature.setExtendedData(ExtendedData)
withFeatureSimpleExtension
public Overlay withFeatureSimpleExtension (java.util.List<java.lang.Object> featureSimpleExtension)
Description copied from class: Feature
fluent setter
Overrides: withFeatureSimpleExtension
in class Feature
Parameters: featureSimpleExtension
- required parameterSee Also: #setFeatureSimpleExtension(List)
withFeatureObjectExtension
public Overlay withFeatureObjectExtension (java.util.List<AbstractObject > featureObjectExtension)
Description copied from class: Feature
fluent setter
Overrides: withFeatureObjectExtension
in class Feature
Parameters: featureObjectExtension
- required parameterSee Also: #setFeatureObjectExtension(List)
clone
public Overlay clone ()
Overrides: clone
in class Feature