Class: KmlLink

KmlLink(options)

Contains the data associated with Link node.

Constructor

Constructs an KmlLink. Applications usually don't call this constructor. It is called by KmlFile as objects from Kml file are read. This object is already concrete implementation.
Parameters:
Name Type Description
options Object
Properties
Name Type Description
objectNode Node Node representing link in the document.
Source:
See:
Throws:
If the node is null or undefined.
Type
ArgumentError

Extends

Members

displayName :String

The display name of the renderable.
Type:
  • String
Inherited From:
Default Value:
  • "Renderable"
Source:

enabled :Boolean

Indicates whether to display this renderable.
Type:
  • Boolean
Inherited From:
Default Value:
  • true
Source:

(readonly) id :String

Every object, which is part of the KML document has its identity. We will use it for changes in the document for binding.
Type:
  • String
Inherited From:
Source:

(readonly) kmlHttpQuery :String

Appends information to the query string, based on the parameters specified. (Google Earth substitutes the appropriate current value at the time it creates the query string.) The following parameters are supported: [clientVersion] [kmlVersion] [clientName] [language]
Type:
  • String
Source:

(readonly) kmlRefreshInterval :Number

Indicates to refresh the file every n seconds.
Type:
  • Number
Source:

(readonly) kmlRefreshMode :String

Specifies a time-based refresh mode, which can be one of the following: onChange - refresh when the file is loaded and whenever the Link parameters change (the default). onInterval - refresh every n seconds (specified in <refreshInterval>). onExpire - refresh the file 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). (See Section RFC261b of the Hypertext Transfer Protocol - HTTP 1.1 for details on HTTP header fields.)
Type:
  • String
Source:

(readonly) kmlViewBoundScale :Number

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.
Type:
  • Number
Source:

(readonly) kmlViewFormat :String

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.) If you specify a <viewRefreshMode> of onStop and do not include the <viewFormat> tag in the file, the following information is automatically appended to the query string: BBOX=[bboxWest],[bboxSouth],[bboxEast],[bboxNorth] This information matches the Web Map Service (WMS) bounding box specification. If you specify an empty <viewFormat> tag, no information is appended to the query string. You can also specify a custom set of viewing parameters to add to the query string. If you supply a format string, it is used instead of the BBOX information. If you also want the BBOX information, you need to add those parameters along with the custom parameters. You can use any of the following parameters in your format string (and Google Earth will substitute the appropriate current value at the time it creates the query string): [lookatLon], [lookatLat] - longitude and latitude of the point that <LookAt> is viewing [lookatRange], [lookatTilt], [lookatHeading] - values used by the <LookAt> element (see descriptions of <range>, <tilt>, and <heading> in <LookAt>) [lookatTerrainLon], [lookatTerrainLat], [lookatTerrainAlt] - point on the terrain in degrees/meters that <LookAt> is viewing [cameraLon], [cameraLat], [cameraAlt] - degrees/meters of the eyepoint for the camera [horizFov], [vertFov] - horizontal, vertical field of view for the camera [horizPixels], [vertPixels] - size in pixels of the 3D viewer [terrainEnabled] - indicates whether the 3D viewer is showing terrain
Type:
  • String
Source:

(readonly) kmlViewRefreshMode :String

Specifies how the link is refreshed when the "camera" changes. Can be one of the following: never (default) - Ignore changes in the view. Also ignore <viewFormat> parameters, if any. onStop - Refresh the file n seconds after movement stops, where n is specified in <viewRefreshTime>. onRequest - Refresh the file only when the user explicitly requests it. (For example, in Google Earth, the user right-clicks and selects Refresh in the Context menu.) onRegion - Refresh the file when the Region becomes active. See <Region>.
Type:
  • String
Source:

(readonly) kmlViewRefreshTime :Number

After camera movement stops, specifies the number of seconds to wait before refreshing the view. (See <viewRefreshMode> and onStop above.)
Type:
  • Number
Source:

(readonly) node :Node

Node of this object. It may be overridden by other users of some functions like parse.
Type:
  • Node
Inherited From:
Source:

pickDelegate :Object

Indicates the object to return as the userObject of this shape when picked. If null, then this shape is returned as the userObject.
Type:
  • Object
Inherited From:
Default Value:
  • null
Source:
See:

timeRange :Array.<Date>

An array with two elements: start time and end time of the visible range.
Type:
  • Array.<Date>
Inherited From:
Source:

userProperties :Object

An application defined object associated with this renderable. A typical use case is to associate application defined data with a picked renderable.
Type:
  • Object
Inherited From:
Default Value:
  • An empty object
Source:

Methods

getTagNames() → {Array.<String>}

Returns tag name of all descendants of abstract node or the tag name for current node.
Overrides:
Source:
Returns:
Type
Array.<String>

hook(controls, options)

It calls all controls associated with current KmlFile with the link to this.
Parameters:
Name Type Description
controls Array.<KmlControls> Controls associated with current tree.
options Object Options to pass into the controls.
Inherited From:
Source:

kmlHref(fileCache) → {String}

It returns valid URL usable for remote resources.
Parameters:
Name Type Description
fileCache KmlFileCache Cache needed to retrieve data urls from remote locations.
Source:
Returns:
URL to use
Type
String

render(dc)

Render this renderable. Some shapes actually draw themselves during this call, others only add themselves to the draw context's ordered rendering list for subsequent drawing when their renderOrdered method is called. This method is intended to be called by layers such as RenderableLayer and not by applications.
Parameters:
Name Type Description
dc DrawContext The current draw context.
Inherited From:
Source: