User Tools

Site Tools


thinkgeo.mapsuite.webedition.highlightfeatureoverlay

This is an old revision of the document!


ThinkGeo.MapSuite.WebEdition.HighlightFeatureOverlay

<!– Class –> Represents a FeatureOverlay that can easily apply a highlight style or hook event to the features in it.

Remarks

The &lt;strong&gt;HighlightFeatureOverlay&lt;/strong&gt; class has a &lt;strong&gt;HighlightStyle&lt;/strong&gt; 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 &lt;strong&gt;HighlightFeatureOverlay&lt;/strong&gt; class also has a &lt;strong&gt;Click&lt;/strong&gt; event and a &lt;strong&gt;ContextMenu&lt;/strong&gt; 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 &lt;strong&gt;OnClientClick&lt;/strong&gt; property holds the Javascript that will be executed before the &lt;strong&gt;Click&lt;/strong&gt; event. If you return &lt;strong&gt;false&lt;/strong&gt; in the Javascript, the &lt;strong&gt;Click&lt;/strong&gt; event will not be fired.You can only accesss the &lt;strong&gt;HighlightFeatureOverlay&lt;/strong&gt; instance by using &lt;strong&gt;Map.HighlightOverlay&lt;/strong&gt;. You cannot create an instance by yourself.&lt;strong&gt;Note:&lt;/strong&gt; Because the &lt;strong&gt;HighlightFeatureOverlay&lt;/strong&gt; 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 &lt;strong&gt;Features&lt;/strong&gt; collection.

Inheritance Hierarchy

Members Summary

Public Constructors

Name Parameters DeclaringType Summary

Protected Constructors

Name Parameters DeclaringType Summary

Public Methods

Name Parameters DeclaringType Summary
Public MethodEquals Object Object
Public MethodGetHashCode Object
Public MethodGetType Object
Public MethodToJson Overlay Returns a JSON string which contains the information for creating an overlay at the client side.
Public MethodToString Object

Protected Methods

Name Parameters DeclaringType Summary
Protected MethodFinalize Object
Protected MethodMemberwiseClone Object
Protected MethodOnClick HighlightFeatureOverlayClickEventArgs Raises the click event on the HighlightFeatureOverlay.
Protected MethodOnTick EventArgs Overlay Raises the Tick event of the MarkerOverlay.
Protected MethodRegisterJavaScriptLibraryCore Page Overlay Registers a Javascript library URL string to the client HTML page.

Public Properties

Name Return DeclaringType Summary
Public PropertyAttribution String Overlay
Public PropertyAutoRefreshInterval TimeSpan Overlay Gets or sets the time interval in which the MarkerOverlay refreshes itself.
Public PropertyColumns Collection<FeatureSourceColumn> FeatureOverlay Gets a collection of FeatureSourceColumns, which specifies the column names of the feature data.
Public PropertyContextMenu ContextMenu Gets or sets the shortcut menu associated with the HighlightFeatureOverlay.
Public PropertyEditTools EditTools FeatureOverlay Gets the EditTools that allow you to easily edit features in the FeatureOverlay.
Public PropertyFeatureSource InMemoryFeatureSource FeatureOverlay Gets the FeatureSource of the FeatureOverlay.
Public PropertyFeatures GeoCollection<Feature> FeatureOverlay Gets a collection of features that will be serialized to the client for drawing and editing.
Public PropertyHighlightStyle FeatureOverlayStyle Gets or sets a FeatureOverlayStyle that will be applied to the features when the mouse pointer is over them.
Public PropertyId String Overlay Gets the identifier for the overlay to be found.
Public PropertyIsBaseOverlay Boolean Overlay Gets or sets a value that indicates whether the overlay is a base overlay.
Public PropertyIsVisible Boolean Overlay Gets or sets a value that indicates whether the overlay is visible on the map.
Public PropertyIsVisibleInOverlaySwitcher Boolean Overlay Gets or sets a value that indicates whether the overlay name is displayed in the OverlaySwitcher.
Public PropertyName String Overlay Gets or sets the name of the overlay, which will display in the OverlaySwitcher.
Public PropertyOnClientClick String Gets or sets the client-side script that executes when the HighlightFeatureOverlay is clicked.
Public PropertyOpacity Single Overlay Gets or sets the opacity level of the overlay.
Public PropertyQueryTools QueryTools FeatureOverlay Gets the QueryTools that allow you to easily query features from the FeatureOverlay.
Public PropertyStyle 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
Protected PropertyHasClickEvent Boolean Gets a flag that check whether it raise an event on the client side.
Protected PropertyHasTickEvent Boolean Overlay Indicates whether the overlay supports tick event.
Protected PropertyOverlayType String Overlay(overriden)

Public Events

Name Event Arguments DeclaringType Summary
Public EventClick HighlightFeatureOverlayClickEventArgs Occurs when the HighlightFeatureOverlay is clicked.
Public EventTick EventArgs Overlay Occurs when the number of milliseconds specified in the AutoRefreshInterval property has elapsed and the page is posted to the server.

Public Constructors

Protected Constructors

Public Methods

Equals(Object)

Remarks

Return Value

Return Type Description
Boolean<!– System.Boolean –>

Parameters

Name Type Description
obj Object<!– System.Object –>

<!– System.Object –> Go Back

GetHashCode()

Remarks

Return Value

Return Type Description
Int32<!– System.Int32 –>

Parameters

Name Type Description

<!– System.Object –> Go Back

GetType()

Remarks

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

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

Return Value

Return Type Description
String<!– System.String –>

Parameters

Name Type Description

<!– System.Object –> Go Back

Protected Methods

Finalize()

Remarks

Return Value

Return Type Description
Void<!– System.Void –>

Parameters

Name Type Description

<!– System.Object –> Go Back

MemberwiseClone()

Remarks

Return Value

Return Type Description
Object<!– System.Object –>

Parameters

Name Type Description

<!– System.Object –> Go Back

OnClick(HighlightFeatureOverlayClickEventArgs)

Raises the click event on the HighlightFeatureOverlay.

Remarks

Return Value

Return Type Description
Void<!– System.Void –>

Parameters

Name Type Description
e HighlightFeatureOverlayClickEventArgs<!– ThinkGeo.MapSuite.WebEdition.HighlightFeatureOverlayClickEventArgs –> A HighlightFeatureOverlayClickEventArgs that contains the event data.

<!– ThinkGeo.MapSuite.WebEdition.HighlightFeatureOverlay –> Go Back

OnTick(EventArgs)

Raises the Tick event of the MarkerOverlay.

Remarks

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 &lt;strong&gt;RegisterJavaScriptLibraryCore&lt;/strong&gt; 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

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

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

Return Value

Return Type
Collection<FeatureSourceColumn><!– System.Collections.ObjectModel.Collection{ThinkGeo.MapSuite.Core.FeatureSourceColumn} –>

<!– ThinkGeo.MapSuite.WebEdition.FeatureOverlay –> Go Back

ContextMenu

Gets or sets the shortcut menu associated with the HighlightFeatureOverlay.

Remarks

Return Value

Return Type
ContextMenu<!– ThinkGeo.MapSuite.WebEdition.ContextMenu –>

<!– ThinkGeo.MapSuite.WebEdition.HighlightFeatureOverlay –> Go Back

EditTools

Gets the EditTools that allow you to easily edit features in the FeatureOverlay.

Remarks

Return Value

Return Type
EditTools<!– ThinkGeo.MapSuite.Core.EditTools –>

<!– ThinkGeo.MapSuite.WebEdition.FeatureOverlay –> Go Back

FeatureSource

Gets the FeatureSource of the FeatureOverlay.

Remarks

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

Return Value

Return Type
GeoCollection<Feature><!– ThinkGeo.MapSuite.Core.GeoCollection{ThinkGeo.MapSuite.Core.Feature} –>

<!– ThinkGeo.MapSuite.WebEdition.FeatureOverlay –> Go Back

HighlightStyle

Gets or sets a FeatureOverlayStyle that will be applied to the features when the mouse pointer is over them.

Remarks

Return Value

Return Type
FeatureOverlayStyle<!– ThinkGeo.MapSuite.WebEdition.FeatureOverlayStyle –>

<!– ThinkGeo.MapSuite.WebEdition.HighlightFeatureOverlay –> Go Back

Id

Gets the identifier for the overlay to be found.

Remarks

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

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

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

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

Return Value

Return Type
String<!– System.String –>

<!– ThinkGeo.MapSuite.WebEdition.Overlay –> Go Back

OnClientClick

Gets or sets the client-side script that executes when the HighlightFeatureOverlay is clicked.

Remarks

Return Value

Return Type
String<!– System.String –>

<!– ThinkGeo.MapSuite.WebEdition.HighlightFeatureOverlay –> Go Back

Opacity

Gets or sets the opacity level of the overlay.

Remarks

The &lt;strong&gt;Opacity&lt;/strong&gt; 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

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

Return Value

Return Type
FeatureOverlayStyle<!– ThinkGeo.MapSuite.WebEdition.FeatureOverlayStyle –>

<!– ThinkGeo.MapSuite.WebEdition.FeatureOverlay –> Go Back

Protected Properties

HasClickEvent

Gets a flag that check whether it raise an event on the client side.

Remarks

Return Value

Return Type
Boolean<!– System.Boolean –>

<!– ThinkGeo.MapSuite.WebEdition.HighlightFeatureOverlay –> Go Back

HasTickEvent

Indicates whether the overlay supports tick event.

Remarks

Return Value

Return Type
Boolean<!– System.Boolean –>

<!– ThinkGeo.MapSuite.WebEdition.Overlay –> Go Back

OverlayType

Remarks

Return Value

Return Type
String<!– System.String –>

<!– ThinkGeo.MapSuite.WebEdition.Overlay(overriden) –> Go Back

Public Events

Click

Occurs when the HighlightFeatureOverlay is clicked.

Remarks

Event Arguments

Event Arguments
HighlightFeatureOverlayClickEventArgs<!– ThinkGeo.MapSuite.WebEdition.HighlightFeatureOverlayClickEventArgs –>

<!– ThinkGeo.MapSuite.WebEdition.HighlightFeatureOverlay –> Go Back

Tick

Occurs when the number of milliseconds specified in the AutoRefreshInterval property has elapsed and the page is posted to the server.

Remarks

Event Arguments

Event Arguments
EventArgs<!– System.EventArgs –>

<!– ThinkGeo.MapSuite.WebEdition.Overlay –> Go Back

NOTOC WebEdition ThinkGeo.MapSuite.WebEdition UpdateDocumentation

thinkgeo.mapsuite.webedition.highlightfeatureoverlay.1440040135.txt.gz · Last modified: 2015/09/18 03:07 (external edit)