Object Inheritance Graph¶

  --- Constructor -+- Base --- Folder    --- Document
                   |        |
                   |        +- Placemark -+- Point
                   |        |             +- LineString
                   |        |             +- LinearRing
                   |        |
                   |        +- StyleBase -+- Style
                   |        |             +- StyleMap
                   |        |
                   |        +- NetworkLink
                   |
                   +- LookAt

Constructors that append to the parent folder object¶

Folder, NetworkLink, Point, LineString, LinearRing

Constructors that return objects for future use¶

LookAt(), Style(), StyleMap()

Wrappers (what makes it easy)¶

Style => IconStyle, LineStyle, PolyStyle, LabelStyle, ListStyle

Point => MultiPoint

new¶

  my $document=Geo::GoogleEarth::Pluggable->new(name=>"My Name");

type¶

Returns the object type.

  my $type=$folder->type;

document¶

Returns the document object.

All objects know to which document they belong even the document itself!

render¶

Returns an XML document with an XML declaration and a root name of "Document"

  print $document->render;

archive¶

Returns a KMZ formatted Zipped archive of the XML document

  print $document->archive;

xmlns¶

Add or update a namespace

  $document->xmlns->{"namespace"}=$url;

Delete a namespace

  delete($document->xmlns->{"xmlns:gx"});

Replace all namespaces

  $document->{"xmlns"}={namespace=>$url};

Reset to default namespaces

  delete($document->{"xmlns"});

nextId¶

This method is in the document since all Styles and StyleMaps are in the document not folders.

  my $id=$document->nextId($type); #$type in "Style" or "StyleMap"

header, header_kml¶

Returns a header appropriate for a web application

  Content-type: application/vnd.google-earth.kml+xml
  Content-Disposition: attachment; filename=filename.xls
  $document->header                                                       #embedded in browser
  $document->header(filename=>"filename.xls")                             #download prompt
  $document->header(content_type=>"application/vnd.google-earth.kml+xml") #default content type

header_kmz¶

Returns a header appropriate for a web application

  Content-type: application/vnd.google-earth.kml+xml
  Content-Disposition: attachment; filename=filename.xls
  $document->header_kmz                                                   #embedded in browser
  $document->header_kmz(filename=>"filename.xls")                         #download prompt
  $document->header_kmz(content_type=>"application/vnd.google-earth.kmz") #default content type

Not So Pretty XML¶

The XML produced by XML::LibXML is not "pretty". If you need pretty XML you must pass the output through xmllint or a simular product.

For example:

  perl -MGeo::GoogleEarth::Pluggable -e "print Geo::GoogleEarth::Pluggable->new->render" | xmllint --format -

Write Only¶

This package can only write KML and KMZ files. However, if you need to read KML files, please see the Geo::KML package's "from" method.