Differences

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

--- thinkgeo.mapsuite.mvcedition.openstreetmapoverlay [2015/08/20 03:08]
127.0.0.1 external edit
+++ thinkgeo.mapsuite.mvcedition.openstreetmapoverlay [2017/03/16 21:59] (current)
@@ Line 1: / Line 1: @@
 ====== ThinkGeo.MapSuite.MvcEdition.OpenStreetMapOverlay ======
+{{section>upgrade_map_suite_to_10.0}}
-<!-- Class -->
 This class is used to display data from OpenStreetMap server.
 ===== Inheritance Hierarchy =====
-*System.Object
+  *System.Object
-**[[ThinkGeo.MapSuite.MvcEdition.Overlay]]
+    *ThinkGeo.MapSuite.MvcEdition.Overlay
-***[[ThinkGeo.MapSuite.MvcEdition.OpenStreetMapOverlay]]
+      ***ThinkGeo.MapSuite.MvcEdition.OpenStreetMapOverlay**
 ===== Members Summary =====
 ==== Public Constructors ====
-^ Name ^ Parameters ^ DeclaringType ^ Summary ^
+** {{wiki:PublicMethod.gif|}} OpenStreetMapOverlay() **
-| {{wiki:PublicMethod.gif|Public Method}}[[#OpenStreetMapOverlay()|OpenStreetMapOverlay]]   |    |    | Initialize an instance of the OpenStreetMapOverlay class.   |
-| {{wiki:PublicMethod.gif|Public Method}}[[#OpenStreetMapOverlay(String)|OpenStreetMapOverlay]]   | String   |    | Initialize an instance of the OpenStreetMapOverlay class.   |
-==== Protected Constructors ====
+  * //Initialize an instance of the OpenStreetMapOverlay class.//
-^ Name ^ Parameters ^ DeclaringType ^ Summary ^
+== Remarks ==
+  * //N/A//
+== Parameters ==
+<div newline></div>
+** {{wiki:PublicMethod.gif|}} OpenStreetMapOverlay(String) **
+  * //Initialize an instance of the OpenStreetMapOverlay class.//
+== Remarks ==
+  * //N/A//
+== Parameters ==
+  * //id//
+    * Type:String
+    * Description:The identifier string of the OpenStreetMapOverlay.
+<div newline></div>
+==== Protected Constructors ====
 ==== Public Methods ====
-^ Name ^ Parameters ^ DeclaringType ^ Summary ^
+** {{wiki:PublicMethod.gif|}} ToJson() **
-| {{wiki:PublicMethod.gif|Public Method}}[[#Equals(Object)|Equals]]   | Object   | Object   |    |
-| {{wiki:PublicMethod.gif|Public Method}}[[#FromJson(String)|FromJson]]   | String   | [[ThinkGeo.MapSuite.MvcEdition.Overlay|Overlay]]   | Load this object from a json string.   |
-| {{wiki:PublicMethod.gif|Public Method}}[[#GetHashCode()|GetHashCode]]   |    | Object   |    |
-| {{wiki:PublicMethod.gif|Public Method}}[[#GetType()|GetType]]   |    | Object   |    |
-| {{wiki:PublicMethod.gif|Public Method}}[[#ToJson()|ToJson]]   |    | [[ThinkGeo.MapSuite.MvcEdition.Overlay|Overlay]]   | Returns a JSON string which contains the information for creating an overlay at the client side.   |
-| {{wiki:PublicMethod.gif|Public Method}}[[#ToString()|ToString]]   |    | Object   |    |
-==== Protected Methods ====
+  * //N/A//
-^ Name ^ Parameters ^ DeclaringType ^ Summary ^
+== Remarks ==
-| {{wiki:ProtectedMethod.gif|Protected Method}}[[#Finalize()|Finalize]]   |    | Object   |    |
+  * //N/A//
-| {{wiki:ProtectedMethod.gif|Protected Method}}[[#MemberwiseClone()|MemberwiseClone]]   |    | Object   |    |
-| {{wiki:ProtectedMethod.gif|Protected Method}}[[#RegisterJavaScriptLibraryCore(Page)|RegisterJavaScriptLibraryCore]]   | Page   | [[ThinkGeo.MapSuite.MvcEdition.Overlay|Overlay]]   | Registers a Javascript library URL string to the client HTML page.   |
-==== Public Properties ====
+== Return Value ==
-^ Name ^ Return ^ DeclaringType ^ Summary ^
+  * Type:String
-| {{wiki:PublicProperty.gif|Public Property}}[[#Attribution|Attribution]]   | String   | [[ThinkGeo.MapSuite.MvcEdition.Overlay|Overlay]]   |    |
+  * Description:N/A
-| {{wiki:PublicProperty.gif|Public Property}}[[#AutoRefreshInterval|AutoRefreshInterval]]   | TimeSpan   | [[ThinkGeo.MapSuite.MvcEdition.Overlay|Overlay]]   | Gets or sets the time interval in which the MarkerOverlay refreshes itself.   |
-| {{wiki:PublicProperty.gif|Public Property}}[[#Id|Id]]   | String   | [[ThinkGeo.MapSuite.MvcEdition.Overlay|Overlay]]   | Gets the identifier for the overlay to be found.   |
-| {{wiki:PublicProperty.gif|Public Property}}[[#IsBaseOverlay|IsBaseOverlay]]   | Boolean   | [[ThinkGeo.MapSuite.MvcEdition.Overlay|Overlay]]   | Gets or sets a value that indicates whether the overlay is a base overlay.   |
-| {{wiki:PublicProperty.gif|Public Property}}[[#IsVisible|IsVisible]]   | Boolean   | [[ThinkGeo.MapSuite.MvcEdition.Overlay|Overlay]]   | Gets or sets a value that indicates whether the overlay is visible on the map.   |
-| {{wiki:PublicProperty.gif|Public Property}}[[#IsVisibleInOverlaySwitcher|IsVisibleInOverlaySwitcher]]   | Boolean   | [[ThinkGeo.MapSuite.MvcEdition.Overlay|Overlay]]   | Gets or sets a value that indicates whether the overlay name is displayed in the OverlaySwitcher.   |
-| {{wiki:PublicProperty.gif|Public Property}}[[#Name|Name]]   | String   | [[ThinkGeo.MapSuite.MvcEdition.Overlay|Overlay]]   | Gets or sets the name of the overlay, which will display in the OverlaySwitcher.   |
-| {{wiki:PublicProperty.gif|Public Property}}[[#OnClientAutoRefreshTick|OnClientAutoRefreshTick]]   | String   | [[ThinkGeo.MapSuite.MvcEdition.Overlay|Overlay]](overriden)   | Don't support auto tick event by default.   |
-| {{wiki:PublicProperty.gif|Public Property}}[[#Opacity|Opacity]]   | Single   | [[ThinkGeo.MapSuite.MvcEdition.Overlay|Overlay]]   | Gets or sets the opacity level of the overlay.   |
-| {{wiki:PublicProperty.gif|Public Property}}[[#TileHeight|TileHeight]]   | Int32   |    | Gets or sets the height of each tile, if the OpenStreetMapOverlay uses tiling.   |
-| {{wiki:PublicProperty.gif|Public Property}}[[#TileWidth|TileWidth]]   | Int32   |    | Gets or sets the width of each tile, if the OpenStreetMapOverlay uses tiling.   |
-==== Protected Properties ====
+== Parameters ==
-^ Name ^ Return ^ DeclaringType ^ Summary ^
+<div newline></div>
-| {{wiki:ProtectedProperty.gif|Protected Property}}[[#OverlayType|OverlayType]]   | String   | [[ThinkGeo.MapSuite.MvcEdition.Overlay|Overlay]](overriden)   | Gets the type of this overlay which uses for serializing to JSON and parses to a real overlay on the client side.   |
+** {{wiki:PublicMethod.gif|}} FromJson(String) **
-==== Public Events ====
+  * //N/A//
-^ Name ^ Event Arguments ^ DeclaringType ^ Summary ^
+== Remarks ==
+  * //N/A//
-===== Public Constructors =====
+== Return Value ==
-==== OpenStreetMapOverlay() ====
+  * Type:Void
-Initialize an instance of the OpenStreetMapOverlay class.
+  * Description:N/A
-=== Parameters ===
-^  Name ^  Type ^  Description ^
-[[#Public Constructors|Go Back]]
+== Parameters ==
-==== OpenStreetMapOverlay(String) ====
+  * //jsonString//
-Initialize an instance of the OpenStreetMapOverlay class.
+    * Type:String
-=== Parameters ===
+    * Description:N/A
-^  Name ^  Type ^  Description ^
-| id   | String<!-- System.String -->   | The identifier string of the OpenStreetMapOverlay.   |
-[[#Public Constructors|Go Back]]
+<div newline></div>
-===== Protected Constructors =====
+** {{wiki:PublicMethod.gif|}} ToString() **
-===== Public Methods =====
-==== Equals(Object) ====
-=== Return Value ===
-^ Return Type ^ Description ^
-| Boolean<!-- System.Boolean -->   |    |
-=== Parameters ===
+  * //N/A//
-^  Name ^  Type ^  Description ^
+== Remarks ==
-| obj   | Object<!-- System.Object -->   |    |
+  * //N/A//
-<!-- System.Object -->
+== Return Value ==
-[[#Public Methods|Go Back]]
+  * Type:String
-==== FromJson(String) ====
+  * Description:N/A
-Load this object from a json string.
-=== Return Value ===
-^ Return Type ^ Description ^
-| Void<!-- System.Void -->   |    |
-=== Parameters ===
+== Parameters ==
-^  Name ^  Type ^  Description ^
+<div newline></div>
-| jsonString   | String<!-- System.String -->   | a json string   |
+** {{wiki:PublicMethod.gif|}} Equals(Object) **
-<!-- ThinkGeo.MapSuite.MvcEdition.Overlay -->
+  * //N/A//
-[[#Public Methods|Go Back]]
+== Remarks ==
-==== GetHashCode() ====
+  * //N/A//
-=== Return Value ===
-^ Return Type ^ Description ^
-| Int32<!-- System.Int32 -->   |    |
-=== Parameters ===
+== Return Value ==
-^  Name ^  Type ^  Description ^
+  * Type:Boolean
+  * Description:N/A
-<!-- System.Object -->
+== Parameters ==
-[[#Public Methods|Go Back]]
+  * //obj//
-==== GetType() ====
+    * Type:Object
-=== Return Value ===
+    * Description:N/A
-^ Return Type ^ Description ^
-| Type<!-- System.Type -->   |    |
-=== Parameters ===
+<div newline></div>
-^  Name ^  Type ^  Description ^
+** {{wiki:PublicMethod.gif|}} GetHashCode() **
-<!-- System.Object -->
+  * //N/A//
-[[#Public Methods|Go Back]]
+== Remarks ==
-==== ToJson() ====
+  * //N/A//
-Returns a JSON string which contains the information for creating an overlay at the client side.
-=== Return Value ===
-^ Return Type ^ Description ^
-| String<!-- System.String -->   | A JSON string which is used to create an overlay at the client side.   |
-=== Parameters ===
+== Return Value ==
-^  Name ^  Type ^  Description ^
+  * Type:Int32
+  * Description:N/A
-<!-- ThinkGeo.MapSuite.MvcEdition.Overlay -->
+== Parameters ==
-[[#Public Methods|Go Back]]
+<div newline></div>
-==== ToString() ====
+** {{wiki:PublicMethod.gif|}} GetType() **
-=== Return Value ===
-^ Return Type ^ Description ^
-| String<!-- System.String -->   |    |
-=== Parameters ===
+  * //N/A//
-^  Name ^  Type ^  Description ^
+== Remarks ==
+  * //N/A//
-<!-- System.Object -->
+== Return Value ==
-[[#Public Methods|Go Back]]
+  * Type:Type
-===== Protected Methods =====
+  * Description:N/A
-==== Finalize() ====
-=== Return Value ===
-^ Return Type ^ Description ^
-| Void<!-- System.Void -->   |    |
-=== Parameters ===
+== Parameters ==
-^  Name ^  Type ^  Description ^
+<div newline></div>
+==== Protected Methods ====
+** {{wiki:ProtectedMethod.gif|}} EhQ=(Page) **
-<!-- System.Object -->
+  * //N/A//
-[[#Protected Methods|Go Back]]
+== Remarks ==
-==== MemberwiseClone() ====
+  * //N/A//
-=== Return Value ===
-^ Return Type ^ Description ^
-| Object<!-- System.Object -->   |    |
-=== Parameters ===
+== Return Value ==
-^  Name ^  Type ^  Description ^
+  * Type:Void
+  * Description:N/A
-<!-- System.Object -->
+== Parameters ==
-[[#Protected Methods|Go Back]]
+  * //page//
-==== RegisterJavaScriptLibraryCore(Page) ====
+    * Type:Page
-Registers a Javascript library URL string to the client HTML page.
+    * Description:N/A
-=== Remarks ===
-The <strong>RegisterJavaScriptLibraryCore</strong> 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 ===
+<div newline></div>
-^  Name ^  Type ^  Description ^
+** {{wiki:ProtectedMethod.gif|}} RegisterJavaScriptLibraryCore(Page) **
-| page   | Page<!-- System.Web.UI.Page -->   | The page object that is used for registering the javascript library.   |
-<!-- ThinkGeo.MapSuite.MvcEdition.Overlay -->
+  * //N/A//
-[[#Protected Methods|Go Back]]
+== Remarks ==
-===== Public Properties =====
+  * //N/A//
-==== Attribution ====
-=== Return Value ===
-^ Return Type ^
-| String<!-- System.String -->   |
-<!-- ThinkGeo.MapSuite.MvcEdition.Overlay -->
+== Return Value ==
-[[#Public Properties|Go Back]]
+  * Type:Void
-==== AutoRefreshInterval ====
+  * Description:N/A
-Gets or sets the time interval in which the MarkerOverlay refreshes itself.
-=== Return Value ===
-^ Return Type ^
-| TimeSpan<!-- System.TimeSpan -->   |
-<!-- ThinkGeo.MapSuite.MvcEdition.Overlay -->
+== Parameters ==
-[[#Public Properties|Go Back]]
+  * //page//
-==== Id ====
+    * Type:Page
-Gets the identifier for the overlay to be found.
+    * Description:N/A
-=== Return Value ===
-^ Return Type ^
-| String<!-- System.String -->   |
-<!-- ThinkGeo.MapSuite.MvcEdition.Overlay -->
+<div newline></div>
-[[#Public Properties|Go Back]]
+** {{wiki:ProtectedMethod.gif|}} Finalize() **
-==== IsBaseOverlay ====
-Gets or sets a value that indicates whether the overlay is a base overlay.
-=== Return Value ===
-^ Return Type ^
-| Boolean<!-- System.Boolean -->   |
-<!-- ThinkGeo.MapSuite.MvcEdition.Overlay -->
+  * //N/A//
-[[#Public Properties|Go Back]]
+== Remarks ==
-==== IsVisible ====
+  * //N/A//
-Gets or sets a value that indicates whether the overlay is visible on the map.
-=== Return Value ===
-^ Return Type ^
-| Boolean<!-- System.Boolean -->   |
-<!-- ThinkGeo.MapSuite.MvcEdition.Overlay -->
+== Return Value ==
-[[#Public Properties|Go Back]]
+  * Type:Void
-==== IsVisibleInOverlaySwitcher ====
+  * Description:N/A
-Gets or sets a value that indicates whether the overlay name is displayed in the OverlaySwitcher.
-=== Return Value ===
-^ Return Type ^
-| Boolean<!-- System.Boolean -->   |
-<!-- ThinkGeo.MapSuite.MvcEdition.Overlay -->
+== Parameters ==
-[[#Public Properties|Go Back]]
+<div newline></div>
-==== Name ====
+** {{wiki:ProtectedMethod.gif|}} MemberwiseClone() **
-Gets or sets the name of the overlay, which will display in the OverlaySwitcher.
-=== Return Value ===
-^ Return Type ^
-| String<!-- System.String -->   |
-<!-- ThinkGeo.MapSuite.MvcEdition.Overlay -->
+  * //N/A//
-[[#Public Properties|Go Back]]
+== Remarks ==
-==== OnClientAutoRefreshTick ====
+  * //N/A//
-Don't support auto tick event by default.
-=== Return Value ===
-^ Return Type ^
-| String<!-- System.String -->   |
-<!-- ThinkGeo.MapSuite.MvcEdition.Overlay(overriden) -->
+== Return Value ==
-[[#Public Properties|Go Back]]
+  * Type:Object
-==== Opacity ====
+  * Description:N/A
-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 ===
-^ Return Type ^
-| Single<!-- System.Single -->   |
-<!-- ThinkGeo.MapSuite.MvcEdition.Overlay -->
+== Parameters ==
-[[#Public Properties|Go Back]]
+<div newline></div>
-==== TileHeight ====
+==== Public Properties ====
-Gets or sets the height of each tile, if the OpenStreetMapOverlay uses tiling.
+** {{wiki:PublicProperty.gif|}} TileWidth **
-=== Return Value ===
-^ Return Type ^
-| Int32<!-- System.Int32 -->   |
-<!-- ThinkGeo.MapSuite.MvcEdition.OpenStreetMapOverlay -->
-[[#Public Properties|Go Back]]
-==== TileWidth ====
 Gets or sets the width of each tile, if the OpenStreetMapOverlay uses tiling.
-=== Return Value ===
+== Remarks ==
-^ Return Type ^
+N/A
-| Int32<!-- System.Int32 -->   |
+== Return Value ==
+  * Type:Int32
+** {{wiki:PublicProperty.gif|}} TileHeight **
+Gets or sets the height of each tile, if the OpenStreetMapOverlay uses tiling.
+== Remarks ==
+N/A
+== Return Value ==
+  * Type:Int32
+** {{wiki:PublicProperty.gif|}} OnClientAutoRefreshTick **
+Don't support auto tick event by default.
+== Remarks ==
+N/A
+== Return Value ==
+  * Type:String
+** {{wiki:PublicProperty.gif|}} IsVisible **
+N/A
+== Remarks ==
+N/A
+== Return Value ==
+  * Type:Boolean
+** {{wiki:PublicProperty.gif|}} Name **
+N/A
+== Remarks ==
+N/A
+== Return Value ==
+  * Type:String
+** {{wiki:PublicProperty.gif|}} Opacity **
+N/A
+== Remarks ==
+N/A
+== Return Value ==
+  * Type:Single
+** {{wiki:PublicProperty.gif|}} IsVisibleInOverlaySwitcher **
+N/A
+== Remarks ==
+N/A
+== Return Value ==
+  * Type:Boolean
+** {{wiki:PublicProperty.gif|}} IsBaseOverlay **
+N/A
+== Remarks ==
+N/A
+== Return Value ==
+  * Type:Boolean
+** {{wiki:PublicProperty.gif|}} Id **
+N/A
+== Remarks ==
+N/A
+== Return Value ==
+  * Type:String
+** {{wiki:PublicProperty.gif|}} AutoRefreshInterval **
+N/A
+== Remarks ==
+N/A
+== Return Value ==
+  * Type:TimeSpan
+** {{wiki:PublicProperty.gif|}} Attribution **
+N/A
+== Remarks ==
+N/A
+== Return Value ==
+  * Type:String
+==== Protected Properties ====
+** {{wiki:ProtectedProperty.gif|}} OverlayType **
-<!-- ThinkGeo.MapSuite.MvcEdition.OpenStreetMapOverlay -->
-[[#Public Properties|Go Back]]
-===== Protected Properties =====
-==== OverlayType ====
 Gets the type of this overlay which uses for serializing to JSON and parses to a real overlay on the client side.
-=== Return Value ===
+== Remarks ==
-^ Return Type ^
+N/A
-| String<!-- System.String -->   |
+== Return Value ==
+  * Type:String
-<!-- ThinkGeo.MapSuite.MvcEdition.Overlay(overriden) -->
+** {{wiki:ProtectedProperty.gif|}} ERQ= **
-[[#Protected Properties|Go Back]]
-===== Public Events =====
+N/A
-__NOTOC__
+== Remarks ==
-[[Category:MvcEdition]]
+N/A
-[[Category:ThinkGeo.MapSuite.MvcEdition]]
+== Return Value ==
-[[Category:UpdateDocumentation]]
+  * Type:Double
+==== Public Events ====

User Tools

Site Tools

Differences

Page Tools