Class: KML

Constructor

new KML(name, optionsopt)

Parameters:

Name	Type	Attributes	Description
`name`	string
`options`	*	<optional>

Source: layer/KML.ts, line 13

Extends

Vector

Members

_id

Overrides: Vector#_id
Source: layer/Layer.ts, line 452

(protected) _pickingColor :Vec3

Layer picking color. Assign when added to the planet.

Type:

Vec3

Overrides: Vector#_pickingColor
Source: layer/Layer.ts, line 304

pickingEnabled

Set layer picking events active.

Overrides: Vector#pickingEnabled
Source: layer/Vector.ts, line 530

planet

Returns planet instance.

Overrides: Vector#planet
Source: layer/Layer.ts, line 568

Methods

(abstract, protected) _assignPlanet(planet)

Assign the planet.

Parameters:

Name	Type	Description
`planet`	Planet	Planet render node.

Overrides: Vector#_assignPlanet
Source: layer/Layer.ts, line 469

_bindEventsDefault(entityCollection)

Parameters:

Name	Type	Description
`entityCollection`

Overrides: Vector#_bindEventsDefault
Source: layer/Vector.ts, line 742
To Do: (refactoring) could be used in somethig like bindEntityCollectionQuad(...)

(abstract, protected) _bindPicking()

Assign picking color to the layer.

Overrides: Vector#_bindPicking
Source: layer/Layer.ts, line 511

(protected) _convertCoordonatesIntoEntities(coordonates, color) → {any}

Creates billboards or polylines from array of lonlat.

Parameters:

Name	Type	Description
`coordonates`	Array
`color`	string

Source: layer/KML.ts, line 208

Returns:

Type:: any

(protected) _correctFullExtent()

Special correction of the whole globe extent.

Overrides: Vector#_correctFullExtent
Source: layer/Layer.ts, line 817

_createEntityCollectionsTree()

Overrides: Vector#_createEntityCollectionsTree
Source: layer/Vector.ts, line 689

(protected) _getXmlContent() → {Document}

Source: layer/KML.ts, line 249

Returns:

Type:: Document

(protected) _parseKMLcoordinates()

Source: layer/KML.ts, line 63

(protected) _reindexEntitiesArray(startIndex)

Refresh collected entities indexes from startIndex entities collection array position.

Parameters:

Name	Type	Description
`startIndex`	number	Entity array index.

Overrides: Vector#_reindexEntitiesArray
Source: layer/Vector.ts, line 561

abortMaterialLoading(material)

Abort exact material loading.

Parameters:

Name	Type	Description
`material`	Material	Segment material.

Inherited From: Vector#abortMaterialLoading
Source: layer/Vector.ts, line 1042

add(entity, rightNowopt) → {Vector}

Adds entity to the layer.

Parameters:

Name	Type	Attributes	Default	Description
`entity`	Entity			Entity.
`rightNow`	boolean	<optional>	false	Entity insertion option. False is default.

Overrides: Vector#add
Source: layer/Vector.ts, line 346

Returns:

Returns this layer.

Type:: Vector

addEntities(entities, rightNowopt) → {Vector}

Adds entity array to the layer.

Parameters:

Name	Type	Attributes	Default	Description
`entities`	Array.<Entity>			Entities array.
`rightNow`	boolean	<optional>	false	Entity insertion option. False is default.

Overrides: Vector#addEntities
Source: layer/Vector.ts, line 444

Returns:

Returns this layer.

Type:: Vector

(async) addKmlFromFiles(kmls, coloropt, billboardopt) → {Promise.<{entities: Array.<Entity>, extent: Extent}>}

Parameters:

Name	Type	Attributes
`kmls`	Array.<File>
`color`	string	<optional>
`billboard`	Billboard	<optional>

Source: layer/KML.ts, line 275

Returns:

Type:: Promise.<{entities: Array.<Entity>, extent: Extent}>

(async) addKmlFromUrl(url, coloropt, billboardopt) → {Promise.<{entities: Array.<Entity>, extent: Extent}>}

Parameters:

Name	Type	Attributes	Description
`url`	string		Url of the KML to display. './myFile.kml' or 'http://mySite/myFile.kml' for example.
`color`	string	<optional>
`billboard`	Billboard	<optional>

Source: layer/KML.ts, line 322

Returns:

Type:: Promise.<{entities: Array.<Entity>, extent: Extent}>

addTo(planet) → {Vector}

Adds layer to the planet.

Parameters:

Name	Type	Description
`planet`	Planet	Planet scene object.

Overrides: Vector#addTo
Source: layer/Vector.ts, line 284

Returns:

Type:: Vector

bringToFront()

Set zIndex to the maximal value depend on other layers on the planet.

Overrides: Vector#bringToFront
Source: layer/Layer.ts, line 634

clear()

TODO: Clear the layer.

Overrides: Vector#clear
Source: layer/Vector.ts, line 593

each(callback)

Safety entities loop.

Parameters:

Name	Type	Description
`callback`

Overrides: Vector#each
Source: layer/Vector.ts, line 622

flyExtent()

Fly extent.

Overrides: Vector#flyExtent
Source: layer/Layer.ts, line 801

getAttribution() → {string}

Gets layer attribution.

Overrides: Vector#getAttribution
Source: layer/Layer.ts, line 587

Returns:

Layer attribution

Type:: string

getEntities() → {Array.<Entity>}

Returns stored entities.

Overrides: Vector#getEntities
Source: layer/Vector.ts, line 309

Returns:

Type:: Array.<Entity>

getExtent() → {Extent}

Gets layer extent.

Overrides: Vector#getExtent
Source: layer/Layer.ts, line 782

Returns:

Layer geodetic extent.

Type:: Extent

getExtentMerc() → {Extent}

Gets layer web-mercator extent.

Overrides: Vector#getExtentMerc
Source: layer/Layer.ts, line 791

Returns:

Layer extent.

Type:: Extent

getHeight() → {number}

Gets layer height.

Overrides: Vector#getHeight
Source: layer/Layer.ts, line 606

Returns:

Type:: number

getID() → {string}

Gets layer identifier.

Overrides: Vector#getID
Source: layer/Layer.ts, line 439

Returns:

Layer object id.

Type:: string

getVisibility() → {boolean}

Gets layer visibility.

Overrides: Vector#getVisibility
Source: layer/Layer.ts, line 750

Returns:

Layer visibility.

Type:: boolean

getZIndex() → {number}

Gets z-index.

Overrides: Vector#getZIndex
Source: layer/Layer.ts, line 625

Returns:

Type:: number

(abstract) hasImageryTiles() → {boolean}

Returns true if a layer has imagery tiles.

Overrides: Vector#hasImageryTiles
Source: layer/Layer.ts, line 429

Returns:

Imagery tiles flag.

Type:: boolean

insert(entity, index, rightNowopt) → {Vector}

Adds entity to the layer in the index position.

Parameters:

Name	Type	Attributes	Default	Description
`entity`	Entity			Entity.
`index`	Number			Index position.
`rightNow`	boolean	<optional>	false	Entity insertion option. False is default.

Overrides: Vector#insert
Source: layer/Vector.ts, line 364

Returns:

Returns this layer.

Type:: Vector

isBaseLayer() → {boolean}

Returns true if the layer is a base.

Overrides: Vector#isBaseLayer
Source: layer/Layer.ts, line 648

Returns:

Base layer flag.

Type:: boolean

isEqual(layer) → {boolean}

Compares layers instances.

Parameters:

Name	Type	Description
`layer`	Layer	Layer instance to compare.

Overrides: Vector#isEqual
Source: layer/Layer.ts, line 459

Returns:

Returns true if the layers is the same instance of the input.

Type:: boolean

(abstract) loadMaterial(material)

Start to load tile material.

Parameters:

Name	Type	Description
`material`	Material	Current material.

Overrides: Vector#loadMaterial
Source: layer/Vector.ts, line 1020

remove() → {Layer}

Removes from planet.

Overrides: Vector#remove
Source: layer/Layer.ts, line 531

Returns:

-This layer.

Type:: Layer

removeEntities(entities) → {Vector}

Removes entities from layer.

Parameters:

Name	Type	Description
`entities`	Array.<Entity>	Entity array.

Overrides: Vector#removeEntities
Source: layer/Vector.ts, line 573

Returns:

Returns this layer.

Type:: Vector

removeEntity(entity) → {Vector}

Remove entity from layer. TODO: memory leaks.

Parameters:

Name	Type	Description
`entity`	Entity	Entity to remove.

Overrides: Vector#removeEntity
Source: layer/Vector.ts, line 459

Returns:

Returns this layer.

Type:: Vector

setAttribution(html)

Sets layer attribution text.

Parameters:

Name	Type	Description
`html`	string	HTML code that represents layer attribution, it could be just a text.

Overrides: Vector#setAttribution
Source: layer/Layer.ts, line 575

setBaseLayer(isBaseLayer)

Sets base layer type true.

Parameters:

Name	Type	Description
`isBaseLayer`	boolean

Overrides: Vector#setBaseLayer
Source: layer/Layer.ts, line 657

setColor(color)

Parameters:

Name	Type	Description
`color`	string

Source: layer/KML.ts, line 296

setEntities(entities) → {Vector}

Removes current entities from layer and adds new entities.

Parameters:

Name	Type	Description
`entities`	Array.<Entity>	New entity array.

Overrides: Vector#setEntities
Source: layer/Vector.ts, line 635

Returns:

Returns layer instance.

Type:: Vector

setExtent(extent)

Sets visible geographical extent.

Parameters:

Name	Type	Description
`extent`	Extent	Layer visible geographical extent.

Overrides: Vector#setExtent
Source: layer/Layer.ts, line 759

setHeight(height)

Sets height over the ground.

Parameters:

Name	Type	Description
`height`	number	Layer height.

Overrides: Vector#setHeight
Source: layer/Layer.ts, line 596

(abstract) setVisibility(visibility)

Sets layer visibility.

Parameters:

Name	Type	Description
`visibility`	boolean	Layer visibility.

Overrides: Vector#setVisibility
Source: layer/Layer.ts, line 672

setZIndex(zIndex)

Sets z-index.

Parameters:

Name	Type	Description
`zIndex`	number	Layer z-index.

Overrides: Vector#setZIndex
Source: layer/Layer.ts, line 615

viewExtent()

View extent.

Overrides: Vector#viewExtent
Source: layer/Layer.ts, line 809