ThinkGeo Cloud
ThinkGeo UI Controls
ThinkGeo Open Source
Help and Support
External Resources
Sidebar
thinkgeo.mapsuite.mvcedition.bingmapsoverlay
This is an old revision of the document!
Table of Contents
ThinkGeo.MapSuite.MvcEdition.BingMapsOverlay
<!– Class –> Represents an overlay object that gets images from Microsoft's Virtual Earth server.
Remarks
The VirtualEarthOverlay registers Virtual Earth's Javascript library to the page and gets the map images from the Virtual Earth server. The VirtualEarthOverlay can only be the base overlay of the map, over which other overlays are laid.
Inheritance Hierarchy
Members Summary
Public Constructors
| Name | Parameters | DeclaringType | Summary |
|---|---|---|---|
 BingMapsOverlay | Initialize an instance of the VirtualEarthOverlay class. | ||
| BingMapsOverlay | String, String | Initialize an instance of the BingMapOverlay class with the overlay identifier, bingMaps map type and bingMapsKey. | |
| BingMapsOverlay | String, String, BingMapsStyle | Initialize an instance of the BingMapOverlay class with the overlay identifier, bingMaps map type and bingMapsKey. |
Protected Constructors
| Name | Parameters | DeclaringType | Summary |
|---|
Public Methods
Protected Methods
| Name | Parameters | DeclaringType | Summary |
|---|---|---|---|
 Finalize | Object | ||
| MemberwiseClone | Object | ||
| RegisterJavaScriptLibraryCore | Page | Overlay | Registers a Javascript library URL string to the client HTML page. |
Public Properties
| Name | Return | DeclaringType | Summary |
|---|---|---|---|
 Attribution | String | Overlay | |
| AutoRefreshInterval | TimeSpan | Overlay | Gets or sets the time interval in which the MarkerOverlay refreshes itself. |
| BingMapsKey | String | ||
| Id | String | Overlay | Gets the identifier for the overlay to be found. |
| IsBaseOverlay | Boolean | Overlay | Gets or sets a value that indicates whether the overlay is a base overlay. |
| IsVisible | Boolean | Overlay | Gets or sets a value that indicates whether the overlay is visible on the map. |
| IsVisibleInOverlaySwitcher | Boolean | Overlay | Gets or sets a value that indicates whether the overlay name is displayed in the OverlaySwitcher. |
| MapStyle | BingMapsStyle | Gets or sets a value to display which type of Virtual Earth map. | |
| Name | String | Overlay | Gets or sets the name of the overlay, which will display in the OverlaySwitcher. |
| OnClientAutoRefreshTick | String | Overlay(overriden) | Don't support auto tick event by default. |
| Opacity | Single | Overlay | Gets or sets the opacity level of the overlay. |
Protected Properties
| Name | Return | DeclaringType | Summary |
|---|---|---|---|
 OverlayType | String | Overlay(overriden) | Gets a string that indicates the overlay type. |
Public Events
| Name | Event Arguments | DeclaringType | Summary |
|---|
Public Constructors
BingMapsOverlay()
Initialize an instance of the VirtualEarthOverlay class.
Overloads
Initialize an instance of the VirtualEarthOverlay class.
Parameters
| Name | Type | Description |
|---|
BingMapsOverlay(String, String)
Initialize an instance of the BingMapOverlay class with the overlay identifier, bingMaps map type and bingMapsKey.
Overloads
Initialize an instance of the BingMapOverlay class.
Parameters
| Name | Type | Description |
|---|---|---|
| id | String<!– System.String –> | The identifier that will be used to find the overlay. |
| bingMapsKey | String<!– System.String –> | the Bing Maps key registered from https://www.bingmapsportal.com/, it will be used to authenticate against any of the REST Services APIs. |
BingMapsOverlay(String, String, BingMapsStyle)
Initialize an instance of the BingMapOverlay class with the overlay identifier, bingMaps map type and bingMapsKey.
Overloads
Initialize an instance of the BingMapOverlay class.
Parameters
| Name | Type | Description |
|---|---|---|
| id | String<!– System.String –> | The identifier that will be used to find the overlay. |
| bingMapsKey | String<!– System.String –> | the Bing Maps key registered from https://www.bingmapsportal.com/, it will be used to authenticate against any of the REST Services APIs. |
| bingMapsMapStyle | BingMapsStyle<!– ThinkGeo.MapSuite.MvcEdition.BingMapsStyle –> | The Bing Map styles. |
Protected Constructors
Public Methods
Equals(Object)
Return Value
| Return Type | Description |
|---|---|
| Boolean<!– System.Boolean –> |
Parameters
| Name | Type | Description |
|---|---|---|
| obj | Object<!– System.Object –> |
<!– System.Object –> Go Back
FromJson(String)
Load this object from a json string.
Return Value
| Return Type | Description |
|---|---|
| Void<!– System.Void –> |
Parameters
| Name | Type | Description |
|---|---|---|
| jsonString | String<!– System.String –> | a json string |
<!– ThinkGeo.MapSuite.MvcEdition.Overlay(overriden) –> Go Back
GetHashCode()
Return Value
| Return Type | Description |
|---|---|
| Int32<!– System.Int32 –> |
Parameters
| Name | Type | Description |
|---|
<!– System.Object –> Go Back
GetType()
Return Value
| Return Type | Description |
|---|---|
| Type<!– System.Type –> |
Parameters
| Name | Type | Description |
|---|
<!– System.Object –> Go Back
ToJson()
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
| Name | Type | Description |
|---|
<!– ThinkGeo.MapSuite.MvcEdition.Overlay –> Go Back
ToString()
Return Value
| Return Type | Description |
|---|---|
| String<!– System.String –> |
Parameters
| Name | Type | Description |
|---|
<!– System.Object –> Go Back
Protected Methods
Finalize()
Return Value
| Return Type | Description |
|---|---|
| Void<!– System.Void –> |
Parameters
| Name | Type | Description |
|---|
<!– System.Object –> Go Back
MemberwiseClone()
Return Value
| Return Type | Description |
|---|---|
| Object<!– System.Object –> |
Parameters
| Name | Type | Description |
|---|
<!– System.Object –> Go Back
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
| Return Type | Description |
|---|---|
| Void<!– System.Void –> |
Parameters
| Name | Type | Description |
|---|---|---|
| page | Page<!– System.Web.UI.Page –> | The page object that is used for registering the javascript library. |
<!– ThinkGeo.MapSuite.MvcEdition.Overlay –> Go Back
Public Properties
Attribution
Return Value
| Return Type |
|---|
| String<!– System.String –> |
<!– ThinkGeo.MapSuite.MvcEdition.Overlay –> Go Back
AutoRefreshInterval
Gets or sets the time interval in which the MarkerOverlay refreshes itself.
Return Value
| Return Type |
|---|
| TimeSpan<!– System.TimeSpan –> |
<!– ThinkGeo.MapSuite.MvcEdition.Overlay –> Go Back
BingMapsKey
Return Value
| Return Type |
|---|
| String<!– System.String –> |
<!– ThinkGeo.MapSuite.MvcEdition.BingMapsOverlay –> Go Back
Id
Gets the identifier for the overlay to be found.
Return Value
| Return Type |
|---|
| String<!– System.String –> |
<!– ThinkGeo.MapSuite.MvcEdition.Overlay –> Go Back
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 –> Go Back
IsVisible
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 –> Go Back
IsVisibleInOverlaySwitcher
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 –> Go Back
MapStyle
Gets or sets a value to display which type of Virtual Earth map.
Return Value
| Return Type |
|---|
| BingMapsStyle<!– ThinkGeo.MapSuite.MvcEdition.BingMapsStyle –> |
<!– ThinkGeo.MapSuite.MvcEdition.BingMapsOverlay –> Go Back
Name
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 –> Go Back
OnClientAutoRefreshTick
Don't support auto tick event by default.
Return Value
| Return Type |
|---|
| String<!– System.String –> |
<!– ThinkGeo.MapSuite.MvcEdition.Overlay(overriden) –> Go Back
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
| Return Type |
|---|
| Single<!– System.Single –> |
<!– ThinkGeo.MapSuite.MvcEdition.Overlay –> Go Back
Protected Properties
OverlayType
Gets a string that indicates the overlay type.
Return Value
| Return Type |
|---|
| String<!– System.String –> |
<!– ThinkGeo.MapSuite.MvcEdition.Overlay(overriden) –> Go Back
Public Events
thinkgeo.mapsuite.mvcedition.bingmapsoverlay.1440040131.txt.gz · Last modified: 2015/09/21 03:32 (external edit)