User Tools

Site Tools

Trace:
thinkgeo.mapsuite.mvcedition.googleoverlay

Differences

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

Link to this comparison view

Next revision 		Previous revision
thinkgeo.mapsuite.mvcedition.googleoverlay [2015/08/20 03:08]
127.0.0.1 external edit 		— (current)
Line 1: Line 1:
-====== ThinkGeo.MapSuite.MvcEdition.GoogleOverlay ====== 
- 
- 
- 
-<!-- Class --> 
-Represents an overlay object that gets images from the Google Maps server. 
-=== Remarks === 
-The GoogleOverlay registers Google'​s Javascript library to the page and gets Google'​s map images as the background of the map. The GoogleOverlay can only be the base overlay of the map, over which other overlays are laid. 
-===== Inheritance Hierarchy ===== 
-*System.Object 
-**[[ThinkGeo.MapSuite.MvcEdition.Overlay]] 
-***[[ThinkGeo.MapSuite.MvcEdition.GoogleOverlay]] 
-===== Members Summary ===== 
-==== Public Constructors ==== 
-^ Name ^ Parameters ^ DeclaringType ^ Summary ^ 
-| {{wiki:​PublicMethod.gif|Public Method}}[[#​GoogleOverlay()|GoogleOverlay]] ​  ​| ​   |    | Initialize an instance of the GoogleOverlay class. ​  | 
-| {{wiki:​PublicMethod.gif|Public Method}}[[#​GoogleOverlay(String)|GoogleOverlay]] ​  | String ​  ​| ​   | Initialize an instance of the GoogleOverlay class with the overlay identifier specified. ​  | 
-| {{wiki:​PublicMethod.gif|Public Method}}[[#​GoogleOverlay(GoogleMapType)|GoogleOverlay]] ​  | [[ThinkGeo.MapSuite.MvcEdition.GoogleMapType|GoogleMapType]] ​  ​| ​   | Initialize an instance of the GoogleOverlay class with the overlay identifier ​  | 
-| {{wiki:​PublicMethod.gif|Public Method}}[[#​GoogleOverlay(String,​ GoogleMapType)|GoogleOverlay]] ​  | String, [[ThinkGeo.MapSuite.MvcEdition.GoogleMapType|GoogleMapType]] ​  ​| ​   | Initialize an instance of the GoogleOverlay class with the overlay identifier and the Google map type specified. ​  | 
- 
-==== Protected Constructors ==== 
-^ Name ^ Parameters ^ DeclaringType ^ Summary ^ 
- 
-==== Public Methods ==== 
-^ Name ^ Parameters ^ DeclaringType ^ Summary ^ 
-| {{wiki:​PublicMethod.gif|Public Method}}[[#​Equals(Object)|Equals]] ​  | Object ​  | Object ​  ​| ​   | 
-| {{wiki:​PublicMethod.gif|Public Method}}[[#​FromJson(String)|FromJson]] ​  | String ​  | [[ThinkGeo.MapSuite.MvcEdition.Overlay|Overlay]](overriden) ​  | 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 ==== 
-^ Name ^ Parameters ^ DeclaringType ^ Summary ^ 
-| {{wiki:​ProtectedMethod.gif|Protected Method}}[[#​Finalize()|Finalize]] ​  ​| ​   | Object ​  ​| ​   | 
-| {{wiki:​ProtectedMethod.gif|Protected Method}}[[#​MemberwiseClone()|MemberwiseClone]] ​  ​| ​   | Object ​  ​| ​   | 
-| {{wiki:​ProtectedMethod.gif|Protected Method}}[[#​RegisterJavaScriptLibraryCore(Page)|RegisterJavaScriptLibraryCore]] ​  | Page   | [[ThinkGeo.MapSuite.MvcEdition.Overlay|Overlay]](overriden) ​  | Registers the Google Javascript library URL string to the client HTML page.   | 
- 
-==== Public Properties ==== 
-^ Name ^ Return ^ DeclaringType ^ Summary ^ 
-| {{wiki:​PublicProperty.gif|Public Property}}[[#​Attribution|Attribution]] ​  | String ​  | [[ThinkGeo.MapSuite.MvcEdition.Overlay|Overlay]] ​  ​| ​   | 
-| {{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}}[[#​CenterOnStreetView|CenterOnStreetView]] ​  | Boolean ​  ​| ​   |    | 
-| {{wiki:​PublicProperty.gif|Public Property}}[[#​GoogleMapType|GoogleMapType]] ​  | [[ThinkGeo.MapSuite.MvcEdition.GoogleMapType|GoogleMapType]] ​  ​| ​   | Gets or sets a value that determines which type of Google Map to use.   | 
-| {{wiki:​PublicProperty.gif|Public Property}}[[#​GoogleStreetView|GoogleStreetView]] ​  | [[ThinkGeo.MapSuite.MvcEdition.GoogleStreetView|GoogleStreetView]] ​  ​| ​   |    | 
-| {{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}}[[#​JavaScriptLibraryUri|JavaScriptLibraryUri]] ​  | Uri   ​| ​   | Gets or sets a URI object for loading the Google Maps Javascript library. ​  | 
-| {{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}}[[#​TiltEnabled|TiltEnabled]] ​  | Boolean ​  ​| ​   |    | 
-| {{wiki:​PublicProperty.gif|Public Property}}[[#​TrafficEnabled|TrafficEnabled]] ​  | Boolean ​  ​| ​   |    | 
- 
-==== Protected Properties ==== 
-^ Name ^ Return ^ DeclaringType ^ Summary ^ 
-| {{wiki:​ProtectedProperty.gif|Protected Property}}[[#​OverlayType|OverlayType]] ​  | String ​  | [[ThinkGeo.MapSuite.MvcEdition.Overlay|Overlay]](overriden) ​  | Gets a string that indicates the overlay type.   | 
- 
-==== Public Events ==== 
-^ Name ^ Event Arguments ^ DeclaringType ^ Summary ^ 
- 
-===== Public Constructors ===== 
-==== GoogleOverlay() ==== 
-Initialize an instance of the GoogleOverlay class. 
-=== Overloads === 
-Initialize an instance of the GoogleOverlay class. 
-=== Parameters === 
-^  Name ^  Type ^  Description ^ 
- 
-[[#Public Constructors|Go Back]] 
-==== GoogleOverlay(String) ==== 
-Initialize an instance of the GoogleOverlay class with the overlay identifier specified. 
-=== Overloads === 
-Initialize an instance of the GoogleOverlay class. 
-=== Parameters === 
-^  Name ^  Type ^  Description ^ 
-| id   | String<​!-- System.String --> ​  | The identifier string of the overlay. ​  | 
- 
-[[#Public Constructors|Go Back]] 
-==== GoogleOverlay(GoogleMapType) ==== 
-Initialize an instance of the GoogleOverlay class with the overlay identifier 
-=== Parameters === 
-^  Name ^  Type ^  Description ^ 
-| googleMapType ​  | [[ThinkGeo.MapSuite.MvcEdition.GoogleMapType|GoogleMapType]]<​!-- ThinkGeo.MapSuite.MvcEdition.GoogleMapType --> ​  | The map type of this GoogleOverlay. ​  | 
- 
-[[#Public Constructors|Go Back]] 
-==== GoogleOverlay(String,​ GoogleMapType) ==== 
-Initialize an instance of the GoogleOverlay class with the overlay identifier and the Google map type specified. 
-=== Overloads === 
-Initialize an instance of the GoogleOverlay class. 
-=== Parameters === 
-^  Name ^  Type ^  Description ^ 
-| id   | String<​!-- System.String --> ​  | The identifier string of the Overlay. ​  | 
-| googleMapType ​  | [[ThinkGeo.MapSuite.MvcEdition.GoogleMapType|GoogleMapType]]<​!-- ThinkGeo.MapSuite.MvcEdition.GoogleMapType --> ​  | The map type of this GoogleOverlay. ​  | 
- 
-[[#Public Constructors|Go Back]] 
-===== Protected Constructors ===== 
-===== Public Methods ===== 
-==== Equals(Object) ==== 
-=== Return Value === 
-^ Return Type ^ Description ^ 
-| Boolean<​!-- System.Boolean --> ​  ​| ​   | 
- 
-=== Parameters === 
-^  Name ^  Type ^  Description ^ 
-| obj   | Object<​!-- System.Object --> ​  ​| ​   | 
- 
-<!-- System.Object --> 
-[[#Public Methods|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) --> 
-[[#Public Methods|Go Back]] 
-==== GetHashCode() ==== 
-=== Return Value === 
-^ Return Type ^ Description ^ 
-| Int32<​!-- System.Int32 --> ​  ​| ​   | 
- 
-=== Parameters === 
-^  Name ^  Type ^  Description ^ 
- 
-<!-- System.Object --> 
-[[#Public Methods|Go Back]] 
-==== GetType() ==== 
-=== Return Value === 
-^ Return Type ^ Description ^ 
-| Type<!-- System.Type --> ​  ​| ​   | 
- 
-=== Parameters === 
-^  Name ^  Type ^  Description ^ 
- 
-<!-- System.Object --> 
-[[#Public Methods|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 --> 
-[[#Public Methods|Go Back]] 
-==== ToString() ==== 
-=== Return Value === 
-^ Return Type ^ Description ^ 
-| String<​!-- System.String --> ​  ​| ​   | 
- 
-=== Parameters === 
-^  Name ^  Type ^  Description ^ 
- 
-<!-- System.Object --> 
-[[#Public Methods|Go Back]] 
-===== Protected Methods ===== 
-==== Finalize() ==== 
-=== Return Value === 
-^ Return Type ^ Description ^ 
-| Void<!-- System.Void --> ​  ​| ​   | 
- 
-=== Parameters === 
-^  Name ^  Type ^  Description ^ 
- 
-<!-- System.Object --> 
-[[#​Protected Methods|Go Back]] 
-==== MemberwiseClone() ==== 
-=== Return Value === 
-^ Return Type ^ Description ^ 
-| Object<​!-- System.Object --> ​  ​| ​   | 
- 
-=== Parameters === 
-^  Name ^  Type ^  Description ^ 
- 
-<!-- System.Object --> 
-[[#​Protected Methods|Go Back]] 
-==== RegisterJavaScriptLibraryCore(Page) ==== 
-Registers the Google 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 that contains the map.   | 
- 
-<!-- ThinkGeo.MapSuite.MvcEdition.Overlay(overriden) --> 
-[[#​Protected Methods|Go Back]] 
-===== Public Properties ===== 
-==== Attribution ==== 
-=== Return Value === 
-^ Return Type ^ 
-| String<​!-- System.String --> ​  | 
- 
-<!-- ThinkGeo.MapSuite.MvcEdition.Overlay --> 
-[[#Public Properties|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 --> 
-[[#Public Properties|Go Back]] 
-==== CenterOnStreetView ==== 
-=== Return Value === 
-^ Return Type ^ 
-| Boolean<​!-- System.Boolean --> ​  | 
- 
-<!-- ThinkGeo.MapSuite.MvcEdition.GoogleOverlay --> 
-[[#Public Properties|Go Back]] 
-==== GoogleMapType ==== 
-Gets or sets a value that determines which type of Google Map to use. 
-=== Return Value === 
-^ Return Type ^ 
-| [[ThinkGeo.MapSuite.MvcEdition.GoogleMapType|GoogleMapType]]<​!-- ThinkGeo.MapSuite.MvcEdition.GoogleMapType --> ​  | 
- 
-<!-- ThinkGeo.MapSuite.MvcEdition.GoogleOverlay --> 
-[[#Public Properties|Go Back]] 
-==== GoogleStreetView ==== 
-=== Return Value === 
-^ Return Type ^ 
-| [[ThinkGeo.MapSuite.MvcEdition.GoogleStreetView|GoogleStreetView]]<​!-- ThinkGeo.MapSuite.MvcEdition.GoogleStreetView --> ​  | 
- 
-<!-- ThinkGeo.MapSuite.MvcEdition.GoogleOverlay --> 
-[[#Public Properties|Go Back]] 
-==== Id ==== 
-Gets the identifier for the overlay to be found. 
-=== Return Value === 
-^ Return Type ^ 
-| String<​!-- System.String --> ​  | 
- 
-<!-- ThinkGeo.MapSuite.MvcEdition.Overlay --> 
-[[#Public Properties|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 --> 
-[[#Public Properties|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 --> 
-[[#Public Properties|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 --> 
-[[#Public Properties|Go Back]] 
-==== JavaScriptLibraryUri ==== 
-Gets or sets a URI object for loading the Google Maps Javascript library. 
-=== Return Value === 
-^ Return Type ^ 
-| Uri<!-- System.Uri --> ​  | 
- 
-<!-- ThinkGeo.MapSuite.MvcEdition.GoogleOverlay --> 
-[[#Public Properties|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 --> 
-[[#Public Properties|Go Back]] 
-==== OnClientAutoRefreshTick ==== 
-Don't support auto tick event by default. 
-=== Return Value === 
-^ Return Type ^ 
-| String<​!-- System.String --> ​  | 
- 
-<!-- ThinkGeo.MapSuite.MvcEdition.Overlay(overriden) --> 
-[[#Public Properties|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 --> 
-[[#Public Properties|Go Back]] 
-==== TiltEnabled ==== 
-=== Return Value === 
-^ Return Type ^ 
-| Boolean<​!-- System.Boolean --> ​  | 
- 
-<!-- ThinkGeo.MapSuite.MvcEdition.GoogleOverlay --> 
-[[#Public Properties|Go Back]] 
-==== TrafficEnabled ==== 
-=== Return Value === 
-^ Return Type ^ 
-| Boolean<​!-- System.Boolean --> ​  | 
- 
-<!-- ThinkGeo.MapSuite.MvcEdition.GoogleOverlay --> 
-[[#Public Properties|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) --> 
-[[#​Protected Properties|Go Back]] 
-===== Public Events ===== 
-__NOTOC__ 
-[[Category:​MvcEdition]] 
-[[Category:​ThinkGeo.MapSuite.MvcEdition]] 
-[[Category:​UpdateDocumentation]] 
  
thinkgeo.mapsuite.mvcedition.googleoverlay.1440040131.txt.gz ยท Last modified: 2015/09/21 03:33 (external edit)

Page Tools