Class: KmlNetworkLink

KmlNetworkLink(options)

Contains the data associated with NetworkLink node.

Constructor

Constructs an KmlNetworkLink. 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 NetworkLink
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) kmlAbstractView :KmlAbstractView

It represents one of the AbstractViews associated with current Feature. Specific implementation of AbstractView will be returned.
Type:
Inherited From:
Source:

(readonly) kmlAddress :String

It represents unstructured address associated with the Feature.
Type:
  • String
Inherited From:
Source:

(readonly) kmlDescription :String

It represents description of this feature. It can be displayed as a part of the feature.
Type:
  • String
Inherited From:
Source:

(readonly) kmlFlyToView :Boolean

Boolean value. A value of 1 causes Google Earth to fly to the view of the LookAt or Camera in the NetworkLinkControl (if it exists). If the NetworkLinkControl does not contain an AbstractView element, Google Earth flies to the LookAt or Camera element in the Feature child within the <kml> element in the refreshed file. If the <kml> element does not have a LookAt or Camera specified, the view is unchanged. For example, Google Earth would fly to the <LookAt> view of the parent Document, not the <LookAt> of the Placemarks contained within the Document.
Type:
  • Boolean
Source:
Type:
Source:
See:

(readonly) kmlName :String

Name of this feature. Every feature should have name.
Type:
  • String
Inherited From:
Source:

(readonly) kmlOpen :Boolean

It is applied only to Document, Folder and NetworkLink and represents whether they should be rendered collapsed or expanded.
Type:
  • Boolean
Inherited From:
Source:

(readonly) kmlPhoneNumber :String

It represents phone number associated with current feature. Quite probably irrelevant information.
Type:
  • String
Inherited From:
Source:

(readonly) kmlRefreshVisibility :Boolean

Boolean value. A value of 0 leaves the visibility of features within the control of the Google Earth user. Set the value to 1 to reset the visibility of features each time the NetworkLink is refreshed. For example, suppose a Placemark within the linked KML file has <visibility> set to 1 and the NetworkLink has <refreshVisibility> set to 1. When the file is first loaded into Google Earth, the user can clear the check box next to the item to turn off display in the 3D viewer. However, when the NetworkLink is refreshed, the Placemark will be made visible again, since its original visibility state was TRUE.
Type:
  • Boolean
Source:

(readonly) kmlRegion :KmlRegion

Features and geometry associated with a Region are drawn only when the Region is active. See <Region>.
Type:
Inherited From:
Source:

(readonly) kmlSnippet :String

A short description of the feature. In Google Earth, this description is displayed in the Places panel under the name of the feature. If a Snippet is not supplied, the first two lines of the <description> are used. In Google Earth, if a Placemark contains both a description and a Snippet, the <Snippet> appears beneath the Placemark in the Places panel, and the <description> appears in the Placemark's description balloon. This tag does not support HTML markup. <Snippet> has a maxLines attribute, an integer that specifies the maximum number of lines to display.
Type:
  • String
Inherited From:
Source:

(readonly) kmlStyleSelector :KmlStyle

One style element per Feature, with possible children of different substyles.
Type:
Inherited From:
Source:

(readonly) kmlStyleUrl :String

URL of a <Style> or <StyleMap> defined in a Document. If the style is in the same file, use a # reference. If the style is defined in an external file, use a full URL along with # referencing. If it references remote URL, this server must support CORS for us to be able to download it.
Type:
  • String
Inherited From:
Source:

(readonly) kmlTimePrimitive :KmlTimePrimitive

It represents one of the TimePrimitives associated with current Feature. Specific implementation of TimePrimitive will be returned.
Type:
Inherited From:
Source:

(readonly) kmlVisibility :Boolean

Visibility of current feature. It is possible for some features to be invisible.
Type:
  • Boolean
Inherited From:
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

fireEvent(kmlOptions)

It fires event when the kmlLink refreshMode contains refreshMode.
Parameters:
Name Type Description
kmlOptions Object
Properties
Name Type Description
listener RefreshListener Object which allows you to schedule events, which will be triggered at some point in future. It doesn't have to be exactly that time.
Source:

getStyle() → {Promise|undefined}

It retrieves the style for current element, regardless of whether it is local or remote.
Inherited From:
Source:
Returns:
Promise of the file to deliver
Type
Promise | undefined

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>

handleRefresh(kmlOptions)

It handles refreshing strategy of the NetworkLink.
Parameters:
Name Type Description
kmlOptions Object
Properties
Name Type Description
activeEvents Array.<RefreshListener.Event> Events which should be processed in this round of render.
Source:

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.
Overrides:
Source:

solveRegion(dc) → {boolean}

Internal use only It solves whether the feature should be visible based on the Region.
Parameters:
Name Type Description
dc DrawContext Draw context associated with current processing.
Inherited From:
Source:
Returns:
true if there is no region or the feature is in the region.
Type
boolean

solveStyle(dc, kmlOptions)

Internal use only It solves style which should be applied to current feature.
Parameters:
Name Type Description
dc DrawContext DrawContext associated with current processing.
kmlOptions Object
Properties
Name Type Description
lastStyle KmlStyle Style representing the one to apply to current information.
Inherited From:
Source:

solveTimeVisibility()

Internal function for solving the visibility based on time. The element is visible when its whole range is inside the selected time range.
Inherited From:
Source:

solveVisibility(dc, kmlOptions)

Internal use only It solves whether current feature should be visible. It takes into account the visibility of parent elements, Time constraints, region, visibility.
Parameters:
Name Type Description
dc DrawContext Draw context associated with current processing.
kmlOptions Object
Inherited From:
Source: