thinkgeo.mapsuite.webedition.markeroverlay
Differences
This shows you the differences between two versions of the page.
| Next revision | Previous revision | ||
|
thinkgeo.mapsuite.webedition.markeroverlay [2015/08/20 03:08] 127.0.0.1 external edit |
— (current) | ||
|---|---|---|---|
| Line 1: | Line 1: | ||
| - | ====== ThinkGeo.MapSuite.WebEdition.MarkerOverlay ====== | ||
| - | |||
| - | |||
| - | |||
| - | <!-- Class --> | ||
| - | Serves as the base class for the overlay that generates and manages markers. | ||
| - | === Remarks === | ||
| - | The <strong>MarkerOverlay</strong> class is the base class for any overlay that deals with markers. A <strong>MarkerOverlay</strong> object corresponds to a <strong>div</strong> that holds a group of marker images at the client side. The MarkerOverlay class has a <strong>GetMarkers</strong> method that generates a collection of markers. These markers will be serialized to a JSON string and sent to the client to create the client marker objects. If you want to create your own MarkerOverlay, inherit from this class and override the <strong>GetMarkerCore</strong> method. | ||
| - | ===== Inheritance Hierarchy ===== | ||
| - | *System.Object | ||
| - | **[[ThinkGeo.MapSuite.WebEdition.Overlay]] | ||
| - | ***[[ThinkGeo.MapSuite.WebEdition.MarkerOverlay]] | ||
| - | ****[[ThinkGeo.MapSuite.WebEdition.FeatureSourceMarkerOverlay]] | ||
| - | ****[[ThinkGeo.MapSuite.WebEdition.InMemoryMarkerOverlay]] | ||
| - | ****[[ThinkGeo.MapSuite.WebEdition.SimpleMarkerOverlay]] | ||
| - | ===== Members Summary ===== | ||
| - | ==== Public Constructors ==== | ||
| - | ^ Name ^ Parameters ^ DeclaringType ^ Summary ^ | ||
| - | |||
| - | ==== Protected Constructors ==== | ||
| - | ^ Name ^ Parameters ^ DeclaringType ^ Summary ^ | ||
| - | | {{wiki:ProtectedMethod.gif|Protected Method}}[[#MarkerOverlay()|MarkerOverlay]] | | | Initialize a new instance of the MarkerOverlay class. | | ||
| - | | {{wiki:ProtectedMethod.gif|Protected Method}}[[#MarkerOverlay(String)|MarkerOverlay]] | String | | Initialize a new instance of the MarkerOverlay class using the identifier specified. | | ||
| - | |||
| - | ==== 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}}[[#GetMarkers(RectangleShape, Int32)|GetMarkers]] | [[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]], Int32 | | Returns a collection of markers based on the extent and zoomlevel that you passed in. | | ||
| - | | {{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}}[[#GetMarkersCore(RectangleShape, Int32)|GetMarkersCore]] | [[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]], Int32 | | Returns a collection of markers based on the extent and zoomlevel that you passed in. | | ||
| - | | {{wiki:ProtectedMethod.gif|Protected Method}}[[#MemberwiseClone()|MemberwiseClone]] | | Object | | | ||
| - | | {{wiki:ProtectedMethod.gif|Protected Method}}[[#OnClick(MarkerOverlayClickEventArgs)|OnClick]] | [[ThinkGeo.MapSuite.WebEdition.MarkerOverlayClickEventArgs|MarkerOverlayClickEventArgs]] | | Raises the Click event of the MarkerOverlay 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]] | Registers a 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.WebEdition.Overlay|Overlay]] | | | ||
| - | | {{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]](overriden) | 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}}[[#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. | | ||
| - | |||
| - | ==== Protected Properties ==== | ||
| - | ^ Name ^ Return ^ DeclaringType ^ Summary ^ | ||
| - | | {{wiki:ProtectedProperty.gif|Protected Property}}[[#HasTickEvent|HasTickEvent]] | Boolean | [[ThinkGeo.MapSuite.WebEdition.Overlay|Overlay]] | Indicates whether the overlay supports tick event. | | ||
| - | | {{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}}[[#Click|Click]] | [[ThinkGeo.MapSuite.WebEdition.MarkerOverlayClickEventArgs|MarkerOverlayClickEventArgs]] | | Occurs when a marker in the overlay is clicked. | | ||
| - | | {{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 ===== | ||
| - | ===== Protected Constructors ===== | ||
| - | ==== MarkerOverlay() ==== | ||
| - | Initialize a new instance of the MarkerOverlay class. | ||
| - | === Overloads === | ||
| - | Initialize a new instance of the MarkerOverlay class. | ||
| - | === Remarks === | ||
| - | For the most updated Info for this topic, please check it here:<a href="http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.MarkerOverlay#MarkerOverlay.28.29" target="_blank">http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.MarkerOverlay#MarkerOverlay.28.29</a> | ||
| - | === Parameters === | ||
| - | ^ Name ^ Type ^ Description ^ | ||
| - | |||
| - | [[#Protected Constructors|Go Back]] | ||
| - | ==== MarkerOverlay(String) ==== | ||
| - | Initialize a new instance of the MarkerOverlay class using the identifier specified. | ||
| - | === Overloads === | ||
| - | Initialize a new instance of the MarkerOverlay class. | ||
| - | === Remarks === | ||
| - | For the most updated Info for this topic, please check it here:<a href="http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.MarkerOverlay#MarkerOverlay.28String.29" target="_blank">http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.MarkerOverlay#MarkerOverlay.28String.29</a> | ||
| - | === Parameters === | ||
| - | ^ Name ^ Type ^ Description ^ | ||
| - | | id | String<!-- System.String --> | The identifier string of the MarkerOverlay. | | ||
| - | |||
| - | [[#Protected Constructors|Go Back]] | ||
| - | ===== Public Methods ===== | ||
| - | ==== Equals(Object) ==== | ||
| - | === Remarks === | ||
| - | For the most updated Info for this topic, please check it here:<a href="http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.MarkerOverlay#Equals.28Object.29" target="_blank">http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.MarkerOverlay#Equals.28Object.29</a> | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ Description ^ | ||
| - | | Boolean<!-- System.Boolean --> | | | ||
| - | |||
| - | === Parameters === | ||
| - | ^ Name ^ Type ^ Description ^ | ||
| - | | obj | Object<!-- System.Object --> | | | ||
| - | |||
| - | <!-- System.Object --> | ||
| - | [[#Public Methods|Go Back]] | ||
| - | ==== GetHashCode() ==== | ||
| - | === Remarks === | ||
| - | For the most updated Info for this topic, please check it here:<a href="http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.MarkerOverlay#GetHashCode.28.29" target="_blank">http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.MarkerOverlay#GetHashCode.28.29</a> | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ Description ^ | ||
| - | | Int32<!-- System.Int32 --> | | | ||
| - | |||
| - | === Parameters === | ||
| - | ^ Name ^ Type ^ Description ^ | ||
| - | |||
| - | <!-- System.Object --> | ||
| - | [[#Public Methods|Go Back]] | ||
| - | ==== GetMarkers(RectangleShape, Int32) ==== | ||
| - | Returns a collection of markers based on the extent and zoomlevel that you passed in. | ||
| - | === Remarks === | ||
| - | The <strong>GetMarkers</strong> method creates the makrers based on the current zoomlevel, the specified extent and the special logic of the MarkerOverlay. The returned markers object will be serialized and sent to the client to create client markers. | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ Description ^ | ||
| - | | Collection<[[ThinkGeo.MapSuite.WebEdition.Marker|Marker]]><!-- System.Collections.ObjectModel.Collection{ThinkGeo.MapSuite.WebEdition.Marker} --> | A collection of marker objects that will be serialized to the client. | | ||
| - | |||
| - | === Parameters === | ||
| - | ^ Name ^ Type ^ Description ^ | ||
| - | | worldExtent | [[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]]<!-- ThinkGeo.MapSuite.Core.RectangleShape --> | The extent that includes all of the markers you want to serialize. | | ||
| - | | currentZoomLevelId | Int32<!-- System.Int32 --> | An int value that indicates which zoomlevel the map is currently at. | | ||
| - | |||
| - | <!-- ThinkGeo.MapSuite.WebEdition.MarkerOverlay --> | ||
| - | [[#Public Methods|Go Back]] | ||
| - | ==== GetType() ==== | ||
| - | === Remarks === | ||
| - | For the most updated Info for this topic, please check it here:<a href="http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.MarkerOverlay#GetType.28.29" target="_blank">http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.MarkerOverlay#GetType.28.29</a> | ||
| - | === 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. | ||
| - | === Remarks === | ||
| - | For the most updated Info for this topic, please check it here:<a href="http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.MarkerOverlay#ToJson.28.29" target="_blank">http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.MarkerOverlay#ToJson.28.29</a> | ||
| - | === 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.WebEdition.Overlay --> | ||
| - | [[#Public Methods|Go Back]] | ||
| - | ==== ToString() ==== | ||
| - | === Remarks === | ||
| - | For the most updated Info for this topic, please check it here:<a href="http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.MarkerOverlay#ToString.28.29" target="_blank">http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.MarkerOverlay#ToString.28.29</a> | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ Description ^ | ||
| - | | String<!-- System.String --> | | | ||
| - | |||
| - | === Parameters === | ||
| - | ^ Name ^ Type ^ Description ^ | ||
| - | |||
| - | <!-- System.Object --> | ||
| - | [[#Public Methods|Go Back]] | ||
| - | ===== Protected Methods ===== | ||
| - | ==== Finalize() ==== | ||
| - | === Remarks === | ||
| - | For the most updated Info for this topic, please check it here:<a href="http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.MarkerOverlay#Finalize.28.29" target="_blank">http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.MarkerOverlay#Finalize.28.29</a> | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ Description ^ | ||
| - | | Void<!-- System.Void --> | | | ||
| - | |||
| - | === Parameters === | ||
| - | ^ Name ^ Type ^ Description ^ | ||
| - | |||
| - | <!-- System.Object --> | ||
| - | [[#Protected Methods|Go Back]] | ||
| - | ==== GetMarkersCore(RectangleShape, Int32) ==== | ||
| - | Returns a collection of markers based on the extent and zoomlevel that you passed in. | ||
| - | === Remarks === | ||
| - | The GetMarkersCore method allows derived classes to rewrite the logic used for dynamically creating the markers that will be serialized to the client. | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ Description ^ | ||
| - | | Collection<[[ThinkGeo.MapSuite.WebEdition.Marker|Marker]]><!-- System.Collections.ObjectModel.Collection{ThinkGeo.MapSuite.WebEdition.Marker} --> | A collection of Marker objects that will be serialized to the client. | | ||
| - | |||
| - | === Parameters === | ||
| - | ^ Name ^ Type ^ Description ^ | ||
| - | | worldExtent | [[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]]<!-- ThinkGeo.MapSuite.Core.RectangleShape --> | The extent that includes all of the markers you want to serialize. | | ||
| - | | currentZoomLevelId | Int32<!-- System.Int32 --> | An int value that indicates which zoomlevel the map is currently at. | | ||
| - | |||
| - | <!-- ThinkGeo.MapSuite.WebEdition.MarkerOverlay --> | ||
| - | [[#Protected Methods|Go Back]] | ||
| - | ==== MemberwiseClone() ==== | ||
| - | === Remarks === | ||
| - | For the most updated Info for this topic, please check it here:<a href="http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.MarkerOverlay#MemberwiseClone.28.29" target="_blank">http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.MarkerOverlay#MemberwiseClone.28.29</a> | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ Description ^ | ||
| - | | Object<!-- System.Object --> | | | ||
| - | |||
| - | === Parameters === | ||
| - | ^ Name ^ Type ^ Description ^ | ||
| - | |||
| - | <!-- System.Object --> | ||
| - | [[#Protected Methods|Go Back]] | ||
| - | ==== OnClick(MarkerOverlayClickEventArgs) ==== | ||
| - | Raises the Click event of the MarkerOverlay object. | ||
| - | === Remarks === | ||
| - | The <strong>OnClick</strong> method also allows derived classes to handle the event without attaching a delegate. This is the preferred technique for handling the event in a derived class.<strong>Notes to Inheritors:</strong> When overriding <strong>OnClick</strong> in a derived class, be sure to call the base class's <strong>OnClick</strong> method so that registered delegates receive the event. | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ Description ^ | ||
| - | | Void<!-- System.Void --> | | | ||
| - | |||
| - | === Parameters === | ||
| - | ^ Name ^ Type ^ Description ^ | ||
| - | | e | [[ThinkGeo.MapSuite.WebEdition.MarkerOverlayClickEventArgs|MarkerOverlayClickEventArgs]]<!-- ThinkGeo.MapSuite.WebEdition.MarkerOverlayClickEventArgs --> | The MarkerOverlayClickEventArgs that contains event data. | | ||
| - | |||
| - | <!-- ThinkGeo.MapSuite.WebEdition.MarkerOverlay --> | ||
| - | [[#Protected Methods|Go Back]] | ||
| - | ==== OnTick(EventArgs) ==== | ||
| - | Raises the Tick event of the MarkerOverlay. | ||
| - | === Remarks === | ||
| - | For the most updated Info for this topic, please check it here:<a href="http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.MarkerOverlay#OnTick.28EventArgs.29" target="_blank">http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.MarkerOverlay#OnTick.28EventArgs.29</a> | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ Description ^ | ||
| - | | Void<!-- System.Void --> | | | ||
| - | |||
| - | === Parameters === | ||
| - | ^ Name ^ Type ^ Description ^ | ||
| - | | e | EventArgs<!-- System.EventArgs --> | An System.EventArgs object that contains the event data. | | ||
| - | |||
| - | <!-- ThinkGeo.MapSuite.WebEdition.Overlay --> | ||
| - | [[#Protected Methods|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.WebEdition.Overlay --> | ||
| - | [[#Protected Methods|Go Back]] | ||
| - | ===== Public Properties ===== | ||
| - | ==== Attribution ==== | ||
| - | === Remarks === | ||
| - | For the most updated Info for this topic, please check it here:<a href="http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.MarkerOverlay#Attribution" target="_blank">http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.MarkerOverlay#Attribution</a> | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ | ||
| - | | String<!-- System.String --> | | ||
| - | |||
| - | <!-- ThinkGeo.MapSuite.WebEdition.Overlay --> | ||
| - | [[#Public Properties|Go Back]] | ||
| - | ==== 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:<a href="http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.MarkerOverlay#AutoRefreshInterval" target="_blank">http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.MarkerOverlay#AutoRefreshInterval</a> | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ | ||
| - | | TimeSpan<!-- System.TimeSpan --> | | ||
| - | |||
| - | <!-- ThinkGeo.MapSuite.WebEdition.Overlay --> | ||
| - | [[#Public Properties|Go Back]] | ||
| - | ==== Id ==== | ||
| - | Gets the identifier for the overlay to be found. | ||
| - | === Remarks === | ||
| - | For the most updated Info for this topic, please check it here:<a href="http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.MarkerOverlay#Id" target="_blank">http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.MarkerOverlay#Id</a> | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ | ||
| - | | String<!-- System.String --> | | ||
| - | |||
| - | <!-- ThinkGeo.MapSuite.WebEdition.Overlay --> | ||
| - | [[#Public Properties|Go Back]] | ||
| - | ==== IsBaseOverlay ==== | ||
| - | Gets or sets a value that indicates whether the overlay is a base overlay. | ||
| - | === Remarks === | ||
| - | The MarkerOverlay can only be a non-base overlay. If you set the <strong>IsBaseOverlay</strong> property to true, there will be an exception thrown. | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ | ||
| - | | Boolean<!-- System.Boolean --> | | ||
| - | |||
| - | <!-- ThinkGeo.MapSuite.WebEdition.Overlay(overriden) --> | ||
| - | [[#Public Properties|Go Back]] | ||
| - | ==== 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:<a href="http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.MarkerOverlay#IsVisible" target="_blank">http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.MarkerOverlay#IsVisible</a> | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ | ||
| - | | Boolean<!-- System.Boolean --> | | ||
| - | |||
| - | <!-- ThinkGeo.MapSuite.WebEdition.Overlay --> | ||
| - | [[#Public Properties|Go Back]] | ||
| - | ==== 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:<a href="http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.MarkerOverlay#IsVisibleInOverlaySwitcher" target="_blank">http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.MarkerOverlay#IsVisibleInOverlaySwitcher</a> | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ | ||
| - | | Boolean<!-- System.Boolean --> | | ||
| - | |||
| - | <!-- ThinkGeo.MapSuite.WebEdition.Overlay --> | ||
| - | [[#Public Properties|Go Back]] | ||
| - | ==== 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:<a href="http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.MarkerOverlay#Name" target="_blank">http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.MarkerOverlay#Name</a> | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ | ||
| - | | String<!-- System.String --> | | ||
| - | |||
| - | <!-- ThinkGeo.MapSuite.WebEdition.Overlay --> | ||
| - | [[#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.WebEdition.Overlay --> | ||
| - | [[#Public Properties|Go Back]] | ||
| - | ===== Protected Properties ===== | ||
| - | ==== HasTickEvent ==== | ||
| - | Indicates whether the overlay supports tick event. | ||
| - | === Remarks === | ||
| - | For the most updated Info for this topic, please check it here:<a href="http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.MarkerOverlay#HasTickEvent" target="_blank">http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.MarkerOverlay#HasTickEvent</a> | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ | ||
| - | | Boolean<!-- System.Boolean --> | | ||
| - | |||
| - | <!-- ThinkGeo.MapSuite.WebEdition.Overlay --> | ||
| - | [[#Protected Properties|Go Back]] | ||
| - | ==== OverlayType ==== | ||
| - | Gets a string that indicates the overlay type. | ||
| - | === Remarks === | ||
| - | For the most updated Info for this topic, please check it here:<a href="http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.MarkerOverlay#OverlayType" target="_blank">http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.MarkerOverlay#OverlayType</a> | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ | ||
| - | | String<!-- System.String --> | | ||
| - | |||
| - | <!-- ThinkGeo.MapSuite.WebEdition.Overlay(overriden) --> | ||
| - | [[#Protected Properties|Go Back]] | ||
| - | ===== Public Events ===== | ||
| - | ==== Click ==== | ||
| - | Occurs when a marker in the overlay is clicked. | ||
| - | === Remarks === | ||
| - | For the most updated Info for this topic, please check it here:<a href="http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.MarkerOverlay#OnClick.28MarkerOverlayClickEventArgs.29" target="_blank">http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.MarkerOverlay#OnClick.28MarkerOverlayClickEventArgs.29</a> | ||
| - | === Event Arguments === | ||
| - | ^ Event Arguments ^ | ||
| - | | [[ThinkGeo.MapSuite.WebEdition.MarkerOverlayClickEventArgs|MarkerOverlayClickEventArgs]]<!-- ThinkGeo.MapSuite.WebEdition.MarkerOverlayClickEventArgs --> | | ||
| - | |||
| - | <!-- ThinkGeo.MapSuite.WebEdition.MarkerOverlay --> | ||
| - | [[#Public Events|Go Back]] | ||
| - | ==== 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:<a href="http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.MarkerOverlay#OnTick.28EventArgs.29" target="_blank">http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.MarkerOverlay#OnTick.28EventArgs.29</a> | ||
| - | === Event Arguments === | ||
| - | ^ Event Arguments ^ | ||
| - | | EventArgs<!-- System.EventArgs --> | | ||
| - | |||
| - | <!-- ThinkGeo.MapSuite.WebEdition.Overlay --> | ||
| - | [[#Public Events|Go Back]] | ||
| - | |||
| - | __NOTOC__ | ||
| - | [[Category:WebEdition]] | ||
| - | [[Category:ThinkGeo.MapSuite.WebEdition]] | ||
| - | [[Category:UpdateDocumentation]] | ||
thinkgeo.mapsuite.webedition.markeroverlay.1440040135.txt.gz ยท Last modified: 2015/09/18 03:08 (external edit)
