ThinkGeo Cloud
ThinkGeo UI Controls
ThinkGeo Open Source
Help and Support
External Resources
Sidebar
thinkgeo.mapsuite.mvcedition.yahoooverlay
Table of Contents
ThinkGeo.MapSuite.MvcEdition.YahooOverlay
Note: The page was created before Map Suite 10. Map Suite 10.0 organized many classes into new namespaces and assemblies as well as had a few minor breaks in compatibility. The majority of previously built code should work without modification assuming the new namespaces are added. For guidance on upgrading your existing code, please check out MapSuite 10 Upgrade Guide.
<!– Class –> Represents an overlay object that gets images from the Yahoo Maps server.
Remarks
The YahooOverlay registers Yahoo Maps' Javascript library to the page and gets the images from the Yahoo Maps server. The YahooOverlay can only be the base overlay of the map, which acts as the background layer over which other overlays are laid.
Inheritance Hierarchy
Members Summary
Public Constructors
| Name | Parameters | DeclaringType | Summary |
|---|---|---|---|
 YahooOverlay | Initialize an instance of the YahooOverlay class. | ||
| YahooOverlay | String | Initialize an instance of the YahooOverlay class with the overlay identifier specified. | |
| YahooOverlay | YahooMapType | Initialize an instance of the YahooOverlay class with the overlay identifier specified. | |
| YahooOverlay | String, YahooMapType | Initialize an instance of the YahooOverlay class with the overlay identifier and the Yahoo map type specified. |
Protected Constructors
| Name | Parameters | DeclaringType | Summary |
|---|
Public Methods
Protected Methods
| Name | Parameters | DeclaringType | Summary |
|---|---|---|---|
 Finalize | Object | ||
| MemberwiseClone | Object | ||
| RegisterJavaScriptLibraryCore | Page | Overlay(overriden) | Registers the Yahoo Maps Javascript library URL string to the client HTML page. |
Public Properties
| Name | Return | DeclaringType | Summary |
|---|---|---|---|
 AutoRefreshInterval | TimeSpan | Overlay | Gets or sets the time interval in which the MarkerOverlay refreshes itself. |
| 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. |
| JavaScriptLibraryUri | Uri | Gets or sets a URI used for loading the Yahoo Maps Javascript library. | |
| 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. |
| YahooMapType | YahooMapType | Gets or sets a value that determines which type of Yahoo Map to display. |
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
YahooOverlay()
Initialize an instance of the YahooOverlay class.
Overloads
Initialize an instance of the YahooOverlay class.
Parameters
| Name | Type | Description |
|---|
YahooOverlay(String)
Initialize an instance of the YahooOverlay class with the overlay identifier specified.
Overloads
Initialize an instance of the YahooOverlay class.
Parameters
| Name | Type | Description |
|---|---|---|
| id | String<!– System.String –> | The identifier string used for finding the overlay. |
YahooOverlay(YahooMapType)
Initialize an instance of the YahooOverlay class with the overlay identifier specified.
Parameters
| Name | Type | Description |
|---|---|---|
| yahooMapType | YahooMapType<!– ThinkGeo.MapSuite.MvcEdition.YahooMapType –> | The map type of the overlay. |
YahooOverlay(String, YahooMapType)
Initialize an instance of the YahooOverlay class with the overlay identifier and the Yahoo map type specified.
Overloads
Initialize an instance of the YahooOverlay class.
Parameters
| Name | Type | Description |
|---|---|---|
| id | String<!– System.String –> | The identifier string used for finding the overlay. |
| yahooMapType | YahooMapType<!– ThinkGeo.MapSuite.MvcEdition.YahooMapType –> | The map type of the overlay. |
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 –> 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 the Yahoo Maps Javascript library URL string to the client HTML page.
Return Value
| Return Type | Description |
|---|---|
| Void<!– System.Void –> |
Parameters
| Name | Type | Description |
|---|---|---|
| page | Page<!– System.Web.UI.Page –> | The page object which contains the map. |
<!– ThinkGeo.MapSuite.MvcEdition.Overlay(overriden) –> Go Back
Public Properties
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
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
JavaScriptLibraryUri
Gets or sets a URI used for loading the Yahoo Maps Javascript library.
Return Value
| Return Type |
|---|
| Uri<!– System.Uri –> |
<!– ThinkGeo.MapSuite.MvcEdition.YahooOverlay –> 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
YahooMapType
Gets or sets a value that determines which type of Yahoo Map to display.
Return Value
| Return Type |
|---|
| YahooMapType<!– ThinkGeo.MapSuite.MvcEdition.YahooMapType –> |
<!– ThinkGeo.MapSuite.MvcEdition.YahooOverlay –> 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.yahoooverlay.txt · Last modified: 2017/03/16 21:59 (external edit)