My favorites | English | Sign in

Google Earth API

KmlFeature Interface Reference

Inheritance diagram for KmlFeature:

KmlObject GEEventEmitter KmlContainer KmlNetworkLink KmlOverlay KmlPlacemark KmlTour KmlDocument KmlFolder KmlGroundOverlay KmlPhotoOverlay KmlScreenOverlay KmlLayer KmlLayerRoot

List of all members.


Public Member Functions

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 ()
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

string KmlFeature.getName (  ) 

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

void KmlFeature.setName ( string  name  ) 

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

bool KmlFeature.getVisibility (  ) 

Specifies whether the feature is drawn in the 3D viewer. 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 3D viewer. 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.

bool KmlFeature.getOpen (  ) 

Default state of left panel.

void KmlFeature.setOpen ( bool  open  ) 

Default state of left panel.

string KmlFeature.getAddress (  ) 

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.

string KmlFeature.getSnippet (  ) 

Specifies a short description of the feature.

void KmlFeature.setSnippet ( string  snippet  ) 

Specifies a short description of the feature.

string KmlFeature.getDescription (  ) 

User-supplied text that appears in the description balloon.

void KmlFeature.setDescription ( string  description  ) 

User-supplied text that appears in the description balloon.

KmlAbstractView KmlFeature.getAbstractView (  ) 

Stores either the lookAt or camera view.

void KmlFeature.setAbstractView ( KmlAbstractView  abstractView  ) 

Stores either the lookAt or camera view.

string KmlFeature.getStyleUrl (  ) 

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.

KmlStyleSelector KmlFeature.getStyleSelector (  ) 

The style based on the current mode of the Placemark.

void KmlFeature.setStyleSelector ( KmlStyleSelector  styleSelector  ) 

The style based on the current mode of the Placemark.

KmlRegion KmlFeature.getRegion (  ) 

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.

KmlFeature KmlFeature.getPreviousSibling (  ) 

Returns previous sibling node within the container.

KmlFeature KmlFeature.getNextSibling (  ) 

Returns the next sibling node within the container.

float KmlFeature.getOpacity (  ) 

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.