====== ThinkGeo.MapSuite.WebEdition.YahooOverlay ====== {{section>upgrade_map_suite_to_10.0}} 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 ===== *System.Object **[[ThinkGeo.MapSuite.WebEdition.Overlay]] ***[[ThinkGeo.MapSuite.WebEdition.YahooOverlay]] ===== Members Summary ===== ==== Public Constructors ==== ^ Name ^ Parameters ^ DeclaringType ^ Summary ^ | {{wiki:PublicMethod.gif|Public Method}}[[#YahooOverlay()|YahooOverlay]] | | | Initialize an instance of the YahooOverlay class. | | {{wiki:PublicMethod.gif|Public Method}}[[#YahooOverlay(String)|YahooOverlay]] | String | | Initialize an instance of the YahooOverlay class with the overlay identifier specified. | | {{wiki:PublicMethod.gif|Public Method}}[[#YahooOverlay(String, YahooMapType)|YahooOverlay]] | String, [[ThinkGeo.MapSuite.WebEdition.YahooMapType|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 ==== ^ Name ^ Parameters ^ DeclaringType ^ Summary ^ | {{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 ==== ^ 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}}[[#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]](overriden) | Registers the Yahoo Maps Javascript library URL string to the client HTML page. | ==== Public Properties ==== ^ Name ^ Return ^ DeclaringType ^ Summary ^ | {{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}}[[#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}}[[#JavaScriptLibraryUri|JavaScriptLibraryUri]] | Uri | | Gets or sets a URI used for loading the Yahoo Maps Javascript library. | | {{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}}[[#YahooMapType|YahooMapType]] | [[ThinkGeo.MapSuite.WebEdition.YahooMapType|YahooMapType]] | | Gets or sets a value that determines which type of Yahoo Map to display. | ==== Protected Properties ==== ^ Name ^ Return ^ DeclaringType ^ Summary ^ | {{wiki:ProtectedProperty.gif|Protected Property}}[[#HasTickEvent|HasTickEvent]] | Boolean | [[ThinkGeo.MapSuite.WebEdition.Overlay|Overlay]](overriden) | Don't support auto tick event by default. | | {{wiki:ProtectedProperty.gif|Protected Property}}[[#OverlayType|OverlayType]] | String | [[ThinkGeo.MapSuite.WebEdition.Overlay|Overlay]](overriden) | Gets a string that indicates the overlay type. | ==== Public Events ==== ^ Name ^ Event Arguments ^ DeclaringType ^ Summary ^ | {{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. | ===== Public Constructors ===== ==== YahooOverlay() ==== Initialize an instance of the YahooOverlay class. === Overloads === Initialize an instance of the YahooOverlay class. === Parameters === ^ Name ^ Type ^ Description ^ [[#Public Constructors|Go Back]] ==== 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 | The identifier string used for finding the overlay. | [[#Public Constructors|Go Back]] ==== 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 | The identifier string used for finding the overlay. | | yahooMapType | [[ThinkGeo.MapSuite.WebEdition.YahooMapType|YahooMapType]] | The map type of the overlay. | [[#Public Constructors|Go Back]] ===== Protected Constructors ===== ===== Public Methods ===== ==== Equals(Object) ==== === Return Value === ^ Return Type ^ Description ^ | Boolean | | === Parameters === ^ Name ^ Type ^ Description ^ | obj | Object | | [[#Public Methods|Go Back]] ==== GetHashCode() ==== === Return Value === ^ Return Type ^ Description ^ | Int32 | | === Parameters === ^ Name ^ Type ^ Description ^ [[#Public Methods|Go Back]] ==== GetType() ==== === Return Value === ^ Return Type ^ Description ^ | Type | | === Parameters === ^ Name ^ Type ^ Description ^ [[#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 | A JSON string which is used to create an overlay at the client side. | === Parameters === ^ Name ^ Type ^ Description ^ [[#Public Methods|Go Back]] ==== ToString() ==== === Return Value === ^ Return Type ^ Description ^ | String | | === Parameters === ^ Name ^ Type ^ Description ^ [[#Public Methods|Go Back]] ===== Protected Methods ===== ==== Finalize() ==== === Return Value === ^ Return Type ^ Description ^ | Void | | === Parameters === ^ Name ^ Type ^ Description ^ [[#Protected Methods|Go Back]] ==== MemberwiseClone() ==== === Return Value === ^ Return Type ^ Description ^ | Object | | === Parameters === ^ Name ^ Type ^ Description ^ [[#Protected Methods|Go Back]] ==== OnTick(EventArgs) ==== Raises the Tick event of the MarkerOverlay. === Return Value === ^ Return Type ^ Description ^ | Void | | === Parameters === ^ Name ^ Type ^ Description ^ | e | EventArgs | An System.EventArgs object that contains the event data. | [[#Protected Methods|Go Back]] ==== RegisterJavaScriptLibraryCore(Page) ==== Registers the Yahoo Maps Javascript library URL string to the client HTML page. === Return Value === ^ Return Type ^ Description ^ | Void | | === Parameters === ^ Name ^ Type ^ Description ^ | page | Page | The page object which contains the map. | [[#Protected Methods|Go Back]] ===== Public Properties ===== ==== AutoRefreshInterval ==== Gets or sets the time interval in which the MarkerOverlay refreshes itself. === Return Value === ^ Return Type ^ | TimeSpan | [[#Public Properties|Go Back]] ==== Id ==== Gets the identifier for the overlay to be found. === Return Value === ^ Return Type ^ | String | [[#Public Properties|Go Back]] ==== IsBaseOverlay ==== Gets or sets a value that indicates whether the overlay is a base overlay. === Return Value === ^ Return Type ^ | Boolean | [[#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 | [[#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 | [[#Public Properties|Go Back]] ==== JavaScriptLibraryUri ==== Gets or sets a URI used for loading the Yahoo Maps Javascript library. === Return Value === ^ Return Type ^ | Uri | [[#Public Properties|Go Back]] ==== Name ==== Gets or sets the name of the overlay, which will display in the OverlaySwitcher. === Return Value === ^ Return Type ^ | String | [[#Public Properties|Go Back]] ==== Opacity ==== Gets or sets the opacity level of the overlay. === Remarks === The Opacity 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 | [[#Public Properties|Go Back]] ==== YahooMapType ==== Gets or sets a value that determines which type of Yahoo Map to display. === Return Value === ^ Return Type ^ | [[ThinkGeo.MapSuite.WebEdition.YahooMapType|YahooMapType]] | [[#Public Properties|Go Back]] ===== Protected Properties ===== ==== HasTickEvent ==== Don't support auto tick event by default. === Return Value === ^ Return Type ^ | Boolean | [[#Protected Properties|Go Back]] ==== OverlayType ==== Gets a string that indicates the overlay type. === Return Value === ^ Return Type ^ | String | [[#Protected Properties|Go Back]] ===== Public Events ===== ==== Tick ==== Occurs when the number of milliseconds specified in the AutoRefreshInterval property has elapsed and the page is posted to the server. === Event Arguments === ^ Event Arguments ^ | EventArgs | [[#Public Events|Go Back]] __NOTOC__ [[Category:WebEdition]] [[Category:ThinkGeo.MapSuite.WebEdition]] [[Category:UpdateDocumentation]]