ThinkGeo.MapSuite.MvcEdition.OverlaySetting‹TOverlay,_TSetting›
Note: The page was created before Map Suite 10. Map Suite 10.0 organized many classes into new namespaces and assemblies as well as had a few minor breaks in compatibility. The majority of previously built code should work without modification assuming the new namespaces are added. For guidance on upgrading your existing code, please check out MapSuite 10 Upgrade Guide.
<!– Class –>
A setting for Overlay that contains APIs to set properties of OverlaySetting using in MVC view.
Inheritance Hierarchy
Members Summary
Public Constructors
| Name | Parameters | DeclaringType | Summary |
Protected Constructors
Public Methods
| Name | Parameters | DeclaringType | Summary |
 AutoRefreshInterval | TimeSpan | OverlaySetting<TOverlay,TSetting> | Sets timeSpan for Element property and retun the OverlaySetting |
| Equals | Object | Object | |
| GetHashCode | | Object | |
| GetType | | Object | |
| Id | String | OverlaySetting<TOverlay,TSetting> | Sets id for Element property and retun the OverlaySetting |
| IsBaseOverlay | Boolean | OverlaySetting<TOverlay,TSetting> | Sets isBaseOverlay for Element property and retun the OverlaySetting |
| IsVisible | Boolean | OverlaySetting<TOverlay,TSetting> | Sets isVisible for Element property and retun the OverlaySetting |
| IsVisibleInOverlaySwitcher | Boolean | OverlaySetting<TOverlay,TSetting> | Sets isVisibleInOverlaySwitcher for Element property and retun the OverlaySetting |
| Name | String | OverlaySetting<TOverlay,TSetting> | Sets name for Element property and retun the OverlaySetting |
| OnClientAutoRefreshTick | String | OverlaySetting<TOverlay,TSetting> | Sets the JavaScript function name which will be executed when the number of milliseconds specified in the AutoRefreshInterval property has elapsed. |
| Opacity | Single | OverlaySetting<TOverlay,TSetting> | Sets opacity for Element property and retun the OverlaySetting |
| ToString | | Object | |
Protected Methods
Public Properties
| Name | Return | DeclaringType | Summary |
Protected Properties
| Name | Return | DeclaringType | Summary |
 Element | TOverlay | MvcElementSettingBase<TOverlay,TSetting> | |
Public Events
| Name | Event Arguments | DeclaringType | Summary |
Public Constructors
Protected Constructors
OverlaySetting‹TOverlay, TSetting›()
Initializes a new instance of the OverlaySetting class.
Parameters
OverlaySetting‹TOverlay, TSetting›(TOverlay)
Parameters
| Name | Type | Description |
| overlay | TOverlay<!– TOverlay –> | |
Go Back
Public Methods
AutoRefreshInterval(TimeSpan)
Sets timeSpan for Element property and retun the OverlaySetting
Return Value
| Return Type | Description |
| TSetting<!– TSetting –> | The setting of OverlaySetting itself |
Parameters
| Name | Type | Description |
| timeSpan | TimeSpan<!– System.TimeSpan –> | A timeSpan for Element property |
<!– ThinkGeo.MapSuite.MvcEdition.OverlaySetting{TOverlay,TSetting} –>
Go Back
Equals(Object)
Return Value
| Return Type | Description |
| Boolean<!– System.Boolean –> | |
Parameters
| Name | Type | Description |
| obj | Object<!– System.Object –> | |
<!– System.Object –>
Go Back
GetHashCode()
Return Value
| Return Type | Description |
| Int32<!– System.Int32 –> | |
Parameters
GetType()
Return Value
| Return Type | Description |
| Type<!– System.Type –> | |
Parameters
Id(String)
Sets id for Element property and retun the OverlaySetting
Return Value
| Return Type | Description |
| TSetting<!– TSetting –> | The setting of OverlaySetting itself |
Parameters
| Name | Type | Description |
| id | String<!– System.String –> | A id for Element property |
<!– ThinkGeo.MapSuite.MvcEdition.OverlaySetting{TOverlay,TSetting} –>
Go Back
IsBaseOverlay(Boolean)
Sets isBaseOverlay for Element property and retun the OverlaySetting
Return Value
| Return Type | Description |
| TSetting<!– TSetting –> | The setting of OverlaySetting itself |
Parameters
| Name | Type | Description |
| isBaseOverlay | Boolean<!– System.Boolean –> | A isBaseOverlay for Element property |
<!– ThinkGeo.MapSuite.MvcEdition.OverlaySetting{TOverlay,TSetting} –>
Go Back
IsVisible(Boolean)
Sets isVisible for Element property and retun the OverlaySetting
Return Value
| Return Type | Description |
| TSetting<!– TSetting –> | The setting of OverlaySetting itself |
Parameters
| Name | Type | Description |
| isVisible | Boolean<!– System.Boolean –> | A isVisible for Element property |
<!– ThinkGeo.MapSuite.MvcEdition.OverlaySetting{TOverlay,TSetting} –>
Go Back
IsVisibleInOverlaySwitcher(Boolean)
Sets isVisibleInOverlaySwitcher for Element property and retun the OverlaySetting
Return Value
| Return Type | Description |
| TSetting<!– TSetting –> | The setting of OverlaySetting itself |
Parameters
| Name | Type | Description |
| isVisibleInOverlaySwitcher | Boolean<!– System.Boolean –> | A isVisibleInOverlaySwitcher for Element property |
<!– ThinkGeo.MapSuite.MvcEdition.OverlaySetting{TOverlay,TSetting} –>
Go Back
Name(String)
Sets name for Element property and retun the OverlaySetting
Return Value
| Return Type | Description |
| TSetting<!– TSetting –> | The setting of OverlaySetting itself |
Parameters
| Name | Type | Description |
| name | String<!– System.String –> | A imageUri for Element property |
<!– ThinkGeo.MapSuite.MvcEdition.OverlaySetting{TOverlay,TSetting} –>
Go Back
OnClientAutoRefreshTick(String)
Sets the JavaScript function name which will be executed when the number of milliseconds specified in the AutoRefreshInterval property has elapsed.
Return Value
| Return Type | Description |
| TSetting<!– TSetting –> | The setting of OverlaySetting itself. |
Parameters
| Name | Type | Description |
| clientTickFunctionName | String<!– System.String –> | The JavaScript function name. |
<!– ThinkGeo.MapSuite.MvcEdition.OverlaySetting{TOverlay,TSetting} –>
Go Back
Opacity(Single)
Sets opacity for Element property and retun the OverlaySetting
Return Value
| Return Type | Description |
| TSetting<!– TSetting –> | The setting of OverlaySetting itself |
Parameters
| Name | Type | Description |
| opacity | Single<!– System.Single –> | A opacity for Element property |
<!– ThinkGeo.MapSuite.MvcEdition.OverlaySetting{TOverlay,TSetting} –>
Go Back
ToString()
Return Value
| Return Type | Description |
| String<!– System.String –> | |
Parameters
Protected Methods
Finalize()
Return Value
| Return Type | Description |
| Void<!– System.Void –> | |
Parameters
MemberwiseClone()
Return Value
| Return Type | Description |
| Object<!– System.Object –> | |
Parameters
Public Properties
Protected Properties
Element
Return Value
| Return Type |
| TOverlay<!– TOverlay –> |
<!– MvcElementSettingBase{TOverlay,TSetting} –>
Go Back
Public Events
OverlaySetting‹TOverlay, TSetting› 
AutoRefreshInterval 
Element