Telogis.GeoBase.MapLayers.RegionShadeLayer

A class for displaying a shaded rectangular region on a map.

Constructor

Name

Description

MapLayers.RegionShadeLayer(config)

Arguments

config (Object) - Configuration options for the layer.

Properties

Name	Type	Description
borderType	String	The CSS property describing the style to draw the region border with. Defaults to 'solid'.
borderWidth	Number	The border width for the region, in pixels. Defaults to 1.
color	Color	The RGBA color (and opacity) with which to shade the region. The same color will be used for the border (if enabled), except that it will be fully opaque. This property may also be referenced by the name: colour.
nw	LatLon	The latitude-longitude coordinates of the north-west (upper-left) corner of the shaded region. Defaults to new LatLon().
se	LatLon	The latitude-longitude coordinates of the south-east (lower-right) corner of the shaded region. Defaults to new LatLon().
viewport	Widgets.Map	The viewport to create a region from. Defaults to null.

Functions

Name	Description
destroy ()	Deallocates resources used by the MapLayers.RegionShadeLayer and frees the associated memory to avoid leaks.
setCorners (LatLon nw, LatLon se)	Sets the north-west and south-east corners of the MapLayers.RegionShadeLayer. Arguments nw (LatLon or Widgets.Map) - The LatLon or Point of the north-west corner of the region, or a map / projection covering the entire region. se (LatLon) - The LatLon or Point of the south-east corner of the region.
setMap (Widgets.Map map)	The same as for MapLayers.AbstractLayer.setMap, except that once the MapLayers.RegionShadeLayer's map is adjusted, the bounds of its region are updated. Arguments map (Widgets.Map or String) - The map to attach the layer to.

Name

Description

destroy ()

Deallocates resources used by the MapLayers.RegionShadeLayer and frees the associated memory to avoid leaks.

setCorners (LatLon nw, LatLon se)

Sets the north-west and south-east corners of the MapLayers.RegionShadeLayer.

Arguments

nw (LatLon or Widgets.Map) - The LatLon or Point of the north-west corner of the region, or a map / projection covering the entire region.
se (LatLon) - The LatLon or Point of the south-east corner of the region.

setMap (Widgets.Map map)

The same as for MapLayers.AbstractLayer.setMap, except that once the MapLayers.RegionShadeLayer's map is adjusted, the bounds of its region are updated.

Arguments