Class: KmlNetworkLinkControl

KmlNetworkLinkControl()

new KmlNetworkLinkControl()

Controls the behavior of files fetched by a . It is direct descendant of kml and there should always be maximum one per document.
Source:

Extends

Members

(readonly) AbstractView :AbstractView

Either Camera or LookAt which will be used to fly to the location whenever the
Type:
  • AbstractView
Source:
Use this element to append a string to the URL query on the next refresh of the network link. You can use this data in your script to provide more intelligent handling on the server side, including version querying and conditional file delivery.
Type:
  • String
Source:

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) expires :Date

You can specify a date/time at which the link should be refreshed. This specification takes effect only if the in has a value of onExpire. See
Type:
  • Date
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) linkDescription :String

You can control the description of the network link from the server, so that changes made to the description on the client side are overridden by the server.You can control the description of the network link from the server, so that changes made to the description on the client side are overridden by the server.
Type:
  • String
Source:

(readonly) linkName :String

You can control the name of the network link from the server, so that changes made to the name on the client side are overridden by the server.
Type:
  • String
Source:

(readonly) linkSnippet :String

You can control the snippet for the network link from the server, so that changes made to the snippet on the client side are overridden by the server. has a maxLines attribute, an integer that specifies the maximum number of lines to display.
Type:
  • String
Source:

(readonly) maxSessionLength :Number

Specified in seconds, is the maximum amount of time for which the client NetworkLink can remain connected. The default value of -1 indicates not to terminate the session explicitly.
Type:
  • Number
Source:

(readonly) message :String

You can deliver a pop-up message, such as usage guidelines for your network link. The message appears when the network link is first loaded into Google Earth, or when it is changed in the network link control.
Type:
  • String
Source:

(readonly) minRefreshPeriod :Number

Specified in seconds, is the minimum allowed time between fetches of the file. This parameter allows servers to throttle fetches of a particular file and to tailor refresh rates to the expected rate of change to the data. For example, a user might set a link refresh to 5 seconds, but you could set your minimum refresh period to 3600 to limit refresh updates to once every hour.
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:

(readonly) Update :Update

With , you can specify any number of Change, Create, and Delete tags for a .kml file or .kmz archive that has previously been loaded with a network link. See .
Type:
  • Update
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:

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: