User Tools

Site Tools


thinkgeo.mapsuite.webedition.measuremaptool

Differences

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

Link to this comparison view

Next revision
Previous revision
thinkgeo.mapsuite.webedition.measuremaptool [2015/08/20 03:08]
127.0.0.1 external edit
thinkgeo.mapsuite.webedition.measuremaptool [2017/03/16 21:59] (current)
Line 1: Line 1:
 ====== ThinkGeo.MapSuite.WebEdition.MeasureMapTool ====== ====== ThinkGeo.MapSuite.WebEdition.MeasureMapTool ======
  
 +{{section>​upgrade_map_suite_to_10.0}}
  
- 
-<!-- Class --> 
 Represents the measure map tool which allows measurements for features. Represents the measure map tool which allows measurements for features.
-=== Remarks === 
-For the most updated Info for this topic, please check it here:<a href="​http://​wiki.thinkgeo.com/​wiki/​ThinkGeo.MapSuite.WebEdition.MeasureMapTool"​ target="​_blank">​http://​wiki.thinkgeo.com/​wiki/​ThinkGeo.MapSuite.WebEdition.MeasureMapTool</​a>​ 
 ===== Inheritance Hierarchy ===== ===== Inheritance Hierarchy =====
-*System.Object +  ​*System.Object 
-**[[ThinkGeo.MapSuite.WebEdition.MapTool]] +    *ThinkGeo.MapSuite.WebEdition.MapTool 
-***[[ThinkGeo.MapSuite.WebEdition.MeasureMapTool]]+      ***ThinkGeo.MapSuite.WebEdition.MeasureMapTool**
 ===== Members Summary ===== ===== Members Summary =====
 ==== Public Constructors ==== ==== Public Constructors ====
-^ Name ^ Parameters ^ DeclaringType ^ Summary ^ +** {{wiki:​PublicMethod.gif|}} MeasureMapTool() ​**
-{{wiki:​PublicMethod.gif|Public Method}}[[#MeasureMapTool()|MeasureMapTool]] ​  ​| ​   |    | Initialize an instance of the MeasureMapTool class. ​  |+
  
 +  * //​Initialize an instance of the MeasureMapTool class.//
 +== Remarks ==
 +  * //The default MeasureType is Line, and the display system units is Metric by default, also it measures geodesic distance by default.//
 +== 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}}[[#​Geodesic|Geodesic]] ​  | Boolean ​  ​| ​   | Indicate whether to measure geodesic distance. ​  | +
-| {{wiki:​PublicProperty.gif|Public Property}}[[#​MeasureType|MeasureType]] ​  | [[ThinkGeo.MapSuite.WebEdition.MeasureType|MeasureType]] ​  ​| ​   | Represents the different types of the MeasureMapTool. ​  | +
-| {{wiki:​PublicProperty.gif|Public Property}}[[#​MeasureUnitType|MeasureUnitType]] ​  | [[ThinkGeo.MapSuite.WebEdition.MeasureUnitType|MeasureUnitType]] ​  ​| ​   | Represents ​the display system units for output measurements  |+
  
-==== 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.MeasureMapTool#​ToString.28.29//​
  
-===== Public Constructors ===== +== Return Value == 
-==== MeasureMapTool() ==== +  ​Type:String 
-Initialize an instance of the MeasureMapTool class. +  Description:N/A
-=== Remarks === +
-The default MeasureType is Line, and the display system units is Metric by default, also it measures geodesic distance by default. +
-=== 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.MeasureMapTool#​Equals.28Object.29"​ target="​_blank"​>http://​wiki.thinkgeo.com/​wiki/​ThinkGeo.MapSuite.WebEdition.MeasureMapTool#​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.MeasureMapTool#​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.MeasureMapTool#​GetHashCode.28.29"​ target="​_blank">​http://​wiki.thinkgeo.com/​wiki/​ThinkGeo.MapSuite.WebEdition.MeasureMapTool#​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.MeasureMapTool#​GetType.28.29"​ target="​_blank">​http://wiki.thinkgeo.com/​wiki/​ThinkGeo.MapSuite.WebEdition.MeasureMapTool#​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.MeasureMapTool#​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 --> ​  ​| ​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.MeasureMapTool#​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.MeasureMapTool#​ToString.28.29" target="​_blank">​http:​//wiki.thinkgeo.com/​wiki/​ThinkGeo.MapSuite.WebEdition.MeasureMapTool#​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.MeasureMapTool#​Finalize.28.29"​ target="​_blank"​>http://​wiki.thinkgeo.com/​wiki/​ThinkGeo.MapSuite.WebEdition.MeasureMapTool#​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.MeasureMapTool#​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.MeasureMapTool#​MemberwiseClone.28.29"​ target="​_blank">​http://​wiki.thinkgeo.com/​wiki/​ThinkGeo.MapSuite.WebEdition.MeasureMapTool#​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.MeasureMapTool#​MemberwiseClone.28.29//
-==== 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.MeasureMapTool#​Enabled"​ target="​_blank">​http://​wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.MeasureMapTool#​Enabled</​a>​ +
-=== Return Value === +
-^ Return Type ^ +
-| Boolean<​!-- System.Boolean --> ​  |+
  
-<!-- ThinkGeo.MapSuite.WebEdition.MapTool --> +== Return Value == 
-[[#Public Properties|Go Back]] +  * Type:​Object 
-==== Geodesic ​==== +  * Description:​N/​A 
-Indicate whether to measure geodesic distance. + 
-=== Remarks === +== Parameters ​== 
-For the most updated Info for this topic, please check it here:<a href="​http://​wiki.thinkgeo.com/​wiki/​ThinkGeo.MapSuite.WebEdition.MeasureMapTool#​Geodesic"​ target="​_blank"​>http://​wiki.thinkgeo.com/​wiki/​ThinkGeo.MapSuite.WebEdition.MeasureMapTool#​Geodesic</a+<div newline></div
-=== Return Value === +==== Public Properties ==== 
-^ Return Type ^ +** {{wiki:​PublicProperty.gif|}} MeasureType **
-| Boolean<​!-- System.Boolean --> ​  |+
  
-<!-- ThinkGeo.MapSuite.WebEdition.MeasureMapTool --> 
-[[#Public Properties|Go Back]] 
-==== MeasureType ==== 
 Represents the different types of the MeasureMapTool. Represents the different types of the MeasureMapTool.
-=== Remarks ​=== +== Remarks == 
-For the most updated Info for this topic, please check it here:<a href="http://​wiki.thinkgeo.com/​wiki/​ThinkGeo.MapSuite.WebEdition.MeasureMapTool#​MeasureType" target="​_blank">​http://​wiki.thinkgeo.com/​wiki/​ThinkGeo.MapSuite.WebEdition.MeasureMapTool#​MeasureType</​a>​ +For the most updated Info for this topic, please check it here:​http://​wiki.thinkgeo.com/​wiki/​ThinkGeo.MapSuite.WebEdition.MeasureMapTool#​MeasureType 
-=== Return Value === +== Return Value == 
-^ Return ​Type +  ​* ​Type:[[ThinkGeo.MapSuite.WebEdition.MeasureType|MeasureType]] 
-[[ThinkGeo.MapSuite.WebEdition.MeasureType|MeasureType]]<!-- ThinkGeo.MapSuite.WebEdition.MeasureType --> ​  |+ 
 +** {{wiki:​PublicProperty.gif|}} MeasureUnitType **
  
-<!-- ThinkGeo.MapSuite.WebEdition.MeasureMapTool --> 
-[[#Public Properties|Go Back]] 
-==== MeasureUnitType ==== 
 Represents the display system units for output measurements. Represents the display system units for output measurements.
-=== Remarks ​=== +== Remarks == 
-For the most updated Info for this topic, please check it here:<a href="http://​wiki.thinkgeo.com/​wiki/​ThinkGeo.MapSuite.WebEdition.MeasureMapTool#​MeasureUnitType" target="​_blank">​http://​wiki.thinkgeo.com/​wiki/​ThinkGeo.MapSuite.WebEdition.MeasureMapTool#​MeasureUnitType</​a>​ +For the most updated Info for this topic, please check it here:​http://​wiki.thinkgeo.com/​wiki/​ThinkGeo.MapSuite.WebEdition.MeasureMapTool#​MeasureUnitType 
-=== Return Value === +== Return Value == 
-^ Return ​Type +  ​* ​Type:[[ThinkGeo.MapSuite.WebEdition.MeasureUnitType|MeasureUnitType]]
-[[ThinkGeo.MapSuite.WebEdition.MeasureUnitType|MeasureUnitType]]<!-- ThinkGeo.MapSuite.WebEdition.MeasureUnitType --> ​  |+
  
-<​!-- ​ThinkGeo.MapSuite.WebEdition.MeasureMapTool ​--> +** {{wiki:​PublicProperty.gif|}} Geodesic ** 
-[[#Public Properties|Go Back]] + 
-===== Protected Properties ​===== +Indicate whether to measure geodesic distance. 
-===== Public Events ====+== Remarks == 
-__NOTOC__ +For the most updated Info for this topic, please check it here:​http://​wiki.thinkgeo.com/​wiki/​ThinkGeo.MapSuite.WebEdition.MeasureMapTool#​Geodesic 
-[[Category:​WebEdition]] +== Return Value == 
-[[Category:​ThinkGeo.MapSuite.WebEdition]] +  * Type:​Boolean 
-[[Category:​UpdateDocumentation]]+ 
 +** {{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.MeasureMapTool#​Enabled 
 +== Return Value == 
 +  * Type:​Boolean 
 + 
 +==== Protected Properties ==== 
 +==== Public Events ====
  
thinkgeo.mapsuite.webedition.measuremaptool.1440040135.txt.gz · Last modified: 2015/09/18 03:08 (external edit)