Products
Professional Services
Demos and Downloads
Help and Support
Sidebar
thinkgeo.mapsuite.mvcedition.highlightfeatureoverlay
This is an old revision of the document!
Table of Contents
ThinkGeo.MapSuite.MvcEdition.HighlightFeatureOverlay
<!– Class –> Represents a FeatureOverlay that can easily apply a highlight style or hook event to the features in it.
Remarks
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.
Inheritance Hierarchy
*System.Object ThinkGeo.MapSuite.MvcEdition.Overlay *ThinkGeo.MapSuite.MvcEdition.FeatureOverlay ThinkGeo.MapSuite.MvcEdition.HighlightFeatureOverlay
Members Summary
Public Constructors
| Name | Parameters | DeclaringType | Summary |
|---|
Protected Constructors
| Name | Parameters | DeclaringType | Summary |
|---|
Public Methods
Protected Methods
| Name | Parameters | DeclaringType | Summary |
|---|---|---|---|
 Finalize | Object | ||
| MemberwiseClone | Object | ||
| 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> | FeatureOverlay | Gets a collection of FeatureSourceColumns, which specifies the column names of the feature data. |
| ContextMenu | ContextMenu | Gets or sets the shortcut menu associated with the HighlightFeatureOverlay. | |
| EditTools | EditTools | FeatureOverlay | Gets the EditTools that allow you to easily edit features in the FeatureOverlay. |
| FeatureSource | InMemoryFeatureSource | FeatureOverlay | Gets the FeatureSource of the FeatureOverlay. |
| Features | GeoCollection<Feature> | FeatureOverlay | Gets a collection of features that will be serialized to the client for drawing and editing. |
| HighlightStyle | FeatureOverlayStyle | Gets or sets a FeatureOverlayStyle that will be applied to the features when the mouse pointer is over them. | |
| 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. |
| OnClientAutoRefreshTick | String | Overlay | Gets or sets a JavaScript function name which will be executed when the number of milliseconds specified in the AutoRefreshInterval property has elapsed. |
| OnClientClick | String | Gets or sets the client-side script that executes when the HighlightFeatureOverlay is clicked. | |
| Opacity | Single | Overlay | Gets or sets the opacity level of the overlay. |
| QueryTools | QueryTools | FeatureOverlay | Gets the QueryTools that allow you to easily query features from the FeatureOverlay. |
| Style | FeatureOverlayStyle | FeatureOverlay | Gets or sets a FeatureOverlayStyle object, which determines how the features are drawn at the client side. |
Protected Properties
| Name | Return | DeclaringType | Summary |
|---|---|---|---|
 OverlayType | String | Overlay(overriden) |
Public Events
| Name | Event Arguments | DeclaringType | Summary |
|---|
Public Constructors
Protected Constructors
Public Methods
Equals(Object)
Return Value
| Return Type | Description |
|---|---|
| Boolean<!– System.Boolean –> |
Parameters
| Name | Type | Description |
|---|---|---|
| obj | Object<!– System.Object –> |
<!– System.Object –> 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 –> Go Back
GetHashCode()
Return Value
| Return Type | Description |
|---|---|
| Int32<!– System.Int32 –> |
Parameters
| Name | Type | Description |
|---|
<!– System.Object –> Go Back
GetType()
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.
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 –> Go Back
ToString()
Return Value
| Return Type | Description |
|---|---|
| String<!– System.String –> |
Parameters
| Name | Type | Description |
|---|
<!– System.Object –> Go Back
Protected Methods
Finalize()
Return Value
| Return Type | Description |
|---|---|
| Void<!– System.Void –> |
Parameters
| Name | Type | Description |
|---|
<!– System.Object –> Go Back
MemberwiseClone()
Return Value
| Return Type | Description |
|---|---|
| Object<!– System.Object –> |
Parameters
| Name | Type | Description |
|---|
<!– System.Object –> 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 –> Go Back
Public Properties
Attribution
Return Value
| Return Type |
|---|
| String<!– System.String –> |
<!– ThinkGeo.MapSuite.MvcEdition.Overlay –> 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 –> Go Back
Columns
Gets a collection of FeatureSourceColumns, which specifies the column names of the feature data.
Return Value
| Return Type |
|---|
| Collection<FeatureSourceColumn><!– System.Collections.ObjectModel.Collection{ThinkGeo.MapSuite.Core.FeatureSourceColumn} –> |
<!– ThinkGeo.MapSuite.MvcEdition.FeatureOverlay –> Go Back
ContextMenu
Gets or sets the shortcut menu associated with the HighlightFeatureOverlay.
Return Value
| Return Type |
|---|
| ContextMenu<!– ThinkGeo.MapSuite.MvcEdition.ContextMenu –> |
<!– ThinkGeo.MapSuite.MvcEdition.HighlightFeatureOverlay –> Go Back
EditTools
Gets the EditTools that allow you to easily edit features in the FeatureOverlay.
Return Value
| Return Type |
|---|
| EditTools<!– ThinkGeo.MapSuite.Core.EditTools –> |
<!– ThinkGeo.MapSuite.MvcEdition.FeatureOverlay –> Go Back
FeatureSource
Gets the FeatureSource of the FeatureOverlay.
Return Value
| Return Type |
|---|
| InMemoryFeatureSource<!– ThinkGeo.MapSuite.Core.InMemoryFeatureSource –> |
<!– ThinkGeo.MapSuite.MvcEdition.FeatureOverlay –> Go Back
Features
Gets a collection of features that will be serialized to the client for drawing and editing.
Return Value
| Return Type |
|---|
| GeoCollection<Feature><!– ThinkGeo.MapSuite.Core.GeoCollection{ThinkGeo.MapSuite.Core.Feature} –> |
<!– ThinkGeo.MapSuite.MvcEdition.FeatureOverlay –> Go Back
HighlightStyle
Gets or sets a FeatureOverlayStyle that will be applied to the features when the mouse pointer is over them.
Return Value
| Return Type |
|---|
| FeatureOverlayStyle<!– ThinkGeo.MapSuite.MvcEdition.FeatureOverlayStyle –> |
<!– ThinkGeo.MapSuite.MvcEdition.HighlightFeatureOverlay –> Go Back
Id
Gets the identifier for the overlay to be found.
Return Value
| Return Type |
|---|
| String<!– System.String –> |
<!– ThinkGeo.MapSuite.MvcEdition.Overlay –> Go Back
IsBaseOverlay
Gets or sets a value that indicates whether the overlay is a base overlay.
Return Value
| Return Type |
|---|
| Boolean<!– System.Boolean –> |
<!– ThinkGeo.MapSuite.MvcEdition.Overlay –> 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 –> 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 –> 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 –> 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 –> Go Back
OnClientClick
Gets or sets the client-side script that executes when the HighlightFeatureOverlay is clicked.
Remarks
There is a default parameter:e, which includes two parameters: “worldXY”, “featureId”
Return Value
| Return Type |
|---|
| String<!– System.String –> |
<!– ThinkGeo.MapSuite.MvcEdition.HighlightFeatureOverlay –> 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 –> Go Back
QueryTools
Gets the QueryTools that allow you to easily query features from the FeatureOverlay.
Return Value
| Return Type |
|---|
| QueryTools<!– ThinkGeo.MapSuite.Core.QueryTools –> |
<!– ThinkGeo.MapSuite.MvcEdition.FeatureOverlay –> Go Back
Style
Gets or sets a FeatureOverlayStyle object, which determines how the features are drawn at the client side.
Return Value
| Return Type |
|---|
| FeatureOverlayStyle<!– ThinkGeo.MapSuite.MvcEdition.FeatureOverlayStyle –> |
<!– ThinkGeo.MapSuite.MvcEdition.FeatureOverlay –> Go Back
Protected Properties
OverlayType
Return Value
| Return Type |
|---|
| String<!– System.String –> |
<!– ThinkGeo.MapSuite.MvcEdition.Overlay(overriden) –> Go Back
Public Events
thinkgeo.mapsuite.mvcedition.highlightfeatureoverlay.1440040131.txt.gz · Last modified: 2015/09/21 03:33 (external edit)
