Google Earth API

KmlFeature Interface Reference

Inheritance diagram for KmlFeature:
Inheritance graph

List of all members.

Public Member Functions

string getBalloonHtml ()
string getBalloonHtmlUnsafe ()
string getName ()
void setName (string name)
bool getVisibility ()
void setVisibility (bool visibility)
bool getOpen ()
void setOpen (bool open)
string getAddress ()
void setAddress (string address)
string getSnippet ()
void setSnippet (string snippet)
string getDescription ()
void setDescription (string description)
KmlAbstractView getAbstractView ()
void setAbstractView (KmlAbstractView abstractView)
string getStyleUrl ()
void setStyleUrl (string styleUrl)
KmlStyleSelector getStyleSelector ()
void setStyleSelector (KmlStyleSelector styleSelector)
KmlRegion getRegion ()
void setRegion (KmlRegion region)
string getKml ()
KmlFeature getPreviousSibling ()
KmlFeature getNextSibling ()
KmlTimePrimitive getTimePrimitive ()
void setTimePrimitive (KmlTimePrimitive timePrimitive)
KmlStyle getComputedStyle ()
Experimental Features
float getOpacity ()
void setOpacity (float opacity)

Detailed Description

The KmlFeature object is an abstract object and is the base for all feature types (for example Placemarks, Overlays, and NetworkLinks).

Member Function Documentation

Retrieves the contents of the feature's <ExtendedData> element. The retrieved contents are scrubbed to remove JavaScript; CSS; and iframe, embed, and object tags.

It should be safe to insert the resulting HTML into your page without concern for malicious content embedded in the feature data; however any feature depending on CSS or Javascript will not work.

Retrieves the contents of the feature's <ExtendedData> element. The contents are not scrubbed. Use this method only if you trust the source of the feature data.

string KmlFeature.getName ( )

User-defined text displayed in the plugin as the label for the object (for example, for a Placemark).

void KmlFeature.setName ( string  name)

User-defined text displayed in the plugin as the label for the object (for example, for a Placemark).

Specifies whether the feature is drawn in the plugin. In order for a feature to be visible, the visibility of all its ancestors must also be set to true. In the Google Earth List View, each feature has a checkbox that allows the user to control visibility of the feature.

void KmlFeature.setVisibility ( bool  visibility)

Specifies whether the feature is drawn in the plugin. In order for a feature to be visible, the visibility of all its ancestors must also be set to true. In the Google Earth List View, each feature has a checkbox that allows the user to control visibility of the feature.

Default state of left panel.

void KmlFeature.setOpen ( bool  open)

Default state of left panel.

Specifies a value representing an unstructured address written as a standard street, city, state address, and/or as a postal code.

void KmlFeature.setAddress ( string  address)

Specifies a value representing an unstructured address written as a standard street, city, state address, and/or as a postal code.

Specifies a short description of the feature.

void KmlFeature.setSnippet ( string  snippet)

Specifies a short description of the feature.

User-supplied text that appears in the description balloon.

void KmlFeature.setDescription ( string  description)

User-supplied text that appears in the description balloon.

Stores either the lookAt or camera view.

Stores either the lookAt or camera view.

URI of a Style or StyleMap defined in a Document. It refers to a Plug-in intitiated object.

void KmlFeature.setStyleUrl ( string  styleUrl)

URI of a Style or StyleMap defined in a Document. It refers to a Plug-in intitiated object.

The style based on the current mode of the Placemark.

The style based on the current mode of the Placemark.

Specifies region objects and their properties. A region contains a bounding box (LatLonAltBox) that describes an area of interest defined by geographic coordinates and altitudes.

void KmlFeature.setRegion ( KmlRegion  region)

Specifies region objects and their properties. A region contains a bounding box (LatLonAltBox) that describes an area of interest defined by geographic coordinates and altitudes.

string KmlFeature.getKml ( )

Returns the KML for a feature.

Returns previous sibling node within the container.

Returns the next sibling node within the container.

Returns the KmlTimeStamp or KmlTimeSpan object associated with this feature.

Attach a KmlTimeStamp or KmlTimeSpan object to this feature.

Returns the computed style of a feature, merging any inline styles with styles imported from setHref() or a StyleUrl.

Note:
Modifying the returned KmlStyle object is undefined and not recommended.

Experimental Feature — this is an experimental feature and can change (or even be removed) at any time.

The opacity of a feature, ranging from 0 (completely transparent) to 1 (complete opaque). The opacity of a folder or document will influence the opacity of child features. Thus, if a folder has an opacity of 0.5 and a child ground overlay in the folder also has an opacity of 0.5, the overlay will be drawn with an opacity of 0.25.

void KmlFeature.setOpacity ( float  opacity)

Experimental Feature — this is an experimental feature and can change (or even be removed) at any time.

The opacity of a feature, ranging from 0 (completely transparent) to 1 (complete opaque). The opacity of a folder or document will influence the opacity of child features. Thus, if a folder has an opacity of 0.5 and a child ground overlay in the folder also has an opacity of 0.5, the overlay will be drawn with an opacity of 0.25.

Authentication required

You need to be signed in with Google+ to do that.

Signing you in...

Google Developers needs your permission to do that.