Table of Contents
ThinkGeo.MapSuite.MvcEdition.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.MvcEdition.Overlay
- ThinkGeo.MapSuite.MvcEdition.LayerOverlay
Members Summary
Public Constructors
LayerOverlay()
- Initialize an instance of the LayerOverlay class.
Remarks
- N/A
Parameters
LayerOverlay(String)
- Initialize an instance of the LayerOverlay class with the overlay identifier specified.
Remarks
- N/A
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
- N/A
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
- N/A
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
- N/A
Return Value
- Type:String
- Description:An EPSG string that indicates the projection of the LayerOverlay.
Parameters
DataBindTo(String,String)
- N/A
Remarks
- N/A
Return Value
- Type:Void
- Description:N/A
Parameters
- controllerName
- Type:String
- Description:N/A
- actionName
- Type:String
- Description:N/A
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
- Type:RectangleShape
- 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
- N/A
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
- Type:RectangleShape
- Description:The extent in which the features of the layers will be drawn.
- mapUnit
- Type:GeographyUnit
- Description:The geographic unit that the map will use to draw.
Redraw()
- Redraw this overlay.
Remarks
- N/A
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
- Type:RectangleShape
- Description:The extent of the region for which the cached images will be generated.
- mapUnit
- Type:GeographyUnit
- Description:The unit of map.
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
- Type:RectangleShape
- Description:The extent of the region for which the cache images will be generated.
- mapUnit
- Type:GeographyUnit
- Description:The unit of map.
ToJson()
- N/A
Remarks
- N/A
Return Value
- Type:String
- Description:N/A
Parameters
FromJson(String)
- N/A
Remarks
- N/A
Return Value
- Type:Void
- Description:N/A
Parameters
- jsonString
- Type:String
- Description:N/A
ToString()
- N/A
Remarks
- N/A
Return Value
- Type:String
- Description:N/A
Parameters
Equals(Object)
- N/A
Remarks
- N/A
Return Value
- Type:Boolean
- Description:N/A
Parameters
- obj
- Type:Object
- Description:N/A
GetHashCode()
- N/A
Remarks
- N/A
Return Value
- Type:Int32
- Description:N/A
Parameters
GetType()
- N/A
Remarks
- N/A
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
- N/A
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
- Type:RectangleShape
- Description:The extent in which the features of the layers will be drawn.
- mapUnit
- Type:GeographyUnit
- Description:The geographic unit that the map will use to draw.
EhQ=(Page)
- N/A
Remarks
- N/A
Return Value
- Type:Void
- Description:N/A
Parameters
- page
- Type:Page
- Description:N/A
RegisterJavaScriptLibraryCore(Page)
- N/A
Remarks
- N/A
Return Value
- Type:Void
- Description:N/A
Parameters
- page
- Type:Page
- Description:N/A
Finalize()
- N/A
Remarks
- N/A
Return Value
- Type:Void
- Description:N/A
Parameters
MemberwiseClone()
- N/A
Remarks
- N/A
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
N/A
Return Value
- Type:Int32
TileHeight
Gets or sets the height of each tile if the layer is in MultipleTile mode.
Remarks
N/A
Return Value
- Type:Int32
TransitionEffect
Gets or sets the transition effect to use when the map is zoomed.
Remarks
N/A
Return Value
Remarks
N/A
Return Value
- Type:Int32
TileType
Gets or sets whether or not the LayerOverlay uses tiling.
Remarks
N/A
Return Value
- Type:TileType
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
N/A
Return Value
- Type:Int32
ServerCache
Gets or sets the server cache in the overlay.
Remarks
N/A
Return Value
- Type:ServerCache
ClientCache
Gets or sets the ClientCache object that contains the configuration for the browser cache of this overlay.
Remarks
N/A
Return Value
- Type:ClientCache
WebImageFormat
Gets or sets the format of the image that is sent to the web browser.
Remarks
N/A
Return Value
- Type:WebImageFormat
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 JpegQuality 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
N/A
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 Layers property holds all of the layers that are used by the Draw 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
N/A
Return Value
- Type:Boolean
WrapDateline
Gets or sets a value that indicates whether the overlay wraps at the date line.
Remarks
N/A
Return Value
Remarks
N/A
Return Value
Remarks
N/A
Return Value
- Type:String
Opacity
N/A
Remarks
N/A
Return Value
- Type:Single
IsVisibleInOverlaySwitcher
N/A
Remarks
N/A
Return Value
- Type:Boolean
IsBaseOverlay
N/A
Remarks
N/A
Return Value
- Type:Boolean
Id
N/A
Remarks
N/A
Return Value
- Type:String
OnClientAutoRefreshTick
N/A
Remarks
N/A
Return Value
- Type:String
AutoRefreshInterval
N/A
Remarks
N/A
Return Value
- Type:TimeSpan
Attribution
N/A
Remarks
N/A
Return Value
- Type:String
Protected Properties
OverlayType
Gets a string that indicates the overlay type.
Remarks
N/A
Return Value
- Type:String
ExtraParameter
Gets or sets extra parameters for current overlay.
Remarks
N/A
Return Value
- Type:String
Projection
Gets or sets projection of current overlay for requesting images.
Remarks
N/A
Return Value
- Type:String
TRU=
N/A
Remarks
N/A
Return Value
Remarks
N/A
Return Value
- Type:Double