KmlObject Interface Reference

Inheritance diagram for KmlObject:

List of all members.

Public Member Functions
string	getType ()
bool	equals (KmlObject compareTo)
string	getId ()
KmlObject	getParentNode ()
KmlDocument	getOwnerDocument ()
void	release ()

---

Detailed Description

The base class for all the other objects in the Google Earth Plug-in. The methods and behavior of KMLObject are inherited by all other objects. This is an abstract base class and cannot be used directly. It provides the id attribute, which allows unique identification of an object.

---

Member Function Documentation

string KmlObject.getType

(

)

The interface name (i.e. 'KmlPlacemark') of the object.

bool KmlObject.equals

(

KmlObject

compareTo

)

Test whether this object is the same as another object. Useful for Chrome and Safari, where the comparison a==b sometimes fails for plugin objects.

string KmlObject.getId

(

)

The unique ID of the KML object.

KmlObject KmlObject.getParentNode

(

)

The parent node of the KML object.

KmlDocument KmlObject.getOwnerDocument

(

)

The document that owns the KML object.

void KmlObject.release

(

)

Permanently deletes an object, allowing its ID to be reused. Attempting to access the object once it is released will result in an error.

Note:

Calling this method is not required; JavaScript's garbage collector will automatically delete unused objects after some indeterminate amount of time.