<< Click to Display Table of Contents >>

 

new sg.geometry.OSMLayer()

 

 

Description

Create OSMLayer object

 

Position

OSMLayer.js

 

 

Properties

 

Properties

Type

Description

extent

sg.geometry.Extent

layer extent

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

String

layer name

node

DOMNODE

layer html node

opacity

Number

layer transparency

spatialReference

sg.SpatialReference

layer coordinate system

tileInfo

sg.layers.TileInfo

tile layer info

title

String

layer title

visible

Boolean

layer visibility

True: Visible
False: Invisible

 

 

 

Methods

 

Methods

Type

Description

getMap()

Returns:

MapBase

return target MapBase

Returns:

Type

Description

MapBase

The target mapbase

getName()

Returns:

String

return layer name

Returns:

Type

Description

String

The layer name

getNode()

Returns:

DOMNODE

return layer node

Returns:

Type

Description

DOMNODE

The layer html target

getTileUrl(s, x, y)

s:Number

x:Number

y;Number

Returns:String

return the specified index of tile image. Rewrite this method to access customized tile service

Name

Type

Description

s

Number

The level of tiles

x

Number

The index in x-direction of tiles

y

Number

The index in y-direction of tiles

Returns:

Type

Description

String

The URL of the tile

getTitle()

Returns:

String

return layer title

Returns:

Type

Description

String

The layer title

getVisible()

Returns:

Boolean

return layer visibility

Returns:

Type

Description

Boolean

True: Visible
False: Invisible

hide()


his 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

removeAllImages


Remove all MapImages from the 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

show()


show layer

UpdateElement()


update layers

 

 

Events

 

Event

Description

load

triggered when layers are loaded

 

 

 

Example

 

 

 

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

 

var osm = new sg.layers.OSMLayer();

osm.url = "http://a.basemaps.cartocdn.com/dark_all/{z}/{x}/{y}.png";

 

 

See live example

 


©2015 Supergeo Technologies Inc.