User Tools

Site Tools


thinkgeo.mapsuite.webedition.layeroverlay

This is an old revision of the document!


ThinkGeo.MapSuite.WebEdition.LayerOverlay

<!– Class –> Represents an Overlay that contains layers.

Remarks

For the most updated Info for this topic, please check it here:<a href=“http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.LayerOverlay” target=“_blank”>http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.LayerOverlay</a>

Inheritance Hierarchy

Members Summary

Public Constructors

Name Parameters DeclaringType Summary
Public MethodLayerOverlay Initialize an instance of the LayerOverlay class.
Public MethodLayerOverlay String Initialize an instance of the LayerOverlay class with the overlay identifier specified.
Public MethodLayerOverlay 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.

Protected Constructors

Name Parameters DeclaringType Summary

Public Methods

Name Parameters DeclaringType Summary
Public MethodDraw GeoCanvas, Object, RectangleShape, GeographyUnit Draw all of the layers to the image object using the parameters specified.
Public MethodEquals Object Object
Public MethodGenerateCacheImages ZoomLevel, RectangleShape, GeographyUnit Generates images to the server cache by zoomLevel.
Public MethodGenerateCacheImages Double, RectangleShape, GeographyUnit Generates the images to the server cache by scale.
Public MethodGetBaseEpsgProjection Returns an EPSG string that indicates the projection of the LayerOverlay.
Public MethodGetBoundingBox Gets the smallest extent that includes all of the features of all layers in the LayerOverlay.
Public MethodGetHashCode Object
Public MethodGetType Object
Public MethodRedraw Redraw this overlay.
Public MethodSetBaseEpsgProjection String Sets the EPSG projection of the LayerOverlay when it is a base overlay.
Public MethodToJson Overlay Returns a JSON string which contains the information for creating an overlay at the client side.
Public MethodToString Object

Protected Methods

Name Parameters DeclaringType Summary
Protected MethodDrawCore GeoCanvas, Object, RectangleShape, GeographyUnit Draw all of the layers to the image object using the parameters specified.
Protected MethodFinalize Object
Protected MethodMemberwiseClone Object
Protected MethodOnTick EventArgs Overlay Raises the Tick event of the MarkerOverlay.
Protected MethodRegisterJavaScriptLibraryCore Page Overlay Registers a Javascript library URL string to the client HTML page.

Public Properties

Name Return DeclaringType Summary
Public PropertyAttribution String Overlay
Public PropertyAutoRefreshInterval TimeSpan Overlay Gets or sets the time interval in which the MarkerOverlay refreshes itself.
Public PropertyClientCache ClientCache Gets or sets the ClientCache object that contains the configuration for the browser cache of this overlay.
Public PropertyId String Overlay Gets the identifier for the overlay to be found.
Public PropertyIsBaseOverlay Boolean Overlay Gets or sets a value that indicates whether the overlay is a base overlay.
Public PropertyIsMultiThreadDisabled Boolean Gets or sets whether the multi-thread is disabled or not.
Public PropertyIsVisible Boolean Overlay(overriden) Gets or sets a value that indicates whether the overlay is visible on the map.
Public PropertyIsVisibleInOverlaySwitcher Boolean Overlay Gets or sets a value that indicates whether the overlay name is displayed in the OverlaySwitcher.
Public PropertyJpegQuality Int32 Gets or sets the quality of the JPEG image that is sent to the web browser. Valid values are between 1 - 100, inclusive.
Public PropertyLayers GeoCollection<Layer> Gets a GeoCollection that contains the layers that will draw on the image that is sent to the browser.
Public PropertyName String Overlay Gets or sets the name of the overlay, which will display in the OverlaySwitcher.
Public PropertyOpacity Single Overlay Gets or sets the opacity level of the overlay.
Public PropertyServerCache ServerCache Gets or sets the server cache in the overlay.
Public PropertyTileHeight Int32 Gets or sets the height of each tile if the layer is in MultipleTile mode.
Public PropertyTileMargin Int32 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.
Public PropertyTileType TileType Gets or sets whether or not the LayerOverlay uses tiling.
Public PropertyTileWidth Int32 Gets or sets the width of each tile if the layer is in MultipleTile mode.
Public PropertyTransitionEffect TransitionEffect Gets or sets the transition effect to use when the map is zoomed.
Public PropertyTransitionEffectDelayInMilliseconds Int32
Public PropertyWebImageFormat WebImageFormat Gets or sets the format of the image that is sent to the web browser.
Public PropertyWrapDateline WrapDatelineMode Gets or sets a value that indicates whether the overlay wraps at the date line.

Protected Properties

Name Return DeclaringType Summary
Protected PropertyExtraParameter String Gets or sets extra parameters for current overlay.
Protected PropertyHasTickEvent Boolean Overlay Indicates whether the overlay supports tick event.
Protected PropertyOverlayType String Overlay(overriden) Gets a string that indicates the overlay type.
Protected PropertyProjection String Gets or sets projection of current overlay for requesting images.

Public Events

Name Event Arguments DeclaringType Summary
Public EventTick EventArgs Overlay Occurs when the number of milliseconds specified in the AutoRefreshInterval property has elapsed and the page is posted to the server.

Public Constructors

LayerOverlay()

Initialize an instance of the LayerOverlay class.

Overloads

Initialize an instance of the LayerOverlay class.

Remarks

Parameters

Name Type Description

Go Back

LayerOverlay(String)

Initialize an instance of the LayerOverlay class with the overlay identifier specified.

Overloads

Initialize an instance of the LayerOverlay class.

Remarks

Parameters

Name Type Description
id String<!– System.String –> The identifier string used to retrieve the overlay for collection.

Go Back

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.

Overloads

Initialize an instance of the LayerOverlay class.

Remarks

Parameters

Name Type Description
id String<!– System.String –> The identifier string used to retrieve the overlay for collection.
isBaseOverlay Boolean<!– System.Boolean –> A boolean value that indicates whether this overlay is a base overlay.
tileType TileType<!– ThinkGeo.MapSuite.WebEdition.TileType –> The TileType that indicates whether this overlay uses tiling.

Go Back

Protected Constructors

Public Methods

Draw(GeoCanvas, Object, RectangleShape, GeographyUnit)

Draw all of the layers to the image object using the parameters specified.

Remarks

Return Value

Return Type Description
Void<!– System.Void –>

Parameters

Name Type Description
canvas GeoCanvas<!– ThinkGeo.MapSuite.Core.GeoCanvas –> The GeoCanvas object that the layers will draw on.
nativeImage Object<!– System.Object –> The image object to which all of the layers will be drawn. Usually it is a bitmap.
canvasExtent RectangleShape<!– ThinkGeo.MapSuite.Core.RectangleShape –> The extent in which the features of the layers will be drawn.
mapUnit GeographyUnit<!– ThinkGeo.MapSuite.Core.GeographyUnit –> The geographic unit that the map will use to draw.

<!– ThinkGeo.MapSuite.WebEdition.LayerOverlay –> Go Back

Equals(Object)

Remarks

Return Value

Return Type Description
Boolean<!– System.Boolean –>

Parameters

Name Type Description
obj Object<!– System.Object –>

<!– System.Object –> Go Back

GenerateCacheImages(ZoomLevel, RectangleShape, GeographyUnit)

Generates images to the server cache by zoomLevel.

Overloads

Generates the images to the server cache.

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

Return Type Description
Void<!– System.Void –>

Parameters

Name Type Description
zoomLevel ZoomLevel<!– ThinkGeo.MapSuite.Core.ZoomLevel –> The zoomlevel at which the images will be generated.
cacheExtent RectangleShape<!– ThinkGeo.MapSuite.Core.RectangleShape –> The extent of the region for which the cached images will be generated.
mapUnit GeographyUnit<!– ThinkGeo.MapSuite.Core.GeographyUnit –> The unit of map.

<!– ThinkGeo.MapSuite.WebEdition.LayerOverlay –> Go Back

GenerateCacheImages(Double, RectangleShape, GeographyUnit)

Generates the images to the server cache by scale.

Overloads

Generates the images to the server cache.

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

Return Type Description
Void<!– System.Void –>

Parameters

Name Type Description
scale Double<!– System.Double –> The scale that is used to calculate the coordinates of the images.
cacheExtent RectangleShape<!– ThinkGeo.MapSuite.Core.RectangleShape –> The extent of the region for which the cache images will be generated.
mapUnit GeographyUnit<!– ThinkGeo.MapSuite.Core.GeographyUnit –> The unit of map.

<!– ThinkGeo.MapSuite.WebEdition.LayerOverlay –> Go Back

GetBaseEpsgProjection()

Returns an EPSG string that indicates the projection of the LayerOverlay.

Remarks

Return Value

Return Type Description
String<!– System.String –> An EPSG string that indicates the projection of the LayerOverlay.

Parameters

Name Type Description

<!– ThinkGeo.MapSuite.WebEdition.LayerOverlay –> Go Back

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

Return Type Description
RectangleShape<!– ThinkGeo.MapSuite.Core.RectangleShape –> The smallest extent that includes all of the features of all layers in the LayerOverlay.

Parameters

Name Type Description

<!– ThinkGeo.MapSuite.WebEdition.LayerOverlay –> Go Back

GetHashCode()

Remarks

Return Value

Return Type Description
Int32<!– System.Int32 –>

Parameters

Name Type Description

<!– System.Object –> Go Back

GetType()

Remarks

Return Value

Return Type Description
Type<!– System.Type –>

Parameters

Name Type Description

<!– System.Object –> Go Back

Redraw()

Redraw this overlay.

Remarks

Return Value

Return Type Description
Void<!– System.Void –>

Parameters

Name Type Description

<!– ThinkGeo.MapSuite.WebEdition.LayerOverlay –> Go Back

SetBaseEpsgProjection(String)

Sets the EPSG projection of the LayerOverlay when it is a base overlay.

Remarks

Return Value

Return Type Description
Void<!– System.Void –>

Parameters

Name Type Description
epsgProjection String<!– System.String –> A string that represents the projection of the LayerOverlay.

<!– ThinkGeo.MapSuite.WebEdition.LayerOverlay –> Go Back

ToJson()

Returns a JSON string which contains the information for creating an overlay at the client side.

Remarks

Return Value

Return Type Description
String<!– System.String –> A JSON string which is used to create an overlay at the client side.

Parameters

Name Type Description

<!– ThinkGeo.MapSuite.WebEdition.Overlay –> Go Back

ToString()

Remarks

Return Value

Return Type Description
String<!– System.String –>

Parameters

Name Type Description

<!– System.Object –> Go Back

Protected Methods

DrawCore(GeoCanvas, Object, RectangleShape, GeographyUnit)

Draw all of the layers to the image object using the parameters specified.

Remarks

Return Value

Return Type Description
Void<!– System.Void –>

Parameters

Name Type Description
canvas GeoCanvas<!– ThinkGeo.MapSuite.Core.GeoCanvas –> The GeoCanvas object that the layers will draw on.
nativeImage Object<!– System.Object –> The image object to which all of the layers will be drawn. Usually it is a bitmap.
canvasExtent RectangleShape<!– ThinkGeo.MapSuite.Core.RectangleShape –> The extent in which the features of the layers will be drawn.
mapUnit GeographyUnit<!– ThinkGeo.MapSuite.Core.GeographyUnit –> The geographic unit that the map will use to draw.

<!– ThinkGeo.MapSuite.WebEdition.LayerOverlay –> Go Back

Finalize()

Remarks

Return Value

Return Type Description
Void<!– System.Void –>

Parameters

Name Type Description

<!– System.Object –> Go Back

MemberwiseClone()

Remarks

Return Value

Return Type Description
Object<!– System.Object –>

Parameters

Name Type Description

<!– System.Object –> Go Back

OnTick(EventArgs)

Raises the Tick event of the MarkerOverlay.

Remarks

Return Value

Return Type Description
Void<!– System.Void –>

Parameters

Name Type Description
e EventArgs<!– System.EventArgs –> An System.EventArgs object that contains the event data.

<!– ThinkGeo.MapSuite.WebEdition.Overlay –> Go Back

RegisterJavaScriptLibraryCore(Page)

Registers a Javascript library URL string to the client HTML page.

Remarks

The &lt;strong&gt;RegisterJavaScriptLibraryCore&lt;/strong&gt; method allows derived classes to override and register their own Javascript library URL to the HTML page.

Return Value

Return Type Description
Void<!– System.Void –>

Parameters

Name Type Description
page Page<!– System.Web.UI.Page –> The page object that is used for registering the javascript library.

<!– ThinkGeo.MapSuite.WebEdition.Overlay –> Go Back

Public Properties

Attribution

Remarks

Return Value

Return Type
String<!– System.String –>

<!– ThinkGeo.MapSuite.WebEdition.Overlay –> Go Back

AutoRefreshInterval

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

Remarks

Return Value

Return Type
TimeSpan<!– System.TimeSpan –>

<!– ThinkGeo.MapSuite.WebEdition.Overlay –> Go Back

ClientCache

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

Remarks

Return Value

Return Type
ClientCache<!– ThinkGeo.MapSuite.WebEdition.ClientCache –>

<!– ThinkGeo.MapSuite.WebEdition.LayerOverlay –> Go Back

Id

Gets the identifier for the overlay to be found.

Remarks

For the most updated Info for this topic, please check it here:<a href=“http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.LayerOverlay#Id” target=“_blank”>http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.LayerOverlay#Id</a>

Return Value

Return Type
String<!– System.String –>

<!– ThinkGeo.MapSuite.WebEdition.Overlay –> Go Back

IsBaseOverlay

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

Remarks

Return Value

Return Type
Boolean<!– System.Boolean –>

<!– ThinkGeo.MapSuite.WebEdition.Overlay –> Go Back

IsMultiThreadDisabled

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

Remarks

Return Value

Return Type
Boolean<!– System.Boolean –>

<!– ThinkGeo.MapSuite.WebEdition.LayerOverlay –> Go Back

IsVisible

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

Remarks

Return Value

Return Type
Boolean<!– System.Boolean –>

<!– ThinkGeo.MapSuite.WebEdition.Overlay(overriden) –> Go Back

IsVisibleInOverlaySwitcher

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

Remarks

Return Value

Return Type
Boolean<!– System.Boolean –>

<!– ThinkGeo.MapSuite.WebEdition.Overlay –> Go Back

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 &lt;strong&gt;JpegQuality&lt;/strong&gt; 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

Return Type
Int32<!– System.Int32 –>

<!– ThinkGeo.MapSuite.WebEdition.LayerOverlay –> Go Back

Layers

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

Remarks

The &lt;strong&gt;Layers&lt;/strong&gt; property holds all of the layers that are used by the &lt;strong&gt;Draw&lt;/strong&gt; 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

Return Type
GeoCollection<Layer><!– ThinkGeo.MapSuite.Core.GeoCollection{ThinkGeo.MapSuite.Core.Layer} –>

<!– ThinkGeo.MapSuite.WebEdition.LayerOverlay –> Go Back

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:<a href=“http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.LayerOverlay#Name” target=“_blank”>http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.LayerOverlay#Name</a>

Return Value

Return Type
String<!– System.String –>

<!– ThinkGeo.MapSuite.WebEdition.Overlay –> Go Back

Opacity

Gets or sets the opacity level of the overlay.

Remarks

The &lt;strong&gt;Opacity&lt;/strong&gt; 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

Return Type
Single<!– System.Single –>

<!– ThinkGeo.MapSuite.WebEdition.Overlay –> Go Back

ServerCache

Gets or sets the server cache in the overlay.

Remarks

Return Value

Return Type
ServerCache<!– ThinkGeo.MapSuite.WebEdition.ServerCache –>

<!– ThinkGeo.MapSuite.WebEdition.LayerOverlay –> Go Back

TileHeight

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

Remarks

Return Value

Return Type
Int32<!– System.Int32 –>

<!– ThinkGeo.MapSuite.WebEdition.LayerOverlay –> Go Back

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

Return Value

Return Type
Int32<!– System.Int32 –>

<!– ThinkGeo.MapSuite.WebEdition.LayerOverlay –> Go Back

TileType

Gets or sets whether or not the LayerOverlay uses tiling.

Remarks

Return Value

Return Type
TileType<!– ThinkGeo.MapSuite.WebEdition.TileType –>

<!– ThinkGeo.MapSuite.WebEdition.LayerOverlay –> Go Back

TileWidth

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

Remarks

Return Value

Return Type
Int32<!– System.Int32 –>

<!– ThinkGeo.MapSuite.WebEdition.LayerOverlay –> Go Back

TransitionEffect

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

Remarks

Return Value

Return Type
TransitionEffect<!– ThinkGeo.MapSuite.WebEdition.TransitionEffect –>

<!– ThinkGeo.MapSuite.WebEdition.LayerOverlay –> Go Back

TransitionEffectDelayInMilliseconds

Remarks

For the most updated Info for this topic, please check it here:<a href=“” target=“_blank”></a>

Return Value

Return Type
Int32<!– System.Int32 –>

<!– ThinkGeo.MapSuite.WebEdition.LayerOverlay –> Go Back

WebImageFormat

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

Remarks

Return Value

Return Type
WebImageFormat<!– ThinkGeo.MapSuite.WebEdition.WebImageFormat –>

<!– ThinkGeo.MapSuite.WebEdition.LayerOverlay –> Go Back

WrapDateline

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

Remarks

Return Value

Return Type
WrapDatelineMode<!– ThinkGeo.MapSuite.WebEdition.WrapDatelineMode –>

<!– ThinkGeo.MapSuite.WebEdition.LayerOverlay –> Go Back

Protected Properties

ExtraParameter

Gets or sets extra parameters for current overlay.

Remarks

Return Value

Return Type
String<!– System.String –>

<!– ThinkGeo.MapSuite.WebEdition.LayerOverlay –> Go Back

HasTickEvent

Indicates whether the overlay supports tick event.

Remarks

Return Value

Return Type
Boolean<!– System.Boolean –>

<!– ThinkGeo.MapSuite.WebEdition.Overlay –> Go Back

OverlayType

Gets a string that indicates the overlay type.

Remarks

Return Value

Return Type
String<!– System.String –>

<!– ThinkGeo.MapSuite.WebEdition.Overlay(overriden) –> Go Back

Projection

Gets or sets projection of current overlay for requesting images.

Remarks

Return Value

Return Type
String<!– System.String –>

<!– ThinkGeo.MapSuite.WebEdition.LayerOverlay –> Go Back

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

Event Arguments

Event Arguments
EventArgs<!– System.EventArgs –>

<!– ThinkGeo.MapSuite.WebEdition.Overlay –> Go Back

NOTOC WebEdition ThinkGeo.MapSuite.WebEdition UpdateDocumentation

thinkgeo.mapsuite.webedition.layeroverlay.1440040135.txt.gz · Last modified: 2015/09/18 03:08 (external edit)