====== ThinkGeo.MapSuite.WebEdition.FeatureOverlay ======
{{section>upgrade_map_suite_to_10.0}}
Serves as the base class for the overlays that contain features and paint the features at client side.
===== Inheritance Hierarchy =====
*System.Object
*ThinkGeo.MapSuite.WebEdition.Overlay
***ThinkGeo.MapSuite.WebEdition.FeatureOverlay**
*[[ThinkGeo.MapSuite.WebEdition.EditFeatureOverlay]]
*[[ThinkGeo.MapSuite.WebEdition.HighlightFeatureOverlay]]
===== Members Summary =====
==== Public Constructors ====
==== Protected Constructors ====
** {{wiki:ProtectedMethod.gif|}} FeatureOverlay() **
* //This is constructor of FeatureOverlay class.//
== Remarks ==
* //For the most updated Info for this topic, please check it here:http:wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.FeatureOverlay#FeatureOverlay.28.29//
== Parameters ==
** {{wiki:ProtectedMethod.gif|}} FeatureOverlay(String) **
* //This is constructor of FeatureOverlay class.//
== Remarks ==
* //For the most updated Info for this topic, please check it here:http:wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.FeatureOverlay#FeatureOverlay.28String.29//
== Parameters ==
* //id//
* Type:String
* Description:A string value indicates the Id property of this object.
** {{wiki:ProtectedMethod.gif|}} FeatureOverlay(String,Boolean) **
* //This is constructor of FeatureOverlay class.//
== Remarks ==
* //For the most updated Info for this topic, please check it here:http:wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.FeatureOverlay#FeatureOverlay.28String.2C_Boolean.29//
== Parameters ==
* //id//
* Type:String
* Description:A string value indicates the Id property of this object.
* //isBaseOverlay//
* Type:Boolean
* Description:A boolean value indicates whether this overlay is base overlay or not.
==== Public Methods ====
** {{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.FeatureOverlay#ToJson.28.29//
== Return Value ==
* Type:String
* Description:A JSON string which is used to create an overlay at the client side.
== Parameters ==
** {{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.FeatureOverlay#ToString.28.29//
== Return Value ==
* Type:String
* Description:N/A
== Parameters ==
** {{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.FeatureOverlay#Equals.28Object.29//
== Return Value ==
* Type:Boolean
* Description:N/A
== Parameters ==
* //obj//
* Type:Object
* Description:N/A
** {{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.FeatureOverlay#GetHashCode.28.29//
== Return Value ==
* Type:Int32
* Description:N/A
== Parameters ==
** {{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.FeatureOverlay#GetType.28.29//
== Return Value ==
* Type:Type
* Description:N/A
== Parameters ==
==== Protected Methods ====
** {{wiki:ProtectedMethod.gif|}} 3xM=(Page) **
* //N/A//
== Remarks ==
* //N/A//
== Return Value ==
* Type:Void
* Description:N/A
== Parameters ==
* //page//
* Type:Page
* Description:N/A
** {{wiki:ProtectedMethod.gif|}} RegisterJavaScriptLibraryCore(Page) **
* //Registers a Javascript library URL string to the client HTML page.//
== Remarks ==
* //The RegisterJavaScriptLibraryCore 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.
** {{wiki:ProtectedMethod.gif|}} RaiseTickEvent(EventArgs) **
* //N/A//
== Remarks ==
* //N/A//
== Return Value ==
* Type:Void
* Description:N/A
== Parameters ==
* //e//
* Type:EventArgs
* Description:N/A
** {{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.FeatureOverlay#OnTick.28EventArgs.29//
== Return Value ==
* Type:Void
* Description:N/A
== Parameters ==
* //e//
* Type:EventArgs
* Description:An System.EventArgs object that contains the event data.
** {{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.FeatureOverlay#Finalize.28.29//
== Return Value ==
* Type:Void
* Description:N/A
== Parameters ==
** {{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.FeatureOverlay#MemberwiseClone.28.29//
== Return Value ==
* Type:Object
* Description:N/A
== Parameters ==
==== Public Properties ====
** {{wiki:PublicProperty.gif|}} Features **
Gets a collection of features that will be serialized to the client for drawing and editing.
== Remarks ==
For the most updated Info for this topic, please check it here:http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.FeatureOverlay#Features
== Return Value ==
* Type:[[ThinkGeo.MapSuite.Core.GeoCollection[[ThinkGeo.MapSuite.Core.Feature, MapSuiteCore, Version=9.0.0.0, Culture=neutral, PublicKeyToken=null]]|GeoCollection]]
** {{wiki:PublicProperty.gif|}} FeatureSource **
Gets the FeatureSource of the FeatureOverlay.
== Remarks ==
For the most updated Info for this topic, please check it here:http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.FeatureOverlay#FeatureSource
== Return Value ==
* Type:[[ThinkGeo.MapSuite.Core.InMemoryFeatureSource|InMemoryFeatureSource]]
** {{wiki:PublicProperty.gif|}} Columns **
Gets a collection of FeatureSourceColumns, which specifies the column names of the feature data.
== Remarks ==
For the most updated Info for this topic, please check it here:http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.FeatureOverlay#Columns
== Return Value ==
* Type:Collection<[[ThinkGeo.MapSuite.Core.FeatureSourceColumn|FeatureSourceColumn]]>
** {{wiki:PublicProperty.gif|}} Style **
Gets or sets a FeatureOverlayStyle object, which determines how the features are drawn 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.FeatureOverlay#Style
== Return Value ==
* Type:[[ThinkGeo.MapSuite.WebEdition.FeatureOverlayStyle|FeatureOverlayStyle]]
** {{wiki:PublicProperty.gif|}} QueryTools **
Gets the QueryTools that allow you to easily query features from the FeatureOverlay.
== Remarks ==
For the most updated Info for this topic, please check it here:http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.FeatureOverlay#QueryTools
== Return Value ==
* Type:[[ThinkGeo.MapSuite.Core.QueryTools|QueryTools]]
** {{wiki:PublicProperty.gif|}} EditTools **
Gets the EditTools that allow you to easily edit features in the FeatureOverlay.
== Remarks ==
For the most updated Info for this topic, please check it here:http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.FeatureOverlay#EditTools
== Return Value ==
* Type:[[ThinkGeo.MapSuite.Core.EditTools|EditTools]]
** {{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.FeatureOverlay#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.FeatureOverlay#Name
== Return Value ==
* Type:String
** {{wiki:PublicProperty.gif|}} 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 ==
* 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.FeatureOverlay#IsVisibleInOverlaySwitcher
== Return Value ==
* Type:Boolean
** {{wiki:PublicProperty.gif|}} IsBaseOverlay **
Gets or sets a value that indicates whether the overlay is a base overlay.
== Remarks ==
For the most updated Info for this topic, please check it here:http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.FeatureOverlay#IsBaseOverlay
== 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.FeatureOverlay#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.FeatureOverlay#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.FeatureOverlay#Attribution
== Return Value ==
* Type:String
==== Protected Properties ====
** {{wiki:ProtectedProperty.gif|}} JsonFeatures **
N/A
== Remarks ==
N/A
== Return Value ==
* Type:Collection<[[ThinkGeo.MapSuite.Core.Feature|Feature]]>
** {{wiki:ProtectedProperty.gif|}} OverlayType **
Gets a string that indicates which type the overlay is.
== Remarks ==
For the most updated Info for this topic, please check it here:http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.FeatureOverlay#OverlayType
== Return Value ==
* Type:String
** {{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.FeatureOverlay#HasTickEvent
== Return Value ==
* Type:Boolean
** {{wiki:ProtectedProperty.gif|}} 3hM= **
N/A
== Remarks ==
N/A
== Return Value ==
* Type:Double
==== Public Events ====
** {{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.FeatureOverlay#OnTick.28EventArgs.29
Event Arguments:EventArgs