thinkgeo.mapsuite.webedition.highlightfeatureoverlay
Differences
This shows you the differences between two versions of the page.
| Both sides previous revision Previous revision | |||
|
thinkgeo.mapsuite.webedition.highlightfeatureoverlay [2015/09/22 08:48] admin |
— (current) | ||
|---|---|---|---|
| Line 1: | Line 1: | ||
| - | ====== ThinkGeo.MapSuite.WebEdition.HighlightFeatureOverlay ====== | ||
| - | Represents a FeatureOverlay that can easily apply a highlight style or hook event to the features in it. | ||
| - | ===== Inheritance Hierarchy ===== | ||
| - | *System.Object | ||
| - | *ThinkGeo.MapSuite.WebEdition.Overlay | ||
| - | *ThinkGeo.MapSuite.WebEdition.FeatureOverlay | ||
| - | ***ThinkGeo.MapSuite.WebEdition.HighlightFeatureOverlay** | ||
| - | ===== Members Summary ===== | ||
| - | ==== Public Constructors ==== | ||
| - | ==== Protected Constructors ==== | ||
| - | ** {{wiki:ProtectedMethod.gif|}} HighlightFeatureOverlay(String) ** | ||
| - | |||
| - | * //N/A// | ||
| - | == Remarks == | ||
| - | * //N/A// | ||
| - | == Parameters == | ||
| - | * //id// | ||
| - | * Type:String | ||
| - | * Description:N/A | ||
| - | |||
| - | <div newline></div> | ||
| - | ==== Public Methods ==== | ||
| - | ** {{wiki:PublicMethod.gif|}} 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:http:wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.HighlightFeatureOverlay#ToJson.28.29// | ||
| - | |||
| - | == Return Value == | ||
| - | * Type:String | ||
| - | * Description:A JSON string which is used to create an overlay at the client side. | ||
| - | |||
| - | == Parameters == | ||
| - | <div newline></div> | ||
| - | ** {{wiki:PublicMethod.gif|}} ToString() ** | ||
| - | |||
| - | * //N/A// | ||
| - | == Remarks == | ||
| - | * //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 == | ||
| - | * Type:String | ||
| - | * Description:N/A | ||
| - | |||
| - | == Parameters == | ||
| - | <div newline></div> | ||
| - | ** {{wiki:PublicMethod.gif|}} Equals(Object) ** | ||
| - | |||
| - | * //N/A// | ||
| - | == Remarks == | ||
| - | * //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 == | ||
| - | * Type:Boolean | ||
| - | * Description:N/A | ||
| - | |||
| - | == Parameters == | ||
| - | * //obj// | ||
| - | * Type:Object | ||
| - | * Description:N/A | ||
| - | |||
| - | <div newline></div> | ||
| - | ** {{wiki:PublicMethod.gif|}} GetHashCode() ** | ||
| - | |||
| - | * //N/A// | ||
| - | == Remarks == | ||
| - | * //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 == | ||
| - | * Type:Int32 | ||
| - | * Description:N/A | ||
| - | |||
| - | == Parameters == | ||
| - | <div newline></div> | ||
| - | ** {{wiki:PublicMethod.gif|}} GetType() ** | ||
| - | |||
| - | * //N/A// | ||
| - | == Remarks == | ||
| - | * //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 == | ||
| - | * Type:Type | ||
| - | * Description:N/A | ||
| - | |||
| - | == Parameters == | ||
| - | <div newline></div> | ||
| - | ==== Protected Methods ==== | ||
| - | ** {{wiki:ProtectedMethod.gif|}} OnClick(HighlightFeatureOverlayClickEventArgs) ** | ||
| - | |||
| - | * //Raises the click event on the HighlightFeatureOverlay.// | ||
| - | == Remarks == | ||
| - | * //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 == | ||
| - | * Type:Void | ||
| - | * Description:N/A | ||
| - | |||
| - | == Parameters == | ||
| - | * //e// | ||
| - | * Type:[[ThinkGeo.MapSuite.WebEdition.HighlightFeatureOverlayClickEventArgs|HighlightFeatureOverlayClickEventArgs]] | ||
| - | * Description:A HighlightFeatureOverlayClickEventArgs that contains the event data. | ||
| - | |||
| - | <div newline></div> | ||
| - | ** {{wiki:ProtectedMethod.gif|}} 4xM=(Double,Double,String) ** | ||
| - | |||
| - | * //N/A// | ||
| - | == Remarks == | ||
| - | * //N/A// | ||
| - | |||
| - | == Return Value == | ||
| - | * Type:Void | ||
| - | * Description:N/A | ||
| - | |||
| - | == Parameters == | ||
| - | * //longitude// | ||
| - | * Type:Double | ||
| - | * Description:N/A | ||
| - | |||
| - | * //latitude// | ||
| - | * Type:Double | ||
| - | * Description:N/A | ||
| - | |||
| - | * //featureId// | ||
| - | * Type:String | ||
| - | * Description:N/A | ||
| - | |||
| - | <div newline></div> | ||
| - | ** {{wiki:ProtectedMethod.gif|}} 5BM=() ** | ||
| - | |||
| - | * //N/A// | ||
| - | == Remarks == | ||
| - | * //N/A// | ||
| - | |||
| - | == Return Value == | ||
| - | * Type:Void | ||
| - | * Description:N/A | ||
| - | |||
| - | == Parameters == | ||
| - | <div newline></div> | ||
| - | ** {{wiki:ProtectedMethod.gif|}} 5RM=(Object) ** | ||
| - | |||
| - | * //N/A// | ||
| - | == Remarks == | ||
| - | * //N/A// | ||
| - | |||
| - | == Return Value == | ||
| - | * Type:Void | ||
| - | * Description:N/A | ||
| - | |||
| - | == Parameters == | ||
| - | * //target// | ||
| - | * Type:Object | ||
| - | * Description:N/A | ||
| - | |||
| - | <div newline></div> | ||
| - | ** {{wiki:ProtectedMethod.gif|}} 5hM=() ** | ||
| - | |||
| - | * //N/A// | ||
| - | == Remarks == | ||
| - | * //N/A// | ||
| - | |||
| - | == Return Value == | ||
| - | * Type:Void | ||
| - | * Description:N/A | ||
| - | |||
| - | == Parameters == | ||
| - | <div newline></div> | ||
| - | ** {{wiki:ProtectedMethod.gif|}} 5xM=(Object) ** | ||
| - | |||
| - | * //N/A// | ||
| - | == Remarks == | ||
| - | * //N/A// | ||
| - | |||
| - | == Return Value == | ||
| - | * Type:Void | ||
| - | * Description:N/A | ||
| - | |||
| - | == Parameters == | ||
| - | * //target// | ||
| - | * Type:Object | ||
| - | * Description:N/A | ||
| - | |||
| - | <div newline></div> | ||
| - | ** {{wiki:ProtectedMethod.gif|}} 3xM=(Page) ** | ||
| - | |||
| - | * //N/A// | ||
| - | == Remarks == | ||
| - | * //N/A// | ||
| - | |||
| - | == Return Value == | ||
| - | * Type:Void | ||
| - | * Description:N/A | ||
| - | |||
| - | == Parameters == | ||
| - | * //page// | ||
| - | * Type:Page | ||
| - | * Description:N/A | ||
| - | |||
| - | <div newline></div> | ||
| - | ** {{wiki:ProtectedMethod.gif|}} 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 == | ||
| - | * Type:Void | ||
| - | * Description:N/A | ||
| - | |||
| - | == Parameters == | ||
| - | * //page// | ||
| - | * Type:Page | ||
| - | * Description:The page object that is used for registering the javascript library. | ||
| - | |||
| - | <div newline></div> | ||
| - | ** {{wiki:ProtectedMethod.gif|}} RaiseTickEvent(EventArgs) ** | ||
| - | |||
| - | * //N/A// | ||
| - | == Remarks == | ||
| - | * //N/A// | ||
| - | |||
| - | == Return Value == | ||
| - | * Type:Void | ||
| - | * Description:N/A | ||
| - | |||
| - | == Parameters == | ||
| - | * //e// | ||
| - | * Type:EventArgs | ||
| - | * Description:N/A | ||
| - | |||
| - | <div newline></div> | ||
| - | ** {{wiki:ProtectedMethod.gif|}} OnTick(EventArgs) ** | ||
| - | |||
| - | * //Raises the Tick event of the MarkerOverlay.// | ||
| - | == Remarks == | ||
| - | * //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 == | ||
| - | * Type:Void | ||
| - | * Description:N/A | ||
| - | |||
| - | == Parameters == | ||
| - | * //e// | ||
| - | * Type:EventArgs | ||
| - | * Description:An System.EventArgs object that contains the event data. | ||
| - | |||
| - | <div newline></div> | ||
| - | ** {{wiki:ProtectedMethod.gif|}} Finalize() ** | ||
| - | |||
| - | * //N/A// | ||
| - | == Remarks == | ||
| - | * //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 == | ||
| - | * Type:Void | ||
| - | * Description:N/A | ||
| - | |||
| - | == Parameters == | ||
| - | <div newline></div> | ||
| - | ** {{wiki:ProtectedMethod.gif|}} MemberwiseClone() ** | ||
| - | |||
| - | * //N/A// | ||
| - | == Remarks == | ||
| - | * //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 == | ||
| - | * Type:Object | ||
| - | * Description:N/A | ||
| - | |||
| - | == Parameters == | ||
| - | <div newline></div> | ||
| - | ==== Public Properties ==== | ||
| - | ** {{wiki:PublicProperty.gif|}} HighlightStyle ** | ||
| - | |||
| - | Gets or sets a FeatureOverlayStyle that will be applied to the features when the mouse pointer is over them. | ||
| - | == Remarks == | ||
| - | For the most updated Info for this topic, please check it here:http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.HighlightFeatureOverlay#HighlightStyle | ||
| - | == Return Value == | ||
| - | * Type:[[ThinkGeo.MapSuite.WebEdition.FeatureOverlayStyle|FeatureOverlayStyle]] | ||
| - | |||
| - | ** {{wiki:PublicProperty.gif|}} ContextMenu ** | ||
| - | |||
| - | Gets or sets the shortcut menu associated with the HighlightFeatureOverlay. | ||
| - | == Remarks == | ||
| - | For the most updated Info for this topic, please check it here:http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.HighlightFeatureOverlay#ContextMenu | ||
| - | == Return Value == | ||
| - | * Type:[[ThinkGeo.MapSuite.WebEdition.ContextMenu|ContextMenu]] | ||
| - | |||
| - | ** {{wiki:PublicProperty.gif|}} OnClientClick ** | ||
| - | |||
| - | Gets or sets the client-side script that executes when the HighlightFeatureOverlay is clicked. | ||
| - | == Remarks == | ||
| - | For the most updated Info for this topic, please check it here:http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.HighlightFeatureOverlay#OnClientClick | ||
| - | == Return Value == | ||
| - | * Type:String | ||
| - | |||
| - | ** {{wiki:PublicProperty.gif|}} 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:http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.HighlightFeatureOverlay#Features | ||
| - | == Return Value == | ||
| - | * Type:[[ThinkGeo.MapSuite.Core.GeoCollection<T>[[ThinkGeo.MapSuite.Core.Feature, MapSuiteCore, Version=9.0.0.0, Culture=neutral, PublicKeyToken=null]]|GeoCollection<T>]] | ||
| - | |||
| - | ** {{wiki:PublicProperty.gif|}} FeatureSource ** | ||
| - | |||
| - | Gets the FeatureSource of the FeatureOverlay. | ||
| - | == Remarks == | ||
| - | For the most updated Info for this topic, please check it here:http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.HighlightFeatureOverlay#FeatureSource | ||
| - | == Return Value == | ||
| - | * Type:[[ThinkGeo.MapSuite.Core.InMemoryFeatureSource|InMemoryFeatureSource]] | ||
| - | |||
| - | ** {{wiki:PublicProperty.gif|}} 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:http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.HighlightFeatureOverlay#Columns | ||
| - | == Return Value == | ||
| - | * Type:Collection<[[ThinkGeo.MapSuite.Core.FeatureSourceColumn|FeatureSourceColumn]]> | ||
| - | |||
| - | ** {{wiki:PublicProperty.gif|}} 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:http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.HighlightFeatureOverlay#HighlightStyle | ||
| - | == Return Value == | ||
| - | * Type:[[ThinkGeo.MapSuite.WebEdition.FeatureOverlayStyle|FeatureOverlayStyle]] | ||
| - | |||
| - | ** {{wiki:PublicProperty.gif|}} 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:http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.HighlightFeatureOverlay#QueryTools | ||
| - | == Return Value == | ||
| - | * Type:[[ThinkGeo.MapSuite.Core.QueryTools|QueryTools]] | ||
| - | |||
| - | ** {{wiki:PublicProperty.gif|}} 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:http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.HighlightFeatureOverlay#EditTools | ||
| - | == Return Value == | ||
| - | * Type:[[ThinkGeo.MapSuite.Core.EditTools|EditTools]] | ||
| - | |||
| - | ** {{wiki:PublicProperty.gif|}} 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:http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.HighlightFeatureOverlay#IsVisible | ||
| - | == Return Value == | ||
| - | * Type:Boolean | ||
| - | |||
| - | ** {{wiki:PublicProperty.gif|}} 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:http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.HighlightFeatureOverlay#Name | ||
| - | == Return Value == | ||
| - | * Type:String | ||
| - | |||
| - | ** {{wiki:PublicProperty.gif|}} 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 == | ||
| - | * Type:Single | ||
| - | |||
| - | ** {{wiki:PublicProperty.gif|}} 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:http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.HighlightFeatureOverlay#IsVisibleInOverlaySwitcher | ||
| - | == Return Value == | ||
| - | * Type:Boolean | ||
| - | |||
| - | ** {{wiki:PublicProperty.gif|}} 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:http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.HighlightFeatureOverlay#IsBaseOverlay | ||
| - | == Return Value == | ||
| - | * Type:Boolean | ||
| - | |||
| - | ** {{wiki:PublicProperty.gif|}} Id ** | ||
| - | |||
| - | Gets the identifier for the overlay to be found. | ||
| - | == Remarks == | ||
| - | For the most updated Info for this topic, please check it here:http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.HighlightFeatureOverlay#Id | ||
| - | == Return Value == | ||
| - | * Type:String | ||
| - | |||
| - | ** {{wiki:PublicProperty.gif|}} 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:http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.HighlightFeatureOverlay#AutoRefreshInterval | ||
| - | == Return Value == | ||
| - | * Type:TimeSpan | ||
| - | |||
| - | ** {{wiki:PublicProperty.gif|}} Attribution ** | ||
| - | |||
| - | N/A | ||
| - | == Remarks == | ||
| - | For the most updated Info for this topic, please check it here:http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.HighlightFeatureOverlay#Attribution | ||
| - | == Return Value == | ||
| - | * Type:String | ||
| - | |||
| - | ==== Protected Properties ==== | ||
| - | ** {{wiki:ProtectedProperty.gif|}} HasClickEvent ** | ||
| - | |||
| - | Gets a flag that check whether it raise an event on the client side. | ||
| - | == Remarks == | ||
| - | For the most updated Info for this topic, please check it here:http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.HighlightFeatureOverlay#HasClickEvent | ||
| - | == Return Value == | ||
| - | * Type:Boolean | ||
| - | |||
| - | ** {{wiki:ProtectedProperty.gif|}} JsonFeatures ** | ||
| - | |||
| - | N/A | ||
| - | == Remarks == | ||
| - | N/A | ||
| - | == Return Value == | ||
| - | * Type:Collection<[[ThinkGeo.MapSuite.Core.Feature|Feature]]> | ||
| - | |||
| - | ** {{wiki:ProtectedProperty.gif|}} OverlayType ** | ||
| - | |||
| - | N/A | ||
| - | == Remarks == | ||
| - | For the most updated Info for this topic, please check it here:http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.HighlightFeatureOverlay#OverlayType | ||
| - | == Return Value == | ||
| - | * Type:String | ||
| - | |||
| - | ** {{wiki:ProtectedProperty.gif|}} HasTickEvent ** | ||
| - | |||
| - | Indicates whether the overlay supports tick event. | ||
| - | == Remarks == | ||
| - | For the most updated Info for this topic, please check it here:http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.HighlightFeatureOverlay#HasTickEvent | ||
| - | == Return Value == | ||
| - | * Type:Boolean | ||
| - | |||
| - | ** {{wiki:ProtectedProperty.gif|}} 3hM= ** | ||
| - | |||
| - | N/A | ||
| - | == Remarks == | ||
| - | N/A | ||
| - | == Return Value == | ||
| - | * Type:Double | ||
| - | |||
| - | ==== Public Events ==== | ||
| - | ** {{wiki:PublicEvent.gif|}} Click ** | ||
| - | Occurs when the HighlightFeatureOverlay is clicked. | ||
| - | == Remarks == | ||
| - | 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]] | ||
| - | |||
| - | ** {{wiki:PublicEvent.gif|}} 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:http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.HighlightFeatureOverlay#OnTick.28EventArgs.29 | ||
| - | |||
| - | Event Arguments:EventArgs | ||
| - | |||
thinkgeo.mapsuite.webedition.highlightfeatureoverlay.1442911724.txt.gz ยท Last modified: 2015/09/22 08:48 by admin
