thinkgeo.mapsuite.webedition.overlayswitchermaptool
Differences
This shows you the differences between two versions of the page.
| Next revision | Previous revision | ||
|
thinkgeo.mapsuite.webedition.overlayswitchermaptool [2015/08/20 03:08] 127.0.0.1 external edit |
thinkgeo.mapsuite.webedition.overlayswitchermaptool [2017/03/16 21:59] (current) |
||
|---|---|---|---|
| Line 1: | Line 1: | ||
| ====== ThinkGeo.MapSuite.WebEdition.OverlaySwitcherMapTool ====== | ====== ThinkGeo.MapSuite.WebEdition.OverlaySwitcherMapTool ====== | ||
| + | {{section>upgrade_map_suite_to_10.0}} | ||
| - | |||
| - | <!-- Class --> | ||
| Represents a panel in the upper right corner of the map, containing a list of overlays in the map. | Represents a panel in the upper right corner of the map, containing a list of overlays in the map. | ||
| - | === Remarks === | ||
| - | The OverlaySwitcher is a panel that contains a list of overlays and provides you with a means to manage the overlays in the map. You can show or hide an overlay by clicking the checkbox beside its name. You can choose an overlay as the current base overlay by clicking the radio button beside it. Setting the <strong>Enabled</strong> property to true will display this panel on the map. | ||
| ===== Inheritance Hierarchy ===== | ===== Inheritance Hierarchy ===== | ||
| - | *System.Object | + | *System.Object |
| - | **[[ThinkGeo.MapSuite.WebEdition.MapTool]] | + | *ThinkGeo.MapSuite.WebEdition.MapTool |
| - | ***[[ThinkGeo.MapSuite.WebEdition.OverlaySwitcherMapTool]] | + | ***ThinkGeo.MapSuite.WebEdition.OverlaySwitcherMapTool** |
| ===== Members Summary ===== | ===== Members Summary ===== | ||
| ==== Public Constructors ==== | ==== Public Constructors ==== | ||
| - | ^ Name ^ Parameters ^ DeclaringType ^ Summary ^ | + | ** {{wiki:PublicMethod.gif|}} OverlaySwitcherMapTool() ** |
| - | | {{wiki:PublicMethod.gif|Public Method}}[[#OverlaySwitcherMapTool()|OverlaySwitcherMapTool]] | | | Initialize an instance of OverlaySwitcherMapTool class. | | + | |
| + | * //Initialize an instance of OverlaySwitcherMapTool class.// | ||
| + | == Remarks == | ||
| + | * //For the most updated Info for this topic, please check it here:http:wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.OverlaySwitcherMapTool#OverlaySwitcherMapTool.28.29// | ||
| + | == Parameters == | ||
| + | <div newline></div> | ||
| ==== Protected Constructors ==== | ==== Protected Constructors ==== | ||
| - | ^ Name ^ Parameters ^ DeclaringType ^ Summary ^ | ||
| - | |||
| ==== 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}}[[#GetHashCode()|GetHashCode]] | | Object | | | + | |
| - | | {{wiki:PublicMethod.gif|Public Method}}[[#GetType()|GetType]] | | Object | | | + | |
| - | | {{wiki:PublicMethod.gif|Public Method}}[[#ToJson()|ToJson]] | | [[ThinkGeo.MapSuite.WebEdition.MapTool|MapTool]] | Returns a JSON string that represents the map control object. | | + | |
| - | | {{wiki:PublicMethod.gif|Public Method}}[[#ToString()|ToString]] | | Object | | | + | |
| - | ==== Protected Methods ==== | + | * //Returns a JSON string that represents the map control object.// |
| - | ^ Name ^ Parameters ^ DeclaringType ^ Summary ^ | + | == Remarks == |
| - | | {{wiki:ProtectedMethod.gif|Protected Method}}[[#Finalize()|Finalize]] | | Object | | | + | * //This method returns a JSON string that instructs the client Javascript to create a specific client object.// |
| - | | {{wiki:ProtectedMethod.gif|Protected Method}}[[#MemberwiseClone()|MemberwiseClone]] | | Object | | | + | |
| - | ==== Public Properties ==== | + | == Return Value == |
| - | ^ Name ^ Return ^ DeclaringType ^ Summary ^ | + | * Type:String |
| - | | {{wiki:PublicProperty.gif|Public Property}}[[#BackgroundColor|BackgroundColor]] | [[ThinkGeo.MapSuite.Core.GeoColor|GeoColor]] | | Gets or sets the background color of the OverlaySwitcher object. | | + | * Description:A JSON string that represents the map control. |
| - | | {{wiki:PublicProperty.gif|Public Property}}[[#BaseOverlayTitle|BaseOverlayTitle]] | String | | Gets or sets the base overlay part title of OverlaySwitcher panel | | + | |
| - | | {{wiki:PublicProperty.gif|Public Property}}[[#DynamicOverlayTitle|DynamicOverlayTitle]] | String | | Gets or sets the dynamic overlay part title of OverlaySwitcher panel | | + | |
| - | | {{wiki:PublicProperty.gif|Public Property}}[[#Enabled|Enabled]] | Boolean | [[ThinkGeo.MapSuite.WebEdition.MapTool|MapTool]] | Gets or sets a value that turns the feature on and off. | | + | |
| - | | {{wiki:PublicProperty.gif|Public Property}}[[#OnClientBaseOverlayChanged|OnClientBaseOverlayChanged]] | String | | Gets or sets the client-side script that executes after the base overlay changes in the OverlaySwitcher. | | + | |
| - | | {{wiki:PublicProperty.gif|Public Property}}[[#RoundedCornerColor|RoundedCornerColor]] | [[ThinkGeo.MapSuite.Core.GeoColor|GeoColor]] | | Gets or sets the rounded corner color of the OverlaySwitcher object. | | + | |
| - | ==== Protected Properties ==== | + | == Parameters == |
| - | ^ Name ^ Return ^ DeclaringType ^ Summary ^ | + | <div newline></div> |
| + | ** {{wiki:PublicMethod.gif|}} ToString() ** | ||
| - | ==== Public Events ==== | + | * //N/A// |
| - | ^ Name ^ Event Arguments ^ DeclaringType ^ Summary ^ | + | == Remarks == |
| + | * //For the most updated Info for this topic, please check it here:http:wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.OverlaySwitcherMapTool#ToString.28.29// | ||
| - | ===== Public Constructors ===== | + | == Return Value == |
| - | ==== OverlaySwitcherMapTool() ==== | + | * Type:String |
| - | Initialize an instance of OverlaySwitcherMapTool class. | + | * Description:N/A |
| - | === Remarks === | + | |
| - | For the most updated Info for this topic, please check it here:<a href="http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.OverlaySwitcherMapTool#OverlaySwitcherMapTool.28.29" target="_blank">http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.OverlaySwitcherMapTool#OverlaySwitcherMapTool.28.29</a> | + | |
| - | === Parameters === | + | |
| - | ^ Name ^ Type ^ Description ^ | + | |
| - | [[#Public Constructors|Go Back]] | + | == Parameters == |
| - | ===== Protected Constructors ===== | + | <div newline></div> |
| - | ===== Public Methods ===== | + | ** {{wiki:PublicMethod.gif|}} Equals(Object) ** |
| - | ==== Equals(Object) ==== | + | |
| - | === Remarks === | + | |
| - | For the most updated Info for this topic, please check it here:<a href="http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.OverlaySwitcherMapTool#Equals.28Object.29" target="_blank">http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.OverlaySwitcherMapTool#Equals.28Object.29</a> | + | |
| - | === Return Value === | + | |
| - | ^ Return Type ^ Description ^ | + | |
| - | | Boolean<!-- System.Boolean --> | | | + | |
| - | === Parameters === | + | * //N/A// |
| - | ^ Name ^ Type ^ Description ^ | + | == Remarks == |
| - | | obj | Object<!-- System.Object --> | | | + | * //For the most updated Info for this topic, please check it here:http:wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.OverlaySwitcherMapTool#Equals.28Object.29// |
| - | <!-- System.Object --> | + | == Return Value == |
| - | [[#Public Methods|Go Back]] | + | * Type:Boolean |
| - | ==== GetHashCode() ==== | + | * Description:N/A |
| - | === Remarks === | + | |
| - | For the most updated Info for this topic, please check it here:<a href="http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.OverlaySwitcherMapTool#GetHashCode.28.29" target="_blank">http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.OverlaySwitcherMapTool#GetHashCode.28.29</a> | + | |
| - | === Return Value === | + | |
| - | ^ Return Type ^ Description ^ | + | |
| - | | Int32<!-- System.Int32 --> | | | + | |
| - | === Parameters === | + | == Parameters == |
| - | ^ Name ^ Type ^ Description ^ | + | * //obj// |
| + | * Type:Object | ||
| + | * Description:N/A | ||
| - | <!-- System.Object --> | + | <div newline></div> |
| - | [[#Public Methods|Go Back]] | + | ** {{wiki:PublicMethod.gif|}} GetHashCode() ** |
| - | ==== GetType() ==== | + | |
| - | === Remarks === | + | |
| - | For the most updated Info for this topic, please check it here:<a href="http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.OverlaySwitcherMapTool#GetType.28.29" target="_blank">http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.OverlaySwitcherMapTool#GetType.28.29</a> | + | |
| - | === Return Value === | + | |
| - | ^ Return Type ^ Description ^ | + | |
| - | | Type<!-- System.Type --> | | | + | |
| - | === Parameters === | + | * //N/A// |
| - | ^ Name ^ Type ^ Description ^ | + | == Remarks == |
| + | * //For the most updated Info for this topic, please check it here:http:wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.OverlaySwitcherMapTool#GetHashCode.28.29// | ||
| - | <!-- System.Object --> | + | == Return Value == |
| - | [[#Public Methods|Go Back]] | + | * Type:Int32 |
| - | ==== ToJson() ==== | + | * Description:N/A |
| - | Returns a JSON string that represents the map control object. | + | |
| - | === Remarks === | + | |
| - | This method returns a JSON string that instructs the client Javascript to create a specific client object. | + | |
| - | === Return Value === | + | |
| - | ^ Return Type ^ Description ^ | + | |
| - | | String<!-- System.String --> | A JSON string that represents the map control. | | + | |
| - | === Parameters === | + | == Parameters == |
| - | ^ Name ^ Type ^ Description ^ | + | <div newline></div> |
| + | ** {{wiki:PublicMethod.gif|}} GetType() ** | ||
| - | <!-- ThinkGeo.MapSuite.WebEdition.MapTool --> | + | * //N/A// |
| - | [[#Public Methods|Go Back]] | + | == Remarks == |
| - | ==== ToString() ==== | + | * //For the most updated Info for this topic, please check it here:http:wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.OverlaySwitcherMapTool#GetType.28.29// |
| - | === Remarks === | + | |
| - | For the most updated Info for this topic, please check it here:<a href="http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.OverlaySwitcherMapTool#ToString.28.29" target="_blank">http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.OverlaySwitcherMapTool#ToString.28.29</a> | + | |
| - | === Return Value === | + | |
| - | ^ Return Type ^ Description ^ | + | |
| - | | String<!-- System.String --> | | | + | |
| - | === Parameters === | + | == Return Value == |
| - | ^ Name ^ Type ^ Description ^ | + | * Type:Type |
| + | * Description:N/A | ||
| - | <!-- System.Object --> | + | == Parameters == |
| - | [[#Public Methods|Go Back]] | + | <div newline></div> |
| - | ===== Protected Methods ===== | + | ==== Protected Methods ==== |
| - | ==== Finalize() ==== | + | ** {{wiki:ProtectedMethod.gif|}} Finalize() ** |
| - | === Remarks === | + | |
| - | For the most updated Info for this topic, please check it here:<a href="http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.OverlaySwitcherMapTool#Finalize.28.29" target="_blank">http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.OverlaySwitcherMapTool#Finalize.28.29</a> | + | |
| - | === Return Value === | + | |
| - | ^ Return Type ^ Description ^ | + | |
| - | | Void<!-- System.Void --> | | | + | |
| - | === Parameters === | + | * //N/A// |
| - | ^ Name ^ Type ^ Description ^ | + | == Remarks == |
| + | * //For the most updated Info for this topic, please check it here:http:wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.OverlaySwitcherMapTool#Finalize.28.29// | ||
| - | <!-- System.Object --> | + | == Return Value == |
| - | [[#Protected Methods|Go Back]] | + | * Type:Void |
| - | ==== MemberwiseClone() ==== | + | * Description:N/A |
| - | === Remarks === | + | |
| - | For the most updated Info for this topic, please check it here:<a href="http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.OverlaySwitcherMapTool#MemberwiseClone.28.29" target="_blank">http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.OverlaySwitcherMapTool#MemberwiseClone.28.29</a> | + | |
| - | === Return Value === | + | |
| - | ^ Return Type ^ Description ^ | + | |
| - | | Object<!-- System.Object --> | | | + | |
| - | === Parameters === | + | == Parameters == |
| - | ^ Name ^ Type ^ Description ^ | + | <div newline></div> |
| + | ** {{wiki:ProtectedMethod.gif|}} MemberwiseClone() ** | ||
| - | <!-- System.Object --> | + | * //N/A// |
| - | [[#Protected Methods|Go Back]] | + | == Remarks == |
| - | ===== Public Properties ===== | + | * //For the most updated Info for this topic, please check it here:http:wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.OverlaySwitcherMapTool#MemberwiseClone.28.29// |
| - | ==== BackgroundColor ==== | + | |
| - | Gets or sets the background color of the OverlaySwitcher object. | + | |
| - | === Remarks === | + | |
| - | For the most updated Info for this topic, please check it here:<a href="http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.OverlaySwitcherMapTool#BackgroundColor" target="_blank">http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.OverlaySwitcherMapTool#BackgroundColor</a> | + | |
| - | === Return Value === | + | |
| - | ^ Return Type ^ | + | |
| - | | [[ThinkGeo.MapSuite.Core.GeoColor|GeoColor]]<!-- ThinkGeo.MapSuite.Core.GeoColor --> | | + | |
| - | <!-- ThinkGeo.MapSuite.WebEdition.OverlaySwitcherMapTool --> | + | == Return Value == |
| - | [[#Public Properties|Go Back]] | + | * Type:Object |
| - | ==== BaseOverlayTitle ==== | + | * Description:N/A |
| - | Gets or sets the base overlay part title of OverlaySwitcher panel | + | |
| - | === Remarks === | + | |
| - | For the most updated Info for this topic, please check it here:<a href="http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.OverlaySwitcherMapTool#BaseOverlayTitle" target="_blank">http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.OverlaySwitcherMapTool#BaseOverlayTitle</a> | + | |
| - | === Return Value === | + | |
| - | ^ Return Type ^ | + | |
| - | | String<!-- System.String --> | | + | |
| - | <!-- ThinkGeo.MapSuite.WebEdition.OverlaySwitcherMapTool --> | + | == Parameters == |
| - | [[#Public Properties|Go Back]] | + | <div newline></div> |
| - | ==== DynamicOverlayTitle ==== | + | ==== Public Properties ==== |
| - | Gets or sets the dynamic overlay part title of OverlaySwitcher panel | + | ** {{wiki:PublicProperty.gif|}} OnClientBaseOverlayChanged ** |
| - | === Remarks === | + | |
| - | For the most updated Info for this topic, please check it here:<a href="http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.OverlaySwitcherMapTool#DynamicOverlayTitle" target="_blank">http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.OverlaySwitcherMapTool#DynamicOverlayTitle</a> | + | |
| - | === Return Value === | + | |
| - | ^ Return Type ^ | + | |
| - | | String<!-- System.String --> | | + | |
| - | + | ||
| - | <!-- ThinkGeo.MapSuite.WebEdition.OverlaySwitcherMapTool --> | + | |
| - | [[#Public Properties|Go Back]] | + | |
| - | ==== Enabled ==== | + | |
| - | Gets or sets a value that turns the feature on and off. | + | |
| - | === Remarks === | + | |
| - | For the most updated Info for this topic, please check it here:<a href="http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.OverlaySwitcherMapTool#Enabled" target="_blank">http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.OverlaySwitcherMapTool#Enabled</a> | + | |
| - | === Return Value === | + | |
| - | ^ Return Type ^ | + | |
| - | | Boolean<!-- System.Boolean --> | | + | |
| - | <!-- ThinkGeo.MapSuite.WebEdition.MapTool --> | ||
| - | [[#Public Properties|Go Back]] | ||
| - | ==== OnClientBaseOverlayChanged ==== | ||
| Gets or sets the client-side script that executes after the base overlay changes in the OverlaySwitcher. | Gets or sets the client-side script that executes after the base overlay changes in the OverlaySwitcher. | ||
| - | === Remarks === | + | == Remarks == |
| The Javascript that is set to this property will be injected into the page and executed whenever the BaseOverlayChanged event occurs at the client side. | The Javascript that is set to this property will be injected into the page and executed whenever the BaseOverlayChanged event occurs at the client side. | ||
| - | === Return Value === | + | == Return Value == |
| - | ^ Return Type ^ | + | * Type:String |
| - | | String<!-- System.String --> | | + | |
| + | ** {{wiki:PublicProperty.gif|}} RoundedCornerColor ** | ||
| - | <!-- ThinkGeo.MapSuite.WebEdition.OverlaySwitcherMapTool --> | ||
| - | [[#Public Properties|Go Back]] | ||
| - | ==== RoundedCornerColor ==== | ||
| Gets or sets the rounded corner color of the OverlaySwitcher object. | Gets or sets the rounded corner color of the OverlaySwitcher object. | ||
| - | === Remarks === | + | == Remarks == |
| - | For the most updated Info for this topic, please check it here:<a href="http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.OverlaySwitcherMapTool#RoundedCornerColor" target="_blank">http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.OverlaySwitcherMapTool#RoundedCornerColor</a> | + | For the most updated Info for this topic, please check it here:http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.OverlaySwitcherMapTool#RoundedCornerColor |
| - | === Return Value === | + | == Return Value == |
| - | ^ Return Type ^ | + | * Type:[[ThinkGeo.MapSuite.Core.GeoColor|GeoColor]] |
| - | | [[ThinkGeo.MapSuite.Core.GeoColor|GeoColor]]<!-- ThinkGeo.MapSuite.Core.GeoColor --> | | + | |
| - | <!-- ThinkGeo.MapSuite.WebEdition.OverlaySwitcherMapTool --> | + | ** {{wiki:PublicProperty.gif|}} BackgroundColor ** |
| - | [[#Public Properties|Go Back]] | + | |
| - | ===== Protected Properties ===== | + | Gets or sets the background color of the OverlaySwitcher object. |
| - | ===== Public Events ===== | + | == Remarks == |
| - | __NOTOC__ | + | For the most updated Info for this topic, please check it here:http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.OverlaySwitcherMapTool#BackgroundColor |
| - | [[Category:WebEdition]] | + | == Return Value == |
| - | [[Category:ThinkGeo.MapSuite.WebEdition]] | + | * Type:[[ThinkGeo.MapSuite.Core.GeoColor|GeoColor]] |
| - | [[Category:UpdateDocumentation]] | + | |
| + | ** {{wiki:PublicProperty.gif|}} BaseOverlayTitle ** | ||
| + | |||
| + | Gets or sets the base overlay part title of OverlaySwitcher panel | ||
| + | == Remarks == | ||
| + | For the most updated Info for this topic, please check it here:http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.OverlaySwitcherMapTool#BaseOverlayTitle | ||
| + | == Return Value == | ||
| + | * Type:String | ||
| + | |||
| + | ** {{wiki:PublicProperty.gif|}} DynamicOverlayTitle ** | ||
| + | |||
| + | Gets or sets the dynamic overlay part title of OverlaySwitcher panel | ||
| + | == Remarks == | ||
| + | For the most updated Info for this topic, please check it here:http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.OverlaySwitcherMapTool#DynamicOverlayTitle | ||
| + | == Return Value == | ||
| + | * Type:String | ||
| + | |||
| + | ** {{wiki:PublicProperty.gif|}} Enabled ** | ||
| + | |||
| + | Gets or sets a value that turns the feature on and off. | ||
| + | == Remarks == | ||
| + | For the most updated Info for this topic, please check it here:http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.OverlaySwitcherMapTool#Enabled | ||
| + | == Return Value == | ||
| + | * Type:Boolean | ||
| + | |||
| + | ==== Protected Properties ==== | ||
| + | ==== Public Events ==== | ||
thinkgeo.mapsuite.webedition.overlayswitchermaptool.1440040135.txt.gz · Last modified: 2015/09/18 03:09 (external edit)