Class: KmlLineString

KmlLineString(options)

Class representing LineString element of KmlFile

Constructor

new KmlLineString(options)

Constructs an KmlLineString object. Applications shouldn't use this constructor. It is used by KmlFile. KmlLineString represents one line string.
Parameters:
Name Type Description
options Object
Properties
Name Type Description
objectNode Node Node representing LineString.
Source:
See:

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) kmlAltitudeMode :String

It represents different modes to count absolute altitude. Possible choices are explained in: https://developers.google.com/kml/documentation/kmlreference#point
Type:
  • String
Source:

(readonly) kmlCenter :Position

Returns average of the positions, which are part of the LineString. It averages also the altitudes.
Type:
Source:

(readonly) kmlExtrude :Boolean

Whether current shape should be extruded.
Type:
  • Boolean
Source:

(readonly) kmlPositions :Array.<Position>

Positions representing points used by the LineString.
Type:
Source:

(readonly) kmlTessellate :Boolean

Whether tessellation should be used for current node.
Type:
  • Boolean
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:

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

createPath(styles)

It creates Path representing this LineString unless already initialized.
Parameters:
Name Type Description
styles Object | null
Properties
Name Type Description
normal KmlStyle Style applied when item not highlighted
highlight KmlStyle Style applied when item is highlighted
Source:

equals(toCompare) → {Boolean}

Two line strings are equal when the properties and positions are equal.
Parameters:
Name Type Description
toCompare KmlLineString LineString to compare to.
Source:
Returns:
True if the LineStrings are equal.
Type
Boolean

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:

moveValidProperties()

Moves KML properties from current object into the internal shape representation.
Source:

prepareAttributes()

Source:

prepareLocations() → {Array.<Position>}

Prepare locations representing current Line String.
Source:
Returns:
Positions representing this LineString.
Type
Array.<Position>

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: