This shows you the differences between two versions of the page.
| Next revision | Previous revision | ||
|
thinkgeo.mapsuite.webedition.openstreetmapoverlay [2015/08/20 03:08] 127.0.0.1 external edit |
thinkgeo.mapsuite.webedition.openstreetmapoverlay [2017/03/16 21:59] (current) |
||
|---|---|---|---|
| Line 1: | Line 1: | ||
| ====== ThinkGeo.MapSuite.WebEdition.OpenStreetMapOverlay ====== | ====== ThinkGeo.MapSuite.WebEdition.OpenStreetMapOverlay ====== | ||
| + | {{section>upgrade_map_suite_to_10.0}} | ||
| - | |||
| - | <!-- Class --> | ||
| This class is used to display data from OpenStreetMap server. | This class is used to display data from OpenStreetMap server. | ||
| - | === Remarks === | ||
| - | For the most updated Info for this topic, please check it here:<a href="http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.OpenStreetMapOverlay" target="_blank">http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.OpenStreetMapOverlay</a> | ||
| ===== Inheritance Hierarchy ===== | ===== Inheritance Hierarchy ===== | ||
| - | *System.Object | + | *System.Object |
| - | **[[ThinkGeo.MapSuite.WebEdition.Overlay]] | + | *ThinkGeo.MapSuite.WebEdition.Overlay |
| - | ***[[ThinkGeo.MapSuite.WebEdition.OpenStreetMapOverlay]] | + | ***ThinkGeo.MapSuite.WebEdition.OpenStreetMapOverlay** |
| ===== Members Summary ===== | ===== Members Summary ===== | ||
| ==== Public Constructors ==== | ==== 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 ==== | ==== 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}}[[#GetHashCode()|GetHashCode]] | | Object | | | + | |
| - | | {{wiki:PublicMethod.gif|Public Method}}[[#GetType()|GetType]] | | Object | | | + | |
| - | | {{wiki:PublicMethod.gif|Public Method}}[[#ToJson()|ToJson]] | | [[ThinkGeo.MapSuite.WebEdition.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}}[[#OnTick(EventArgs)|OnTick]] | EventArgs | [[ThinkGeo.MapSuite.WebEdition.Overlay|Overlay]] | Raises the Tick event of the MarkerOverlay. | | + | |
| - | | {{wiki:ProtectedMethod.gif|Protected Method}}[[#RegisterJavaScriptLibraryCore(Page)|RegisterJavaScriptLibraryCore]] | Page | [[ThinkGeo.MapSuite.WebEdition.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.WebEdition.Overlay|Overlay]] | | | + | * Description:N/A |
| - | | {{wiki:PublicProperty.gif|Public Property}}[[#AutoRefreshInterval|AutoRefreshInterval]] | TimeSpan | [[ThinkGeo.MapSuite.WebEdition.Overlay|Overlay]] | Gets or sets the time interval in which the MarkerOverlay refreshes itself. | | + | |
| - | | {{wiki:PublicProperty.gif|Public Property}}[[#CustomServerUris|CustomServerUris]] | Collection<Uri> | | | | + | |
| - | | {{wiki:PublicProperty.gif|Public Property}}[[#Id|Id]] | String | [[ThinkGeo.MapSuite.WebEdition.Overlay|Overlay]] | Gets the identifier for the overlay to be found. | | + | |
| - | | {{wiki:PublicProperty.gif|Public Property}}[[#IsBaseOverlay|IsBaseOverlay]] | Boolean | [[ThinkGeo.MapSuite.WebEdition.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.WebEdition.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.WebEdition.Overlay|Overlay]] | Gets or sets a value that indicates whether the overlay name is displayed in the OverlaySwitcher. | | + | |
| - | | {{wiki:PublicProperty.gif|Public Property}}[[#MapType|MapType]] | [[ThinkGeo.MapSuite.WebEdition.OpenStreetMapType|OpenStreetMapType]] | | Gets or sets a value to display which tileset for render OpenStreetMap data. | | + | |
| - | | {{wiki:PublicProperty.gif|Public Property}}[[#Name|Name]] | String | [[ThinkGeo.MapSuite.WebEdition.Overlay|Overlay]] | Gets or sets the name of the overlay, which will display in the OverlaySwitcher. | | + | |
| - | | {{wiki:PublicProperty.gif|Public Property}}[[#Opacity|Opacity]] | Single | [[ThinkGeo.MapSuite.WebEdition.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}}[[#HasTickEvent|HasTickEvent]] | Boolean | [[ThinkGeo.MapSuite.WebEdition.Overlay|Overlay]](overriden) | Don't support auto tick event by default. | | + | ** {{wiki:PublicMethod.gif|}} ToString() ** |
| - | | {{wiki:ProtectedProperty.gif|Protected Property}}[[#OverlayType|OverlayType]] | String | [[ThinkGeo.MapSuite.WebEdition.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. | | + | |
| - | ==== Public Events ==== | + | N/A |
| - | ^ Name ^ Event Arguments ^ DeclaringType ^ Summary ^ | + | == Remarks == |
| - | | {{wiki:PublicEvent.gif|Public Event}}[[#Tick|Tick]] | EventArgs | [[ThinkGeo.MapSuite.WebEdition.Overlay|Overlay]] | Occurs when the number of milliseconds specified in the AutoRefreshInterval property has elapsed and the page is posted to the server. | | + | N/A |
| - | ===== Public Constructors ===== | + | == Return Value == |
| - | ==== OpenStreetMapOverlay() ==== | + | * Type:String |
| - | Initialize an instance of the OpenStreetMapOverlay class. | + | * Description:N/A |
| - | === Remarks === | + | |
| - | For the most updated Info for this topic, please check it here:<a href="http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.OpenStreetMapOverlay#OpenStreetMapOverlay.28.29" target="_blank">http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.OpenStreetMapOverlay#OpenStreetMapOverlay.28.29</a> | + | |
| - | === Parameters === | + | |
| - | ^ Name ^ Type ^ Description ^ | + | |
| - | [[#Public Constructors|Go Back]] | + | == Parameters == |
| - | ==== OpenStreetMapOverlay(String) ==== | + | <div newline></div> |
| - | Initialize an instance of the OpenStreetMapOverlay class. | + | ** {{wiki:PublicMethod.gif|}} Equals(Object) ** |
| - | === Remarks === | + | |
| - | For the most updated Info for this topic, please check it here:<a href="http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.OpenStreetMapOverlay#OpenStreetMapOverlay.28String.29" target="_blank">http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.OpenStreetMapOverlay#OpenStreetMapOverlay.28String.29</a> | + | |
| - | === Parameters === | + | |
| - | ^ Name ^ Type ^ Description ^ | + | |
| - | | id | String<!-- System.String --> | The identifier string of the OpenStreetMapOverlay. | | + | |
| - | [[#Public Constructors|Go Back]] | + | N/A |
| - | ===== Protected Constructors ===== | + | == Remarks == |
| - | ===== Public Methods ===== | + | N/A |
| - | ==== Equals(Object) ==== | + | |
| - | === Remarks === | + | |
| - | For the most updated Info for this topic, please check it here:<a href="http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.OpenStreetMapOverlay#Equals.28Object.29" target="_blank">http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.OpenStreetMapOverlay#Equals.28Object.29</a> | + | |
| - | === Return Value === | + | |
| - | ^ Return Type ^ Description ^ | + | |
| - | | Boolean<!-- System.Boolean --> | | | + | |
| - | === Parameters === | + | == Return Value == |
| - | ^ Name ^ Type ^ Description ^ | + | * Type:Boolean |
| - | | obj | Object<!-- System.Object --> | | | + | * Description:N/A |
| - | <!-- System.Object --> | + | == Parameters == |
| - | [[#Public Methods|Go Back]] | + | * //obj// |
| - | ==== GetHashCode() ==== | + | * Type:Object |
| - | === Remarks === | + | * Description:N/A |
| - | For the most updated Info for this topic, please check it here:<a href="http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.OpenStreetMapOverlay#GetHashCode.28.29" target="_blank">http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.OpenStreetMapOverlay#GetHashCode.28.29</a> | + | |
| - | === Return Value === | + | |
| - | ^ Return Type ^ Description ^ | + | |
| - | | Int32<!-- System.Int32 --> | | | + | |
| - | === Parameters === | + | <div newline></div> |
| - | ^ Name ^ Type ^ Description ^ | + | ** {{wiki:PublicMethod.gif|}} GetHashCode() ** |
| - | <!-- System.Object --> | + | N/A |
| - | [[#Public Methods|Go Back]] | + | == Remarks == |
| - | ==== GetType() ==== | + | N/A |
| - | === Remarks === | + | |
| - | For the most updated Info for this topic, please check it here:<a href="http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.OpenStreetMapOverlay#GetType.28.29" target="_blank">http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.OpenStreetMapOverlay#GetType.28.29</a> | + | |
| - | === Return Value === | + | |
| - | ^ Return Type ^ Description ^ | + | |
| - | | Type<!-- System.Type --> | | | + | |
| - | === Parameters === | + | == Return Value == |
| - | ^ Name ^ Type ^ Description ^ | + | * Type:Int32 |
| + | * Description:N/A | ||
| - | <!-- System.Object --> | + | == Parameters == |
| - | [[#Public Methods|Go Back]] | + | <div newline></div> |
| - | ==== ToJson() ==== | + | ** {{wiki:PublicMethod.gif|}} GetType() ** |
| - | 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:<a href="http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.OpenStreetMapOverlay#ToJson.28.29" target="_blank">http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.OpenStreetMapOverlay#ToJson.28.29</a> | + | |
| - | === Return Value === | + | |
| - | ^ Return Type ^ Description ^ | + | |
| - | | String<!-- System.String --> | A JSON string which is used to create an overlay at the client side. | | + | |
| - | === Parameters === | + | N/A |
| - | ^ Name ^ Type ^ Description ^ | + | == Remarks == |
| + | N/A | ||
| - | <!-- ThinkGeo.MapSuite.WebEdition.Overlay --> | + | == Return Value == |
| - | [[#Public Methods|Go Back]] | + | * Type:Type |
| - | ==== ToString() ==== | + | * Description:N/A |
| - | === Remarks === | + | |
| - | For the most updated Info for this topic, please check it here:<a href="http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.OpenStreetMapOverlay#ToString.28.29" target="_blank">http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.OpenStreetMapOverlay#ToString.28.29</a> | + | |
| - | === Return Value === | + | |
| - | ^ Return Type ^ Description ^ | + | |
| - | | String<!-- System.String --> | | | + | |
| - | === Parameters === | + | == Parameters == |
| - | ^ Name ^ Type ^ Description ^ | + | <div newline></div> |
| + | ==== Protected Methods ==== | ||
| + | ** {{wiki:ProtectedMethod.gif|}} 3xM=(Page) ** | ||
| - | <!-- System.Object --> | + | N/A |
| - | [[#Public Methods|Go Back]] | + | == Remarks == |
| - | ===== Protected Methods ===== | + | N/A |
| - | ==== Finalize() ==== | + | |
| - | === Remarks === | + | |
| - | For the most updated Info for this topic, please check it here:<a href="http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.OpenStreetMapOverlay#Finalize.28.29" target="_blank">http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.OpenStreetMapOverlay#Finalize.28.29</a> | + | |
| - | === Return Value === | + | |
| - | ^ Return Type ^ Description ^ | + | |
| - | | Void<!-- System.Void --> | | | + | |
| - | === Parameters === | + | == Return Value == |
| - | ^ Name ^ Type ^ Description ^ | + | * Type:Void |
| + | * Description:N/A | ||
| - | <!-- System.Object --> | + | == Parameters == |
| - | [[#Protected Methods|Go Back]] | + | * //page// |
| - | ==== MemberwiseClone() ==== | + | * Type:Page |
| - | === Remarks === | + | * Description:N/A |
| - | For the most updated Info for this topic, please check it here:<a href="http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.OpenStreetMapOverlay#MemberwiseClone.28.29" target="_blank">http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.OpenStreetMapOverlay#MemberwiseClone.28.29</a> | + | |
| - | === Return Value === | + | |
| - | ^ Return Type ^ Description ^ | + | |
| - | | Object<!-- System.Object --> | | | + | |
| - | === Parameters === | + | <div newline></div> |
| - | ^ Name ^ Type ^ Description ^ | + | ** {{wiki:ProtectedMethod.gif|}} RegisterJavaScriptLibraryCore(Page) ** |
| - | <!-- System.Object --> | + | N/A |
| - | [[#Protected Methods|Go Back]] | + | == Remarks == |
| - | ==== OnTick(EventArgs) ==== | + | N/A |
| - | Raises the Tick event of the MarkerOverlay. | + | |
| - | === Remarks === | + | |
| - | For the most updated Info for this topic, please check it here:<a href="http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.OpenStreetMapOverlay#OnTick.28EventArgs.29" target="_blank">http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.OpenStreetMapOverlay#OnTick.28EventArgs.29</a> | + | |
| - | === Return Value === | + | |
| - | ^ Return Type ^ Description ^ | + | |
| - | | Void<!-- System.Void --> | | | + | |
| - | === Parameters === | + | == Return Value == |
| - | ^ Name ^ Type ^ Description ^ | + | * Type:Void |
| - | | e | EventArgs<!-- System.EventArgs --> | An System.EventArgs object that contains the event data. | | + | * Description:N/A |
| - | <!-- ThinkGeo.MapSuite.WebEdition.Overlay --> | + | == 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|}} RaiseTickEvent(EventArgs) ** |
| - | | page | Page<!-- System.Web.UI.Page --> | The page object that is used for registering the javascript library. | | + | |
| - | <!-- ThinkGeo.MapSuite.WebEdition.Overlay --> | + | N/A |
| - | [[#Protected Methods|Go Back]] | + | == Remarks == |
| - | ===== Public Properties ===== | + | N/A |
| - | ==== Attribution ==== | + | |
| - | === Remarks === | + | |
| - | For the most updated Info for this topic, please check it here:<a href="http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.OpenStreetMapOverlay#Attribution" target="_blank">http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.OpenStreetMapOverlay#Attribution</a> | + | |
| - | === Return Value === | + | |
| - | ^ Return Type ^ | + | |
| - | | String<!-- System.String --> | | + | |
| - | <!-- ThinkGeo.MapSuite.WebEdition.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. | + | |
| - | === Remarks === | + | |
| - | For the most updated Info for this topic, please check it here:<a href="http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.OpenStreetMapOverlay#AutoRefreshInterval" target="_blank">http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.OpenStreetMapOverlay#AutoRefreshInterval</a> | + | |
| - | === Return Value === | + | |
| - | ^ Return Type ^ | + | |
| - | | TimeSpan<!-- System.TimeSpan --> | | + | |
| - | <!-- ThinkGeo.MapSuite.WebEdition.Overlay --> | + | == Parameters == |
| - | [[#Public Properties|Go Back]] | + | * //e// |
| - | ==== CustomServerUris ==== | + | * Type:EventArgs |
| - | === Remarks === | + | * Description:N/A |
| - | For the most updated Info for this topic, please check it here:<a href="http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.OpenStreetMapOverlay#CustomServerUris" target="_blank">http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.OpenStreetMapOverlay#CustomServerUris</a> | + | |
| - | === Return Value === | + | |
| - | ^ Return Type ^ | + | |
| - | | Collection<Uri><!-- System.Collections.ObjectModel.Collection{System.Uri} --> | | + | |
| - | <!-- ThinkGeo.MapSuite.WebEdition.OpenStreetMapOverlay --> | + | <div newline></div> |
| - | [[#Public Properties|Go Back]] | + | ** {{wiki:ProtectedMethod.gif|}} OnTick(EventArgs) ** |
| - | ==== 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.OpenStreetMapOverlay#Id" target="_blank">http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.OpenStreetMapOverlay#Id</a> | + | |
| - | === Return Value === | + | |
| - | ^ Return Type ^ | + | |
| - | | String<!-- System.String --> | | + | |
| - | <!-- ThinkGeo.MapSuite.WebEdition.Overlay --> | + | N/A |
| - | [[#Public Properties|Go Back]] | + | == Remarks == |
| - | ==== IsBaseOverlay ==== | + | N/A |
| - | 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:<a href="http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.OpenStreetMapOverlay#IsBaseOverlay" target="_blank">http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.OpenStreetMapOverlay#IsBaseOverlay</a> | + | |
| - | === Return Value === | + | |
| - | ^ Return Type ^ | + | |
| - | | Boolean<!-- System.Boolean --> | | + | |
| - | <!-- ThinkGeo.MapSuite.WebEdition.Overlay --> | + | == Return Value == |
| - | [[#Public Properties|Go Back]] | + | * Type:Void |
| - | ==== IsVisible ==== | + | * Description:N/A |
| - | 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:<a href="http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.OpenStreetMapOverlay#IsVisible" target="_blank">http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.OpenStreetMapOverlay#IsVisible</a> | + | |
| - | === Return Value === | + | |
| - | ^ Return Type ^ | + | |
| - | | Boolean<!-- System.Boolean --> | | + | |
| - | <!-- ThinkGeo.MapSuite.WebEdition.Overlay --> | + | == Parameters == |
| - | [[#Public Properties|Go Back]] | + | * //e// |
| - | ==== IsVisibleInOverlaySwitcher ==== | + | * Type:EventArgs |
| - | Gets or sets a value that indicates whether the overlay name is displayed in the OverlaySwitcher. | + | * Description:N/A |
| - | === Remarks === | + | |
| - | For the most updated Info for this topic, please check it here:<a href="http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.OpenStreetMapOverlay#IsVisibleInOverlaySwitcher" target="_blank">http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.OpenStreetMapOverlay#IsVisibleInOverlaySwitcher</a> | + | |
| - | === Return Value === | + | |
| - | ^ Return Type ^ | + | |
| - | | Boolean<!-- System.Boolean --> | | + | |
| - | <!-- ThinkGeo.MapSuite.WebEdition.Overlay --> | + | <div newline></div> |
| - | [[#Public Properties|Go Back]] | + | ** {{wiki:ProtectedMethod.gif|}} Finalize() ** |
| - | ==== MapType ==== | + | |
| - | Gets or sets a value to display which tileset for render OpenStreetMap data. | + | |
| - | === Remarks === | + | |
| - | For the most updated Info for this topic, please check it here:<a href="http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.OpenStreetMapOverlay#MapType" target="_blank">http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.OpenStreetMapOverlay#MapType</a> | + | |
| - | === Return Value === | + | |
| - | ^ Return Type ^ | + | |
| - | | [[ThinkGeo.MapSuite.WebEdition.OpenStreetMapType|OpenStreetMapType]]<!-- ThinkGeo.MapSuite.WebEdition.OpenStreetMapType --> | | + | |
| - | <!-- ThinkGeo.MapSuite.WebEdition.OpenStreetMapOverlay --> | + | N/A |
| - | [[#Public Properties|Go Back]] | + | == Remarks == |
| - | ==== Name ==== | + | N/A |
| - | 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.OpenStreetMapOverlay#Name" target="_blank">http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.OpenStreetMapOverlay#Name</a> | + | |
| - | === Return Value === | + | |
| - | ^ Return Type ^ | + | |
| - | | String<!-- System.String --> | | + | |
| - | <!-- ThinkGeo.MapSuite.WebEdition.Overlay --> | + | == Return Value == |
| - | [[#Public Properties|Go Back]] | + | * Type:Void |
| - | ==== 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.WebEdition.Overlay --> | + | == Parameters == |
| - | [[#Public Properties|Go Back]] | + | <div newline></div> |
| - | ==== TileHeight ==== | + | ** {{wiki:ProtectedMethod.gif|}} MemberwiseClone() ** |
| - | Gets or sets the height of each tile, if the OpenStreetMapOverlay uses tiling. | + | |
| - | === Remarks === | + | N/A |
| - | For the most updated Info for this topic, please check it here:<a href="http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.OpenStreetMapOverlay#TileHeight" target="_blank">http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.OpenStreetMapOverlay#TileHeight</a> | + | == Remarks == |
| - | === Return Value === | + | N/A |
| - | ^ Return Type ^ | + | |
| - | | Int32<!-- System.Int32 --> | | + | == Return Value == |
| + | * Type:Object | ||
| + | * Description:N/A | ||
| + | |||
| + | == Parameters == | ||
| + | <div newline></div> | ||
| + | ==== Public Properties ==== | ||
| + | ** {{wiki:PublicProperty.gif|}} CustomServerUris ** | ||
| + | |||
| + | N/A | ||
| + | == Remarks == | ||
| + | N/A | ||
| + | == Return Value == | ||
| + | * Type:Collection<Uri> | ||
| + | |||
| + | ** {{wiki:PublicProperty.gif|}} TileWidth ** | ||
| - | <!-- ThinkGeo.MapSuite.WebEdition.OpenStreetMapOverlay --> | ||
| - | [[#Public Properties|Go Back]] | ||
| - | ==== TileWidth ==== | ||
| Gets or sets the width of each tile, if the OpenStreetMapOverlay uses tiling. | Gets or sets the width of each tile, if the OpenStreetMapOverlay uses tiling. | ||
| - | === Remarks === | + | == Remarks == |
| - | For the most updated Info for this topic, please check it here:<a href="http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.OpenStreetMapOverlay#TileWidth" target="_blank">http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.OpenStreetMapOverlay#TileWidth</a> | + | N/A |
| - | === Return Value === | + | == Return Value == |
| - | ^ Return Type ^ | + | * Type:Int32 |
| - | | Int32<!-- System.Int32 --> | | + | |
| - | <!-- ThinkGeo.MapSuite.WebEdition.OpenStreetMapOverlay --> | + | ** {{wiki:PublicProperty.gif|}} TileHeight ** |
| - | [[#Public Properties|Go Back]] | + | |
| - | ===== Protected Properties ===== | + | Gets or sets the height of each tile, if the OpenStreetMapOverlay uses tiling. |
| - | ==== HasTickEvent ==== | + | == Remarks == |
| - | Don't support auto tick event by default. | + | N/A |
| - | === Remarks === | + | == Return Value == |
| - | For the most updated Info for this topic, please check it here:<a href="http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.OpenStreetMapOverlay#HasTickEvent" target="_blank">http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.OpenStreetMapOverlay#HasTickEvent</a> | + | * Type:Int32 |
| - | === Return Value === | + | |
| - | ^ Return Type ^ | + | ** {{wiki:PublicProperty.gif|}} MapType ** |
| - | | Boolean<!-- System.Boolean --> | | + | |
| + | Gets or sets a value to display which tileset for render OpenStreetMap data. | ||
| + | == Remarks == | ||
| + | N/A | ||
| + | == Return Value == | ||
| + | * Type:[[ThinkGeo.MapSuite.WebEdition.OpenStreetMapType|OpenStreetMapType]] | ||
| + | |||
| + | ** {{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.WebEdition.Overlay(overriden) --> | ||
| - | [[#Protected Properties|Go Back]] | ||
| - | ==== OverlayType ==== | ||
| Gets the type of this overlay which uses for serializing to JSON and parses to a real overlay on the client side. | Gets the type of this overlay which uses for serializing to JSON and parses to a real overlay on the client side. | ||
| - | === Remarks === | + | == Remarks == |
| - | For the most updated Info for this topic, please check it here:<a href="http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.OpenStreetMapOverlay#OverlayType" target="_blank">http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.OpenStreetMapOverlay#OverlayType</a> | + | N/A |
| - | === Return Value === | + | == Return Value == |
| - | ^ Return Type ^ | + | * Type:String |
| - | | String<!-- System.String --> | | + | |
| - | <!-- ThinkGeo.MapSuite.WebEdition.Overlay(overriden) --> | + | ** {{wiki:ProtectedProperty.gif|}} HasTickEvent ** |
| - | [[#Protected Properties|Go Back]] | + | |
| - | ===== Public Events ===== | + | Don't support auto tick event by default. |
| - | ==== Tick ==== | + | == Remarks == |
| - | Occurs when the number of milliseconds specified in the AutoRefreshInterval property has elapsed and the page is posted to the server. | + | N/A |
| - | === Remarks === | + | == Return Value == |
| - | For the most updated Info for this topic, please check it here:<a href="http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.OpenStreetMapOverlay#OnTick.28EventArgs.29" target="_blank">http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.OpenStreetMapOverlay#OnTick.28EventArgs.29</a> | + | * Type:Boolean |
| - | === Event Arguments === | + | |
| - | ^ Event Arguments ^ | + | ** {{wiki:ProtectedProperty.gif|}} 3hM= ** |
| - | | EventArgs<!-- System.EventArgs --> | | + | |
| + | N/A | ||
| + | == Remarks == | ||
| + | N/A | ||
| + | == Return Value == | ||
| + | * Type:Double | ||
| + | |||
| + | ==== Public Events ==== | ||
| + | ** {{wiki:PublicEvent.gif|}} Tick ** | ||
| + | N/A | ||
| + | == Remarks == | ||
| + | N/A | ||
| - | <!-- ThinkGeo.MapSuite.WebEdition.Overlay --> | + | Event Arguments:EventArgs |
| - | [[#Public Events|Go Back]] | + | |
| - | __NOTOC__ | ||
| - | [[Category:WebEdition]] | ||
| - | [[Category:ThinkGeo.MapSuite.WebEdition]] | ||
| - | [[Category:UpdateDocumentation]] | ||