User Tools

Site Tools


thinkgeo.mapsuite.webedition.layeroverlay

ThinkGeo.MapSuite.WebEdition.LayerOverlay

Note: The page was created before Map Suite 10. Map Suite 10.0 organized many classes into new namespaces and assemblies as well as had a few minor breaks in compatibility. The majority of previously built code should work without modification assuming the new namespaces are added. For guidance on upgrading your existing code, please check out MapSuite 10 Upgrade Guide.

Represents an Overlay that contains layers.

Inheritance Hierarchy

  • System.Object
    • ThinkGeo.MapSuite.WebEdition.Overlay
      • ThinkGeo.MapSuite.WebEdition.LayerOverlay

Members Summary

Public Constructors

LayerOverlay()

  • Initialize an instance of the LayerOverlay class.
Remarks
  • For the most updated Info for this topic, please check it here:http:wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.LayerOverlay#LayerOverlay.28.29
Parameters

LayerOverlay(String)

  • Initialize an instance of the LayerOverlay class with the overlay identifier specified.
Remarks
  • For the most updated Info for this topic, please check it here:http:wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.LayerOverlay#LayerOverlay.28String.29
Parameters
  • id
    • Type:String
    • Description:The identifier string used to retrieve the overlay for collection.

LayerOverlay(String,Boolean,TileType)

  • Initialize an instance of the LayerOverlay class with the overlay identifier, IsBaseOverlay boolean value and the value indicating whether to use tiling.
Remarks
  • For the most updated Info for this topic, please check it here:http:wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.LayerOverlay#LayerOverlay.28String.2C_Boolean.2C_TileType.29
Parameters
  • id
    • Type:String
    • Description:The identifier string used to retrieve the overlay for collection.
  • isBaseOverlay
    • Type:Boolean
    • Description:A boolean value that indicates whether this overlay is a base overlay.
  • tileType
    • Type:TileType
    • Description:The TileType that indicates whether this overlay uses tiling.

Protected Constructors

Public Methods

SetBaseEpsgProjection(String)

  • Sets the EPSG projection of the LayerOverlay when it is a base overlay.
Remarks
  • For the most updated Info for this topic, please check it here:http:wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.LayerOverlay#SetBaseEpsgProjection.28String.29
Return Value
  • Type:Void
  • Description:N/A
Parameters
  • epsgProjection
    • Type:String
    • Description:A string that represents the projection of the LayerOverlay.

GetBaseEpsgProjection()

  • Returns an EPSG string that indicates the projection of the LayerOverlay.
Remarks
  • For the most updated Info for this topic, please check it here:http:wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.LayerOverlay#GetBaseEpsgProjection.28.29
Return Value
  • Type:String
  • Description:An EPSG string that indicates the projection of the LayerOverlay.
Parameters

GetBoundingBox()

  • Gets the smallest extent that includes all of the features of all layers in the LayerOverlay.
Remarks
  • If you have several layers, with one justified up and to the right and another justified down and to the left, this method will combine all of the current extents to make one composite extent.
Return Value
  • Description:The smallest extent that includes all of the features of all layers in the LayerOverlay.
Parameters

Draw(GeoCanvas,Object,RectangleShape,GeographyUnit)

  • Draw all of the layers to the image object using the parameters specified.
Remarks
  • For the most updated Info for this topic, please check it here:http:wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.LayerOverlay#Draw.28GeoCanvas.2C_Object.2C_RectangleShape.2C_GeographyUnit.29
Return Value
  • Type:Void
  • Description:N/A
Parameters
  • canvas
    • Type:GeoCanvas
    • Description:The GeoCanvas object that the layers will draw on.
  • nativeImage
    • Type:Object
    • Description:The image object to which all of the layers will be drawn. Usually it is a bitmap.
  • canvasExtent
    • Description:The extent in which the features of the layers will be drawn.
  • mapUnit
    • Description:The geographic unit that the map will use to draw.

Redraw()

  • Redraw this overlay.
Remarks
  • For the most updated Info for this topic, please check it here:http:wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.LayerOverlay#Redraw.28.29
Return Value
  • Type:Void
  • Description:N/A
Parameters

GenerateCacheImages(ZoomLevel,RectangleShape,GeographyUnit)

  • Generates images to the server cache by zoomLevel.
Remarks
  • This method will generate images to the server cache if you enable the ServerCache on this LayerOverlay. You can use this method to fill your server cache to enhance the performance of your web site.
Return Value
  • Type:Void
  • Description:N/A
Parameters
  • zoomLevel
    • Type:ZoomLevel
    • Description:The zoomlevel at which the images will be generated.
  • cacheExtent
    • Description:The extent of the region for which the cached images will be generated.

GenerateCacheImages(Double,RectangleShape,GeographyUnit)

  • Generates the images to the server cache by scale.
Remarks
  • This method will generate images to the server cache if you enable the ServerCache on this LayerOverlay. You can use this method to fill your server cache to enhance the performance of your web site.
Return Value
  • Type:Void
  • Description:N/A
Parameters
  • scale
    • Type:Double
    • Description:The scale that is used to calculate the coordinates of the images.
  • cacheExtent
    • Description:The extent of the region for which the cache images will be generated.

ToJson()

  • Returns a JSON string which contains the information for creating an overlay at the client side.
Remarks
  • For the most updated Info for this topic, please check it here:http:wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.LayerOverlay#ToJson.28.29
Return Value
  • Type:String
  • Description:A JSON string which is used to create an overlay at the client side.
Parameters

ToString()

  • N/A
Remarks
  • For the most updated Info for this topic, please check it here:http:wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.LayerOverlay#ToString.28.29
Return Value
  • Type:String
  • Description:N/A
Parameters

Equals(Object)

  • N/A
Remarks
  • For the most updated Info for this topic, please check it here:http:wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.LayerOverlay#Equals.28Object.29
Return Value
  • Type:Boolean
  • Description:N/A
Parameters
  • obj
    • Type:Object
    • Description:N/A

GetHashCode()

  • N/A
Remarks
  • For the most updated Info for this topic, please check it here:http:wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.LayerOverlay#GetHashCode.28.29
Return Value
  • Type:Int32
  • Description:N/A
Parameters

GetType()

  • N/A
Remarks
  • For the most updated Info for this topic, please check it here:http:wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.LayerOverlay#GetType.28.29
Return Value
  • Type:Type
  • Description:N/A
Parameters

Protected Methods

DrawCore(GeoCanvas,Object,RectangleShape,GeographyUnit)

  • Draw all of the layers to the image object using the parameters specified.
Remarks
  • For the most updated Info for this topic, please check it here:http:wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.LayerOverlay#DrawCore.28GeoCanvas.2C_Object.2C_RectangleShape.2C_GeographyUnit.29
Return Value
  • Type:Void
  • Description:N/A
Parameters
  • canvas
    • Type:GeoCanvas
    • Description:The GeoCanvas object that the layers will draw on.
  • nativeImage
    • Type:Object
    • Description:The image object to which all of the layers will be drawn. Usually it is a bitmap.
  • canvasExtent
    • Description:The extent in which the features of the layers will be drawn.
  • mapUnit
    • Description:The geographic unit that the map will use to draw.

3xM=(Page)

  • N/A
Remarks
  • N/A
Return Value
  • Type:Void
  • Description:N/A
Parameters
  • page
    • Type:Page
    • Description:N/A

RegisterJavaScriptLibraryCore(Page)

  • Registers a Javascript library URL string to the client HTML page.
Remarks
  • The <strong>RegisterJavaScriptLibraryCore</strong> method allows derived classes to override and register their own Javascript library URL to the HTML page.
Return Value
  • Type:Void
  • Description:N/A
Parameters
  • page
    • Type:Page
    • Description:The page object that is used for registering the javascript library.

RaiseTickEvent(EventArgs)

  • N/A
Remarks
  • N/A
Return Value
  • Type:Void
  • Description:N/A
Parameters
  • e
    • Type:EventArgs
    • Description:N/A

OnTick(EventArgs)

  • Raises the Tick event of the MarkerOverlay.
Remarks
  • For the most updated Info for this topic, please check it here:http:wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.LayerOverlay#OnTick.28EventArgs.29
Return Value
  • Type:Void
  • Description:N/A
Parameters
  • e
    • Type:EventArgs
    • Description:An System.EventArgs object that contains the event data.

Finalize()

  • N/A
Remarks
  • For the most updated Info for this topic, please check it here:http:wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.LayerOverlay#Finalize.28.29
Return Value
  • Type:Void
  • Description:N/A
Parameters

MemberwiseClone()

  • N/A
Remarks
  • For the most updated Info for this topic, please check it here:http:wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.LayerOverlay#MemberwiseClone.28.29
Return Value
  • Type:Object
  • Description:N/A
Parameters

Public Properties

TileWidth

Gets or sets the width of each tile if the layer is in MultipleTile mode.

Remarks

For the most updated Info for this topic, please check it here:http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.LayerOverlay#TileWidth

Return Value
  • Type:Int32

TileHeight

Gets or sets the height of each tile if the layer is in MultipleTile mode.

Remarks

For the most updated Info for this topic, please check it here:http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.LayerOverlay#TileHeight

Return Value
  • Type:Int32

TransitionEffect

Gets or sets the transition effect to use when the map is zoomed.

Remarks

For the most updated Info for this topic, please check it here:http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.LayerOverlay#TransitionEffect

Return Value

TransitionEffectDelayInMilliseconds

N/A

Remarks

For the most updated Info for this topic, please check it here:

Return Value
  • Type:Int32

TileType

Gets or sets whether or not the LayerOverlay uses tiling.

Remarks
Return Value

TileMargin

Gets or sets the number of extra rows and colums of tiles on each side that will surround the minimum grid tiles to cover the map. Used only when in MultipleTile mode.

Remarks

For the most updated Info for this topic, please check it here:http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.LayerOverlay#TileMargin

Return Value
  • Type:Int32

ServerCache

Gets or sets the server cache in the overlay.

Remarks

For the most updated Info for this topic, please check it here:http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.LayerOverlay#ServerCache

Return Value

ClientCache

Gets or sets the ClientCache object that contains the configuration for the browser cache of this overlay.

Remarks

For the most updated Info for this topic, please check it here:http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.LayerOverlay#ClientCache

Return Value

WebImageFormat

Gets or sets the format of the image that is sent to the web browser.

Remarks

For the most updated Info for this topic, please check it here:http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.LayerOverlay#WebImageFormat

Return Value

JpegQuality

Gets or sets the quality of the JPEG image that is sent to the web browser. Valid values are between 1 - 100, inclusive.

Remarks

The <strong>JpegQuality</strong> property determines the quality of the JPEG image that is sent to the browser if the WebImageFormat is Jpeg. Setting this property to a lower value will reduce the image filesize. The value must be between 1 - 100. The default is 100.

Return Value
  • Type:Int32

IsMultiThreadDisabled

Gets or sets whether the multi-thread is disabled or not.

Remarks

For the most updated Info for this topic, please check it here:http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.LayerOverlay#IsMultiThreadDisabled

Return Value
  • Type:Boolean

Layers

Gets a GeoCollection that contains the layers that will draw on the image that is sent to the browser.

Remarks

The <strong>Layers</strong> property holds all of the layers that are used by the <strong>Draw</strong> method. The Draw method loops through all layers to filter out features and draw with specified styles to the image that will be sent to the browser.

Return Value

IsVisible

Gets or sets a value that indicates whether the overlay is visible on the map.

Remarks

For the most updated Info for this topic, please check it here:http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.LayerOverlay#IsVisible

Return Value
  • Type:Boolean

WrapDateline

Gets or sets a value that indicates whether the overlay wraps at the date line.

Remarks

For the most updated Info for this topic, please check it here:http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.LayerOverlay#WrapDateline

Return Value

Name

Gets or sets the name of the overlay, which will display in the OverlaySwitcher.

Remarks

For the most updated Info for this topic, please check it here:http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.LayerOverlay#Name

Return Value
  • Type:String

Opacity

Gets or sets the opacity level of the overlay.

Remarks

The <strong>Opacity</strong> property enables you to specify a level of transparency for the overlay. When this property is set to a value less than 100 percent (1.00), the entire overlay is made more transparent. The lower the value, the more transparent it is. Setting this property to a value of 0 percent (0.00) makes the overlay completely invisible.

Return Value
  • Type:Single

IsVisibleInOverlaySwitcher

Gets or sets a value that indicates whether the overlay name is displayed in the OverlaySwitcher.

Remarks
Return Value
  • Type:Boolean

IsBaseOverlay

Gets or sets a value that indicates whether the overlay is a base overlay.

Remarks

For the most updated Info for this topic, please check it here:http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.LayerOverlay#IsBaseOverlay

Return Value
  • Type:Boolean

Id

Gets the identifier for the overlay to be found.

Remarks

For the most updated Info for this topic, please check it here:http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.LayerOverlay#Id

Return Value
  • Type:String

AutoRefreshInterval

Gets or sets the time interval in which the MarkerOverlay refreshes itself.

Remarks

For the most updated Info for this topic, please check it here:http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.LayerOverlay#AutoRefreshInterval

Return Value
  • Type:TimeSpan

Attribution

N/A

Remarks

For the most updated Info for this topic, please check it here:http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.LayerOverlay#Attribution

Return Value
  • Type:String

Protected Properties

OverlayType

Gets a string that indicates the overlay type.

Remarks

For the most updated Info for this topic, please check it here:http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.LayerOverlay#OverlayType

Return Value
  • Type:String

ExtraParameter

Gets or sets extra parameters for current overlay.

Remarks

For the most updated Info for this topic, please check it here:http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.LayerOverlay#ExtraParameter

Return Value
  • Type:String

Projection

Gets or sets projection of current overlay for requesting images.

Remarks
Return Value
  • Type:String

HasTickEvent

Indicates whether the overlay supports tick event.

Remarks

For the most updated Info for this topic, please check it here:http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.LayerOverlay#HasTickEvent

Return Value
  • Type:Boolean

3hM=

N/A

Remarks

N/A

Return Value
  • Type:Double

Public Events

Tick Occurs when the number of milliseconds specified in the AutoRefreshInterval property has elapsed and the page is posted to the server.

Remarks

For the most updated Info for this topic, please check it here:http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.LayerOverlay#OnTick.28EventArgs.29

Event Arguments:EventArgs

thinkgeo.mapsuite.webedition.layeroverlay.txt · Last modified: 2017/03/16 21:59 (external edit)