User Tools

Site Tools


thinkgeo.mapsuite.mvcedition.animationpanmaptool

Differences

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

Link to this comparison view

Next revision
Previous revision
thinkgeo.mapsuite.mvcedition.animationpanmaptool [2015/08/20 03:08]
127.0.0.1 external edit
thinkgeo.mapsuite.mvcedition.animationpanmaptool [2017/03/16 21:59] (current)
Line 1: Line 1:
 ====== ThinkGeo.MapSuite.MvcEdition.AnimationPanMapTool ====== ====== ThinkGeo.MapSuite.MvcEdition.AnimationPanMapTool ======
  
 +{{section>​upgrade_map_suite_to_10.0}}
  
- 
-<!-- Class --> 
 Represents an animation pan tool which allows map pans to the position which users click using the transition effect. Represents an animation pan tool which allows map pans to the position which users click using the transition effect.
-=== Remarks === 
-This map tools mainly caputure the click event on the map and then pan to the location clciked with the transition effect, also user could define the delay (in milliseconds) of the click event. ​ 
-If user don't want this pan transition effect, and uesr could define his own client event using <​strong>​OnClick</​strong>​ property. 
 ===== Inheritance Hierarchy ===== ===== Inheritance Hierarchy =====
-*System.Object +  ​*System.Object 
-**[[ThinkGeo.MapSuite.MvcEdition.MapTool]] +    *ThinkGeo.MapSuite.MvcEdition.MapTool 
-***[[ThinkGeo.MapSuite.MvcEdition.AnimationPanMapTool]]+      ***ThinkGeo.MapSuite.MvcEdition.AnimationPanMapTool**
 ===== Members Summary ===== ===== Members Summary =====
 ==== Public Constructors ==== ==== Public Constructors ====
-^ Name ^ Parameters ^ DeclaringType ^ Summary ^ +** {{wiki:​PublicMethod.gif|}} AnimationPanMapTool() ​**
-{{wiki:​PublicMethod.gif|Public Method}}[[#AnimationPanMapTool()|AnimationPanMapTool]] ​  ​| ​   |    | Initialize an instance of the AnimationPanMapTool class. ​  |+
  
 +  * //​Initialize an instance of the AnimationPanMapTool class.//
 +== Remarks ==
 +  * //N/A//
 +== 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}}[[#​FromJson(String)|FromJson]] ​  | String ​  | [[ThinkGeo.MapSuite.MvcEdition.MapTool|MapTool]] ​  | 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.MapTool|MapTool]] ​  | Returns a JSON string that represents the map control object. ​  | +
-| {{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 ​  ​| ​   |+
  
-==== Public Properties ==== +== Return Value == 
-^ Name ^ Return ^ DeclaringType ^ Summary ^ +  * Type:String 
-| {{wiki:PublicProperty.gif|Public Property}}[[#​Delay|Delay]] ​  | Int32   ​| ​   | The number of milliseconds between clicks before the event is considered a double-click. ​  | +  * Description:N/A
-| {{wiki:PublicProperty.gif|Public Property}}[[#​Enabled|Enabled]] ​  | Boolean ​  | [[ThinkGeo.MapSuite.MvcEdition.MapTool|MapTool]] ​  | Gets or sets a value that turns the feature on and off.   | +
-| {{wiki:​PublicProperty.gif|Public Property}}[[#​OnClientClick|OnClientClick]] ​  | String ​  ​| ​   | Gets or sets the client-side script that executes when you click on the map using this Animation Pan map tool.   |+
  
-==== Protected Properties ==== +== Parameters ​== 
-^ Name ^ Return ^ DeclaringType ^ Summary ^+<div newline></​div>​ 
 +** {{wiki:​PublicMethod.gif|}} FromJson(String) **
  
-==== Public Events ==== +  * //N/A// 
-^ Name ^ Event Arguments ^ DeclaringType ^ Summary ^+== Remarks ​== 
 +  * //N/A//
  
-===== Public Constructors ===== +== Return Value == 
-==== AnimationPanMapTool() ==== +  ​Type:Void 
-Initialize an instance of the AnimationPanMapTool class. +  Description:N/A
-=== Parameters === +
-^  Name ^  ​Type ​ ​Description ​^+
  
-[[#Public Constructors|Go Back]] +== Parameters ​== 
-===== Protected Constructors ===== +  * //​jsonString//​ 
-===== Public Methods ===== +    ​* ​Type:String 
-==== Equals(Object) ==== +    ​* Description:​N/​A
-=== Return Value === +
-^ Return ​Type ^ Description ^ +
-| Boolean<​!-- System.Boolean --> ​  ​| ​   |+
  
-=== Parameters === +<div newline></​div>​ 
-^  Name ^  Type ^  Description ^ +** {{wiki:​PublicMethod.gif|}} ToString() **
-| obj   | Object<​!-- System.Object --> ​  ​| ​   ​|+
  
-<!-- System.Object --> +  * //N/A// 
-[[#Public Methods|Go Back]] +== Remarks ​== 
-==== FromJson(String) ==== +  * //N/A//
-Load this object from a json string. +
-=== Return Value === +
-^ Return Type ^ Description ^ +
-| Void<!-- System.Void --> ​  ​| ​   |+
  
-=== Parameters === +== Return Value == 
-^  Name ^  ​Type ​ ​Description ​+  ​Type:String 
-| jsonString ​  | String<​!-- System.String --> ​  | a json string ​  |+  Description:N/A
  
-<!-- ThinkGeo.MapSuite.MvcEdition.MapTool --> +== Parameters ​== 
-[[#Public Methods|Go Back]] +<div newline></​div>​ 
-==== GetHashCode() ​==== +** {{wiki:​PublicMethod.gif|}} Equals(Object) **
-=== Return Value === +
-^ Return Type ^ Description ^ +
-| Int32<​!-- System.Int32 --> ​  ​| ​   ​|+
  
-=== Parameters === +  * //N/A// 
-^  Name ^  Type ^  Description ^+== Remarks ​== 
 +  ​* //N/A//
  
-<!-- System.Object --> +== Return Value == 
-[[#Public Methods|Go Back]] +  ​* ​Type:Boolean 
-==== GetType() ==== +  * Description:N/A
-=== Return Value === +
-^ Return ​Type Description ​+
-| Type<!-- System.Type --> ​  ​| ​   |+
  
-=== Parameters ​=== +== Parameters == 
-^  Name ^  ​Type ​^  ​Description ​^+  ​* //obj// 
 +    * Type:Object 
 +    * Description:N/A
  
-<!-- System.Object --+<div newline></​div
-[[#Public Methods|Go Back]] +** {{wiki:​PublicMethod.gif|}} GetHashCode() **
-==== ToJson() ==== +
-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 === +  * //N/A// 
-^  Name ^  Type ^  Description ^+== Remarks ​== 
 +  ​* //N/A//
  
-<!-- ThinkGeo.MapSuite.MvcEdition.MapTool --> +== Return Value == 
-[[#Public Methods|Go Back]] +  ​* ​Type:Int32 
-==== ToString() ==== +  * Description:N/A
-=== Return Value === +
-^ Return ​Type Description ​+
-| String<​!-- System.String --> ​  ​| ​   |+
  
-=== Parameters === +== Parameters == 
-^  Name ^  Type ^  Description ^+<div newline></​div>​ 
 +** {{wiki:​PublicMethod.gif|}} GetType() **
  
-<!-- System.Object --> +  * //N/A// 
-[[#Public Methods|Go Back]] +== Remarks ​== 
-===== Protected Methods ===== +  * //N/A//
-==== Finalize() ==== +
-=== Return Value === +
-^ Return Type ^ Description ^ +
-| Void<!-- System.Void --> ​  ​| ​   |+
  
-=== Parameters === +== Return Value == 
-^  Name ^  ​Type ​ ​Description ​^+  ​Type:Type 
 +  Description:N/A
  
-<!-- System.Object --> +== Parameters ​== 
-[[#​Protected Methods|Go Back]] +<div newline></​div>​ 
-==== MemberwiseClone() ​==== +==== Protected Methods ​==== 
-=== Return Value === +** {{wiki:​ProtectedMethod.gif|}} Finalize() **
-^ Return Type ^ Description ^ +
-| Object<​!-- System.Object --> ​  ​| ​   ​|+
  
-=== Parameters === +  * //N/A// 
- Name ^  ​Type ​ ​Description ​^+== Remarks == 
 +  * //N/A// 
 + 
 +== Return Value == 
 +  * Type:Void 
 +  * Description:​N/​A 
 + 
 +== Parameters =
 +<div newline></​div>​ 
 +** {{wiki:​ProtectedMethod.gif|}} MemberwiseClone() ** 
 + 
 +  * //N/A// 
 +== Remarks ​== 
 +  ​* //N/A// 
 + 
 +== Return Value == 
 +  Type:Object 
 +  Description:N/A 
 + 
 +== Parameters == 
 +<div newline></​div>​ 
 +==== Public Properties ==== 
 +** {{wiki:​PublicProperty.gif|}} Delay **
  
-<!-- System.Object --> 
-[[#​Protected Methods|Go Back]] 
-===== Public Properties ===== 
-==== Delay ==== 
 The number of milliseconds between clicks before the event is considered a double-click. The number of milliseconds between clicks before the event is considered a double-click.
-=== Return Value === +== Remarks == 
-^ Return ​Type +N/A 
-| Int32<​!-- System.Int32 --> ​  |+== Return Value == 
 +  ​* ​Type:Int32
  
-<!-- ThinkGeo.MapSuite.MvcEdition.AnimationPanMapTool --> +** {{wiki:​PublicProperty.gif|}} OnClientClick **
-[[#Public Properties|Go Back]] +
-==== Enabled ==== +
-Gets or sets a value that turns the feature on and off. +
-=== Return Value === +
-^ Return Type ^ +
-| Boolean<​!-- System.Boolean --> ​  |+
  
-<!-- ThinkGeo.MapSuite.MvcEdition.MapTool --> 
-[[#Public Properties|Go Back]] 
-==== OnClientClick ==== 
 Gets or sets the client-side script that executes when you click on the map using this Animation Pan map tool. Gets or sets the client-side script that executes when you click on the map using this Animation Pan map tool.
-=== Remarks ​===+== Remarks ==
 There is a default parameter:​e,​ which includes one parameter: "​worldXY"​ There is a default parameter:​e,​ which includes one parameter: "​worldXY"​
-=== Return Value === +== Return Value == 
-^ Return ​Type +  ​* ​Type:String
-| String<​!-- System.String ​--> ​  |+
  
-<!-- ThinkGeo.MapSuite.MvcEdition.AnimationPanMapTool --> +** {{wiki:​PublicProperty.gif|}} Enabled ** 
-[[#Public Properties|Go Back]] + 
-===== Protected Properties ​===== +N/A 
-===== Public Events ====+== Remarks == 
-__NOTOC__ +N/A 
-[[Category:​MvcEdition]] +== Return Value == 
-[[Category:​ThinkGeo.MapSuite.MvcEdition]] +  * Type:​Boolean 
-[[Category:​UpdateDocumentation]]+ 
 +==== Protected Properties ==== 
 +==== Public Events ====
  
thinkgeo.mapsuite.mvcedition.animationpanmaptool.1440040131.txt.gz · Last modified: 2015/09/21 03:32 (external edit)