The Perl Toolchain Summit needs more sponsors. If your company depends on Perl, please support this very important event.
 / 
Geo-GoogleEarth-Document-modules2
River stage zero No dependents
++
/ Geo::GoogleEarth::Document::Feature

NAME

Geo::GoogleEarth::Document::Feature - Geo::GoogleEarth::Document::Feature

SYNOPSIS

        None, Feature is an abstract class.

DESCRIPTION

Geo::GoogleEarth::Document::Feature is a Geo::GoogleEarth::Document::Base with a few other methods.

USAGE

        None, Feature is an abstract class.

CONSTRUCTOR

new

        None, Feature is an abstract class.

METHODS

type

Returns the object type.

  my $type=$Feature->type;

structure

Returns a hash reference for feeding directly into XML::Simple.

my $structure = $Feature->structure; <!-- abstract element; do not create --> <!-- Feature id="ID" --> <!-- Document,Folder, NetworkLink,Placemark, GroundOverlay,PhotoOverlay,ScreenOverlay --> <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> <!-- TimeStamp or TimeSpan --> <styleUrl>...</styleUrl> <!-- anyURI --> <StyleSelector>...</StyleSelector> <Region>...</Region> <Metadata>...</Metadata> <!-- deprecated in KML 2.2 --> <ExtendedData>...</ExtendedData> <!-- new in KML 2.2 --> <-- /Feature -->

id

address

Sets or returns address

  my $address=$placemark->address;

description

Set or returns the description. Google Earth uses this as the HTML description in the Placemark popup window.

snippet

Sets or returns the "snippet", which is the descriptive text shown in the places list. Optionally sets the maximum number of lines to show.

  my $snippet=$placemark->snippet($text);
  $placemark->snippet($text, {maxLines=>2});
  $placemark->snippet("", {maxLines=>0});        #popular setting

visibility

Sets or returns visibility

        my $visibility=$placemark->visibility;

open

Sets or returns open-ness

        my $open = $folder->open;

TimeSpan

Sets or returns TimeSpan object

   my $ts = $placemark->TimeSpan;

BUGS

SUPPORT

        Contact the author.

AUTHOR

        David Hillman
        CPAN: DAHILLMA

COPYRIGHT

This program is free software licensed under the...

        The BSD License

The full text of the license can be found in the LICENSE file included with this module.

SEE ALSO

Geo::GoogleEarth::Document creates a GoogleEarth KML Document.