ThinkGeo Cloud
ThinkGeo UI Controls
ThinkGeo Open Source
Help and Support
External Resources
ThinkGeo Cloud
ThinkGeo UI Controls
ThinkGeo Open Source
Help and Support
External Resources
This is an old revision of the document!
<!– Class –> Represents a FeatureOverlay that can easily apply a highlight style or hook event to the features in it.
The <strong>HighlightFeatureOverlay</strong> class has a <strong>HighlightStyle</strong> property which determines the style of features when you move your mouse over them. By setting this property, you can add an attractive highlight effect.The <strong>HighlightFeatureOverlay</strong> class also has a <strong>Click</strong> event and a <strong>ContextMenu</strong> property that can be attached to its features. When you click or right-click on the features, the event will be fired or the context menu will pop up, respectively.The <strong>OnClientClick</strong> property holds the Javascript that will be executed before the <strong>Click</strong> event. If you return <strong>false</strong> in the Javascript, the <strong>Click</strong> event will not be fired.You can only accesss the <strong>HighlightFeatureOverlay</strong> instance by using <strong>Map.HighlightOverlay</strong>. You cannot create an instance by yourself.<strong>Note:</strong> Because the <strong>HighlightFeatureOverlay</strong> serializes and paints all of its features to the client side, there might be a performance impact if you add too many features to its <strong>Features</strong> collection.
*System.Object ThinkGeo.MapSuite.WebEdition.Overlay *ThinkGeo.MapSuite.WebEdition.FeatureOverlay ThinkGeo.MapSuite.WebEdition.HighlightFeatureOverlay
Name | Parameters | DeclaringType | Summary |
---|
Name | Parameters | DeclaringType | Summary |
---|
Name | Parameters | DeclaringType | Summary |
---|---|---|---|
![]() | Object | ||
![]() | Object | ||
![]() | HighlightFeatureOverlayClickEventArgs | Raises the click event on the HighlightFeatureOverlay. | |
![]() | EventArgs | Overlay | Raises the Tick event of the MarkerOverlay. |
![]() | Page | Overlay | Registers a Javascript library URL string to the client HTML page. |
Name | Return | DeclaringType | Summary |
---|---|---|---|
![]() | String | Overlay | |
![]() | TimeSpan | Overlay | Gets or sets the time interval in which the MarkerOverlay refreshes itself. |
![]() | Collection<FeatureSourceColumn> | FeatureOverlay | Gets a collection of FeatureSourceColumns, which specifies the column names of the feature data. |
![]() | ContextMenu | Gets or sets the shortcut menu associated with the HighlightFeatureOverlay. | |
![]() | EditTools | FeatureOverlay | Gets the EditTools that allow you to easily edit features in the FeatureOverlay. |
![]() | InMemoryFeatureSource | FeatureOverlay | Gets the FeatureSource of the FeatureOverlay. |
![]() | GeoCollection<Feature> | FeatureOverlay | Gets a collection of features that will be serialized to the client for drawing and editing. |
![]() | FeatureOverlayStyle | Gets or sets a FeatureOverlayStyle that will be applied to the features when the mouse pointer is over them. | |
![]() | String | Overlay | Gets the identifier for the overlay to be found. |
![]() | Boolean | Overlay | Gets or sets a value that indicates whether the overlay is a base overlay. |
![]() | Boolean | Overlay | Gets or sets a value that indicates whether the overlay is visible on the map. |
![]() | Boolean | Overlay | Gets or sets a value that indicates whether the overlay name is displayed in the OverlaySwitcher. |
![]() | String | Overlay | Gets or sets the name of the overlay, which will display in the OverlaySwitcher. |
![]() | String | Gets or sets the client-side script that executes when the HighlightFeatureOverlay is clicked. | |
![]() | Single | Overlay | Gets or sets the opacity level of the overlay. |
![]() | QueryTools | FeatureOverlay | Gets the QueryTools that allow you to easily query features from the FeatureOverlay. |
![]() | FeatureOverlayStyle | FeatureOverlay | Gets or sets a FeatureOverlayStyle object, which determines how the features are drawn at the client side. |
Name | Return | DeclaringType | Summary |
---|---|---|---|
![]() | Boolean | Gets a flag that check whether it raise an event on the client side. | |
![]() | Boolean | Overlay | Indicates whether the overlay supports tick event. |
![]() | String | Overlay(overriden) |
Name | Event Arguments | DeclaringType | Summary |
---|---|---|---|
![]() | HighlightFeatureOverlayClickEventArgs | Occurs when the HighlightFeatureOverlay is clicked. | |
![]() | EventArgs | Overlay | Occurs when the number of milliseconds specified in the AutoRefreshInterval property has elapsed and the page is posted to the server. |
For the most updated Info for this topic, please check it here:<a href=“http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.HighlightFeatureOverlay#Equals.28Object.29” target=“_blank”>http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.HighlightFeatureOverlay#Equals.28Object.29</a>
Return Type | Description |
---|---|
Boolean<!– System.Boolean –> |
Name | Type | Description |
---|---|---|
obj | Object<!– System.Object –> |
<!– System.Object –> Go Back
For the most updated Info for this topic, please check it here:<a href=“http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.HighlightFeatureOverlay#GetHashCode.28.29” target=“_blank”>http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.HighlightFeatureOverlay#GetHashCode.28.29</a>
Return Type | Description |
---|---|
Int32<!– System.Int32 –> |
Name | Type | Description |
---|
<!– System.Object –> Go Back
For the most updated Info for this topic, please check it here:<a href=“http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.HighlightFeatureOverlay#GetType.28.29” target=“_blank”>http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.HighlightFeatureOverlay#GetType.28.29</a>
Return Type | Description |
---|---|
Type<!– System.Type –> |
Name | Type | Description |
---|
<!– System.Object –> Go Back
Returns a JSON string which contains the information for creating an overlay at the client side.
For the most updated Info for this topic, please check it here:<a href=“http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.HighlightFeatureOverlay#ToJson.28.29” target=“_blank”>http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.HighlightFeatureOverlay#ToJson.28.29</a>
Return Type | Description |
---|---|
String<!– System.String –> | A JSON string which is used to create an overlay at the client side. |
Name | Type | Description |
---|
<!– ThinkGeo.MapSuite.WebEdition.Overlay –> Go Back
For the most updated Info for this topic, please check it here:<a href=“http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.HighlightFeatureOverlay#ToString.28.29” target=“_blank”>http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.HighlightFeatureOverlay#ToString.28.29</a>
Return Type | Description |
---|---|
String<!– System.String –> |
Name | Type | Description |
---|
<!– System.Object –> Go Back
For the most updated Info for this topic, please check it here:<a href=“http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.HighlightFeatureOverlay#Finalize.28.29” target=“_blank”>http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.HighlightFeatureOverlay#Finalize.28.29</a>
Return Type | Description |
---|---|
Void<!– System.Void –> |
Name | Type | Description |
---|
<!– System.Object –> Go Back
For the most updated Info for this topic, please check it here:<a href=“http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.HighlightFeatureOverlay#MemberwiseClone.28.29” target=“_blank”>http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.HighlightFeatureOverlay#MemberwiseClone.28.29</a>
Return Type | Description |
---|---|
Object<!– System.Object –> |
Name | Type | Description |
---|
<!– System.Object –> Go Back
Raises the click event on the HighlightFeatureOverlay.
For the most updated Info for this topic, please check it here:<a href=“http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.HighlightFeatureOverlay#OnClick.28HighlightFeatureOverlayClickEventArgs.29” target=“_blank”>http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.HighlightFeatureOverlay#OnClick.28HighlightFeatureOverlayClickEventArgs.29</a>
Return Type | Description |
---|---|
Void<!– System.Void –> |
Name | Type | Description |
---|---|---|
e | HighlightFeatureOverlayClickEventArgs<!– ThinkGeo.MapSuite.WebEdition.HighlightFeatureOverlayClickEventArgs –> | A HighlightFeatureOverlayClickEventArgs that contains the event data. |
<!– ThinkGeo.MapSuite.WebEdition.HighlightFeatureOverlay –> Go Back
Raises the Tick event of the MarkerOverlay.
For the most updated Info for this topic, please check it here:<a href=“http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.HighlightFeatureOverlay#OnTick.28EventArgs.29” target=“_blank”>http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.HighlightFeatureOverlay#OnTick.28EventArgs.29</a>
Return Type | Description |
---|---|
Void<!– System.Void –> |
Name | Type | Description |
---|---|---|
e | EventArgs<!– System.EventArgs –> | An System.EventArgs object that contains the event data. |
<!– ThinkGeo.MapSuite.WebEdition.Overlay –> Go Back
Registers a Javascript library URL string to the client HTML page.
The <strong>RegisterJavaScriptLibraryCore</strong> method allows derived classes to override and register their own Javascript library URL to the HTML page.
Return Type | Description |
---|---|
Void<!– System.Void –> |
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
For the most updated Info for this topic, please check it here:<a href=“http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.HighlightFeatureOverlay#Attribution” target=“_blank”>http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.HighlightFeatureOverlay#Attribution</a>
Return Type |
---|
String<!– System.String –> |
<!– ThinkGeo.MapSuite.WebEdition.Overlay –> Go Back
Gets or sets the time interval in which the MarkerOverlay refreshes itself.
For the most updated Info for this topic, please check it here:<a href=“http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.HighlightFeatureOverlay#AutoRefreshInterval” target=“_blank”>http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.HighlightFeatureOverlay#AutoRefreshInterval</a>
Return Type |
---|
TimeSpan<!– System.TimeSpan –> |
<!– ThinkGeo.MapSuite.WebEdition.Overlay –> Go Back
Gets a collection of FeatureSourceColumns, which specifies the column names of the feature data.
For the most updated Info for this topic, please check it here:<a href=“http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.HighlightFeatureOverlay#Columns” target=“_blank”>http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.HighlightFeatureOverlay#Columns</a>
Return Type |
---|
Collection<FeatureSourceColumn><!– System.Collections.ObjectModel.Collection{ThinkGeo.MapSuite.Core.FeatureSourceColumn} –> |
<!– ThinkGeo.MapSuite.WebEdition.FeatureOverlay –> Go Back
Gets or sets the shortcut menu associated with the HighlightFeatureOverlay.
For the most updated Info for this topic, please check it here:<a href=“http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.HighlightFeatureOverlay#ContextMenu” target=“_blank”>http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.HighlightFeatureOverlay#ContextMenu</a>
Return Type |
---|
ContextMenu<!– ThinkGeo.MapSuite.WebEdition.ContextMenu –> |
<!– ThinkGeo.MapSuite.WebEdition.HighlightFeatureOverlay –> Go Back
Gets the EditTools that allow you to easily edit features in the FeatureOverlay.
For the most updated Info for this topic, please check it here:<a href=“http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.HighlightFeatureOverlay#EditTools” target=“_blank”>http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.HighlightFeatureOverlay#EditTools</a>
Return Type |
---|
EditTools<!– ThinkGeo.MapSuite.Core.EditTools –> |
<!– ThinkGeo.MapSuite.WebEdition.FeatureOverlay –> Go Back
Gets the FeatureSource of the FeatureOverlay.
For the most updated Info for this topic, please check it here:<a href=“http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.HighlightFeatureOverlay#FeatureSource” target=“_blank”>http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.HighlightFeatureOverlay#FeatureSource</a>
Return Type |
---|
InMemoryFeatureSource<!– ThinkGeo.MapSuite.Core.InMemoryFeatureSource –> |
<!– ThinkGeo.MapSuite.WebEdition.FeatureOverlay –> Go Back
Gets a collection of features that will be serialized to the client for drawing and editing.
For the most updated Info for this topic, please check it here:<a href=“http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.HighlightFeatureOverlay#Features” target=“_blank”>http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.HighlightFeatureOverlay#Features</a>
Return Type |
---|
GeoCollection<Feature><!– ThinkGeo.MapSuite.Core.GeoCollection{ThinkGeo.MapSuite.Core.Feature} –> |
<!– ThinkGeo.MapSuite.WebEdition.FeatureOverlay –> Go Back
Gets or sets a FeatureOverlayStyle that will be applied to the features when the mouse pointer is over them.
For the most updated Info for this topic, please check it here:<a href=“http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.HighlightFeatureOverlay#HighlightStyle” target=“_blank”>http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.HighlightFeatureOverlay#HighlightStyle</a>
Return Type |
---|
FeatureOverlayStyle<!– ThinkGeo.MapSuite.WebEdition.FeatureOverlayStyle –> |
<!– ThinkGeo.MapSuite.WebEdition.HighlightFeatureOverlay –> Go Back
Gets the identifier for the overlay to be found.
For the most updated Info for this topic, please check it here:<a href=“http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.HighlightFeatureOverlay#Id” target=“_blank”>http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.HighlightFeatureOverlay#Id</a>
Return Type |
---|
String<!– System.String –> |
<!– ThinkGeo.MapSuite.WebEdition.Overlay –> Go Back
Gets or sets a value that indicates whether the overlay is a base overlay.
For the most updated Info for this topic, please check it here:<a href=“http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.HighlightFeatureOverlay#IsBaseOverlay” target=“_blank”>http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.HighlightFeatureOverlay#IsBaseOverlay</a>
Return Type |
---|
Boolean<!– System.Boolean –> |
<!– ThinkGeo.MapSuite.WebEdition.Overlay –> Go Back
Gets or sets a value that indicates whether the overlay is visible on the map.
For the most updated Info for this topic, please check it here:<a href=“http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.HighlightFeatureOverlay#IsVisible” target=“_blank”>http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.HighlightFeatureOverlay#IsVisible</a>
Return Type |
---|
Boolean<!– System.Boolean –> |
<!– ThinkGeo.MapSuite.WebEdition.Overlay –> Go Back
Gets or sets a value that indicates whether the overlay name is displayed in the OverlaySwitcher.
For the most updated Info for this topic, please check it here:<a href=“http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.HighlightFeatureOverlay#IsVisibleInOverlaySwitcher” target=“_blank”>http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.HighlightFeatureOverlay#IsVisibleInOverlaySwitcher</a>
Return Type |
---|
Boolean<!– System.Boolean –> |
<!– ThinkGeo.MapSuite.WebEdition.Overlay –> Go Back
Gets or sets the name of the overlay, which will display in the OverlaySwitcher.
For the most updated Info for this topic, please check it here:<a href=“http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.HighlightFeatureOverlay#Name” target=“_blank”>http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.HighlightFeatureOverlay#Name</a>
Return Type |
---|
String<!– System.String –> |
<!– ThinkGeo.MapSuite.WebEdition.Overlay –> Go Back
Gets or sets the client-side script that executes when the HighlightFeatureOverlay is clicked.
For the most updated Info for this topic, please check it here:<a href=“http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.HighlightFeatureOverlay#OnClientClick” target=“_blank”>http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.HighlightFeatureOverlay#OnClientClick</a>
Return Type |
---|
String<!– System.String –> |
<!– ThinkGeo.MapSuite.WebEdition.HighlightFeatureOverlay –> Go Back
Gets or sets the opacity level of the overlay.
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 Type |
---|
Single<!– System.Single –> |
<!– ThinkGeo.MapSuite.WebEdition.Overlay –> Go Back
Gets the QueryTools that allow you to easily query features from the FeatureOverlay.
For the most updated Info for this topic, please check it here:<a href=“http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.HighlightFeatureOverlay#QueryTools” target=“_blank”>http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.HighlightFeatureOverlay#QueryTools</a>
Return Type |
---|
QueryTools<!– ThinkGeo.MapSuite.Core.QueryTools –> |
<!– ThinkGeo.MapSuite.WebEdition.FeatureOverlay –> Go Back
Gets or sets a FeatureOverlayStyle object, which determines how the features are drawn at the client side.
For the most updated Info for this topic, please check it here:<a href=“http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.HighlightFeatureOverlay#HighlightStyle” target=“_blank”>http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.HighlightFeatureOverlay#HighlightStyle</a>
Return Type |
---|
FeatureOverlayStyle<!– ThinkGeo.MapSuite.WebEdition.FeatureOverlayStyle –> |
<!– ThinkGeo.MapSuite.WebEdition.FeatureOverlay –> Go Back
Gets a flag that check whether it raise an event on the client side.
For the most updated Info for this topic, please check it here:<a href=“http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.HighlightFeatureOverlay#HasClickEvent” target=“_blank”>http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.HighlightFeatureOverlay#HasClickEvent</a>
Return Type |
---|
Boolean<!– System.Boolean –> |
<!– ThinkGeo.MapSuite.WebEdition.HighlightFeatureOverlay –> Go Back
Indicates whether the overlay supports tick event.
For the most updated Info for this topic, please check it here:<a href=“http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.HighlightFeatureOverlay#HasTickEvent” target=“_blank”>http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.HighlightFeatureOverlay#HasTickEvent</a>
Return Type |
---|
Boolean<!– System.Boolean –> |
<!– ThinkGeo.MapSuite.WebEdition.Overlay –> Go Back
For the most updated Info for this topic, please check it here:<a href=“http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.HighlightFeatureOverlay#OverlayType” target=“_blank”>http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.HighlightFeatureOverlay#OverlayType</a>
Return Type |
---|
String<!– System.String –> |
<!– ThinkGeo.MapSuite.WebEdition.Overlay(overriden) –> Go Back
Occurs when the HighlightFeatureOverlay is clicked.
For the most updated Info for this topic, please check it here:<a href=“http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.HighlightFeatureOverlay#OnClick.28HighlightFeatureOverlayClickEventArgs.29” target=“_blank”>http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.HighlightFeatureOverlay#OnClick.28HighlightFeatureOverlayClickEventArgs.29</a>
Event Arguments |
---|
HighlightFeatureOverlayClickEventArgs<!– ThinkGeo.MapSuite.WebEdition.HighlightFeatureOverlayClickEventArgs –> |
<!– ThinkGeo.MapSuite.WebEdition.HighlightFeatureOverlay –> Go Back
Occurs when the number of milliseconds specified in the AutoRefreshInterval property has elapsed and the page is posted to the server.
For the most updated Info for this topic, please check it here:<a href=“http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.HighlightFeatureOverlay#OnTick.28EventArgs.29” target=“_blank”>http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.HighlightFeatureOverlay#OnTick.28EventArgs.29</a>
Event Arguments |
---|
EventArgs<!– System.EventArgs –> |
<!– ThinkGeo.MapSuite.WebEdition.Overlay –> Go Back
NOTOC WebEdition ThinkGeo.MapSuite.WebEdition UpdateDocumentation