This shows you the differences between two versions of the page.
Next revision | Previous revision | ||
thinkgeo.mapsuite.webedition.panzoommaptool [2015/08/20 03:08] 127.0.0.1 external edit |
thinkgeo.mapsuite.webedition.panzoommaptool [2017/03/16 21:59] (current) |
||
---|---|---|---|
Line 1: | Line 1: | ||
====== ThinkGeo.MapSuite.WebEdition.PanZoomMapTool ====== | ====== ThinkGeo.MapSuite.WebEdition.PanZoomMapTool ====== | ||
+ | {{section>upgrade_map_suite_to_10.0}} | ||
- | |||
- | <!-- Class --> | ||
Represents the panning and zooming panel in the upper left corner of the map, by which you can operate the map. | Represents the panning and zooming panel in the upper left corner of the map, by which you can operate the map. | ||
- | === Remarks === | ||
- | The PanZoom map tool contains a panning control and two zooming (in/out) buttons. The panning controls have four panning buttons and a globe button that zooms the map out to show the whole world. Set the <strong>Enabled</strong> property to true to show this tool on the map. | ||
===== Inheritance Hierarchy ===== | ===== Inheritance Hierarchy ===== | ||
- | *System.Object | + | *System.Object |
- | **[[ThinkGeo.MapSuite.WebEdition.MapTool]] | + | *ThinkGeo.MapSuite.WebEdition.MapTool |
- | ***[[ThinkGeo.MapSuite.WebEdition.PanZoomMapTool]] | + | ***ThinkGeo.MapSuite.WebEdition.PanZoomMapTool** |
===== Members Summary ===== | ===== Members Summary ===== | ||
==== Public Constructors ==== | ==== Public Constructors ==== | ||
- | ^ Name ^ Parameters ^ DeclaringType ^ Summary ^ | + | ** {{wiki:PublicMethod.gif|}} PanZoomMapTool() ** |
- | | {{wiki:PublicMethod.gif|Public Method}}[[#PanZoomMapTool()|PanZoomMapTool]] | | | Initialize an instance of the PanZoomMapTool class. | | + | |
+ | * //Initialize an instance of the PanZoomMapTool class.// | ||
+ | == Remarks == | ||
+ | * //For the most updated Info for this topic, please check it here:http:wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.PanZoomMapTool#PanZoomMapTool.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}}[[#Enabled|Enabled]] | Boolean | [[ThinkGeo.MapSuite.WebEdition.MapTool|MapTool]] | Gets or sets a value that turns the feature on and off. | | + | * Description:A JSON string that represents the map control. |
- | | {{wiki:PublicProperty.gif|Public Property}}[[#IsGlobeButtonEnabled|IsGlobeButtonEnabled]] | Boolean | | Gets or sets a boolean value that determines whether the globe button shows in the PanZoom map tool. | | + | |
- | ==== 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.PanZoomMapTool#ToString.28.29// | ||
- | ===== Public Constructors ===== | + | == Return Value == |
- | ==== PanZoomMapTool() ==== | + | * Type:String |
- | Initialize an instance of the PanZoomMapTool 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.PanZoomMapTool#PanZoomMapTool.28.29" target="_blank">http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.PanZoomMapTool#PanZoomMapTool.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.PanZoomMapTool#Equals.28Object.29" target="_blank">http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.PanZoomMapTool#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.PanZoomMapTool#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.PanZoomMapTool#GetHashCode.28.29" target="_blank">http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.PanZoomMapTool#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.PanZoomMapTool#GetType.28.29" target="_blank">http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.PanZoomMapTool#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.PanZoomMapTool#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.PanZoomMapTool#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.PanZoomMapTool#ToString.28.29" target="_blank">http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.PanZoomMapTool#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.PanZoomMapTool#Finalize.28.29" target="_blank">http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.PanZoomMapTool#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.PanZoomMapTool#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.PanZoomMapTool#MemberwiseClone.28.29" target="_blank">http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.PanZoomMapTool#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.PanZoomMapTool#MemberwiseClone.28.29// |
- | ==== Enabled ==== | + | |
- | Gets or sets a value that turns the feature on and off. | + | == Return Value == |
- | === Remarks === | + | * Type:Object |
- | For the most updated Info for this topic, please check it here:<a href="http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.PanZoomMapTool#Enabled" target="_blank">http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.PanZoomMapTool#Enabled</a> | + | * Description:N/A |
- | === Return Value === | + | |
- | ^ Return Type ^ | + | == Parameters == |
- | | Boolean<!-- System.Boolean --> | | + | <div newline></div> |
+ | ==== Public Properties ==== | ||
+ | ** {{wiki:PublicProperty.gif|}} IsGlobeButtonEnabled ** | ||
- | <!-- ThinkGeo.MapSuite.WebEdition.MapTool --> | ||
- | [[#Public Properties|Go Back]] | ||
- | ==== IsGlobeButtonEnabled ==== | ||
Gets or sets a boolean value that determines whether the globe button shows in the PanZoom map tool. | Gets or sets a boolean value that determines whether the globe button shows in the PanZoom map tool. | ||
- | === Remarks === | + | == Remarks == |
- | For the most updated Info for this topic, please check it here:<a href="http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.PanZoomMapTool#IsGlobeButtonEnabled" target="_blank">http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.PanZoomMapTool#IsGlobeButtonEnabled</a> | + | For the most updated Info for this topic, please check it here:http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.PanZoomMapTool#IsGlobeButtonEnabled |
- | === Return Value === | + | == Return Value == |
- | ^ Return Type ^ | + | * Type:Boolean |
- | | Boolean<!-- System.Boolean --> | | + | |
- | <!-- ThinkGeo.MapSuite.WebEdition.PanZoomMapTool --> | + | ** {{wiki:PublicProperty.gif|}} Enabled ** |
- | [[#Public Properties|Go Back]] | + | |
- | ===== Protected Properties ===== | + | Gets or sets a value that turns the feature on and off. |
- | ===== Public Events ===== | + | == Remarks == |
- | __NOTOC__ | + | For the most updated Info for this topic, please check it here:http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.PanZoomMapTool#Enabled |
- | [[Category:WebEdition]] | + | == Return Value == |
- | [[Category:ThinkGeo.MapSuite.WebEdition]] | + | * Type:Boolean |
- | [[Category:UpdateDocumentation]] | + | |
+ | ==== Protected Properties ==== | ||
+ | ==== Public Events ==== | ||