<< Click to Display Table of Contents >>

 

new sg.layers.KMLLayer(id, url, options)

 

 

Description

Create a KMLLayer object.

 

Position

KMLLayer.js

 

 

Parameters

 

Parameter

Type

Description

id

String

ID

url

String

KML URL

options

Object

layer options

set object

Name

Type

Description

outSR

sg.SpatialReference

export SpatialReference, only support WebMercator(EPSG3857)

opacity

Number

transparency

0:transparent
1:opaque

visible

Boolean

visibility

True:visible
False:invisible

refreshInterval

Number

interval of layers refreshment (unit:minutes)

 

 

Properties

 

Properties

Type

Description

extent

sg.geometry.Extent

layer extent

graphicsLayer

String

the GraphicsLayer to add the KML features

layers

Array.<sg.layers.Layer>

sub-layer array

loadError

Error

contains value when the layer is failed to load

map

MapBase

target MapBase

maxscale

Number

Maximum visible scale

minscale

Number

Minimum visible scale

name

Error

layer name

node

DOMNODE

layer node

opacity

Number

layer transparency

proxy

String

proxy service URL

refreshInterval

Number

refresh interval whose unit is 1 minute. Refreshes layers when time's up.

title

String

layer title

url

String

KML/KMZ URL

visible

Boolean

layer visibility

True: Visible
False: Invisible

 

 

 

Methods

 

Methods

Type

Description

addLayer(lyr)

sg.layers.layer

add sub-layer

Name

Type

Description

lyr

sg.layers.layer

The layer object

getLayers()

Array.<sg.layers.Layer>        

return sub-layer

Name

Type

Description

lyr

Array.<sg.layers.Layer>

The layer object

getMap()

Returns:

MapBase

return target MapBase

Returns:

Type

Description

MapBase

The target mapbase

getName()

Returns:

String

return map name

Returns:

Type

Description

String

The layer name

getNode()

Returns:

DOMNODE

return map node

Returns:

Type

Description

DOMNODE

The layer html node

getTitle()

Returns:

String

return map title

Returns:

Type

Description

String

The layer title

getVisible()

Returns:

Boolean

return map visibility

Returns:

Type

Description

Boolean

True: Visible
False: Invisible

hide()


hide layer

Initialize()


called when a layer is added to MapBase

putName(newVal)

String

set layer name

Name

Type

Description

newVal

String

The layer name

putTitle(newVal)

String

set layer title

Name

Type

Description

newVal

String

The layer title

putVisible(newVal)

Boolean        

set layer visibility

Name

Type

Description

newVal

Boolean        

True: Visible
False: Invisible

RebuildElement()


redraw layers

refresh()


refresh KML layers

removeLayer(lyr)

sg.layers.layer

remove sub-layer

RemoveSelf()


remove self

setMaxScale(maxscale)

Number

set the maximum visible scale of the layer

Name

Type

Description

maxScale

Number

The max scale for visible

setMinScale(minscale)

Number

set the minimum visible scale of the layer

Name

Type

Description

minScale

Number

The min scale for visible

setOpacity(opacity)

Number

set layer transparency

Name

Type

Description

opacity

Number

0: 100% transparent
1: No transparency

setRefreshInterval(p)

Number

set refresh interval in second

Name

Type

Description

p

Number


show()

None

show layer

UpdateElement()

None

update layers

 

 

Events

 

Event

Description

load

triggered when layer loaded

 

 

 

Example

 

 

<script type="text/javascript" src="scripts/KMLLayer.js"></script>

 

var kmlLayer = new sg.layers.KMLLayer(null, "http://sgs.supergeo.com.tw/River/traffic.kml");

 

 

 

See live example

 


©2015 Supergeo Technologies Inc.