This shows you the differences between two versions of the page.
Both sides previous revision Previous revision Next revision | Previous revision | ||
thinkgeo.mapsuite.webedition.highlightfeatureoverlay [2015/09/18 03:07] admin |
thinkgeo.mapsuite.webedition.highlightfeatureoverlay [2017/03/16 21:59] (current) |
||
---|---|---|---|
Line 1: | Line 1: | ||
====== ThinkGeo.MapSuite.WebEdition.HighlightFeatureOverlay ====== | ====== ThinkGeo.MapSuite.WebEdition.HighlightFeatureOverlay ====== | ||
+ | |||
+ | {{section>upgrade_map_suite_to_10.0}} | ||
+ | |||
Represents a FeatureOverlay that can easily apply a highlight style or hook event to the features in it. | Represents a FeatureOverlay that can easily apply a highlight style or hook event to the features in it. | ||
===== Inheritance Hierarchy ===== | ===== Inheritance Hierarchy ===== | ||
Line 11: | Line 14: | ||
** {{wiki:ProtectedMethod.gif|}} HighlightFeatureOverlay(String) ** | ** {{wiki:ProtectedMethod.gif|}} HighlightFeatureOverlay(String) ** | ||
- | N/A | + | * //N/A// |
== Remarks == | == Remarks == | ||
- | N/A | + | * //N/A// |
== Parameters == | == Parameters == | ||
* //id// | * //id// | ||
Line 23: | Line 26: | ||
** {{wiki:PublicMethod.gif|}} ToJson() ** | ** {{wiki:PublicMethod.gif|}} ToJson() ** | ||
- | N/A | + | * //Returns a JSON string which contains the information for creating an overlay at the client side.// |
== Remarks == | == Remarks == | ||
- | N/A | + | * //For the most updated Info for this topic, please check it here:http:wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.HighlightFeatureOverlay#ToJson.28.29// |
== Return Value == | == Return Value == | ||
* Type:String | * Type:String | ||
- | * Description:N/A | + | * Description:A JSON string which is used to create an overlay at the client side. |
== Parameters == | == Parameters == | ||
Line 35: | Line 38: | ||
** {{wiki:PublicMethod.gif|}} ToString() ** | ** {{wiki:PublicMethod.gif|}} ToString() ** | ||
- | N/A | + | * //N/A// |
== Remarks == | == Remarks == | ||
- | N/A | + | * //For the most updated Info for this topic, please check it here:http:wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.HighlightFeatureOverlay#ToString.28.29// |
== Return Value == | == Return Value == | ||
Line 47: | Line 50: | ||
** {{wiki:PublicMethod.gif|}} Equals(Object) ** | ** {{wiki:PublicMethod.gif|}} Equals(Object) ** | ||
- | N/A | + | * //N/A// |
== Remarks == | == Remarks == | ||
- | N/A | + | * //For the most updated Info for this topic, please check it here:http:wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.HighlightFeatureOverlay#Equals.28Object.29// |
== Return Value == | == Return Value == | ||
Line 63: | Line 66: | ||
** {{wiki:PublicMethod.gif|}} GetHashCode() ** | ** {{wiki:PublicMethod.gif|}} GetHashCode() ** | ||
- | N/A | + | * //N/A// |
== Remarks == | == Remarks == | ||
- | N/A | + | * //For the most updated Info for this topic, please check it here:http:wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.HighlightFeatureOverlay#GetHashCode.28.29// |
== Return Value == | == Return Value == | ||
Line 75: | Line 78: | ||
** {{wiki:PublicMethod.gif|}} GetType() ** | ** {{wiki:PublicMethod.gif|}} GetType() ** | ||
- | N/A | + | * //N/A// |
== Remarks == | == Remarks == | ||
- | N/A | + | * //For the most updated Info for this topic, please check it here:http:wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.HighlightFeatureOverlay#GetType.28.29// |
== Return Value == | == Return Value == | ||
Line 88: | Line 91: | ||
** {{wiki:ProtectedMethod.gif|}} OnClick(HighlightFeatureOverlayClickEventArgs) ** | ** {{wiki:ProtectedMethod.gif|}} OnClick(HighlightFeatureOverlayClickEventArgs) ** | ||
- | Raises the click event on the HighlightFeatureOverlay. | + | * //Raises the click event on the HighlightFeatureOverlay.// |
== Remarks == | == Remarks == | ||
- | N/A | + | * //For the most updated Info for this topic, please check it here:http:wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.HighlightFeatureOverlay#OnClick.28HighlightFeatureOverlayClickEventArgs.29// |
== Return Value == | == Return Value == | ||
Line 104: | Line 107: | ||
** {{wiki:ProtectedMethod.gif|}} 4xM=(Double,Double,String) ** | ** {{wiki:ProtectedMethod.gif|}} 4xM=(Double,Double,String) ** | ||
- | N/A | + | * //N/A// |
== Remarks == | == Remarks == | ||
- | N/A | + | * //N/A// |
== Return Value == | == Return Value == | ||
Line 128: | Line 131: | ||
** {{wiki:ProtectedMethod.gif|}} 5BM=() ** | ** {{wiki:ProtectedMethod.gif|}} 5BM=() ** | ||
- | N/A | + | * //N/A// |
== Remarks == | == Remarks == | ||
- | N/A | + | * //N/A// |
== Return Value == | == Return Value == | ||
Line 140: | Line 143: | ||
** {{wiki:ProtectedMethod.gif|}} 5RM=(Object) ** | ** {{wiki:ProtectedMethod.gif|}} 5RM=(Object) ** | ||
- | N/A | + | * //N/A// |
== Remarks == | == Remarks == | ||
- | N/A | + | * //N/A// |
== Return Value == | == Return Value == | ||
Line 156: | Line 159: | ||
** {{wiki:ProtectedMethod.gif|}} 5hM=() ** | ** {{wiki:ProtectedMethod.gif|}} 5hM=() ** | ||
- | N/A | + | * //N/A// |
== Remarks == | == Remarks == | ||
- | N/A | + | * //N/A// |
== Return Value == | == Return Value == | ||
Line 168: | Line 171: | ||
** {{wiki:ProtectedMethod.gif|}} 5xM=(Object) ** | ** {{wiki:ProtectedMethod.gif|}} 5xM=(Object) ** | ||
- | N/A | + | * //N/A// |
== Remarks == | == Remarks == | ||
- | N/A | + | * //N/A// |
== Return Value == | == Return Value == | ||
Line 184: | Line 187: | ||
** {{wiki:ProtectedMethod.gif|}} 3xM=(Page) ** | ** {{wiki:ProtectedMethod.gif|}} 3xM=(Page) ** | ||
- | N/A | + | * //N/A// |
== Remarks == | == Remarks == | ||
- | N/A | + | * //N/A// |
== Return Value == | == Return Value == | ||
Line 200: | Line 203: | ||
** {{wiki:ProtectedMethod.gif|}} RegisterJavaScriptLibraryCore(Page) ** | ** {{wiki:ProtectedMethod.gif|}} RegisterJavaScriptLibraryCore(Page) ** | ||
- | N/A | + | * //Registers a Javascript library URL string to the client HTML page.// |
== Remarks == | == Remarks == | ||
- | N/A | + | * //The <strong>RegisterJavaScriptLibraryCore</strong> method allows derived classes to override and register their own Javascript library URL to the HTML page.// |
== Return Value == | == Return Value == | ||
Line 211: | Line 214: | ||
* //page// | * //page// | ||
* Type:Page | * Type:Page | ||
- | * Description:N/A | + | * Description:The page object that is used for registering the javascript library. |
<div newline></div> | <div newline></div> | ||
** {{wiki:ProtectedMethod.gif|}} RaiseTickEvent(EventArgs) ** | ** {{wiki:ProtectedMethod.gif|}} RaiseTickEvent(EventArgs) ** | ||
- | N/A | + | * //N/A// |
== Remarks == | == Remarks == | ||
- | N/A | + | * //N/A// |
== Return Value == | == Return Value == | ||
Line 232: | Line 235: | ||
** {{wiki:ProtectedMethod.gif|}} OnTick(EventArgs) ** | ** {{wiki:ProtectedMethod.gif|}} OnTick(EventArgs) ** | ||
- | N/A | + | * //Raises the Tick event of the MarkerOverlay.// |
== Remarks == | == Remarks == | ||
- | N/A | + | * //For the most updated Info for this topic, please check it here:http:wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.HighlightFeatureOverlay#OnTick.28EventArgs.29// |
== Return Value == | == Return Value == | ||
Line 243: | Line 246: | ||
* //e// | * //e// | ||
* Type:EventArgs | * Type:EventArgs | ||
- | * Description:N/A | + | * Description:An System.EventArgs object that contains the event data. |
<div newline></div> | <div newline></div> | ||
** {{wiki:ProtectedMethod.gif|}} Finalize() ** | ** {{wiki:ProtectedMethod.gif|}} Finalize() ** | ||
- | N/A | + | * //N/A// |
== Remarks == | == Remarks == | ||
- | N/A | + | * //For the most updated Info for this topic, please check it here:http:wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.HighlightFeatureOverlay#Finalize.28.29// |
== Return Value == | == Return Value == | ||
Line 260: | Line 263: | ||
** {{wiki:ProtectedMethod.gif|}} MemberwiseClone() ** | ** {{wiki:ProtectedMethod.gif|}} MemberwiseClone() ** | ||
- | N/A | + | * //N/A// |
== Remarks == | == Remarks == | ||
- | N/A | + | * //For the most updated Info for this topic, please check it here:http:wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.HighlightFeatureOverlay#MemberwiseClone.28.29// |
== Return Value == | == Return Value == | ||
Line 275: | Line 278: | ||
Gets or sets a FeatureOverlayStyle that will be applied to the features when the mouse pointer is over them. | Gets or sets a FeatureOverlayStyle that will be applied to the features when the mouse pointer is over them. | ||
== Remarks == | == Remarks == | ||
- | N/A | + | For the most updated Info for this topic, please check it here:http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.HighlightFeatureOverlay#HighlightStyle |
== Return Value == | == Return Value == | ||
* Type:[[ThinkGeo.MapSuite.WebEdition.FeatureOverlayStyle|FeatureOverlayStyle]] | * Type:[[ThinkGeo.MapSuite.WebEdition.FeatureOverlayStyle|FeatureOverlayStyle]] | ||
Line 283: | Line 286: | ||
Gets or sets the shortcut menu associated with the HighlightFeatureOverlay. | Gets or sets the shortcut menu associated with the HighlightFeatureOverlay. | ||
== Remarks == | == Remarks == | ||
- | N/A | + | For the most updated Info for this topic, please check it here:http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.HighlightFeatureOverlay#ContextMenu |
== Return Value == | == Return Value == | ||
* Type:[[ThinkGeo.MapSuite.WebEdition.ContextMenu|ContextMenu]] | * Type:[[ThinkGeo.MapSuite.WebEdition.ContextMenu|ContextMenu]] | ||
Line 291: | Line 294: | ||
Gets or sets the client-side script that executes when the HighlightFeatureOverlay is clicked. | Gets or sets the client-side script that executes when the HighlightFeatureOverlay is clicked. | ||
== Remarks == | == Remarks == | ||
- | N/A | + | For the most updated Info for this topic, please check it here:http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.HighlightFeatureOverlay#OnClientClick |
== Return Value == | == Return Value == | ||
* Type:String | * Type:String | ||
Line 297: | Line 300: | ||
** {{wiki:PublicProperty.gif|}} Features ** | ** {{wiki:PublicProperty.gif|}} Features ** | ||
- | N/A | + | Gets a collection of features that will be serialized to the client for drawing and editing. |
== Remarks == | == Remarks == | ||
- | N/A | + | For the most updated Info for this topic, please check it here:http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.HighlightFeatureOverlay#Features |
== Return Value == | == Return Value == | ||
* Type:[[ThinkGeo.MapSuite.Core.GeoCollection<T>[[ThinkGeo.MapSuite.Core.Feature, MapSuiteCore, Version=9.0.0.0, Culture=neutral, PublicKeyToken=null]]|GeoCollection<T>]] | * Type:[[ThinkGeo.MapSuite.Core.GeoCollection<T>[[ThinkGeo.MapSuite.Core.Feature, MapSuiteCore, Version=9.0.0.0, Culture=neutral, PublicKeyToken=null]]|GeoCollection<T>]] | ||
Line 305: | Line 308: | ||
** {{wiki:PublicProperty.gif|}} FeatureSource ** | ** {{wiki:PublicProperty.gif|}} FeatureSource ** | ||
- | N/A | + | Gets the FeatureSource of the FeatureOverlay. |
== Remarks == | == Remarks == | ||
- | N/A | + | For the most updated Info for this topic, please check it here:http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.HighlightFeatureOverlay#FeatureSource |
== Return Value == | == Return Value == | ||
* Type:[[ThinkGeo.MapSuite.Core.InMemoryFeatureSource|InMemoryFeatureSource]] | * Type:[[ThinkGeo.MapSuite.Core.InMemoryFeatureSource|InMemoryFeatureSource]] | ||
Line 313: | Line 316: | ||
** {{wiki:PublicProperty.gif|}} Columns ** | ** {{wiki:PublicProperty.gif|}} Columns ** | ||
- | N/A | + | Gets a collection of FeatureSourceColumns, which specifies the column names of the feature data. |
== Remarks == | == Remarks == | ||
- | N/A | + | For the most updated Info for this topic, please check it here:http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.HighlightFeatureOverlay#Columns |
== Return Value == | == Return Value == | ||
* Type:Collection<[[ThinkGeo.MapSuite.Core.FeatureSourceColumn|FeatureSourceColumn]]> | * Type:Collection<[[ThinkGeo.MapSuite.Core.FeatureSourceColumn|FeatureSourceColumn]]> | ||
Line 321: | Line 324: | ||
** {{wiki:PublicProperty.gif|}} Style ** | ** {{wiki:PublicProperty.gif|}} Style ** | ||
- | N/A | + | Gets or sets a FeatureOverlayStyle object, which determines how the features are drawn at the client side. |
== Remarks == | == Remarks == | ||
- | N/A | + | For the most updated Info for this topic, please check it here:http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.HighlightFeatureOverlay#HighlightStyle |
== Return Value == | == Return Value == | ||
* Type:[[ThinkGeo.MapSuite.WebEdition.FeatureOverlayStyle|FeatureOverlayStyle]] | * Type:[[ThinkGeo.MapSuite.WebEdition.FeatureOverlayStyle|FeatureOverlayStyle]] | ||
Line 329: | Line 332: | ||
** {{wiki:PublicProperty.gif|}} QueryTools ** | ** {{wiki:PublicProperty.gif|}} QueryTools ** | ||
- | N/A | + | Gets the QueryTools that allow you to easily query features from the FeatureOverlay. |
== Remarks == | == Remarks == | ||
- | N/A | + | For the most updated Info for this topic, please check it here:http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.HighlightFeatureOverlay#QueryTools |
== Return Value == | == Return Value == | ||
* Type:[[ThinkGeo.MapSuite.Core.QueryTools|QueryTools]] | * Type:[[ThinkGeo.MapSuite.Core.QueryTools|QueryTools]] | ||
Line 337: | Line 340: | ||
** {{wiki:PublicProperty.gif|}} EditTools ** | ** {{wiki:PublicProperty.gif|}} EditTools ** | ||
- | N/A | + | Gets the EditTools that allow you to easily edit features in the FeatureOverlay. |
== Remarks == | == Remarks == | ||
- | N/A | + | For the most updated Info for this topic, please check it here:http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.HighlightFeatureOverlay#EditTools |
== Return Value == | == Return Value == | ||
* Type:[[ThinkGeo.MapSuite.Core.EditTools|EditTools]] | * Type:[[ThinkGeo.MapSuite.Core.EditTools|EditTools]] | ||
Line 345: | Line 348: | ||
** {{wiki:PublicProperty.gif|}} IsVisible ** | ** {{wiki:PublicProperty.gif|}} IsVisible ** | ||
- | N/A | + | Gets or sets a value that indicates whether the overlay is visible on the map. |
== Remarks == | == Remarks == | ||
- | N/A | + | For the most updated Info for this topic, please check it here:http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.HighlightFeatureOverlay#IsVisible |
== Return Value == | == Return Value == | ||
* Type:Boolean | * Type:Boolean | ||
Line 353: | Line 356: | ||
** {{wiki:PublicProperty.gif|}} Name ** | ** {{wiki:PublicProperty.gif|}} Name ** | ||
- | N/A | + | Gets or sets the name of the overlay, which will display in the OverlaySwitcher. |
== Remarks == | == Remarks == | ||
- | N/A | + | For the most updated Info for this topic, please check it here:http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.HighlightFeatureOverlay#Name |
== Return Value == | == Return Value == | ||
* Type:String | * Type:String | ||
Line 361: | Line 364: | ||
** {{wiki:PublicProperty.gif|}} Opacity ** | ** {{wiki:PublicProperty.gif|}} Opacity ** | ||
- | N/A | + | Gets or sets the opacity level of the overlay. |
== Remarks == | == Remarks == | ||
- | N/A | + | 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 Value == | ||
* Type:Single | * Type:Single | ||
Line 369: | Line 372: | ||
** {{wiki:PublicProperty.gif|}} IsVisibleInOverlaySwitcher ** | ** {{wiki:PublicProperty.gif|}} IsVisibleInOverlaySwitcher ** | ||
- | N/A | + | Gets or sets a value that indicates whether the overlay name is displayed in the OverlaySwitcher. |
== Remarks == | == Remarks == | ||
- | N/A | + | For the most updated Info for this topic, please check it here:http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.HighlightFeatureOverlay#IsVisibleInOverlaySwitcher |
== Return Value == | == Return Value == | ||
* Type:Boolean | * Type:Boolean | ||
Line 377: | Line 380: | ||
** {{wiki:PublicProperty.gif|}} IsBaseOverlay ** | ** {{wiki:PublicProperty.gif|}} IsBaseOverlay ** | ||
- | N/A | + | Gets or sets a value that indicates whether the overlay is a base overlay. |
== Remarks == | == Remarks == | ||
- | N/A | + | For the most updated Info for this topic, please check it here:http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.HighlightFeatureOverlay#IsBaseOverlay |
== Return Value == | == Return Value == | ||
* Type:Boolean | * Type:Boolean | ||
Line 385: | Line 388: | ||
** {{wiki:PublicProperty.gif|}} Id ** | ** {{wiki:PublicProperty.gif|}} Id ** | ||
- | N/A | + | Gets the identifier for the overlay to be found. |
== Remarks == | == Remarks == | ||
- | N/A | + | For the most updated Info for this topic, please check it here:http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.HighlightFeatureOverlay#Id |
== Return Value == | == Return Value == | ||
* Type:String | * Type:String | ||
Line 393: | Line 396: | ||
** {{wiki:PublicProperty.gif|}} AutoRefreshInterval ** | ** {{wiki:PublicProperty.gif|}} AutoRefreshInterval ** | ||
- | N/A | + | Gets or sets the time interval in which the MarkerOverlay refreshes itself. |
== Remarks == | == Remarks == | ||
- | N/A | + | For the most updated Info for this topic, please check it here:http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.HighlightFeatureOverlay#AutoRefreshInterval |
== Return Value == | == Return Value == | ||
* Type:TimeSpan | * Type:TimeSpan | ||
Line 403: | Line 406: | ||
N/A | N/A | ||
== Remarks == | == Remarks == | ||
- | N/A | + | For the most updated Info for this topic, please check it here:http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.HighlightFeatureOverlay#Attribution |
== Return Value == | == Return Value == | ||
* Type:String | * Type:String | ||
Line 412: | Line 415: | ||
Gets a flag that check whether it raise an event on the client side. | Gets a flag that check whether it raise an event on the client side. | ||
== Remarks == | == Remarks == | ||
- | N/A | + | For the most updated Info for this topic, please check it here:http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.HighlightFeatureOverlay#HasClickEvent |
== Return Value == | == Return Value == | ||
* Type:Boolean | * Type:Boolean | ||
Line 428: | Line 431: | ||
N/A | N/A | ||
== Remarks == | == Remarks == | ||
- | N/A | + | For the most updated Info for this topic, please check it here:http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.HighlightFeatureOverlay#OverlayType |
== Return Value == | == Return Value == | ||
* Type:String | * Type:String | ||
Line 434: | Line 437: | ||
** {{wiki:ProtectedProperty.gif|}} HasTickEvent ** | ** {{wiki:ProtectedProperty.gif|}} HasTickEvent ** | ||
- | N/A | + | Indicates whether the overlay supports tick event. |
== Remarks == | == Remarks == | ||
- | N/A | + | For the most updated Info for this topic, please check it here:http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.HighlightFeatureOverlay#HasTickEvent |
== Return Value == | == Return Value == | ||
* Type:Boolean | * Type:Boolean | ||
Line 452: | Line 455: | ||
Occurs when the HighlightFeatureOverlay is clicked. | Occurs when the HighlightFeatureOverlay is clicked. | ||
== Remarks == | == Remarks == | ||
- | N/A | + | For the most updated Info for this topic, please check it here:http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.HighlightFeatureOverlay#OnClick.28HighlightFeatureOverlayClickEventArgs.29 |
Event Arguments:[[ThinkGeo.MapSuite.WebEdition.HighlightFeatureOverlayClickEventArgs|HighlightFeatureOverlayClickEventArgs]] | Event Arguments:[[ThinkGeo.MapSuite.WebEdition.HighlightFeatureOverlayClickEventArgs|HighlightFeatureOverlayClickEventArgs]] | ||
** {{wiki:PublicEvent.gif|}} Tick ** | ** {{wiki:PublicEvent.gif|}} Tick ** | ||
- | N/A | + | Occurs when the number of milliseconds specified in the AutoRefreshInterval property has elapsed and the page is posted to the server. |
== Remarks == | == Remarks == | ||
- | N/A | + | For the most updated Info for this topic, please check it here:http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.HighlightFeatureOverlay#OnTick.28EventArgs.29 |
Event Arguments:EventArgs | Event Arguments:EventArgs | ||