User Tools

Site Tools


thinkgeo.mapsuite.webedition.bingmapsoverlay

Differences

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

Link to this comparison view

Both sides previous revision Previous revision
thinkgeo.mapsuite.webedition.bingmapsoverlay [2015/09/22 08:48]
admin
— (current)
Line 1: Line 1:
-====== ThinkGeo.MapSuite.WebEdition.BingMapsOverlay ====== 
-Represents an overlay object that gets images from Microsoft'​s Virtual Earth server. 
-===== Inheritance Hierarchy ===== 
-  *System.Object 
-    *ThinkGeo.MapSuite.WebEdition.Overlay 
-      ***ThinkGeo.MapSuite.WebEdition.BingMapsOverlay** 
-===== Members Summary ===== 
-==== Public Constructors ==== 
-** {{wiki:​PublicMethod.gif|}} BingMapsOverlay() ** 
- 
-  * //​Initialize an instance of the VirtualEarthOverlay class.// 
-== Remarks == 
-  * //For the most updated Info for this topic, please check it here:​http:​wiki.thinkgeo.com/​wiki/​ThinkGeo.MapSuite.WebEdition.BingMapsOverlay#​BingMapsOverlay.28.29//​ 
-== Parameters == 
-<div newline></​div>​ 
-** {{wiki:​PublicMethod.gif|}} BingMapsOverlay(String) ** 
- 
-  * //​Initialize an instance of the VirtualEarthOverlay class with the overlay identifier specified.//​ 
-== Remarks == 
-  * //For the most updated Info for this topic, please check it here:​http:​wiki.thinkgeo.com/​wiki/​ThinkGeo.MapSuite.WebEdition.BingMapsOverlay#​BingMapsOverlay.28String.29//​ 
-== Parameters == 
-  * //id// 
-    * Type:String 
-    * Description:​The identifier that will be used to find the overlay. 
- 
-<div newline></​div>​ 
-** {{wiki:​PublicMethod.gif|}} BingMapsOverlay(String,​BingMapsStyle) ** 
- 
-  * //​Initialize an instance of the VirtualEarthOverlay class with the overlay identifier and Virtual Earth map type specified.//​ 
-== Remarks == 
-  * //For the most updated Info for this topic, please check it here:​http:​wiki.thinkgeo.com/​wiki/​ThinkGeo.MapSuite.WebEdition.BingMapsOverlay#​BingMapsOverlay.28String.2C_BingMapsStyle.29//​ 
-== Parameters == 
-  * //id// 
-    * Type:String 
-    * Description:​The identifier that will be used to find the overlay. 
- 
-  * //​bingMapsMapType//​ 
-    * Type:​[[ThinkGeo.MapSuite.WebEdition.BingMapsStyle|BingMapsStyle]] 
-    * Description:​The VirtualEarth map type. 
- 
-<div newline></​div>​ 
-** {{wiki:​PublicMethod.gif|}} BingMapsOverlay(BingMapsStyle,​String) ** 
- 
-  * //N/A// 
-== Remarks == 
-  * //For the most updated Info for this topic, please check it here:​http:​wiki.thinkgeo.com/​wiki/​ThinkGeo.MapSuite.WebEdition.BingMapsOverlay#​BingMapsOverlay.28BingMapsStyle.2C_String.29//​ 
-== Parameters == 
-  * //​bingMapsMapType//​ 
-    * Type:​[[ThinkGeo.MapSuite.WebEdition.BingMapsStyle|BingMapsStyle]] 
-    * Description:​N/​A 
- 
-  * //​credentials//​ 
-    * Type:String 
-    * Description:​N/​A 
- 
-<div newline></​div>​ 
-** {{wiki:​PublicMethod.gif|}} BingMapsOverlay(String,​BingMapsStyle,​String) ** 
- 
-  * //N/A// 
-== Remarks == 
-  * //For the most updated Info for this topic, please check it here:​http:​wiki.thinkgeo.com/​wiki/​ThinkGeo.MapSuite.WebEdition.BingMapsOverlay#​BingMapsOverlay.28String.2C_BingMapsStyle.2C_String.29//​ 
-== Parameters == 
-  * //id// 
-    * Type:String 
-    * Description:​N/​A 
- 
-  * //​bingMapsMapType//​ 
-    * Type:​[[ThinkGeo.MapSuite.WebEdition.BingMapsStyle|BingMapsStyle]] 
-    * Description:​N/​A 
- 
-  * //​credentials//​ 
-    * Type:String 
-    * Description:​N/​A 
- 
-<div newline></​div>​ 
-** {{wiki:​PublicMethod.gif|}} BingMapsOverlay(String,​String) ** 
- 
-  * //N/A// 
-== Remarks == 
-  * //For the most updated Info for this topic, please check it here:// 
-== Parameters == 
-  * //id// 
-    * Type:String 
-    * Description:​N/​A 
- 
-  * //​bingMapsKey//​ 
-    * Type:String 
-    * Description:​N/​A 
- 
-<div newline></​div>​ 
-** {{wiki:​PublicMethod.gif|}} BingMapsOverlay(String,​String,​BingMapsStyle) ** 
- 
-  * //N/A// 
-== Remarks == 
-  * //For the most updated Info for this topic, please check it here:// 
-== Parameters == 
-  * //id// 
-    * Type:String 
-    * Description:​N/​A 
- 
-  * //​bingMapsKey//​ 
-    * Type:String 
-    * Description:​N/​A 
- 
-  * //​bingMapsMapStyle//​ 
-    * Type:​[[ThinkGeo.MapSuite.WebEdition.BingMapsStyle|BingMapsStyle]] 
-    * Description:​N/​A 
- 
-<div newline></​div>​ 
-==== Protected Constructors ==== 
-==== Public Methods ==== 
-** {{wiki:​PublicMethod.gif|}} ToJson() ** 
- 
-  * //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:​http:​wiki.thinkgeo.com/​wiki/​ThinkGeo.MapSuite.WebEdition.BingMapsOverlay#​ToJson.28.29//​ 
- 
-== Return Value == 
-  * Type:String 
-  * Description:​A JSON string which is used to create an overlay at the client side. 
- 
-== Parameters == 
-<div newline></​div>​ 
-** {{wiki:​PublicMethod.gif|}} ToString() ** 
- 
-  * //N/A// 
-== Remarks == 
-  * //For the most updated Info for this topic, please check it here:​http:​wiki.thinkgeo.com/​wiki/​ThinkGeo.MapSuite.WebEdition.BingMapsOverlay#​ToString.28.29//​ 
- 
-== Return Value == 
-  * Type:String 
-  * Description:​N/​A 
- 
-== Parameters == 
-<div newline></​div>​ 
-** {{wiki:​PublicMethod.gif|}} Equals(Object) ** 
- 
-  * //N/A// 
-== Remarks == 
-  * //For the most updated Info for this topic, please check it here:​http:​wiki.thinkgeo.com/​wiki/​ThinkGeo.MapSuite.WebEdition.BingMapsOverlay#​Equals.28Object.29//​ 
- 
-== Return Value == 
-  * Type:​Boolean 
-  * Description:​N/​A 
- 
-== Parameters == 
-  * //obj// 
-    * Type:Object 
-    * Description:​N/​A 
- 
-<div newline></​div>​ 
-** {{wiki:​PublicMethod.gif|}} GetHashCode() ** 
- 
-  * //N/A// 
-== Remarks == 
-  * //For the most updated Info for this topic, please check it here:​http:​wiki.thinkgeo.com/​wiki/​ThinkGeo.MapSuite.WebEdition.BingMapsOverlay#​GetHashCode.28.29//​ 
- 
-== Return Value == 
-  * Type:Int32 
-  * Description:​N/​A 
- 
-== Parameters == 
-<div newline></​div>​ 
-** {{wiki:​PublicMethod.gif|}} GetType() ** 
- 
-  * //N/A// 
-== Remarks == 
-  * //For the most updated Info for this topic, please check it here:​http:​wiki.thinkgeo.com/​wiki/​ThinkGeo.MapSuite.WebEdition.BingMapsOverlay#​GetType.28.29//​ 
- 
-== Return Value == 
-  * Type:Type 
-  * Description:​N/​A 
- 
-== Parameters == 
-<div newline></​div>​ 
-==== Protected Methods ==== 
-** {{wiki:​ProtectedMethod.gif|}} 3xM=(Page) ** 
- 
-  * //N/A// 
-== Remarks == 
-  * //N/A// 
- 
-== Return Value == 
-  * Type:Void 
-  * Description:​N/​A 
- 
-== Parameters == 
-  * //page// 
-    * Type:Page 
-    * Description:​N/​A 
- 
-<div newline></​div>​ 
-** {{wiki:​ProtectedMethod.gif|}} RegisterJavaScriptLibraryCore(Page) ** 
- 
-  * //Registers a Javascript library URL string to the client HTML page.// 
-== Remarks == 
-  * //The <​strong>​RegisterJavaScriptLibraryCore</​strong>​ method allows derived classes to override and register their own Javascript library URL to the HTML page.// 
- 
-== Return Value == 
-  * Type:Void 
-  * Description:​N/​A 
- 
-== Parameters == 
-  * //page// 
-    * Type:Page 
-    * Description:​The page object that is used for registering the javascript library. 
- 
-<div newline></​div>​ 
-** {{wiki:​ProtectedMethod.gif|}} RaiseTickEvent(EventArgs) ** 
- 
-  * //N/A// 
-== Remarks == 
-  * //N/A// 
- 
-== Return Value == 
-  * Type:Void 
-  * Description:​N/​A 
- 
-== Parameters == 
-  * //e// 
-    * Type:​EventArgs 
-    * Description:​N/​A 
- 
-<div newline></​div>​ 
-** {{wiki:​ProtectedMethod.gif|}} OnTick(EventArgs) ** 
- 
-  * //Raises the Tick event of the MarkerOverlay.//​ 
-== Remarks == 
-  * //For the most updated Info for this topic, please check it here:​http:​wiki.thinkgeo.com/​wiki/​ThinkGeo.MapSuite.WebEdition.BingMapsOverlay#​OnTick.28EventArgs.29//​ 
- 
-== Return Value == 
-  * Type:Void 
-  * Description:​N/​A 
- 
-== Parameters == 
-  * //e// 
-    * Type:​EventArgs 
-    * Description:​An System.EventArgs object that contains the event data. 
- 
-<div newline></​div>​ 
-** {{wiki:​ProtectedMethod.gif|}} Finalize() ** 
- 
-  * //N/A// 
-== Remarks == 
-  * //For the most updated Info for this topic, please check it here:​http:​wiki.thinkgeo.com/​wiki/​ThinkGeo.MapSuite.WebEdition.BingMapsOverlay#​Finalize.28.29//​ 
- 
-== Return Value == 
-  * Type:Void 
-  * Description:​N/​A 
- 
-== Parameters == 
-<div newline></​div>​ 
-** {{wiki:​ProtectedMethod.gif|}} MemberwiseClone() ** 
- 
-  * //N/A// 
-== Remarks == 
-  * //For the most updated Info for this topic, please check it here:​http:​wiki.thinkgeo.com/​wiki/​ThinkGeo.MapSuite.WebEdition.BingMapsOverlay#​MemberwiseClone.28.29//​ 
- 
-== Return Value == 
-  * Type:Object 
-  * Description:​N/​A 
- 
-== Parameters == 
-<div newline></​div>​ 
-==== Public Properties ==== 
-** {{wiki:​PublicProperty.gif|}} Credentials ** 
- 
-Gets or sets the Bing Maps key registered from https://​www.bingmapsportal.com/,​ it will be used to authenticate against any of the REST Services APIs. 
-== Remarks == 
-For the most updated Info for this topic, please check it here:​http://​wiki.thinkgeo.com/​wiki/​ThinkGeo.MapSuite.WebEdition.BingMapsOverlay#​Credentials 
-== Return Value == 
-  * Type:String 
- 
-** {{wiki:​PublicProperty.gif|}} BingMapsKey ** 
- 
-N/A 
-== Remarks == 
-For the most updated Info for this topic, please check it here: 
-== Return Value == 
-  * Type:String 
- 
-** {{wiki:​PublicProperty.gif|}} MapType ** 
- 
-Gets or sets a value to display which type of Virtual Earth map. 
-== Remarks == 
-For the most updated Info for this topic, please check it here:​http://​wiki.thinkgeo.com/​wiki/​ThinkGeo.MapSuite.WebEdition.BingMapsOverlay#​MapType 
-== Return Value == 
-  * Type:​[[ThinkGeo.MapSuite.WebEdition.BingMapsStyle|BingMapsStyle]] 
- 
-** {{wiki:​PublicProperty.gif|}} MapStyle ** 
- 
-N/A 
-== Remarks == 
-For the most updated Info for this topic, please check it here: 
-== Return Value == 
-  * Type:​[[ThinkGeo.MapSuite.WebEdition.BingMapsStyle|BingMapsStyle]] 
- 
-** {{wiki:​PublicProperty.gif|}} IsVisible ** 
- 
-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:​http://​wiki.thinkgeo.com/​wiki/​ThinkGeo.MapSuite.WebEdition.BingMapsOverlay#​IsVisible 
-== Return Value == 
-  * Type:​Boolean 
- 
-** {{wiki:​PublicProperty.gif|}} 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:​http://​wiki.thinkgeo.com/​wiki/​ThinkGeo.MapSuite.WebEdition.BingMapsOverlay#​Name 
-== Return Value == 
-  * Type:String 
- 
-** {{wiki:​PublicProperty.gif|}} Opacity ** 
- 
-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 == 
-  * Type:Single 
- 
-** {{wiki:​PublicProperty.gif|}} IsVisibleInOverlaySwitcher ** 
- 
-Gets or sets a value that indicates whether the overlay name is displayed in the OverlaySwitcher. 
-== Remarks == 
-For the most updated Info for this topic, please check it here:​http://​wiki.thinkgeo.com/​wiki/​ThinkGeo.MapSuite.WebEdition.BingMapsOverlay#​IsVisibleInOverlaySwitcher 
-== Return Value == 
-  * Type:​Boolean 
- 
-** {{wiki:​PublicProperty.gif|}} IsBaseOverlay ** 
- 
-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:​http://​wiki.thinkgeo.com/​wiki/​ThinkGeo.MapSuite.WebEdition.BingMapsOverlay#​IsBaseOverlay 
-== Return Value == 
-  * Type:​Boolean 
- 
-** {{wiki:​PublicProperty.gif|}} Id ** 
- 
-Gets the identifier for the overlay to be found. 
-== Remarks == 
-For the most updated Info for this topic, please check it here:​http://​wiki.thinkgeo.com/​wiki/​ThinkGeo.MapSuite.WebEdition.BingMapsOverlay#​Id 
-== Return Value == 
-  * Type:String 
- 
-** {{wiki:​PublicProperty.gif|}} AutoRefreshInterval ** 
- 
-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:​http://​wiki.thinkgeo.com/​wiki/​ThinkGeo.MapSuite.WebEdition.BingMapsOverlay#​AutoRefreshInterval 
-== Return Value == 
-  * Type:​TimeSpan 
- 
-** {{wiki:​PublicProperty.gif|}} Attribution ** 
- 
-N/A 
-== Remarks == 
-For the most updated Info for this topic, please check it here:​http://​wiki.thinkgeo.com/​wiki/​ThinkGeo.MapSuite.WebEdition.BingMapsOverlay#​Attribution 
-== Return Value == 
-  * Type:String 
- 
-==== Protected Properties ==== 
-** {{wiki:​ProtectedProperty.gif|}} OverlayType ** 
- 
-Gets a string that indicates the overlay type. 
-== Remarks == 
-For the most updated Info for this topic, please check it here:​http://​wiki.thinkgeo.com/​wiki/​ThinkGeo.MapSuite.WebEdition.BingMapsOverlay#​OverlayType 
-== Return Value == 
-  * Type:String 
- 
-** {{wiki:​ProtectedProperty.gif|}} HasTickEvent ** 
- 
-Don't support auto tick event by default. 
-== Remarks == 
-For the most updated Info for this topic, please check it here:​http://​wiki.thinkgeo.com/​wiki/​ThinkGeo.MapSuite.WebEdition.BingMapsOverlay#​HasTickEvent 
-== Return Value == 
-  * Type:​Boolean 
- 
-** {{wiki:​ProtectedProperty.gif|}} 3hM= ** 
- 
-N/A 
-== Remarks == 
-N/A 
-== Return Value == 
-  * Type:Double 
- 
-==== Public Events ==== 
-** {{wiki:​PublicEvent.gif|}} Tick ** 
-Occurs when the number of milliseconds specified in the AutoRefreshInterval property has elapsed and the page is posted to the server. 
-== Remarks == 
-For the most updated Info for this topic, please check it here:​http://​wiki.thinkgeo.com/​wiki/​ThinkGeo.MapSuite.WebEdition.BingMapsOverlay#​OnTick.28EventArgs.29 
- 
-Event Arguments:​EventArgs 
- 
  
thinkgeo.mapsuite.webedition.bingmapsoverlay.1442911683.txt.gz ยท Last modified: 2015/09/22 08:48 by admin