User Tools

Site Tools


thinkgeo.mapsuite.mvcedition.highlightfeatureoverlay

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Next revision
Previous revision
thinkgeo.mapsuite.mvcedition.highlightfeatureoverlay [2015/08/20 03:08]
127.0.0.1 external edit
— (current)
Line 1: Line 1:
-====== 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 ==== 
-^ Name ^ Parameters ^ DeclaringType ^ Summary ^ 
-| {{wiki:​PublicMethod.gif|Public Method}}[[#​Equals(Object)|Equals]] ​  | Object ​  | Object ​  ​| ​   | 
-| {{wiki:​PublicMethod.gif|Public Method}}[[#​FromJson(String)|FromJson]] ​  | String ​  | [[ThinkGeo.MapSuite.MvcEdition.Overlay|Overlay]] ​  | Load this object from a json string. ​  | 
-| {{wiki:​PublicMethod.gif|Public Method}}[[#​GetHashCode()|GetHashCode]] ​  ​| ​   | Object ​  ​| ​   | 
-| {{wiki:​PublicMethod.gif|Public Method}}[[#​GetType()|GetType]] ​  ​| ​   | Object ​  ​| ​   | 
-| {{wiki:​PublicMethod.gif|Public Method}}[[#​ToJson()|ToJson]] ​  ​| ​   | [[ThinkGeo.MapSuite.MvcEdition.Overlay|Overlay]] ​  | Returns a JSON string which contains the information for creating an overlay at the client side.   | 
-| {{wiki:​PublicMethod.gif|Public Method}}[[#​ToString()|ToString]] ​  ​| ​   | Object ​  ​| ​   | 
- 
-==== Protected Methods ==== 
-^ Name ^ Parameters ^ DeclaringType ^ Summary ^ 
-| {{wiki:​ProtectedMethod.gif|Protected Method}}[[#​Finalize()|Finalize]] ​  ​| ​   | Object ​  ​| ​   | 
-| {{wiki:​ProtectedMethod.gif|Protected Method}}[[#​MemberwiseClone()|MemberwiseClone]] ​  ​| ​   | Object ​  ​| ​   | 
-| {{wiki:​ProtectedMethod.gif|Protected Method}}[[#​RegisterJavaScriptLibraryCore(Page)|RegisterJavaScriptLibraryCore]] ​  | Page   | [[ThinkGeo.MapSuite.MvcEdition.Overlay|Overlay]] ​  | Registers a Javascript library URL string to the client HTML page.   | 
- 
-==== Public Properties ==== 
-^ Name ^ Return ^ DeclaringType ^ Summary ^ 
-| {{wiki:​PublicProperty.gif|Public Property}}[[#​Attribution|Attribution]] ​  | String ​  | [[ThinkGeo.MapSuite.MvcEdition.Overlay|Overlay]] ​  ​| ​   | 
-| {{wiki:​PublicProperty.gif|Public Property}}[[#​AutoRefreshInterval|AutoRefreshInterval]] ​  | TimeSpan ​  | [[ThinkGeo.MapSuite.MvcEdition.Overlay|Overlay]] ​  | Gets or sets the time interval in which the MarkerOverlay refreshes itself. ​  | 
-| {{wiki:​PublicProperty.gif|Public Property}}[[#​Columns|Columns]] ​  | Collection<​[[ThinkGeo.MapSuite.Core.FeatureSourceColumn|FeatureSourceColumn]]> ​  | [[ThinkGeo.MapSuite.MvcEdition.FeatureOverlay|FeatureOverlay]] ​  | Gets a collection of FeatureSourceColumns,​ which specifies the column names of the feature data.   | 
-| {{wiki:​PublicProperty.gif|Public Property}}[[#​ContextMenu|ContextMenu]] ​  | [[ThinkGeo.MapSuite.MvcEdition.ContextMenu|ContextMenu]] ​  ​| ​   | Gets or sets the shortcut menu associated with the HighlightFeatureOverlay. ​  | 
-| {{wiki:​PublicProperty.gif|Public Property}}[[#​EditTools|EditTools]] ​  | [[ThinkGeo.MapSuite.Core.EditTools|EditTools]] ​  | [[ThinkGeo.MapSuite.MvcEdition.FeatureOverlay|FeatureOverlay]] ​  | Gets the EditTools that allow you to easily edit features in the FeatureOverlay. ​  | 
-| {{wiki:​PublicProperty.gif|Public Property}}[[#​FeatureSource|FeatureSource]] ​  | [[ThinkGeo.MapSuite.Core.InMemoryFeatureSource|InMemoryFeatureSource]] ​  | [[ThinkGeo.MapSuite.MvcEdition.FeatureOverlay|FeatureOverlay]] ​  | Gets the FeatureSource of the FeatureOverlay. ​  | 
-| {{wiki:​PublicProperty.gif|Public Property}}[[#​Features|Features]] ​  | [[ThinkGeo.MapSuite.Core.GeoCollection|GeoCollection]]<​[[ThinkGeo.MapSuite.Core.Feature|Feature]]> ​  | [[ThinkGeo.MapSuite.MvcEdition.FeatureOverlay|FeatureOverlay]] ​  | Gets a collection of features that will be serialized to the client for drawing and editing. ​  | 
-| {{wiki:​PublicProperty.gif|Public Property}}[[#​HighlightStyle|HighlightStyle]] ​  | [[ThinkGeo.MapSuite.MvcEdition.FeatureOverlayStyle|FeatureOverlayStyle]] ​  ​| ​   | Gets or sets a FeatureOverlayStyle that will be applied to the features when the mouse pointer is over them.   | 
-| {{wiki:​PublicProperty.gif|Public Property}}[[#​Id|Id]] ​  | String ​  | [[ThinkGeo.MapSuite.MvcEdition.Overlay|Overlay]] ​  | Gets the identifier for the overlay to be found. ​  | 
-| {{wiki:​PublicProperty.gif|Public Property}}[[#​IsBaseOverlay|IsBaseOverlay]] ​  | Boolean ​  | [[ThinkGeo.MapSuite.MvcEdition.Overlay|Overlay]] ​  | Gets or sets a value that indicates whether the overlay is a base overlay. ​  | 
-| {{wiki:​PublicProperty.gif|Public Property}}[[#​IsVisible|IsVisible]] ​  | Boolean ​  | [[ThinkGeo.MapSuite.MvcEdition.Overlay|Overlay]] ​  | Gets or sets a value that indicates whether the overlay is visible on the map.   | 
-| {{wiki:​PublicProperty.gif|Public Property}}[[#​IsVisibleInOverlaySwitcher|IsVisibleInOverlaySwitcher]] ​  | Boolean ​  | [[ThinkGeo.MapSuite.MvcEdition.Overlay|Overlay]] ​  | Gets or sets a value that indicates whether the overlay name is displayed in the OverlaySwitcher. ​  | 
-| {{wiki:​PublicProperty.gif|Public Property}}[[#​Name|Name]] ​  | String ​  | [[ThinkGeo.MapSuite.MvcEdition.Overlay|Overlay]] ​  | Gets or sets the name of the overlay, which will display in the OverlaySwitcher. ​  | 
-| {{wiki:​PublicProperty.gif|Public Property}}[[#​OnClientAutoRefreshTick|OnClientAutoRefreshTick]] ​  | String ​  | [[ThinkGeo.MapSuite.MvcEdition.Overlay|Overlay]] ​  | Gets or sets a JavaScript function name which will be executed when the number of milliseconds specified in the AutoRefreshInterval property has elapsed. ​  | 
-| {{wiki:​PublicProperty.gif|Public Property}}[[#​OnClientClick|OnClientClick]] ​  | String ​  ​| ​   | Gets or sets the client-side script that executes when the HighlightFeatureOverlay is clicked. ​  | 
-| {{wiki:​PublicProperty.gif|Public Property}}[[#​Opacity|Opacity]] ​  | Single ​  | [[ThinkGeo.MapSuite.MvcEdition.Overlay|Overlay]] ​  | Gets or sets the opacity level of the overlay. ​  | 
-| {{wiki:​PublicProperty.gif|Public Property}}[[#​QueryTools|QueryTools]] ​  | [[ThinkGeo.MapSuite.Core.QueryTools|QueryTools]] ​  | [[ThinkGeo.MapSuite.MvcEdition.FeatureOverlay|FeatureOverlay]] ​  | Gets the QueryTools that allow you to easily query features from the FeatureOverlay. ​  | 
-| {{wiki:​PublicProperty.gif|Public Property}}[[#​Style|Style]] ​  | [[ThinkGeo.MapSuite.MvcEdition.FeatureOverlayStyle|FeatureOverlayStyle]] ​  | [[ThinkGeo.MapSuite.MvcEdition.FeatureOverlay|FeatureOverlay]] ​  | Gets or sets a FeatureOverlayStyle object, which determines how the features are drawn at the client side.   | 
- 
-==== Protected Properties ==== 
-^ Name ^ Return ^ DeclaringType ^ Summary ^ 
-| {{wiki:​ProtectedProperty.gif|Protected Property}}[[#​OverlayType|OverlayType]] ​  | String ​  | [[ThinkGeo.MapSuite.MvcEdition.Overlay|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 --> 
-[[#Public Methods|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 --> 
-[[#Public Methods|Go Back]] 
-==== GetHashCode() ==== 
-=== Return Value === 
-^ Return Type ^ Description ^ 
-| Int32<​!-- System.Int32 --> ​  ​| ​   | 
- 
-=== Parameters === 
-^  Name ^  Type ^  Description ^ 
- 
-<!-- System.Object --> 
-[[#Public Methods|Go Back]] 
-==== GetType() ==== 
-=== Return Value === 
-^ Return Type ^ Description ^ 
-| Type<!-- System.Type --> ​  ​| ​   | 
- 
-=== Parameters === 
-^  Name ^  Type ^  Description ^ 
- 
-<!-- System.Object --> 
-[[#Public Methods|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 --> 
-[[#Public Methods|Go Back]] 
-==== ToString() ==== 
-=== Return Value === 
-^ Return Type ^ Description ^ 
-| String<​!-- System.String --> ​  ​| ​   | 
- 
-=== Parameters === 
-^  Name ^  Type ^  Description ^ 
- 
-<!-- System.Object --> 
-[[#Public Methods|Go Back]] 
-===== Protected Methods ===== 
-==== Finalize() ==== 
-=== Return Value === 
-^ Return Type ^ Description ^ 
-| Void<!-- System.Void --> ​  ​| ​   | 
- 
-=== Parameters === 
-^  Name ^  Type ^  Description ^ 
- 
-<!-- System.Object --> 
-[[#​Protected Methods|Go Back]] 
-==== MemberwiseClone() ==== 
-=== Return Value === 
-^ Return Type ^ Description ^ 
-| Object<​!-- System.Object --> ​  ​| ​   | 
- 
-=== Parameters === 
-^  Name ^  Type ^  Description ^ 
- 
-<!-- System.Object --> 
-[[#​Protected Methods|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 --> 
-[[#​Protected Methods|Go Back]] 
-===== Public Properties ===== 
-==== Attribution ==== 
-=== Return Value === 
-^ Return Type ^ 
-| String<​!-- System.String --> ​  | 
- 
-<!-- ThinkGeo.MapSuite.MvcEdition.Overlay --> 
-[[#Public Properties|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 --> 
-[[#Public Properties|Go Back]] 
-==== Columns ==== 
-Gets a collection of FeatureSourceColumns,​ which specifies the column names of the feature data. 
-=== Return Value === 
-^ Return Type ^ 
-| Collection<​[[ThinkGeo.MapSuite.Core.FeatureSourceColumn|FeatureSourceColumn]]><​!-- System.Collections.ObjectModel.Collection{ThinkGeo.MapSuite.Core.FeatureSourceColumn} --> ​  | 
- 
-<!-- ThinkGeo.MapSuite.MvcEdition.FeatureOverlay --> 
-[[#Public Properties|Go Back]] 
-==== ContextMenu ==== 
-Gets or sets the shortcut menu associated with the HighlightFeatureOverlay. 
-=== Return Value === 
-^ Return Type ^ 
-| [[ThinkGeo.MapSuite.MvcEdition.ContextMenu|ContextMenu]]<​!-- ThinkGeo.MapSuite.MvcEdition.ContextMenu --> ​  | 
- 
-<!-- ThinkGeo.MapSuite.MvcEdition.HighlightFeatureOverlay --> 
-[[#Public Properties|Go Back]] 
-==== EditTools ==== 
-Gets the EditTools that allow you to easily edit features in the FeatureOverlay. 
-=== Return Value === 
-^ Return Type ^ 
-| [[ThinkGeo.MapSuite.Core.EditTools|EditTools]]<​!-- ThinkGeo.MapSuite.Core.EditTools --> ​  | 
- 
-<!-- ThinkGeo.MapSuite.MvcEdition.FeatureOverlay --> 
-[[#Public Properties|Go Back]] 
-==== FeatureSource ==== 
-Gets the FeatureSource of the FeatureOverlay. 
-=== Return Value === 
-^ Return Type ^ 
-| [[ThinkGeo.MapSuite.Core.InMemoryFeatureSource|InMemoryFeatureSource]]<​!-- ThinkGeo.MapSuite.Core.InMemoryFeatureSource --> ​  | 
- 
-<!-- ThinkGeo.MapSuite.MvcEdition.FeatureOverlay --> 
-[[#Public Properties|Go Back]] 
-==== Features ==== 
-Gets a collection of features that will be serialized to the client for drawing and editing. 
-=== Return Value === 
-^ Return Type ^ 
-| [[ThinkGeo.MapSuite.Core.GeoCollection|GeoCollection]]<​[[ThinkGeo.MapSuite.Core.Feature|Feature]]><​!-- ThinkGeo.MapSuite.Core.GeoCollection{ThinkGeo.MapSuite.Core.Feature} --> ​  | 
- 
-<!-- ThinkGeo.MapSuite.MvcEdition.FeatureOverlay --> 
-[[#Public Properties|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 ^ 
-| [[ThinkGeo.MapSuite.MvcEdition.FeatureOverlayStyle|FeatureOverlayStyle]]<​!-- ThinkGeo.MapSuite.MvcEdition.FeatureOverlayStyle --> ​  | 
- 
-<!-- ThinkGeo.MapSuite.MvcEdition.HighlightFeatureOverlay --> 
-[[#Public Properties|Go Back]] 
-==== Id ==== 
-Gets the identifier for the overlay to be found. 
-=== Return Value === 
-^ Return Type ^ 
-| String<​!-- System.String --> ​  | 
- 
-<!-- ThinkGeo.MapSuite.MvcEdition.Overlay --> 
-[[#Public Properties|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 --> 
-[[#Public Properties|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 --> 
-[[#Public Properties|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 --> 
-[[#Public Properties|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 --> 
-[[#Public Properties|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 --> 
-[[#Public Properties|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 --> 
-[[#Public Properties|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 --> 
-[[#Public Properties|Go Back]] 
-==== QueryTools ==== 
-Gets the QueryTools that allow you to easily query features from the FeatureOverlay. 
-=== Return Value === 
-^ Return Type ^ 
-| [[ThinkGeo.MapSuite.Core.QueryTools|QueryTools]]<​!-- ThinkGeo.MapSuite.Core.QueryTools --> ​  | 
- 
-<!-- ThinkGeo.MapSuite.MvcEdition.FeatureOverlay --> 
-[[#Public Properties|Go Back]] 
-==== Style ==== 
-Gets or sets a FeatureOverlayStyle object, which determines how the features are drawn at the client side. 
-=== Return Value === 
-^ Return Type ^ 
-| [[ThinkGeo.MapSuite.MvcEdition.FeatureOverlayStyle|FeatureOverlayStyle]]<​!-- ThinkGeo.MapSuite.MvcEdition.FeatureOverlayStyle --> ​  | 
- 
-<!-- ThinkGeo.MapSuite.MvcEdition.FeatureOverlay --> 
-[[#Public Properties|Go Back]] 
-===== Protected Properties ===== 
-==== OverlayType ==== 
-=== Return Value === 
-^ Return Type ^ 
-| String<​!-- System.String --> ​  | 
- 
-<!-- ThinkGeo.MapSuite.MvcEdition.Overlay(overriden) --> 
-[[#​Protected Properties|Go Back]] 
-===== Public Events ===== 
-__NOTOC__ 
-[[Category:​MvcEdition]] 
-[[Category:​ThinkGeo.MapSuite.MvcEdition]] 
-[[Category:​UpdateDocumentation]] 
  
thinkgeo.mapsuite.mvcedition.highlightfeatureoverlay.1440040131.txt.gz ยท Last modified: 2015/09/21 03:33 (external edit)