Differences

This shows you the differences between two versions of the page.

--- thinkgeo.mapsuite.webedition.layeroverlay [2015/09/18 03:08]
admin
+++ thinkgeo.mapsuite.webedition.layeroverlay [2017/03/16 21:59] (current)
@@ Line 1: / Line 1: @@
 ====== ThinkGeo.MapSuite.WebEdition.LayerOverlay ======
+{{section>upgrade_map_suite_to_10.0}}
 Represents an Overlay that contains layers.
 ===== Inheritance Hierarchy =====
@@ Line 9: / Line 12: @@
 ** {{wiki:PublicMethod.gif|}} LayerOverlay() **
-Initialize an instance of the LayerOverlay class.
+  * //Initialize an instance of the LayerOverlay class.//
 == Remarks ==
-N/A
+  * //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 ==
 <div newline></div>
 ** {{wiki:PublicMethod.gif|}} LayerOverlay(String) **
-Initialize an instance of the LayerOverlay class with the overlay identifier specified.
+  * //Initialize an instance of the LayerOverlay class with the overlay identifier specified.//
 == Remarks ==
-N/A
+  * //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//
@@ Line 27: / Line 30: @@
 ** {{wiki:PublicMethod.gif|}} 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.
+  * //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
+  * //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//
@@ Line 48: / Line 51: @@
 ** {{wiki:PublicMethod.gif|}} SetBaseEpsgProjection(String) **
-Sets the EPSG projection of the LayerOverlay when it is a base overlay.
+  * //Sets the EPSG projection of the LayerOverlay when it is a base overlay.//
 == Remarks ==
-N/A
+  * //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 ==
@@ Line 64: / Line 67: @@
 ** {{wiki:PublicMethod.gif|}} GetBaseEpsgProjection() **
-Returns an EPSG string that indicates the projection of the LayerOverlay.
+  * //Returns an EPSG string that indicates the projection of the LayerOverlay.//
 == Remarks ==
-N/A
+  * //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 ==
@@ Line 76: / Line 79: @@
 ** {{wiki:PublicMethod.gif|}} GetBoundingBox() **
-Gets the smallest extent that includes all of the features of all layers in the LayerOverlay.
+  * //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.
+  * //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 ==
@@ Line 88: / Line 91: @@
 ** {{wiki:PublicMethod.gif|}} Draw(GeoCanvas,Object,RectangleShape,GeographyUnit) **
-Draw all of the layers to the image object using the parameters specified.
+  * //Draw all of the layers to the image object using the parameters specified.//
 == Remarks ==
-N/A
+  * //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 ==
@@ Line 116: / Line 119: @@
 ** {{wiki:PublicMethod.gif|}} Redraw() **
-Redraw this overlay.
+  * //Redraw this overlay.//
 == Remarks ==
-N/A
+  * //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 ==
@@ Line 128: / Line 131: @@
 ** {{wiki:PublicMethod.gif|}} GenerateCacheImages(ZoomLevel,RectangleShape,GeographyUnit) **
-Generates images to the server cache by zoomLevel.
+  * //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.
+  * //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 ==
@@ Line 152: / Line 155: @@
 ** {{wiki:PublicMethod.gif|}} GenerateCacheImages(Double,RectangleShape,GeographyUnit) **
-Generates the images to the server cache by scale.
+  * //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.
+  * //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 ==
@@ Line 176: / Line 179: @@
 ** {{wiki:PublicMethod.gif|}} ToJson() **
-N/A
+  * //Returns a JSON string which contains the information for creating an overlay at the client side.//
 == Remarks ==
-N/A
+  * //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:N/A
+  * Description:A JSON string which is used to create an overlay at the client side.
 == Parameters ==
@@ Line 188: / Line 191: @@
 ** {{wiki:PublicMethod.gif|}} ToString() **
-N/A
+  * //N/A//
 == Remarks ==
-N/A
+  * //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 ==
@@ Line 200: / Line 203: @@
 ** {{wiki:PublicMethod.gif|}} Equals(Object) **
-N/A
+  * //N/A//
 == Remarks ==
-N/A
+  * //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 ==
@@ Line 216: / Line 219: @@
 ** {{wiki:PublicMethod.gif|}} GetHashCode() **
-N/A
+  * //N/A//
 == Remarks ==
-N/A
+  * //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 ==
@@ Line 228: / Line 231: @@
 ** {{wiki:PublicMethod.gif|}} GetType() **
-N/A
+  * //N/A//
 == Remarks ==
-N/A
+  * //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 ==
@@ Line 241: / Line 244: @@
 ** {{wiki:ProtectedMethod.gif|}} DrawCore(GeoCanvas,Object,RectangleShape,GeographyUnit) **
-Draw all of the layers to the image object using the parameters specified.
+  * //Draw all of the layers to the image object using the parameters specified.//
 == Remarks ==
-N/A
+  * //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 ==
@@ Line 269: / Line 272: @@
 ** {{wiki:ProtectedMethod.gif|}} 3xM=(Page) **
-N/A
+  * //N/A//
 == Remarks ==
-N/A
+  * //N/A//
 == Return Value ==
@@ Line 285: / Line 288: @@
 ** {{wiki:ProtectedMethod.gif|}} RegisterJavaScriptLibraryCore(Page) **
-N/A
+  * //Registers a Javascript library URL string to the client HTML page.//
 == Remarks ==
-N/A
+  * //The <strong>RegisterJavaScriptLibraryCore</strong> method allows derived classes to override and register their own Javascript library URL to the HTML page.//
 == Return Value ==
@@ Line 296: / Line 299: @@
   * //page//
     * Type:Page
-    * Description:N/A
+    * Description:The page object that is used for registering the javascript library.
 <div newline></div>
 ** {{wiki:ProtectedMethod.gif|}} RaiseTickEvent(EventArgs) **
-N/A
+  * //N/A//
 == Remarks ==
-N/A
+  * //N/A//
 == Return Value ==
@@ Line 317: / Line 320: @@
 ** {{wiki:ProtectedMethod.gif|}} OnTick(EventArgs) **
-N/A
+  * //Raises the Tick event of the MarkerOverlay.//
 == Remarks ==
-N/A
+  * //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 ==
@@ Line 328: / Line 331: @@
   * //e//
     * Type:EventArgs
-    * Description:N/A
+    * Description:An System.EventArgs object that contains the event data.
 <div newline></div>
 ** {{wiki:ProtectedMethod.gif|}} Finalize() **
-N/A
+  * //N/A//
 == Remarks ==
-N/A
+  * //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 ==
@@ Line 345: / Line 348: @@
 ** {{wiki:ProtectedMethod.gif|}} MemberwiseClone() **
-N/A
+  * //N/A//
 == Remarks ==
-N/A
+  * //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 ==
@@ Line 360: / Line 363: @@
 Gets or sets the width of each tile if the layer is in MultipleTile mode.
 == Remarks ==
-N/A
+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
@@ Line 368: / Line 371: @@
 Gets or sets the height of each tile if the layer is in MultipleTile mode.
 == Remarks ==
-N/A
+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
@@ Line 376: / Line 379: @@
 Gets or sets the transition effect to use when the map is zoomed.
 == Remarks ==
-N/A
+For the most updated Info for this topic, please check it here:http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.LayerOverlay#TransitionEffect
 == Return Value ==
   * Type:[[ThinkGeo.MapSuite.WebEdition.TransitionEffect|TransitionEffect]]
@@ Line 384: / Line 387: @@
 N/A
 == Remarks ==
-N/A
+For the most updated Info for this topic, please check it here:
 == Return Value ==
   * Type:Int32
@@ Line 392: / Line 395: @@
 Gets or sets whether or not the LayerOverlay uses tiling.
 == Remarks ==
-N/A
+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
 == Return Value ==
   * Type:[[ThinkGeo.MapSuite.WebEdition.TileType|TileType]]
@@ Line 400: / Line 403: @@
 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
+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
@@ Line 408: / Line 411: @@
 Gets or sets the server cache in the overlay.
 == Remarks ==
-N/A
+For the most updated Info for this topic, please check it here:http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.LayerOverlay#ServerCache
 == Return Value ==
   * Type:[[ThinkGeo.MapSuite.WebEdition.ServerCache|ServerCache]]
@@ Line 416: / Line 419: @@
 Gets or sets the ClientCache object that contains the configuration for the browser cache of this overlay.
 == Remarks ==
-N/A
+For the most updated Info for this topic, please check it here:http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.LayerOverlay#ClientCache
 == Return Value ==
   * Type:[[ThinkGeo.MapSuite.WebEdition.ClientCache|ClientCache]]
@@ Line 424: / Line 427: @@
 Gets or sets the format of the image that is sent to the web browser.
 == Remarks ==
-N/A
+For the most updated Info for this topic, please check it here:http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.LayerOverlay#WebImageFormat
 == Return Value ==
   * Type:[[ThinkGeo.MapSuite.WebEdition.WebImageFormat|WebImageFormat]]
@@ Line 432: / Line 435: @@
 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.
+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
@@ Line 440: / Line 443: @@
 Gets or sets whether the multi-thread is disabled or not.
 == Remarks ==
-N/A
+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
@@ Line 448: / Line 451: @@
 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.
+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 ==
   * Type:[[ThinkGeo.MapSuite.Core.GeoCollection<T>[[ThinkGeo.MapSuite.Core.Layer, MapSuiteCore, Version=9.0.0.0, Culture=neutral, PublicKeyToken=null]]|GeoCollection<T>]]
@@ Line 456: / Line 459: @@
 Gets or sets a value that indicates whether the overlay is visible on the map.
 == Remarks ==
-N/A
+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
@@ Line 464: / Line 467: @@
 Gets or sets a value that indicates whether the overlay wraps at the date line.
 == Remarks ==
-N/A
+For the most updated Info for this topic, please check it here:http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.LayerOverlay#WrapDateline
 == Return Value ==
   * Type:[[ThinkGeo.MapSuite.WebEdition.WrapDatelineMode|WrapDatelineMode]]
@@ Line 470: / Line 473: @@
 ** {{wiki:PublicProperty.gif|}} Name **
-N/A
+Gets or sets the name of the overlay, which will display in the OverlaySwitcher.
 == Remarks ==
-N/A
+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
@@ Line 478: / Line 481: @@
 ** {{wiki:PublicProperty.gif|}} Opacity **
-N/A
+Gets or sets the opacity level of the overlay.
 == Remarks ==
-N/A
+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
@@ Line 486: / Line 489: @@
 ** {{wiki:PublicProperty.gif|}} IsVisibleInOverlaySwitcher **
-N/A
+Gets or sets a value that indicates whether the overlay name is displayed in the OverlaySwitcher.
 == Remarks ==
-N/A
+For the most updated Info for this topic, please check it here:http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.LayerOverlay#IsVisibleInOverlaySwitcher
 == Return Value ==
   * Type:Boolean
@@ Line 494: / Line 497: @@
 ** {{wiki:PublicProperty.gif|}} IsBaseOverlay **
-N/A
+Gets or sets a value that indicates whether the overlay is a base overlay.
 == Remarks ==
-N/A
+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
@@ Line 502: / Line 505: @@
 ** {{wiki:PublicProperty.gif|}} Id **
-N/A
+Gets the identifier for the overlay to be found.
 == Remarks ==
-N/A
+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
@@ Line 510: / Line 513: @@
 ** {{wiki:PublicProperty.gif|}} AutoRefreshInterval **
-N/A
+Gets or sets the time interval in which the MarkerOverlay refreshes itself.
 == Remarks ==
-N/A
+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
@@ Line 520: / Line 523: @@
 N/A
 == Remarks ==
-N/A
+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
@@ Line 529: / Line 532: @@
 Gets a string that indicates the overlay type.
 == Remarks ==
-N/A
+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
@@ Line 537: / Line 540: @@
 Gets or sets extra parameters for current overlay.
 == Remarks ==
-N/A
+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
@@ Line 545: / Line 548: @@
 Gets or sets projection of current overlay for requesting images.
 == Remarks ==
-N/A
+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
@@ Line 551: / Line 554: @@
 ** {{wiki:ProtectedProperty.gif|}} HasTickEvent **
-N/A
+Indicates whether the overlay supports tick event.
 == Remarks ==
-N/A
+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
@@ Line 567: / Line 570: @@
 ==== Public Events ====
 ** {{wiki:PublicEvent.gif|}} Tick **
-N/A
+Occurs when the number of milliseconds specified in the AutoRefreshInterval property has elapsed and the page is posted to the server.
 == Remarks ==
-N/A
+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

User Tools

Site Tools

Differences

Page Tools