My favorites | English | Sign in

Google Earth API

KmlLink Interface Reference

Inheritance diagram for KmlLink:

KmlObject GEEventEmitter KmlIcon

List of all members.


Public Member Functions

string getHref ()
void setHref (string href)
KmlRefreshModeEnum getRefreshMode ()
void setRefreshMode (KmlRefreshModeEnum refreshMode)
float getRefreshInterval ()
void setRefreshInterval (float refreshInterval)
KmlViewRefreshModeEnum getViewRefreshMode ()
void setViewRefreshMode (KmlViewRefreshModeEnum viewRefreshMode)
float getViewRefreshTime ()
void setViewRefreshTime (float viewRefreshTime)
float getViewBoundScale ()
void setViewBoundScale (float viewBoundScale)
string getViewFormat ()
void setViewFormat (string viewFormat)

Detailed Description

Specifies the location of any KML files fetched by network links, image files used by icons in icon styles, ground overlays, and screen overlays, or model files used in the Model object.

Member Function Documentation

string KmlLink.getHref (  ) 

A URL (either an HTTP address or a local file specification). When the parent of Link is a NetworkLink, href is a KML file. When the parent of Link is a Model, href is a COLLADA file. When the parent of Link is an Overlay, href is an image.

void KmlLink.setHref ( string  href  ) 

A URL (either an HTTP address or a local file specification). When the parent of Link is a NetworkLink, href is a KML file. When the parent of Link is a Model, href is a COLLADA file. When the parent of Link is an Overlay, href is an image.

KmlRefreshModeEnum KmlLink.getRefreshMode (  ) 

Specifies to use a time-based refresh mode.

See also:
GEPlugin.REFRESH_ON_CHANGE

GEPlugin.REFRESH_ON_INTERVAL

GEPlugin.REFRESH_ON_EXPIRE

void KmlLink.setRefreshMode ( KmlRefreshModeEnum  refreshMode  ) 

Specifies to use a time-based refresh mode.

See also:
GEPlugin.REFRESH_ON_CHANGE

GEPlugin.REFRESH_ON_INTERVAL

GEPlugin.REFRESH_ON_EXPIRE

float KmlLink.getRefreshInterval (  ) 

Indicates to refresh the file every n seconds.

void KmlLink.setRefreshInterval ( float  refreshInterval  ) 

Indicates to refresh the file every n seconds.

KmlViewRefreshModeEnum KmlLink.getViewRefreshMode (  ) 

Specifies how the link is refreshed when the viewport changes.

See also:
GEPlugin.VIEW_REFRESH_NEVER

GEPlugin.VIEW_REFRESH_ON_STOP

GEPlugin.VIEW_REFRESH_ON_REGION

void KmlLink.setViewRefreshMode ( KmlViewRefreshModeEnum  viewRefreshMode  ) 

Specifies how the link is refreshed when the viewport changes.

See also:
GEPlugin.VIEW_REFRESH_NEVER

GEPlugin.VIEW_REFRESH_ON_STOP

GEPlugin.VIEW_REFRESH_ON_REGION

float KmlLink.getViewRefreshTime (  ) 

Specifies how the link is refreshed when the camera changes.

void KmlLink.setViewRefreshTime ( float  viewRefreshTime  ) 

Specifies how the link is refreshed when the camera changes.

float KmlLink.getViewBoundScale (  ) 

Scales the BBOX parameters before sending them to the server. A value less than 1 specifies to use less than the full view (screen). A value greater than 1 specifies to fetch an area that extends beyond the edges of the current view.

void KmlLink.setViewBoundScale ( float  viewBoundScale  ) 

Scales the BBOX parameters before sending them to the server. A value less than 1 specifies to use less than the full view (screen). A value greater than 1 specifies to fetch an area that extends beyond the edges of the current view.

string KmlLink.getViewFormat (  ) 

Specifies the format of the query string that is appended to the Link's href before the file is fetched.(If the href specifies a local file, this element is ignored.)

void KmlLink.setViewFormat ( string  viewFormat  ) 

Specifies the format of the query string that is appended to the Link's href before the file is fetched.(If the href specifies a local file, this element is ignored.)