GEPlugin Interface Reference
List of all members.
Detailed Description
The
GEPlugin is the Google Earth Plug-in's main object, and this is the object that is returned to the JavaScript application when you first create a plug-in instance.
GEPlugin provides factory methods for ructing other objects (placemarks, and so on), and is also used to retrieve the root document objects.
Member Function Documentation
Parse a string of KML and return a handle to the root of the KML object structure that was created.
Creates a placemark on the globe. A Placemark is a feature with associated Geometry. A Placemark with a Point has an icon associated with it that marks a point on the Earth in the 3D viewer. (In the Google Earth 3D viewer, a Point Placemark is the only object you can click or roll over. Other Geometry objects do not have an icon in the 3D viewer. To allow the user to click in the 3D viewer, you would need to create a MultiGeometry object that contains both a Point and the other Geometry object.)
- Parameters:
-
| KmlPoint GEPlugin.createPoint |
( |
string |
id |
) |
|
Creates a point on the globe. Specifies the geographic location defined by longitude, latitude, and (optional) altitude.
- Parameters:
-
Creates a line string on Google Earth.
- Parameters:
-
| id | location of the new string. |
| KmlFolder GEPlugin.createFolder |
( |
string |
id |
) |
|
Creates a folder. A KMLFolder is used to arrange other features hierarchically (Folders, Placemarks, NetworkLinks, or Overlays). A feature is visible only if it and all its ancestors are visible.
- Parameters:
-
| KmlLod GEPlugin.createLod |
( |
string |
id |
) |
|
Creates level of detail (LOD). LOD describes the size of the projected region on the screen that is required in order for the region to be considered active. Also specifies the size of the pixel ramp used for fading in (from transparent to opaque) and fading out (from opaque to transparent).
- Parameters:
-
Creates a LatLonBox, a bounding box that describes an area of interest defined by geographic coordinates and altitudes.
- Parameters:
-
| id | ID of the new LatLonBox |
Creates a LatLonAltBox, a bounding box that describes an area of interest defined by geographic coordinates and altitudes.
- Parameters:
-
| id | ID of the new LatLonAltBox |
Creates a Document. A Document is a container for features and styles.
- Parameters:
-
| id | ID of the new KML document. |
| KmlRegion GEPlugin.createRegion |
( |
string |
id |
) |
|
Creates a Region in Google Earth. A Region contains a bounding box that describes an area of interest defined by geographic coordinates and altitudes.
- Parameters:
-
| id | ID of the new KML region. |
Specifies the exact coordinates of the Model's origin in latitude, longitude, and altitude. Latitude and longitude measurements are standard lat-lon projection with WGS84 datum. Altitude is distance above the earth's surface, in meters, and is interpreted according to altitudeMode.
- Parameters:
-
| id | ID of the new KML location. |
Sets the rotation of a 3D model's coordinate system to position the object in Google Earth.
- Parameters:
-
| id | ID of the new KMLOrientation. |
| KmlScale GEPlugin.createScale |
( |
string |
id |
) |
|
Sets the scale of a model along the x, y, and z axes in the model's coordinate space.
- Parameters:
-
| KmlModel GEPlugin.createModel |
( |
string |
id |
) |
|
Creates a model. A model is a 3D object described in a COLLADA file. COLLADA files have a .dae file extension. Models are created in their own coordinate space and then located, positioned, and scaled in Google Earth.
- Parameters:
-
| KmlStyle GEPlugin.createStyle |
( |
string |
id |
) |
|
A Style defines an addressable style group that can be referenced by StyleMaps and features.
- Parameters:
-
| id | ID of the new KMLStyle object. |
Creates a LinearRing. A LinearRing defines a closed line string, typically the outer boundary of a Polygon. Optionally, a LinearRing can also be used as the inner boundary of a Polygon to create holes in the Polygon.
- Parameters:
-
Creates a Polygon. A Polygon is defined by an outer boundary and 0 or more inner boundaries.
- Parameters:
-
| id | ID of the new Polygon. |
| KmlIcon GEPlugin.createIcon |
( |
string |
id |
) |
|
Creates an Icon. An icon defines an image associated with an Icon style or overlay.
- Parameters:
-
| KmlLink GEPlugin.createLink |
( |
string |
id |
) |
|
Creates a Link. A Link specifies the location of KML files fetched by network links, image files used in any overlay, or model files used with the Model object.
- Parameters:
-
Creates a GroundOverlay. A GroundOverlay draws an image overlay draped onto the terrain.
- Parameters:
-
Creates a NetworkLink. A NetworkLink references a KML file or KMZ archive on a local or remote network.
- Parameters:
-
Creates a ScreenOverlay. A ScreenOverlay draws an image overlay fixed to the screen.
- Parameters:
-
Creates a container for one or more geometry primitives associated with the same feature.
- Parameters:
-
Creates a StyleMap. A StyleMap maps between two different icon styles. Typically, a StyleMap is used to provide separate normal and highlighted styles for a Placemark, so that the highlighted version appears when the user mouses over the icon in Google Earth.
| KmlLookAt GEPlugin.createLookAt |
( |
string |
id |
) |
|
Creates a new LookAt. A LookAt element positions the camera view in relation to an object that is being viewed.
| KmlCamera GEPlugin.createCamera |
( |
string |
id |
) |
|
Creates a new Camera. This element positions the camera relative to the Earth's surface and defines the view direction.
Creates a Feature balloon.
- Parameters:
-
Creates an HTML string balloon.
- Parameters:
-
Creates an Html Div Balloon.
- Parameters:
-
Returns the currently active balloon, or null.
Sets the given balloon as the active balloon, replacing any existing active balloon. If the given feature is visible, then the balloon is displayed. Otherwise, the balloon is hidden.
If the argument is null, then any existing active balloon will be hidden.
| string GEPlugin.getEarthVersion |
( |
|
) |
|
Used for debugging purposes; if this value is not equal to the value returned by getPluginVersion then there is a misconfiguration on the end user's system. This check is automatically done during plugin instantiation.
| string GEPlugin.getPluginVersion |
( |
|
) |
|
The version of the Google Earth Plug-in installed on the end user's machine.
| string GEPlugin.getApiVersion |
( |
|
) |
|
The version of the JavaScript API that the Google Earth Plug-in installed on the end user's machine is capable of interfacing with.
The options used to manipulate the behavior of the Google Earth plugin.
Controls the window options.
Controls the globe behavior.
| GESun GEPlugin.getSun |
( |
|
) |
|
Displays the dawn to dusk views.
Controls built-in layer behavior.
Controls the plugin viewport.
Controls the navigation controls on the globe.
The top-level features currently in the Earth object.
Exposes functionality for interacting with KML tours.
Exposes functionality for interacting with photo overlays.
| float GEPlugin.getStreamingPercent |
( |
|
) |
|
Returns a number between 0 and 100 (inclusive) that indicates the progress of the streaming of imagery for the current view.
A value of 100 means that the imagery is completely streamed in.
| void GEPlugin.frameend |
( |
|
) |
|
Event fired when Earth has finished rendering the viewport. This event will be called many times in succession when the viewport is changing. Add a listener for this event and make incremental changes to the viewport for smooth animation.
| void GEPlugin.balloonclose |
( |
|
) |
|
Event fired when the current balloon is closed.
Member Data Documentation
Specifies that altitudes are at ground level. For Ground overlays, this means that the image will be draped over the terrain.
Specifies that altitudes are to be interpreted as meters above or below ground level (i.e. the elevation of the terrain at the location).
Specifies that altitudes are to be interpreted as meters above or below sea level, regardless of the actual elevation of the terrain beneath the object. For example, if you set the altitude of an object to 10 meters with an absolute altitude mode, the object will appear to be at ground level if the terrain beneath is also 10 meters above sea level. If the terrain is 3 meters above sea level, the object will appear elevated above the terrain by 7 meters. If, on the other hand, the terrain is 15 meters above sea level, the object may be completely invisible.
Specifies that altitudes are at sea floor level.
Specifies that altitudes are to be interpreted as meters above sea floor (i.e. the elevation of the sea floor at the location).
Refresh when the file is loaded and whenever the Link parameters change. This refresh mode is the default.
Refresh every n seconds (specified in refreshInterval).
Refresh when the expiration time is reached. If a fetched file has a NetworkLinkControl, the expires time takes precedence over expiration times specified in HTTP headers. If no expires time is specified, the HTTP max-age header is used (if present). If max-age is not present, the Expires HTTP header is used (if present).
Ignore changes in the view. Also ignore viewFormat parameters, if any. This view refresh mode is the default.
Refresh n seconds after movement stops, where n is specified in viewRefreshTime.
Refresh only when the feature's Region becomes active.
Screen coordinates are to be interpreted as a fraction of an item, like an image or Google Earth window.
Screen coordinates are to be interpreted as pixels from the left or bottom edge.
Screen coordinates are to be interpreted as pixels from the top or right edge.
Apply no color mode effect, i.e. use the base color as is.
Apply a random linear scale to the base color. See the KML <colorMode> documentation for more details.
Inherit the color mode from ancestor styles.
The Earth map type, used with GEOptions' setMapType
The Sky map type, used with GEOptions' setMapType
Hide the navigation control.
Show the navigation control always.
Automatically show or hide the navigation control depending on user interaction.
Specifies that fly-to should happen immediately, without a smooth transition.
The Layer ID of the terrain layer. Use as an argument to getLayerById() or enableLayerById().
The Layer ID of the roads layer. Use as an argument to getLayerById() or enableLayerById().
The Layer ID of the photorealistic buildings layer. Use as an argument to getLayerById() or enableLayerById().
The Layer ID of the low resolution (gray) buildings layer. Use as an argument to getLayerById() or enableLayerById(). Note that as photorealistic buildings continue to be created and added to the LAYER_BUILDINGS layer, the low-resolution version of those buildings will be removed from this layer. This layer will therefore change over time.
The Layer ID of the borders layer. Use as an argument to getLayerById() or enableLayerById().
When using the GEView.hitTest method, this mode samples the globe (the earth's sphere at altitude 0, without terrain or buildings).
When using the GEView.hitTest method, this mode samples the earth's terrain (the ground surface, including variations in altitude).
The feature's visibility is tied to its list item's checkbox state.
When specified for a folder, document or network link, prevents all items from being made visible at once—that is, the user can turn all children off but cannot turn them all on at the same time. This setting is useful for containers or network links containing large amounts of data.
Use a normal checkbox for visibility but do not display children in a list view. The item's checkbox should allows the user to toggle visibility of the child objects in the viewport.
When specified for a container (a folder or a document), only one of the container's items should be visible at a time.
|
