Parameter

Type

Description

url

String

GeoJSON url

options

Object

(optional) layer options

set object

Properties

Type

Description

extent

sg.geometry.Extent

layer extent

graphics

Array.<sg.Graphic>

array of Graphic

infoTemplate

sg.InfoTemplate

the Graphic information template displayed in the information dialog box

loadError

Error

contains value if layer loading failed

map

MapBase

The target MapBase into which layer(s) will be added

maxScale

Number

maximum visible scale

minScale

Number

minimum visible scale

mouseEventEnabled

Boolean

whether to enable mouse event

name

Error

layer name

node

DOMNODE

layer html node

opacity

number

transparency whose range is from 0 to 1

renderer

sg.renderers.Render

layer renderer

surface

Object

the surface on which the layer is drawn

svgContainer

DOMNODE

the div of layer

title

String

layer title

visible

boolean

whether the layer is visible

Methods

Type

Description

add(graphic)

sg.Graphic

add a graphic to GraphicsLayer

graphic: Graphic

clear()

clear all graphics

disableMouseEvents()

disable mouse events

enableMouseEvents()

enable mouse events

getMap()

Returns:

MapBase

return the MapBase of the layer

getName()

Returns:

String

return layer name

getNode()

Returns:

DOMNODE

return the div of the layer

getTitle()

Returns:

String

return all layer title

getVisible()

Returns:

Boolean

return layer visibility

hide()

hide layer

Initialize()

called when layer being added to the MapBase

isVisibleAtScale(scale)

scale:number

Returns:Boolean

return if the layer is visible at the specific scale

putName()

String

set layer name

putTitle()

String

set layer title

putVisible(newVal)

String

set layer visibility

RebuildElement()

rebuild all elements

redraw()

redraw layers

remove(graphic)

sg.Graphic

remove a specific graphic

graphic: Graphic

RemoveSelf()

remove the layer

setInfoTemplate(temp)

sg.InfoTemplate        

set InfoTemplate

temp: information template

setMaxScale(maxScale)

Number

set the maximum visible scale of the layer

setMinScale(minScale)

Number

set the minimum visible scale of the layer

setOpacity(opacity)

Number

set layer transparency

opacity: layer transparency

setRenderer(layer Renderer)

sg.renderers.Renderer

set layer renderer

setVisibility(if visibile)

newVal

set layer visibility

show()

show layer

UpdateElement()

update layer

Event

Description

click

triggered when mouse is clicked on graphics

graphic: Graphic

dbl-click

triggered when mouse is double-clicked on graphics

graphic: Graphic

drag

triggered while mouse is dragged.

graphic: Graphic

drag-end

triggered while mouse button is released

graphic: Graphic

drag-start

triggered when mouse button is pressed and the cursor is dragged

grapgic-add

triggered when a graphic is added

graphic：the graphic which is added

grapgic-clear

triggered when all graphics are cleared

graphic：the graphics that are cleared

grapgic-remove

triggered when a graphic is removed

graphic: the graphic which is removed

load

triggered when layer loading is accomplished

mouse-down

triggered when mouse button is pressed down on a graphic

graphic: Graphic

mouse-move

triggered when mouse is moved on a graphic

graphic: Graphic

mouse-out

triggered when mouse is moved out from a graphic

graphic: Graphic

mouse-over

triggered when mouse is moved onto a graphic

graphic: Graphic

mouse-up

triggered when mouse-click is released on a graphic

graphic: Graphic