ThinkGeo Wiki

This page is read only. You can view the source, but not change it. Ask your administrator if you think this is wrong.
====== ThinkGeo.MapSuite.WebEdition.FeatureSourceMarkerOverlay ======
Represents a MarkerOverlay that dynamically creates markers from the feature source specified.
===== Inheritance Hierarchy =====
  *System.Object
    *ThinkGeo.MapSuite.WebEdition.Overlay
      *ThinkGeo.MapSuite.WebEdition.MarkerOverlay
        ***ThinkGeo.MapSuite.WebEdition.FeatureSourceMarkerOverlay**
===== Members Summary =====
==== Public Constructors ====
** {{wiki:PublicMethod.gif|}} FeatureSourceMarkerOverlay() **

  * //Initialize an instance of the FeatureMarkerOverlay class.//
== Remarks ==
  * //For the most updated Info for this topic, please check it here:http:wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.FeatureSourceMarkerOverlay#FeatureSourceMarkerOverlay.28.29//
== Parameters ==
<div newline></div>
** {{wiki:PublicMethod.gif|}} FeatureSourceMarkerOverlay(String) **

  * //Initialize an instance of the FeatureMarkerOverlay class.//
== Remarks ==
  * //For the most updated Info for this topic, please check it here:http:wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.FeatureSourceMarkerOverlay#FeatureSourceMarkerOverlay.28String.29//
== Parameters ==
  * //id//
    * Type:String
    * Description:The identifier string used for retrieving the overlay.

<div newline></div>
** {{wiki:PublicMethod.gif|}} FeatureSourceMarkerOverlay(String,FeatureSource) **

  * //Initialize an instance of the FeatureMarkerOverlay class.//
== Remarks ==
  * //For the most updated Info for this topic, please check it here:http:wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.FeatureSourceMarkerOverlay#FeatureSourceMarkerOverlay.28String.2C_FeatureSource.29//
== Parameters ==
  * //id//
    * Type:String
    * Description:The identifier string used for retrieving the overlay.

  * //featureSource//
    * Type:[[ThinkGeo.MapSuite.Core.FeatureSource|FeatureSource]]
    * Description:The feature source object that provides the features from which the markers are created.

<div newline></div>
==== Protected Constructors ====
==== Public Methods ====
** {{wiki:PublicMethod.gif|}} 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 ==
  * Type:Collection<[[ThinkGeo.MapSuite.WebEdition.Marker|Marker]]>
  * Description:A collection of marker objects that will be serialized to the client.

== Parameters ==
  * //worldExtent//
    * Type:[[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]]
    * Description:The extent that includes all of the markers you want to serialize.

  * //currentZoomLevelId//
    * Type:Int32
    * Description:An int value that indicates which zoomlevel the map is currently at.

<div newline></div>
** {{wiki:PublicMethod.gif|}} 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:http:wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.FeatureSourceMarkerOverlay#ToJson.28.29//

== Return Value ==
  * Type:String
  * Description:A JSON string which is used to create an overlay at the client side.

== Parameters ==
<div newline></div>
** {{wiki:PublicMethod.gif|}} ToString() **

  * //N/A//
== Remarks ==
  * //For the most updated Info for this topic, please check it here:http:wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.FeatureSourceMarkerOverlay#ToString.28.29//

== Return Value ==
  * Type:String
  * Description:N/A

== Parameters ==
<div newline></div>
** {{wiki:PublicMethod.gif|}} Equals(Object) **

  * //N/A//
== Remarks ==
  * //For the most updated Info for this topic, please check it here:http:wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.FeatureSourceMarkerOverlay#Equals.28Object.29//

== Return Value ==
  * Type:Boolean
  * Description:N/A

== Parameters ==
  * //obj//
    * Type:Object
    * Description:N/A

<div newline></div>
** {{wiki:PublicMethod.gif|}} GetHashCode() **

  * //N/A//
== Remarks ==
  * //For the most updated Info for this topic, please check it here:http:wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.FeatureSourceMarkerOverlay#GetHashCode.28.29//

== Return Value ==
  * Type:Int32
  * Description:N/A

== Parameters ==
<div newline></div>
** {{wiki:PublicMethod.gif|}} GetType() **

  * //N/A//
== Remarks ==
  * //For the most updated Info for this topic, please check it here:http:wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.FeatureSourceMarkerOverlay#GetType.28.29//

== Return Value ==
  * Type:Type
  * Description:N/A

== Parameters ==
<div newline></div>
==== Protected Methods ====
** {{wiki:ProtectedMethod.gif|}} GetMarkersCore(RectangleShape,Int32) **

  * //Returns a collection of markers based on the extent and zoomlevel that you passed in.//
== Remarks ==
  * //For the most updated Info for this topic, please check it here:http:wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.FeatureSourceMarkerOverlay#GetMarkersCore.28RectangleShape.2C_Int32.29//

== Return Value ==
  * Type:Collection<[[ThinkGeo.MapSuite.WebEdition.Marker|Marker]]>
  * Description:A collection of marker objects that will be serialized to the client.

== Parameters ==
  * //worldExtent//
    * Type:[[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]]
    * Description:The extent that includes the markers you want to serialize.

  * //currentZoomLevelId//
    * Type:Int32
    * Description:An int value that indicates which zoomlevel the map is currently at.

<div newline></div>
** {{wiki:ProtectedMethod.gif|}} 5hM=() **

  * //N/A//
== Remarks ==
  * //N/A//

== Return Value ==
  * Type:Void
  * Description:N/A

== Parameters ==
<div newline></div>
** {{wiki:ProtectedMethod.gif|}} 5xM=(Object) **

  * //N/A//
== Remarks ==
  * //N/A//

== Return Value ==
  * Type:Void
  * Description:N/A

== Parameters ==
  * //target//
    * Type:Object
    * Description:N/A

<div newline></div>
** {{wiki:ProtectedMethod.gif|}} 4xM=(String,String) **

  * //N/A//
== Remarks ==
  * //N/A//

== Return Value ==
  * Type:Void
  * Description:N/A

== Parameters ==
  * //overlayId//
    * Type:String
    * Description:N/A

  * //featureId//
    * Type:String
    * Description:N/A

<div newline></div>
** {{wiki:ProtectedMethod.gif|}} 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 ==
  * Type:Void
  * Description:N/A

== Parameters ==
  * //e//
    * Type:[[ThinkGeo.MapSuite.WebEdition.MarkerOverlayClickEventArgs|MarkerOverlayClickEventArgs]]
    * Description:The MarkerOverlayClickEventArgs that contains event data.

<div newline></div>
** {{wiki:ProtectedMethod.gif|}} 5BM=() **

  * //N/A//
== Remarks ==
  * //N/A//

== Return Value ==
  * Type:Void
  * Description:N/A

== Parameters ==
<div newline></div>
** {{wiki:ProtectedMethod.gif|}} 5RM=(Object) **

  * //N/A//
== Remarks ==
  * //N/A//

== Return Value ==
  * Type:Void
  * Description:N/A

== Parameters ==
  * //target//
    * Type:Object
    * Description:N/A

<div newline></div>
** {{wiki:ProtectedMethod.gif|}} 3xM=(Page) **

  * //N/A//
== Remarks ==
  * //N/A//

== Return Value ==
  * Type:Void
  * Description:N/A

== Parameters ==
  * //page//
    * Type:Page
    * Description:N/A

<div newline></div>
** {{wiki:ProtectedMethod.gif|}} 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 ==
  * Type:Void
  * Description:N/A

== Parameters ==
  * //page//
    * Type:Page
    * Description:The page object that is used for registering the javascript library.

<div newline></div>
** {{wiki:ProtectedMethod.gif|}} RaiseTickEvent(EventArgs) **

  * //N/A//
== Remarks ==
  * //N/A//

== Return Value ==
  * Type:Void
  * Description:N/A

== Parameters ==
  * //e//
    * Type:EventArgs
    * Description:N/A

<div newline></div>
** {{wiki:ProtectedMethod.gif|}} OnTick(EventArgs) **

  * //Raises the Tick event of the MarkerOverlay.//
== Remarks ==
  * //For the most updated Info for this topic, please check it here:http:wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.FeatureSourceMarkerOverlay#OnTick.28EventArgs.29//

== Return Value ==
  * Type:Void
  * Description:N/A

== Parameters ==
  * //e//
    * Type:EventArgs
    * Description:An System.EventArgs object that contains the event data.

<div newline></div>
** {{wiki:ProtectedMethod.gif|}} Finalize() **

  * //N/A//
== Remarks ==
  * //For the most updated Info for this topic, please check it here:http:wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.FeatureSourceMarkerOverlay#Finalize.28.29//

== Return Value ==
  * Type:Void
  * Description:N/A

== Parameters ==
<div newline></div>
** {{wiki:ProtectedMethod.gif|}} MemberwiseClone() **

  * //N/A//
== Remarks ==
  * //For the most updated Info for this topic, please check it here:http:wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.FeatureSourceMarkerOverlay#MemberwiseClone.28.29//

== Return Value ==
  * Type:Object
  * Description:N/A

== Parameters ==
<div newline></div>
==== Public Properties ====
** {{wiki:PublicProperty.gif|}} FeatureSource **

Gets or sets a feature source object that provides the features from which the markers are created.
== Remarks ==
For the most updated Info for this topic, please check it here:http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.FeatureSourceMarkerOverlay#firstHeading" class="firstHeading" lang="en"><span dir="auto
== Return Value ==
  * Type:[[ThinkGeo.MapSuite.Core.FeatureSource|FeatureSource]]

** {{wiki:PublicProperty.gif|}} ZoomLevelSet **

Gets the ZoomLevelSet object that controls the markers' generation.
== Remarks ==
For the most updated Info for this topic, please check it here:http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.FeatureSourceMarkerOverlay#ZoomLevelSet
== Return Value ==
  * Type:[[ThinkGeo.MapSuite.WebEdition.MarkerZoomLevelSet|MarkerZoomLevelSet]]

** {{wiki:PublicProperty.gif|}} SuppressingGridSize **

Gets or sets the grid size in screen coordinate to suppress markers in current Viewport.
== Remarks ==
Current ViewPort will be split into several cells by FilterGridSize, one cell will contains only one marker in it, in another word, markers which are near too close will be removed. if the value is greater than 0, this function will be enabled.
== Return Value ==
  * Type:Int32

** {{wiki:PublicProperty.gif|}} IsBaseOverlay **

N/A
== Remarks ==
For the most updated Info for this topic, please check it here:http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.FeatureSourceMarkerOverlay#IsBaseOverlay
== Return Value ==
  * Type:Boolean

** {{wiki:PublicProperty.gif|}} 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:http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.FeatureSourceMarkerOverlay#IsVisible
== Return Value ==
  * Type:Boolean

** {{wiki:PublicProperty.gif|}} 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:http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.FeatureSourceMarkerOverlay#Name
== Return Value ==
  * Type:String

** {{wiki:PublicProperty.gif|}} 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 ==
  * Type:Single

** {{wiki:PublicProperty.gif|}} 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:http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.FeatureSourceMarkerOverlay#IsVisibleInOverlaySwitcher
== Return Value ==
  * Type:Boolean

** {{wiki:PublicProperty.gif|}} Id **

Gets the identifier for the overlay to be found.
== Remarks ==
For the most updated Info for this topic, please check it here:http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.FeatureSourceMarkerOverlay#Id
== Return Value ==
  * Type:String

** {{wiki:PublicProperty.gif|}} 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:http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.FeatureSourceMarkerOverlay#AutoRefreshInterval
== Return Value ==
  * Type:TimeSpan

** {{wiki:PublicProperty.gif|}} Attribution **

N/A
== Remarks ==
For the most updated Info for this topic, please check it here:http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.FeatureSourceMarkerOverlay#Attribution
== Return Value ==
  * Type:String

==== Protected Properties ====
** {{wiki:ProtectedProperty.gif|}} OverlayType **

N/A
== Remarks ==
For the most updated Info for this topic, please check it here:http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.FeatureSourceMarkerOverlay#OverlayType
== Return Value ==
  * Type:String

** {{wiki:ProtectedProperty.gif|}} HasClickEvent **

N/A
== Remarks ==
N/A
== Return Value ==
  * Type:Boolean

** {{wiki:ProtectedProperty.gif|}} IsDefault **

N/A
== Remarks ==
N/A
== Return Value ==
  * Type:Boolean

** {{wiki:ProtectedProperty.gif|}} HasTickEvent **

Indicates whether the overlay supports tick event.
== Remarks ==
For the most updated Info for this topic, please check it here:http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.FeatureSourceMarkerOverlay#HasTickEvent
== Return Value ==
  * Type:Boolean

** {{wiki:ProtectedProperty.gif|}} 3hM= **

N/A
== Remarks ==
N/A
== Return Value ==
  * Type:Double

==== Public Events ====
** {{wiki:PublicEvent.gif|}} Click **
Occurs when a marker in the overlay is clicked.
== Remarks ==
For the most updated Info for this topic, please check it here:http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.FeatureSourceMarkerOverlay#OnClick.28MarkerOverlayClickEventArgs.29

Event Arguments:[[ThinkGeo.MapSuite.WebEdition.MarkerOverlayClickEventArgs|MarkerOverlayClickEventArgs]]

** {{wiki:PublicEvent.gif|}} 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:http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.FeatureSourceMarkerOverlay#OnTick.28EventArgs.29

Event Arguments:EventArgs
Map Suite UI Controls

MapSuite GIS Services

Free Tools

Professional Services

Support & Learning

About ThinkGeo

User Tools

Site Tools

Page Tools

Map Suite UI Controls

MapSuite GIS Services

Free Tools

Professional Services

Support & Learning

About ThinkGeo
