ThinkGeo Cloud
ThinkGeo UI Controls
ThinkGeo Open Source
Help and Support
External Resources
Sidebar
thinkgeo.mapsuite.webedition.featureoverlay
This is an old revision of the document!
Table of Contents
ThinkGeo.MapSuite.WebEdition.FeatureOverlay
<!– Class –> Serves as the base class for the overlays that contain features and paint the features at client side.
Remarks
The <strong>FeatureOverlay</strong> class is the base class for the overlays that need to draw features at client side. An instance of <strong>FeatureOverlay</strong> corresponds to an OpenLayer's vector layer at the client side.All features in the <strong>Features</strong> collection will be serialized to the client and drawn as the <strong>Style</strong> property specifies.<strong>Note:</strong> The <strong>Features</strong> property exposes the internal features of the <strong>FeatureSource</strong> property.The <strong>FeatureSource</strong> property provides you with a batch of properties and functions that affect its internal features.The <strong>Columns</strong> collection defines the column names for the feature data. It will be used to fetch a certain column from the data.The <strong>QueryTools</strong> and <strong>EditTools</strong> provide you an easy way to query or edit features.
Inheritance Hierarchy
*System.Object ThinkGeo.MapSuite.WebEdition.Overlay *ThinkGeo.MapSuite.WebEdition.FeatureOverlay ThinkGeo.MapSuite.WebEdition.EditFeatureOverlay ThinkGeo.MapSuite.WebEdition.HighlightFeatureOverlay
Members Summary
Public Constructors
| Name | Parameters | DeclaringType | Summary |
|---|
Protected Constructors
| Name | Parameters | DeclaringType | Summary |
|---|---|---|---|
 FeatureOverlay | This is constructor of FeatureOverlay class. | ||
| FeatureOverlay | String | This is constructor of FeatureOverlay class. | |
| FeatureOverlay | String, Boolean | This is constructor of FeatureOverlay class. |
Public Methods
Protected Methods
| Name | Parameters | DeclaringType | Summary |
|---|---|---|---|
| Finalize | Object | ||
| MemberwiseClone | Object | ||
| OnTick | EventArgs | Overlay | Raises the Tick event of the MarkerOverlay. |
| RegisterJavaScriptLibraryCore | Page | Overlay | Registers a Javascript library URL string to the client HTML page. |
Public Properties
| Name | Return | DeclaringType | Summary |
|---|---|---|---|
 Attribution | String | Overlay | |
| AutoRefreshInterval | TimeSpan | Overlay | Gets or sets the time interval in which the MarkerOverlay refreshes itself. |
| Columns | Collection<FeatureSourceColumn> | Gets a collection of FeatureSourceColumns, which specifies the column names of the feature data. | |
| EditTools | EditTools | Gets the EditTools that allow you to easily edit features in the FeatureOverlay. | |
| FeatureSource | InMemoryFeatureSource | Gets the FeatureSource of the FeatureOverlay. | |
| Features | GeoCollection<Feature> | Gets a collection of features that will be serialized to the client for drawing and editing. | |
| Id | String | Overlay | Gets the identifier for the overlay to be found. |
| IsBaseOverlay | Boolean | Overlay | Gets or sets a value that indicates whether the overlay is a base overlay. |
| IsVisible | Boolean | Overlay | Gets or sets a value that indicates whether the overlay is visible on the map. |
| IsVisibleInOverlaySwitcher | Boolean | Overlay | Gets or sets a value that indicates whether the overlay name is displayed in the OverlaySwitcher. |
| Name | String | Overlay | Gets or sets the name of the overlay, which will display in the OverlaySwitcher. |
| Opacity | Single | Overlay | Gets or sets the opacity level of the overlay. |
| QueryTools | QueryTools | Gets the QueryTools that allow you to easily query features from the FeatureOverlay. | |
| Style | FeatureOverlayStyle | Gets or sets a FeatureOverlayStyle object, which determines how the features are drawn at the client side. |
Protected Properties
| Name | Return | DeclaringType | Summary |
|---|---|---|---|
 HasTickEvent | Boolean | Overlay | Indicates whether the overlay supports tick event. |
| OverlayType | String | Overlay(overriden) | Gets a string that indicates which type the overlay is. |
Public Events
Public Constructors
Protected Constructors
FeatureOverlay()
This is constructor of FeatureOverlay class.
Remarks
For the most updated Info for this topic, please check it here:<a href=“http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.FeatureOverlay#FeatureOverlay.28.29” target=“_blank”>http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.FeatureOverlay#FeatureOverlay.28.29</a>
Parameters
| Name | Type | Description |
|---|
FeatureOverlay(String)
This is constructor of FeatureOverlay class.
Remarks
For the most updated Info for this topic, please check it here:<a href=“http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.FeatureOverlay#FeatureOverlay.28String.29” target=“_blank”>http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.FeatureOverlay#FeatureOverlay.28String.29</a>
Parameters
| Name | Type | Description |
|---|---|---|
| id | String<!– System.String –> | A string value indicates the Id property of this object. |
FeatureOverlay(String, Boolean)
This is constructor of FeatureOverlay class.
Remarks
For the most updated Info for this topic, please check it here:<a href=“http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.FeatureOverlay#FeatureOverlay.28String.2C_Boolean.29” target=“_blank”>http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.FeatureOverlay#FeatureOverlay.28String.2C_Boolean.29</a>
Parameters
| Name | Type | Description |
|---|---|---|
| id | String<!– System.String –> | A string value indicates the Id property of this object. |
| isBaseOverlay | Boolean<!– System.Boolean –> | A boolean value indicates whether this overlay is base overlay or not. |
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.FeatureOverlay#Equals.28Object.29” target=“_blank”>http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.FeatureOverlay#Equals.28Object.29</a>
Return Value
| Return Type | Description |
|---|---|
| Boolean<!– System.Boolean –> |
Parameters
| Name | Type | Description |
|---|---|---|
| obj | Object<!– System.Object –> |
<!– System.Object –> 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.FeatureOverlay#GetHashCode.28.29” target=“_blank”>http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.FeatureOverlay#GetHashCode.28.29</a>
Return Value
| Return Type | Description |
|---|---|
| Int32<!– System.Int32 –> |
Parameters
| Name | Type | Description |
|---|
<!– System.Object –> 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.FeatureOverlay#GetType.28.29” target=“_blank”>http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.FeatureOverlay#GetType.28.29</a>
Return Value
| Return Type | Description |
|---|---|
| Type<!– System.Type –> |
Parameters
| Name | Type | Description |
|---|
<!– System.Object –> 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.FeatureOverlay#ToJson.28.29” target=“_blank”>http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.FeatureOverlay#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 –> 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.FeatureOverlay#ToString.28.29” target=“_blank”>http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.FeatureOverlay#ToString.28.29</a>
Return Value
| Return Type | Description |
|---|---|
| String<!– System.String –> |
Parameters
| Name | Type | Description |
|---|
<!– System.Object –> 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.FeatureOverlay#Finalize.28.29” target=“_blank”>http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.FeatureOverlay#Finalize.28.29</a>
Return Value
| Return Type | Description |
|---|---|
| Void<!– System.Void –> |
Parameters
| Name | Type | Description |
|---|
<!– System.Object –> 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.FeatureOverlay#MemberwiseClone.28.29” target=“_blank”>http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.FeatureOverlay#MemberwiseClone.28.29</a>
Return Value
| Return Type | Description |
|---|---|
| Object<!– System.Object –> |
Parameters
| Name | Type | Description |
|---|
<!– System.Object –> 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.FeatureOverlay#OnTick.28EventArgs.29” target=“_blank”>http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.FeatureOverlay#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 –> 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 –> 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.FeatureOverlay#Attribution” target=“_blank”>http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.FeatureOverlay#Attribution</a>
Return Value
| Return Type |
|---|
| String<!– System.String –> |
<!– ThinkGeo.MapSuite.WebEdition.Overlay –> 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.FeatureOverlay#AutoRefreshInterval” target=“_blank”>http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.FeatureOverlay#AutoRefreshInterval</a>
Return Value
| Return Type |
|---|
| TimeSpan<!– System.TimeSpan –> |
<!– ThinkGeo.MapSuite.WebEdition.Overlay –> Go Back
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:<a href=“http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.FeatureOverlay#Columns” target=“_blank”>http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.FeatureOverlay#Columns</a>
Return Value
| Return Type |
|---|
| Collection<FeatureSourceColumn><!– System.Collections.ObjectModel.Collection{ThinkGeo.MapSuite.Core.FeatureSourceColumn} –> |
<!– ThinkGeo.MapSuite.WebEdition.FeatureOverlay –> Go Back
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:<a href=“http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.FeatureOverlay#EditTools” target=“_blank”>http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.FeatureOverlay#EditTools</a>
Return Value
| Return Type |
|---|
| EditTools<!– ThinkGeo.MapSuite.Core.EditTools –> |
<!– ThinkGeo.MapSuite.WebEdition.FeatureOverlay –> Go Back
FeatureSource
Gets the FeatureSource of the FeatureOverlay.
Remarks
For the most updated Info for this topic, please check it here:<a href=“http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.FeatureOverlay#FeatureSource” target=“_blank”>http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.FeatureOverlay#FeatureSource</a>
Return Value
| Return Type |
|---|
| InMemoryFeatureSource<!– ThinkGeo.MapSuite.Core.InMemoryFeatureSource –> |
<!– ThinkGeo.MapSuite.WebEdition.FeatureOverlay –> Go Back
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:<a href=“http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.FeatureOverlay#Features” target=“_blank”>http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.FeatureOverlay#Features</a>
Return Value
| Return Type |
|---|
| GeoCollection<Feature><!– ThinkGeo.MapSuite.Core.GeoCollection{ThinkGeo.MapSuite.Core.Feature} –> |
<!– ThinkGeo.MapSuite.WebEdition.FeatureOverlay –> 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.FeatureOverlay#Id” target=“_blank”>http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.FeatureOverlay#Id</a>
Return Value
| Return Type |
|---|
| String<!– System.String –> |
<!– ThinkGeo.MapSuite.WebEdition.Overlay –> Go Back
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:<a href=“http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.FeatureOverlay#IsBaseOverlay” target=“_blank”>http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.FeatureOverlay#IsBaseOverlay</a>
Return Value
| Return Type |
|---|
| Boolean<!– System.Boolean –> |
<!– ThinkGeo.MapSuite.WebEdition.Overlay –> 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.FeatureOverlay#IsVisible” target=“_blank”>http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.FeatureOverlay#IsVisible</a>
Return Value
| Return Type |
|---|
| Boolean<!– System.Boolean –> |
<!– ThinkGeo.MapSuite.WebEdition.Overlay –> 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.FeatureOverlay#IsVisibleInOverlaySwitcher” target=“_blank”>http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.FeatureOverlay#IsVisibleInOverlaySwitcher</a>
Return Value
| Return Type |
|---|
| Boolean<!– System.Boolean –> |
<!– ThinkGeo.MapSuite.WebEdition.Overlay –> 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.FeatureOverlay#Name” target=“_blank”>http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.FeatureOverlay#Name</a>
Return Value
| Return Type |
|---|
| String<!– System.String –> |
<!– ThinkGeo.MapSuite.WebEdition.Overlay –> 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 –> Go Back
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:<a href=“http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.FeatureOverlay#QueryTools” target=“_blank”>http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.FeatureOverlay#QueryTools</a>
Return Value
| Return Type |
|---|
| QueryTools<!– ThinkGeo.MapSuite.Core.QueryTools –> |
<!– ThinkGeo.MapSuite.WebEdition.FeatureOverlay –> Go Back
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:<a href=“http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.FeatureOverlay#Style” target=“_blank”>http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.FeatureOverlay#Style</a>
Return Value
| Return Type |
|---|
| FeatureOverlayStyle<!– ThinkGeo.MapSuite.WebEdition.FeatureOverlayStyle –> |
<!– ThinkGeo.MapSuite.WebEdition.FeatureOverlay –> 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.FeatureOverlay#HasTickEvent” target=“_blank”>http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.FeatureOverlay#HasTickEvent</a>
Return Value
| Return Type |
|---|
| Boolean<!– System.Boolean –> |
<!– ThinkGeo.MapSuite.WebEdition.Overlay –> Go Back
OverlayType
Gets a string that indicates which type the overlay is.
Remarks
For the most updated Info for this topic, please check it here:<a href=“http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.FeatureOverlay#OverlayType” target=“_blank”>http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.FeatureOverlay#OverlayType</a>
Return Value
| Return Type |
|---|
| String<!– System.String –> |
<!– ThinkGeo.MapSuite.WebEdition.Overlay(overriden) –> 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.
Remarks
For the most updated Info for this topic, please check it here:<a href=“http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.FeatureOverlay#OnTick.28EventArgs.29” target=“_blank”>http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.FeatureOverlay#OnTick.28EventArgs.29</a>
Event Arguments
| Event Arguments |
|---|
| EventArgs<!– System.EventArgs –> |
<!– ThinkGeo.MapSuite.WebEdition.Overlay –> Go Back
NOTOC WebEdition ThinkGeo.MapSuite.WebEdition UpdateDocumentation
thinkgeo.mapsuite.webedition.featureoverlay.1440040135.txt.gz · Last modified: 2015/09/22 08:48 (external edit)