Properties

Type

Description

surface

sg.geometry.Extent

Type of vector graphics surface used to draw graphics.

graphics

Array.<sg.Graphic>

An array of graphics which make up the layer.

maxScale

sg.InfoTemplate

Maximum visible scale of the layer.

minScale

Error

Minimum visible scale of the layer.

opacity

Number

Layer opacity.

renderer

Number

Definition of graphic render.

visible

Boolean

Layer visibility.

extent

Error

layer extent

infoTemplate

DOMNODE

the message shown in the info window of the graphic

loadError

Number

contains value if layer is failed to loaded

mouseEventEnabled

sg.renderers.Render

whether to enable mouse event

node

Object

layer html node

name

DOMNODE

layer name

svgContainer

String

the div of layer

title

Boolean

layer title

Methods

Type

Description

add(graphic)

sg.Graphic

Add a graphic.

clear()

Clear all graphics.

disableMouseEvents()

Disable all mouse events on the graphic layer.

enableMouseEvents()

Enable all mouse events on the graphic layer.

getMap()

Returns:

MapBase

Return the map control that the layer is added to.

Returns:

getName()

Returns:

String

return layer name.

Returns:

getNode()

Returns:

DOMNODE

Returns the layer's DOM node.

Returns:

getTitle()

Returns:

String

return layer title.

Returns:

getVisible()

Returns:

Boolean

return layer visibility.

Returns:

hide()

Hide the layer.

Initialize()

called method when layer is added to MapBase.

isVisibleAtScale(scale)

scale:number

Returns:Boolean

A Boolean value representing the visibility of the layer at the specific scale.

Returns:

putName(newVal)

String

set layer name.

putTitle(newVal)

String

set layer visibility.

putVisible(newVal)

Boolean

set layer visibility.

RebuildElement()

redraw layer.

redraw()

Redraw all graphics in the specified layer.

remove(graphic)

sg.Graphic

Remove a specified graphic.

RemoveSelf()

remove self.

setInfoTemplate(temp)

sg.InfoTemplate        

Define the layer's info template.

setMaxScale(maxScale)

Number

Define the maximum scale for the layer.

setMinScale(minScale)

Number

Define the minimum scale for the layer.

setOpacity(opacity)

Number

Define opacity of the graphic layer.

setRenderer(renderer)

sg.renderers.Renderer

Define the renderer for the graphic layer.

setVisibility(newVal)

Boolean

Define the visibility of the layer.

show()

Show the layer.

UpdateElement()

update layer.

Event

Description

click

triggered when clicked on graphics

dbl-click

triggered when double clicked on graphics

graphic-add

triggered when graphics are added

graphic-clear

triggered when all graphics are cleared

graphic-remove

triggered when a graphic is removed

load

triggered when layers are loaded

mouse-down

triggered when mouse presses down on a graphic

mouse-move

triggered when mouse moves on a graphic

mouse-out

triggered when mouse moves out of a graphic

mouse-over

triggered when mouse moves into a graphic

mouse-up

triggered when mouse-click releases on a graphic