This shows you the differences between two versions of the page.
Next revision | Previous revision | ||
thinkgeo.mapsuite.mvcedition.highlightfeatureoverlay [2015/08/20 03:08] 127.0.0.1 external edit |
thinkgeo.mapsuite.mvcedition.highlightfeatureoverlay [2017/03/16 21:59] (current) |
||
---|---|---|---|
Line 1: | Line 1: | ||
====== ThinkGeo.MapSuite.MvcEdition.HighlightFeatureOverlay ====== | ====== ThinkGeo.MapSuite.MvcEdition.HighlightFeatureOverlay ====== | ||
+ | {{section>upgrade_map_suite_to_10.0}} | ||
- | |||
- | <!-- Class --> | ||
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. | ||
- | === 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 ===== | ===== Inheritance Hierarchy ===== | ||
- | *System.Object | + | *System.Object |
- | **[[ThinkGeo.MapSuite.MvcEdition.Overlay]] | + | *ThinkGeo.MapSuite.MvcEdition.Overlay |
- | ***[[ThinkGeo.MapSuite.MvcEdition.FeatureOverlay]] | + | *ThinkGeo.MapSuite.MvcEdition.FeatureOverlay |
- | ****[[ThinkGeo.MapSuite.MvcEdition.HighlightFeatureOverlay]] | + | ***ThinkGeo.MapSuite.MvcEdition.HighlightFeatureOverlay** |
===== Members Summary ===== | ===== Members Summary ===== | ||
==== Public Constructors ==== | ==== Public Constructors ==== | ||
- | ^ Name ^ Parameters ^ DeclaringType ^ Summary ^ | ||
- | |||
==== Protected Constructors ==== | ==== Protected Constructors ==== | ||
- | ^ Name ^ Parameters ^ DeclaringType ^ Summary ^ | + | ** {{wiki:ProtectedMethod.gif|}} HighlightFeatureOverlay(String) ** |
+ | * //N/A// | ||
+ | == Remarks == | ||
+ | * //N/A// | ||
+ | == Parameters == | ||
+ | * //id// | ||
+ | * Type:String | ||
+ | * Description:N/A | ||
+ | |||
+ | <div newline></div> | ||
==== Public Methods ==== | ==== Public Methods ==== | ||
- | ^ Name ^ Parameters ^ DeclaringType ^ Summary ^ | + | ** {{wiki:PublicMethod.gif|}} ToJson() ** |
- | | {{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 ==== | + | * //N/A// |
- | ^ Name ^ Parameters ^ DeclaringType ^ Summary ^ | + | == Remarks == |
- | | {{wiki:ProtectedMethod.gif|Protected Method}}[[#Finalize()|Finalize]] | | Object | | | + | * //N/A// |
- | | {{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 ==== | + | == Return Value == |
- | ^ Name ^ Return ^ DeclaringType ^ Summary ^ | + | * Type:String |
- | | {{wiki:PublicProperty.gif|Public Property}}[[#Attribution|Attribution]] | String | [[ThinkGeo.MapSuite.MvcEdition.Overlay|Overlay]] | | | + | * Description:N/A |
- | | {{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 ==== | + | == Parameters == |
- | ^ Name ^ Return ^ DeclaringType ^ Summary ^ | + | <div newline></div> |
- | | {{wiki:ProtectedProperty.gif|Protected Property}}[[#OverlayType|OverlayType]] | String | [[ThinkGeo.MapSuite.MvcEdition.Overlay|Overlay]](overriden) | | | + | ** {{wiki:PublicMethod.gif|}} FromJson(String) ** |
- | ==== Public Events ==== | + | * //N/A// |
- | ^ Name ^ Event Arguments ^ DeclaringType ^ Summary ^ | + | == Remarks == |
+ | * //N/A// | ||
- | ===== Public Constructors ===== | + | == Return Value == |
- | ===== Protected Constructors ===== | + | * Type:Void |
- | ===== Public Methods ===== | + | * Description:N/A |
- | ==== Equals(Object) ==== | + | |
- | === Return Value === | + | |
- | ^ Return Type ^ Description ^ | + | |
- | | Boolean<!-- System.Boolean --> | | | + | |
- | === Parameters === | + | == Parameters == |
- | ^ Name ^ Type ^ Description ^ | + | * //jsonString// |
- | | obj | Object<!-- System.Object --> | | | + | * Type:String |
+ | * Description:N/A | ||
- | <!-- System.Object --> | + | <div newline></div> |
- | [[#Public Methods|Go Back]] | + | ** {{wiki:PublicMethod.gif|}} ToString() ** |
- | ==== FromJson(String) ==== | + | |
- | Load this object from a json string. | + | |
- | === Return Value === | + | |
- | ^ Return Type ^ Description ^ | + | |
- | | Void<!-- System.Void --> | | | + | |
- | === Parameters === | + | * //N/A// |
- | ^ Name ^ Type ^ Description ^ | + | == Remarks == |
- | | jsonString | String<!-- System.String --> | a json string | | + | * //N/A// |
- | <!-- ThinkGeo.MapSuite.MvcEdition.Overlay --> | + | == Return Value == |
- | [[#Public Methods|Go Back]] | + | * Type:String |
- | ==== GetHashCode() ==== | + | * Description:N/A |
- | === Return Value === | + | |
- | ^ Return Type ^ Description ^ | + | |
- | | Int32<!-- System.Int32 --> | | | + | |
- | === Parameters === | + | == Parameters == |
- | ^ Name ^ Type ^ Description ^ | + | <div newline></div> |
+ | ** {{wiki:PublicMethod.gif|}} Equals(Object) ** | ||
- | <!-- System.Object --> | + | * //N/A// |
- | [[#Public Methods|Go Back]] | + | == Remarks == |
- | ==== GetType() ==== | + | * //N/A// |
- | === Return Value === | + | |
- | ^ Return Type ^ Description ^ | + | |
- | | Type<!-- System.Type --> | | | + | |
- | === Parameters === | + | == Return Value == |
- | ^ Name ^ Type ^ Description ^ | + | * Type:Boolean |
+ | * Description:N/A | ||
- | <!-- System.Object --> | + | == Parameters == |
- | [[#Public Methods|Go Back]] | + | * //obj// |
- | ==== ToJson() ==== | + | * Type:Object |
- | Returns a JSON string which contains the information for creating an overlay at the client side. | + | * Description:N/A |
- | === Return Value === | + | |
- | ^ Return Type ^ Description ^ | + | |
- | | String<!-- System.String --> | A JSON string which is used to create an overlay at the client side. | | + | |
- | === Parameters === | + | <div newline></div> |
- | ^ Name ^ Type ^ Description ^ | + | ** {{wiki:PublicMethod.gif|}} GetHashCode() ** |
- | <!-- ThinkGeo.MapSuite.MvcEdition.Overlay --> | + | * //N/A// |
- | [[#Public Methods|Go Back]] | + | == Remarks == |
- | ==== ToString() ==== | + | * //N/A// |
- | === Return Value === | + | |
- | ^ Return Type ^ Description ^ | + | |
- | | String<!-- System.String --> | | | + | |
- | === Parameters === | + | == Return Value == |
- | ^ Name ^ Type ^ Description ^ | + | * Type:Int32 |
+ | * Description:N/A | ||
- | <!-- System.Object --> | + | == Parameters == |
- | [[#Public Methods|Go Back]] | + | <div newline></div> |
- | ===== Protected Methods ===== | + | ** {{wiki:PublicMethod.gif|}} GetType() ** |
- | ==== Finalize() ==== | + | |
- | === Return Value === | + | |
- | ^ Return Type ^ Description ^ | + | |
- | | Void<!-- System.Void --> | | | + | |
- | === Parameters === | + | * //N/A// |
- | ^ Name ^ Type ^ Description ^ | + | == Remarks == |
+ | * //N/A// | ||
- | <!-- System.Object --> | + | == Return Value == |
- | [[#Protected Methods|Go Back]] | + | * Type:Type |
- | ==== MemberwiseClone() ==== | + | * Description:N/A |
- | === Return Value === | + | |
- | ^ Return Type ^ Description ^ | + | |
- | | Object<!-- System.Object --> | | | + | |
- | === Parameters === | + | == Parameters == |
- | ^ Name ^ Type ^ Description ^ | + | <div newline></div> |
+ | ==== Protected Methods ==== | ||
+ | ** {{wiki:ProtectedMethod.gif|}} EhQ=(Page) ** | ||
- | <!-- System.Object --> | + | * //N/A// |
- | [[#Protected Methods|Go Back]] | + | == Remarks == |
- | ==== RegisterJavaScriptLibraryCore(Page) ==== | + | * //N/A// |
- | 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 === | + | == Return Value == |
- | ^ Name ^ Type ^ Description ^ | + | * Type:Void |
- | | page | Page<!-- System.Web.UI.Page --> | The page object that is used for registering the javascript library. | | + | * Description:N/A |
- | <!-- ThinkGeo.MapSuite.MvcEdition.Overlay --> | + | == Parameters == |
- | [[#Protected Methods|Go Back]] | + | * //page// |
- | ===== Public Properties ===== | + | * Type:Page |
- | ==== Attribution ==== | + | * Description:N/A |
- | === Return Value === | + | |
- | ^ Return Type ^ | + | |
- | | String<!-- System.String --> | | + | |
- | <!-- ThinkGeo.MapSuite.MvcEdition.Overlay --> | + | <div newline></div> |
- | [[#Public Properties|Go Back]] | + | ** {{wiki:ProtectedMethod.gif|}} RegisterJavaScriptLibraryCore(Page) ** |
- | ==== AutoRefreshInterval ==== | + | |
- | Gets or sets the time interval in which the MarkerOverlay refreshes itself. | + | |
- | === Return Value === | + | |
- | ^ Return Type ^ | + | |
- | | TimeSpan<!-- System.TimeSpan --> | | + | |
- | <!-- ThinkGeo.MapSuite.MvcEdition.Overlay --> | + | * //N/A// |
- | [[#Public Properties|Go Back]] | + | == Remarks == |
- | ==== Columns ==== | + | * //N/A// |
- | 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 --> | + | == Return Value == |
- | [[#Public Properties|Go Back]] | + | * Type:Void |
- | ==== ContextMenu ==== | + | * Description:N/A |
- | 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 --> | + | == Parameters == |
- | [[#Public Properties|Go Back]] | + | * //page// |
- | ==== EditTools ==== | + | * Type:Page |
- | Gets the EditTools that allow you to easily edit features in the FeatureOverlay. | + | * Description:N/A |
- | === Return Value === | + | |
- | ^ Return Type ^ | + | |
- | | [[ThinkGeo.MapSuite.Core.EditTools|EditTools]]<!-- ThinkGeo.MapSuite.Core.EditTools --> | | + | |
- | <!-- ThinkGeo.MapSuite.MvcEdition.FeatureOverlay --> | + | <div newline></div> |
- | [[#Public Properties|Go Back]] | + | ** {{wiki:ProtectedMethod.gif|}} Finalize() ** |
- | ==== FeatureSource ==== | + | |
- | Gets the FeatureSource of the FeatureOverlay. | + | |
- | === Return Value === | + | |
- | ^ Return Type ^ | + | |
- | | [[ThinkGeo.MapSuite.Core.InMemoryFeatureSource|InMemoryFeatureSource]]<!-- ThinkGeo.MapSuite.Core.InMemoryFeatureSource --> | | + | |
- | <!-- ThinkGeo.MapSuite.MvcEdition.FeatureOverlay --> | + | * //N/A// |
- | [[#Public Properties|Go Back]] | + | == Remarks == |
- | ==== Features ==== | + | * //N/A// |
- | 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 --> | + | == Return Value == |
- | [[#Public Properties|Go Back]] | + | * Type:Void |
- | ==== HighlightStyle ==== | + | * Description:N/A |
- | 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 --> | + | == Parameters == |
- | [[#Public Properties|Go Back]] | + | <div newline></div> |
- | ==== Id ==== | + | ** {{wiki:ProtectedMethod.gif|}} MemberwiseClone() ** |
- | Gets the identifier for the overlay to be found. | + | |
- | === Return Value === | + | |
- | ^ Return Type ^ | + | |
- | | String<!-- System.String --> | | + | |
- | <!-- ThinkGeo.MapSuite.MvcEdition.Overlay --> | + | * //N/A// |
- | [[#Public Properties|Go Back]] | + | == Remarks == |
- | ==== IsBaseOverlay ==== | + | * //N/A// |
- | 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 --> | + | == Return Value == |
- | [[#Public Properties|Go Back]] | + | * Type:Object |
- | ==== IsVisible ==== | + | * Description:N/A |
- | 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 --> | + | == Parameters == |
- | [[#Public Properties|Go Back]] | + | <div newline></div> |
- | ==== IsVisibleInOverlaySwitcher ==== | + | ==== Public Properties ==== |
- | Gets or sets a value that indicates whether the overlay name is displayed in the OverlaySwitcher. | + | ** {{wiki:PublicProperty.gif|}} HighlightStyle ** |
- | === Return Value === | + | |
- | ^ Return Type ^ | + | |
- | | Boolean<!-- System.Boolean --> | | + | |
- | <!-- ThinkGeo.MapSuite.MvcEdition.Overlay --> | + | Gets or sets a FeatureOverlayStyle that will be applied to the features when the mouse pointer is over them. |
- | [[#Public Properties|Go Back]] | + | == Remarks == |
- | ==== Name ==== | + | N/A |
- | Gets or sets the name of the overlay, which will display in the OverlaySwitcher. | + | == Return Value == |
- | === Return Value === | + | * Type:[[ThinkGeo.MapSuite.MvcEdition.FeatureOverlayStyle|FeatureOverlayStyle]] |
- | ^ Return Type ^ | + | |
- | | String<!-- System.String --> | | + | |
- | <!-- ThinkGeo.MapSuite.MvcEdition.Overlay --> | + | ** {{wiki:PublicProperty.gif|}} ContextMenu ** |
- | [[#Public Properties|Go Back]] | + | |
- | ==== OnClientAutoRefreshTick ==== | + | Gets or sets the shortcut menu associated with the HighlightFeatureOverlay. |
- | Gets or sets a JavaScript function name which will be executed when the number of milliseconds specified in the AutoRefreshInterval property has elapsed. | + | == Remarks == |
- | === Return Value === | + | N/A |
- | ^ Return Type ^ | + | == Return Value == |
- | | String<!-- System.String --> | | + | * Type:[[ThinkGeo.MapSuite.MvcEdition.ContextMenu|ContextMenu]] |
+ | |||
+ | ** {{wiki:PublicProperty.gif|}} OnClientClick ** | ||
- | <!-- ThinkGeo.MapSuite.MvcEdition.Overlay --> | ||
- | [[#Public Properties|Go Back]] | ||
- | ==== OnClientClick ==== | ||
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 == |
There is a default parameter:e, which includes two parameters: "worldXY", "featureId" | There is a default parameter:e, which includes two parameters: "worldXY", "featureId" | ||
- | === Return Value === | + | == Return Value == |
- | ^ Return Type ^ | + | * Type:String |
- | | String<!-- System.String --> | | + | |
- | <!-- ThinkGeo.MapSuite.MvcEdition.HighlightFeatureOverlay --> | + | ** {{wiki:PublicProperty.gif|}} Features ** |
- | [[#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 --> | + | N/A |
- | [[#Public Properties|Go Back]] | + | == Remarks == |
- | ==== QueryTools ==== | + | N/A |
- | Gets the QueryTools that allow you to easily query features from the FeatureOverlay. | + | == 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>]] |
- | ^ Return Type ^ | + | |
- | | [[ThinkGeo.MapSuite.Core.QueryTools|QueryTools]]<!-- ThinkGeo.MapSuite.Core.QueryTools --> | | + | |
- | <!-- ThinkGeo.MapSuite.MvcEdition.FeatureOverlay --> | + | ** {{wiki:PublicProperty.gif|}} FeatureSource ** |
- | [[#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 --> | + | N/A |
- | [[#Public Properties|Go Back]] | + | == Remarks == |
- | ===== Protected Properties ===== | + | N/A |
- | ==== OverlayType ==== | + | == Return Value == |
- | === Return Value === | + | * Type:[[ThinkGeo.MapSuite.Core.InMemoryFeatureSource|InMemoryFeatureSource]] |
- | ^ Return Type ^ | + | |
- | | String<!-- System.String --> | | + | |
- | <!-- ThinkGeo.MapSuite.MvcEdition.Overlay(overriden) --> | + | ** {{wiki:PublicProperty.gif|}} Columns ** |
- | [[#Protected Properties|Go Back]] | + | |
- | ===== Public Events ===== | + | N/A |
- | __NOTOC__ | + | == Remarks == |
- | [[Category:MvcEdition]] | + | N/A |
- | [[Category:ThinkGeo.MapSuite.MvcEdition]] | + | == Return Value == |
- | [[Category:UpdateDocumentation]] | + | * Type:Collection<[[ThinkGeo.MapSuite.Core.FeatureSourceColumn|FeatureSourceColumn]]> |
+ | |||
+ | ** {{wiki:PublicProperty.gif|}} Style ** | ||
+ | |||
+ | N/A | ||
+ | == Remarks == | ||
+ | N/A | ||
+ | == Return Value == | ||
+ | * Type:[[ThinkGeo.MapSuite.MvcEdition.FeatureOverlayStyle|FeatureOverlayStyle]] | ||
+ | |||
+ | ** {{wiki:PublicProperty.gif|}} QueryTools ** | ||
+ | |||
+ | N/A | ||
+ | == Remarks == | ||
+ | N/A | ||
+ | == Return Value == | ||
+ | * Type:[[ThinkGeo.MapSuite.Core.QueryTools|QueryTools]] | ||
+ | |||
+ | ** {{wiki:PublicProperty.gif|}} EditTools ** | ||
+ | |||
+ | N/A | ||
+ | == Remarks == | ||
+ | N/A | ||
+ | == Return Value == | ||
+ | * Type:[[ThinkGeo.MapSuite.Core.EditTools|EditTools]] | ||
+ | |||
+ | ** {{wiki:PublicProperty.gif|}} IsVisible ** | ||
+ | |||
+ | N/A | ||
+ | == Remarks == | ||
+ | N/A | ||
+ | == Return Value == | ||
+ | * Type:Boolean | ||
+ | |||
+ | ** {{wiki:PublicProperty.gif|}} Name ** | ||
+ | |||
+ | N/A | ||
+ | == Remarks == | ||
+ | N/A | ||
+ | == Return Value == | ||
+ | * Type:String | ||
+ | |||
+ | ** {{wiki:PublicProperty.gif|}} Opacity ** | ||
+ | |||
+ | N/A | ||
+ | == Remarks == | ||
+ | N/A | ||
+ | == Return Value == | ||
+ | * Type:Single | ||
+ | |||
+ | ** {{wiki:PublicProperty.gif|}} IsVisibleInOverlaySwitcher ** | ||
+ | |||
+ | N/A | ||
+ | == Remarks == | ||
+ | N/A | ||
+ | == Return Value == | ||
+ | * Type:Boolean | ||
+ | |||
+ | ** {{wiki:PublicProperty.gif|}} IsBaseOverlay ** | ||
+ | |||
+ | N/A | ||
+ | == Remarks == | ||
+ | N/A | ||
+ | == Return Value == | ||
+ | * Type:Boolean | ||
+ | |||
+ | ** {{wiki:PublicProperty.gif|}} Id ** | ||
+ | |||
+ | N/A | ||
+ | == Remarks == | ||
+ | N/A | ||
+ | == Return Value == | ||
+ | * Type:String | ||
+ | |||
+ | ** {{wiki:PublicProperty.gif|}} OnClientAutoRefreshTick ** | ||
+ | |||
+ | N/A | ||
+ | == Remarks == | ||
+ | N/A | ||
+ | == Return Value == | ||
+ | * Type:String | ||
+ | |||
+ | ** {{wiki:PublicProperty.gif|}} AutoRefreshInterval ** | ||
+ | |||
+ | N/A | ||
+ | == Remarks == | ||
+ | N/A | ||
+ | == Return Value == | ||
+ | * Type:TimeSpan | ||
+ | |||
+ | ** {{wiki:PublicProperty.gif|}} Attribution ** | ||
+ | |||
+ | N/A | ||
+ | == Remarks == | ||
+ | N/A | ||
+ | == Return Value == | ||
+ | * Type:String | ||
+ | |||
+ | ==== Protected Properties ==== | ||
+ | ** {{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 == | ||
+ | N/A | ||
+ | == Return Value == | ||
+ | * Type:String | ||
+ | |||
+ | ** {{wiki:ProtectedProperty.gif|}} ERQ= ** | ||
+ | |||
+ | N/A | ||
+ | == Remarks == | ||
+ | N/A | ||
+ | == Return Value == | ||
+ | * Type:Double | ||
+ | |||
+ | ==== Public Events ==== | ||