User Tools

Site Tools


thinkgeo.mapsuite.mvcedition.markeroverlay

Differences

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

Link to this comparison view

Next revision
Previous revision
thinkgeo.mapsuite.mvcedition.markeroverlay [2015/08/20 03:08]
127.0.0.1 external edit
— (current)
Line 1: Line 1:
-====== ThinkGeo.MapSuite.MvcEdition.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.MvcEdition.Overlay]] 
-***[[ThinkGeo.MapSuite.MvcEdition.MarkerOverlay]] 
-****[[ThinkGeo.MapSuite.MvcEdition.FeatureSourceMarkerOverlay]] 
-****[[ThinkGeo.MapSuite.MvcEdition.InMemoryMarkerOverlay]] 
-****[[ThinkGeo.MapSuite.MvcEdition.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}}[[#​DataBindTo(String,​ String)|DataBindTo]] ​  | String, String ​  ​| ​   |    | 
-| {{wiki:​PublicMethod.gif|Public Method}}[[#​Equals(Object)|Equals]] ​  | Object ​  | Object ​  ​| ​   | 
-| {{wiki:​PublicMethod.gif|Public Method}}[[#​FromJson(String)|FromJson]] ​  | String ​  | [[ThinkGeo.MapSuite.MvcEdition.Overlay|Overlay]] ​  | Load this object from a json string. ​  | 
-| {{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.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}}[[#​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}}[[#​RegisterJavaScriptLibraryCore(Page)|RegisterJavaScriptLibraryCore]] ​  | Page   | [[ThinkGeo.MapSuite.MvcEdition.Overlay|Overlay]] ​  | Registers a Javascript library URL string to the client HTML page.   | 
- 
-==== Public Properties ==== 
-^ Name ^ Return ^ DeclaringType ^ Summary ^ 
-| {{wiki:​PublicProperty.gif|Public Property}}[[#​ActionTriggers|ActionTriggers]] ​  | Collection<​[[ThinkGeo.MapSuite.MvcEdition.ActionTrigger|ActionTrigger]]> ​  ​| ​   |    | 
-| {{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}}[[#​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]](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.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}}[[#​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]] ​  | Gets or sets a JavaScript function name which will be executed when the number of milliseconds specified in the AutoRefreshInterval property has elapsed. ​  | 
-| {{wiki:​PublicProperty.gif|Public Property}}[[#​OnClientClick|OnClientClick]] ​  | String ​  ​| ​   | Gets or sets a client function name which will be executed after clicking on the MarkerOverlay ​  | 
-| {{wiki:​PublicProperty.gif|Public Property}}[[#​OnClientMarkersRequested|OnClientMarkersRequested]] ​  | String ​  ​| ​   |    | 
-| {{wiki:​PublicProperty.gif|Public Property}}[[#​OnClientMarkersRequesting|OnClientMarkersRequesting]] ​  | String ​  ​| ​   |    | 
-| {{wiki:​PublicProperty.gif|Public Property}}[[#​Opacity|Opacity]] ​  | Single ​  | [[ThinkGeo.MapSuite.MvcEdition.Overlay|Overlay]] ​  | Gets or sets the opacity level of the overlay. ​  | 
- 
-==== 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 ===== 
-===== Protected Constructors ===== 
-==== MarkerOverlay() ==== 
-Initialize a new instance of the MarkerOverlay class. 
-=== Overloads === 
-Initialize a new instance of the MarkerOverlay class. 
-=== 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. 
-=== Parameters === 
-^  Name ^  Type ^  Description ^ 
-| id   | String<​!-- System.String --> ​  | The identifier string of the MarkerOverlay. ​  | 
- 
-[[#​Protected Constructors|Go Back]] 
-===== Public Methods ===== 
-==== DataBindTo(String,​ String) ==== 
-=== Return Value === 
-^ Return Type ^ Description ^ 
-| Void<!-- System.Void --> ​  ​| ​   | 
- 
-=== Parameters === 
-^  Name ^  Type ^  Description ^ 
-| controllerName ​  | String<​!-- System.String --> ​  ​| ​   | 
-| actionName ​  | String<​!-- System.String --> ​  ​| ​   | 
- 
-<!-- ThinkGeo.MapSuite.MvcEdition.MarkerOverlay --> 
-[[#Public Methods|Go Back]] 
-==== 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 --> 
-[[#Public Methods|Go Back]] 
-==== GetHashCode() ==== 
-=== 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.MvcEdition.Marker|Marker]]><​!-- System.Collections.ObjectModel.Collection{ThinkGeo.MapSuite.MvcEdition.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.MvcEdition.MarkerOverlay --> 
-[[#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]] 
-==== 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.MvcEdition.Marker|Marker]]><​!-- System.Collections.ObjectModel.Collection{ThinkGeo.MapSuite.MvcEdition.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.MvcEdition.MarkerOverlay --> 
-[[#​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 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 --> 
-[[#​Protected Methods|Go Back]] 
-===== Public Properties ===== 
-==== ActionTriggers ==== 
-=== Return Value === 
-^ Return Type ^ 
-| Collection<​[[ThinkGeo.MapSuite.MvcEdition.ActionTrigger|ActionTrigger]]><​!-- System.Collections.ObjectModel.Collection{ThinkGeo.MapSuite.MvcEdition.ActionTrigger} --> ​  | 
- 
-<!-- ThinkGeo.MapSuite.MvcEdition.MarkerOverlay --> 
-[[#Public Properties|Go Back]] 
-==== 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]] 
-==== 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. 
-=== 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.MvcEdition.Overlay(overriden) --> 
-[[#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]] 
-==== 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 ==== 
-Gets or sets a JavaScript function name which will be executed when the number of milliseconds specified in the AutoRefreshInterval property has elapsed. 
-=== Return Value === 
-^ Return Type ^ 
-| String<​!-- System.String --> ​  | 
- 
-<!-- ThinkGeo.MapSuite.MvcEdition.Overlay --> 
-[[#Public Properties|Go Back]] 
-==== OnClientClick ==== 
-Gets or sets a client function name which will be executed after clicking on the MarkerOverlay 
-=== Remarks === 
-There is a default parameter:​e,​ which includes two parameters: "​worldXY",​ "​overlayId"​ 
-=== Return Value === 
-^ Return Type ^ 
-| String<​!-- System.String --> ​  | 
- 
-<!-- ThinkGeo.MapSuite.MvcEdition.MarkerOverlay --> 
-[[#Public Properties|Go Back]] 
-==== OnClientMarkersRequested ==== 
-=== Return Value === 
-^ Return Type ^ 
-| String<​!-- System.String --> ​  | 
- 
-<!-- ThinkGeo.MapSuite.MvcEdition.MarkerOverlay --> 
-[[#Public Properties|Go Back]] 
-==== OnClientMarkersRequesting ==== 
-=== Return Value === 
-^ Return Type ^ 
-| String<​!-- System.String --> ​  | 
- 
-<!-- ThinkGeo.MapSuite.MvcEdition.MarkerOverlay --> 
-[[#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]] 
-===== 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.markeroverlay.1440040131.txt.gz ยท Last modified: 2015/09/21 03:34 (external edit)