This shows you the differences between two versions of the page.
Both sides previous revision Previous revision Next revision | Previous revision | ||
thinkgeo.mapsuite.core.zoomlevelset [2015/09/17 10:43] admin |
thinkgeo.mapsuite.core.zoomlevelset [2017/03/16 21:59] (current) |
||
---|---|---|---|
Line 1: | Line 1: | ||
====== ThinkGeo.MapSuite.Core.ZoomLevelSet ====== | ====== ThinkGeo.MapSuite.Core.ZoomLevelSet ====== | ||
+ | |||
+ | {{section>upgrade_map_suite_to_10.0}} | ||
+ | |||
This class represents a collection of ZoomLevels. | This class represents a collection of ZoomLevels. | ||
===== Inheritance Hierarchy ===== | ===== Inheritance Hierarchy ===== | ||
Line 10: | Line 13: | ||
*[[ThinkGeo.MapSuite.Core.OpenStreetMapsZoomLevelSet]] | *[[ThinkGeo.MapSuite.Core.OpenStreetMapsZoomLevelSet]] | ||
===== Members Summary ===== | ===== Members Summary ===== | ||
- | === Public Constructors === | + | ==== Public Constructors ==== |
- | <div class_table> | + | ** {{wiki:PublicMethod.gif|}} ZoomLevelSet() ** |
- | **{{wiki:PublicMethod.gif|}}[[#ZoomLevelSet()|ZoomLevelSet]]** | + | |
- | * **Parameters**:N/A | + | |
- | * **DeclaringType**:N/A | + | |
- | * **Summary**:This is the default constructor. | + | |
- | </div> | + | |
- | === Protected Constructors === | + | * //This is the default constructor.// |
- | === Public Methods === | + | == Remarks == |
- | <div class_table> | + | * //This constructor is where we set the default scales for each ZoomLevel. If you inherit from this class to create your own custom ZoomSet, then you should not call the base constructor if you want to supply your own custom ZoomLevels.// |
- | **{{wiki:PublicMethod.gif|}}[[#Equals(Object)|Equals]]** | + | == Parameters == |
- | * **Parameters**:Object | + | <div newline></div> |
- | * **DeclaringType**:Object | + | ==== Protected Constructors ==== |
- | * **Summary**:N/A | + | ==== Public Methods ==== |
- | </div> | + | ** {{wiki:PublicMethod.gif|}} GetZoomLevel(RectangleShape,Double,GeographyUnit) ** |
- | <div class_table> | + | * //This method returns the active ZoomLevel based on an extent, a map unit and a screen width.// |
- | **{{wiki:PublicMethod.gif|}}[[#GetHashCode()|GetHashCode]]** | + | == Remarks == |
- | * **Parameters**:N/A | + | * //N/A// |
- | * **DeclaringType**:Object | + | |
- | * **Summary**:N/A | + | |
- | </div> | + | |
- | <div class_table> | + | == Return Value == |
- | **{{wiki:PublicMethod.gif|}}{{wiki:Static.gif|}}[[#GetHigherZoomLevelScale(Double,ZoomLevelSet)|GetHigherZoomLevelScale]]** | + | * Type:[[ThinkGeo.MapSuite.Core.ZoomLevel|ZoomLevel]] |
- | * **Parameters**:Double,[[ThinkGeo.MapSuite.Core.ZoomLevelSet|ZoomLevelSet]] | + | * Description:This method returns the active ZoomLevel based on an extent, a map unit and a screen width. |
- | * **DeclaringType**:N/A | + | |
- | * **Summary**:ZoomToScale out, the result is greater than input | + | |
- | </div> | + | |
- | <div class_table> | + | == Parameters == |
- | **{{wiki:PublicMethod.gif|}}{{wiki:Static.gif|}}[[#GetLowerZoomLevelScale(Double,ZoomLevelSet)|GetLowerZoomLevelScale]]** | + | * //extent// |
- | * **Parameters**:Double,[[ThinkGeo.MapSuite.Core.ZoomLevelSet|ZoomLevelSet]] | + | * Type:[[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]] |
- | * **DeclaringType**:N/A | + | * Description:This parameter is a world extent. |
- | * **Summary**:ZoomToScale in, the result is less than input | + | |
- | </div> | + | |
- | <div class_table> | + | * //screenWidth// |
- | **{{wiki:PublicMethod.gif|}}[[#GetType()|GetType]]** | + | * Type:Double |
- | * **Parameters**:N/A | + | * Description:This parameter is the width of the map in pixels. |
- | * **DeclaringType**:Object | + | |
- | * **Summary**:N/A | + | |
- | </div> | + | |
- | <div class_table> | + | * //mapUnit// |
- | **{{wiki:PublicMethod.gif|}}[[#GetZoomLevel(RectangleShape,Double,GeographyUnit)|GetZoomLevel]]** | + | * Type:[[ThinkGeo.MapSuite.Core.GeographyUnit|GeographyUnit]] |
- | * **Parameters**:[[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]],Double,[[ThinkGeo.MapSuite.Core.GeographyUnit|GeographyUnit]] | + | * Description:This parameter is the unit of the map. |
- | * **DeclaringType**:N/A | + | |
- | * **Summary**:This method returns the active ZoomLevel based on an extent, a map unit and a screen width. | + | |
- | </div> | + | |
- | <div class_table> | + | <div newline></div> |
- | **{{wiki:PublicMethod.gif|}}[[#GetZoomLevel(RectangleShape,Double,GeographyUnit,Single)|GetZoomLevel]]** | + | ** {{wiki:PublicMethod.gif|}} GetZoomLevel(RectangleShape,Double,GeographyUnit,Single) ** |
- | * **Parameters**:[[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]],Double,[[ThinkGeo.MapSuite.Core.GeographyUnit|GeographyUnit]],Single | + | |
- | * **DeclaringType**:N/A | + | |
- | * **Summary**:This method returns the active ZoomLevel based on an extent, a map unit and a screen width. | + | |
- | </div> | + | |
- | <div class_table> | + | * //This method returns the active ZoomLevel based on an extent, a map unit and a screen width.// |
- | **{{wiki:PublicMethod.gif|}}[[#GetZoomLevelForDrawing(RectangleShape,Double,GeographyUnit,Single)|GetZoomLevelForDrawing]]** | + | == Remarks == |
- | * **Parameters**:[[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]],Double,[[ThinkGeo.MapSuite.Core.GeographyUnit|GeographyUnit]],Single | + | * //N/A// |
- | * **DeclaringType**:N/A | + | |
- | * **Summary**:This method returns the active ZoomLevel based on an extent, a map unit and a canvas width. | + | |
- | </div> | + | |
- | <div class_table> | + | == Return Value == |
- | **{{wiki:PublicMethod.gif|}}[[#GetZoomLevelForDrawing(RectangleShape,Double,GeographyUnit)|GetZoomLevelForDrawing]]** | + | * Type:[[ThinkGeo.MapSuite.Core.ZoomLevel|ZoomLevel]] |
- | * **Parameters**:[[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]],Double,[[ThinkGeo.MapSuite.Core.GeographyUnit|GeographyUnit]] | + | * Description:This method returns the active ZoomLevel based on an extent, a map unit and a screen width. |
- | * **DeclaringType**:N/A | + | |
- | * **Summary**:This method returns the active ZoomLevel based on an extent, a map unit and a canvas width. | + | |
- | </div> | + | |
- | <div class_table> | + | == Parameters == |
- | **{{wiki:PublicMethod.gif|}}[[#GetZoomLevels()|GetZoomLevels]]** | + | * //extent// |
- | * **Parameters**:N/A | + | * Type:[[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]] |
- | * **DeclaringType**:N/A | + | * Description:This parameter is a world extent. |
- | * **Summary**:This method return all of the zoomLevels in the zoomLevelSet. | + | |
- | </div> | + | |
- | <div class_table> | + | * //screenWidth// |
- | **{{wiki:PublicMethod.gif|}}[[#ToString()|ToString]]** | + | * Type:Double |
- | * **Parameters**:N/A | + | * Description:This parameter is the width of the map in pixels. |
- | * **DeclaringType**:Object | + | |
- | * **Summary**:N/A | + | |
- | </div> | + | |
- | === Protected Methods === | + | * //mapUnit// |
- | <div class_table> | + | * Type:[[ThinkGeo.MapSuite.Core.GeographyUnit|GeographyUnit]] |
- | **{{wiki:ProtectedMethod.gif|}}[[#Finalize()|Finalize]]** | + | * Description:This parameter is the unit of the map. |
- | * **Parameters**:N/A | + | |
- | * **DeclaringType**:Object | + | |
- | * **Summary**:N/A | + | |
- | </div> | + | |
- | <div class_table> | + | * //dpi// |
- | **{{wiki:ProtectedMethod.gif|}}[[#MemberwiseClone()|MemberwiseClone]]** | + | * Type:Single |
- | * **Parameters**:N/A | + | * Description:This parameter is the dpi of the extent. |
- | * **DeclaringType**:Object | + | |
- | * **Summary**:N/A | + | |
- | </div> | + | |
- | <div class_table> | + | <div newline></div> |
- | **{{wiki:ProtectedMethod.gif|}}[[#uSk=(Double)|uSk=]]** | + | ** {{wiki:PublicMethod.gif|}} GetZoomLevelForDrawing(RectangleShape,Double,GeographyUnit,Single) ** |
- | * **Parameters**:Double | + | |
- | * **DeclaringType**:N/A | + | |
- | * **Summary**:N/A | + | |
- | </div> | + | |
- | === Public Properties === | + | * //This method returns the active ZoomLevel based on an extent, a map unit and a canvas width.// |
- | **{{wiki:PublicProperty.gif|}}[[#CustomZoomLevels|CustomZoomLevels]]** | + | == Remarks == |
- | * **Return**:Collection<[[ThinkGeo.MapSuite.Core.ZoomLevel|ZoomLevel]]> | + | * //N/A// |
- | * **Summary**:This property gets the custom zoom levels from the zoomLevelSet. | + | |
- | **{{wiki:PublicProperty.gif|}}[[#Name|Name]]** | + | == Return Value == |
- | * **Return**:String | + | * Type:[[ThinkGeo.MapSuite.Core.ZoomLevel|ZoomLevel]] |
- | * **Summary**:This property gets and sets the name for the ZoomSet. | + | * Description:This method returns the active ZoomLevel based on an extent, map unit and a canvas width. |
- | **{{wiki:PublicProperty.gif|}}[[#ZoomLevel01|ZoomLevel01]]** | + | == Parameters == |
- | * **Return**:[[ThinkGeo.MapSuite.Core.ZoomLevel|ZoomLevel]] | + | * //extent// |
- | * **Summary**:This property gets the ZoomLevel for Level01. | + | * Type:[[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]] |
+ | * Description:This parameter is a world extent. | ||
- | **{{wiki:PublicProperty.gif|}}[[#ZoomLevel02|ZoomLevel02]]** | + | * //screenWidth// |
- | * **Return**:[[ThinkGeo.MapSuite.Core.ZoomLevel|ZoomLevel]] | + | * Type:Double |
- | * **Summary**:This property gets the ZoomLevel for Level02. | + | * Description:This parameter is the width of the canvas in pixels. |
- | **{{wiki:PublicProperty.gif|}}[[#ZoomLevel03|ZoomLevel03]]** | + | * //mapUnit// |
- | * **Return**:[[ThinkGeo.MapSuite.Core.ZoomLevel|ZoomLevel]] | + | * Type:[[ThinkGeo.MapSuite.Core.GeographyUnit|GeographyUnit]] |
- | * **Summary**:This property gets the ZoomLevel for Level03. | + | * Description:This parameter is the unit of the map. |
- | **{{wiki:PublicProperty.gif|}}[[#ZoomLevel04|ZoomLevel04]]** | + | * //dpi// |
- | * **Return**:[[ThinkGeo.MapSuite.Core.ZoomLevel|ZoomLevel]] | + | * Type:Single |
- | * **Summary**:This property gets the ZoomLevel for Level04. | + | * Description:This parameter is the dpi of the extent. |
- | **{{wiki:PublicProperty.gif|}}[[#ZoomLevel05|ZoomLevel05]]** | + | <div newline></div> |
- | * **Return**:[[ThinkGeo.MapSuite.Core.ZoomLevel|ZoomLevel]] | + | ** {{wiki:PublicMethod.gif|}} GetZoomLevelForDrawing(RectangleShape,Double,GeographyUnit) ** |
- | * **Summary**:This property gets the ZoomLevel for Level05. | + | |
- | **{{wiki:PublicProperty.gif|}}[[#ZoomLevel06|ZoomLevel06]]** | + | * //This method returns the active ZoomLevel based on an extent, a map unit and a canvas width.// |
- | * **Return**:[[ThinkGeo.MapSuite.Core.ZoomLevel|ZoomLevel]] | + | == Remarks == |
- | * **Summary**:This property gets the ZoomLevel for Level06. | + | * //N/A// |
- | **{{wiki:PublicProperty.gif|}}[[#ZoomLevel07|ZoomLevel07]]** | + | == Return Value == |
- | * **Return**:[[ThinkGeo.MapSuite.Core.ZoomLevel|ZoomLevel]] | + | * Type:[[ThinkGeo.MapSuite.Core.ZoomLevel|ZoomLevel]] |
- | * **Summary**:This property gets the ZoomLevel for Level07. | + | * Description:This method returns the active ZoomLevel based on an extent, map unit and a canvas width. |
- | **{{wiki:PublicProperty.gif|}}[[#ZoomLevel08|ZoomLevel08]]** | + | == Parameters == |
- | * **Return**:[[ThinkGeo.MapSuite.Core.ZoomLevel|ZoomLevel]] | + | * //extent// |
- | * **Summary**:This property gets the ZoomLevel for Level08. | + | * Type:[[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]] |
+ | * Description:This parameter is a world extent. | ||
- | **{{wiki:PublicProperty.gif|}}[[#ZoomLevel09|ZoomLevel09]]** | + | * //screenWidth// |
- | * **Return**:[[ThinkGeo.MapSuite.Core.ZoomLevel|ZoomLevel]] | + | * Type:Double |
- | * **Summary**:This property gets the ZoomLevel for Level09. | + | * Description:This parameter is the width of the canvas in pixels. |
- | **{{wiki:PublicProperty.gif|}}[[#ZoomLevel10|ZoomLevel10]]** | + | * //mapUnit// |
- | * **Return**:[[ThinkGeo.MapSuite.Core.ZoomLevel|ZoomLevel]] | + | * Type:[[ThinkGeo.MapSuite.Core.GeographyUnit|GeographyUnit]] |
- | * **Summary**:This property gets the ZoomLevel for Level10. | + | * Description:This parameter is the unit of the map. |
- | **{{wiki:PublicProperty.gif|}}[[#ZoomLevel11|ZoomLevel11]]** | + | <div newline></div> |
- | * **Return**:[[ThinkGeo.MapSuite.Core.ZoomLevel|ZoomLevel]] | + | ** {{wiki:PublicMethod.gif|}} GetZoomLevels() ** |
- | * **Summary**:This property gets the ZoomLevel for Level11. | + | |
- | **{{wiki:PublicProperty.gif|}}[[#ZoomLevel12|ZoomLevel12]]** | + | * //This method return all of the zoomLevels in the zoomLevelSet.// |
- | * **Return**:[[ThinkGeo.MapSuite.Core.ZoomLevel|ZoomLevel]] | + | == Remarks == |
- | * **Summary**:This property gets the ZoomLevel for Level12. | + | * //None.// |
- | **{{wiki:PublicProperty.gif|}}[[#ZoomLevel13|ZoomLevel13]]** | + | == Return Value == |
- | * **Return**:[[ThinkGeo.MapSuite.Core.ZoomLevel|ZoomLevel]] | + | * Type:Collection<[[ThinkGeo.MapSuite.Core.ZoomLevel|ZoomLevel]]> |
- | * **Summary**:This property gets the ZoomLevel for Level13. | + | * Description:This method return all of the zoomlevels in the zoomLevelSet. |
- | **{{wiki:PublicProperty.gif|}}[[#ZoomLevel14|ZoomLevel14]]** | + | == Parameters == |
- | * **Return**:[[ThinkGeo.MapSuite.Core.ZoomLevel|ZoomLevel]] | + | <div newline></div> |
- | * **Summary**:This property gets the ZoomLevel for Level14. | + | ** {{wiki:PublicMethod.gif|}} ToString() ** |
- | **{{wiki:PublicProperty.gif|}}[[#ZoomLevel15|ZoomLevel15]]** | + | * //N/A// |
- | * **Return**:[[ThinkGeo.MapSuite.Core.ZoomLevel|ZoomLevel]] | + | == Remarks == |
- | * **Summary**:This property gets the ZoomLevel for Level15. | + | * //N/A// |
- | **{{wiki:PublicProperty.gif|}}[[#ZoomLevel16|ZoomLevel16]]** | + | == Return Value == |
- | * **Return**:[[ThinkGeo.MapSuite.Core.ZoomLevel|ZoomLevel]] | + | * Type:String |
- | * **Summary**:This property gets the ZoomLevel for Level16. | + | * Description:N/A |
- | **{{wiki:PublicProperty.gif|}}[[#ZoomLevel17|ZoomLevel17]]** | + | == Parameters == |
- | * **Return**:[[ThinkGeo.MapSuite.Core.ZoomLevel|ZoomLevel]] | + | <div newline></div> |
- | * **Summary**:This property gets the ZoomLevel for Level17. | + | ** {{wiki:PublicMethod.gif|}} Equals(Object) ** |
- | **{{wiki:PublicProperty.gif|}}[[#ZoomLevel18|ZoomLevel18]]** | + | * //N/A// |
- | * **Return**:[[ThinkGeo.MapSuite.Core.ZoomLevel|ZoomLevel]] | + | == Remarks == |
- | * **Summary**:This property gets the ZoomLevel for Level18. | + | * //N/A// |
- | **{{wiki:PublicProperty.gif|}}[[#ZoomLevel19|ZoomLevel19]]** | + | == Return Value == |
- | * **Return**:[[ThinkGeo.MapSuite.Core.ZoomLevel|ZoomLevel]] | + | * Type:Boolean |
- | * **Summary**:This property gets the ZoomLevel for Level19. | + | * Description:N/A |
- | **{{wiki:PublicProperty.gif|}}[[#ZoomLevel20|ZoomLevel20]]** | + | == Parameters == |
- | * **Return**:[[ThinkGeo.MapSuite.Core.ZoomLevel|ZoomLevel]] | + | * //obj// |
- | * **Summary**:This property gets the ZoomLevel for Level20. | + | * Type:Object |
+ | * Description:N/A | ||
- | === Protected Properties === | + | <div newline></div> |
- | === Public Events === | + | ** {{wiki:PublicMethod.gif|}} GetHashCode() ** |
- | ===== Public Constructors ===== | + | |
- | === ZoomLevelSet() === | + | |
- | This is the default constructor. | + | |
- | ==== Remarks ==== | + | |
- | This constructor is where we set the default scales for each ZoomLevel. If you inherit from this class to create your own custom ZoomSet, then you should not call the base constructor if you want to supply your own custom ZoomLevels. | + | |
- | ==== Parameters ==== | + | |
- | [[#Public Constructors|Go Back]] | + | |
- | ===== Protected Constructors ===== | + | |
- | ===== Public Methods ===== | + | |
- | === Equals(Object) === | + | |
- | N/A | + | |
- | ==== Remarks ==== | + | |
- | N/A | + | |
- | **Return Value** | + | * //N/A// |
- | * **Return Type**:Boolean | + | == Remarks == |
- | * **Description**:N/A | + | * //N/A// |
- | ==== Parameters ==== | + | == Return Value == |
- | **obj** | + | * Type:Int32 |
- | * **Type**:Object | + | * Description:N/A |
- | * **Description**:N/A | + | |
- | [[#Public Methods|Go Back]] | + | == Parameters == |
- | === GetHashCode() === | + | <div newline></div> |
- | N/A | + | ** {{wiki:PublicMethod.gif|}} GetType() ** |
- | ==== Remarks ==== | + | |
- | N/A | + | |
- | **Return Value** | + | * //N/A// |
- | * **Return Type**:Int32 | + | == Remarks == |
- | * **Description**:N/A | + | * //N/A// |
- | ==== Parameters ==== | + | == Return Value == |
- | [[#Public Methods|Go Back]] | + | * Type:Type |
- | === GetHigherZoomLevelScale(Double,ZoomLevelSet) === | + | * Description:N/A |
- | ZoomToScale out, the result is greater than input | + | |
- | ==== Remarks ==== | + | |
- | N/A | + | |
- | **Return Value** | + | == Parameters == |
- | * **Return Type**:Double | + | <div newline></div> |
- | * **Description**:N/A | + | ** {{wiki:PublicMethod.gif|}}{{wiki:Static.gif|}} GetLowerZoomLevelScale(Double,ZoomLevelSet) ** |
- | ==== Parameters ==== | + | * //ZoomToScale in, the result is less than input// |
- | **currentScale** | + | == Remarks == |
- | * **Type**:Double | + | * //N/A// |
- | * **Description**:N/A | + | |
- | **zoomLevelSet** | + | == Return Value == |
- | * **Type**:[[ThinkGeo.MapSuite.Core.ZoomLevelSet|ZoomLevelSet]] | + | * Type:Double |
- | * **Description**:N/A | + | * Description:N/A |
- | [[#Public Methods|Go Back]] | + | == Parameters == |
- | === GetLowerZoomLevelScale(Double,ZoomLevelSet) === | + | * //currentScale// |
- | ZoomToScale in, the result is less than input | + | * Type:Double |
- | ==== Remarks ==== | + | * Description:N/A |
- | N/A | + | |
- | **Return Value** | + | * //zoomLevelSet// |
- | * **Return Type**:Double | + | * Type:[[ThinkGeo.MapSuite.Core.ZoomLevelSet|ZoomLevelSet]] |
- | * **Description**:N/A | + | * Description:N/A |
- | ==== Parameters ==== | + | <div newline></div> |
- | **currentScale** | + | ** {{wiki:PublicMethod.gif|}}{{wiki:Static.gif|}} GetHigherZoomLevelScale(Double,ZoomLevelSet) ** |
- | * **Type**:Double | + | |
- | * **Description**:N/A | + | |
- | **zoomLevelSet** | + | * //ZoomToScale out, the result is greater than input// |
- | * **Type**:[[ThinkGeo.MapSuite.Core.ZoomLevelSet|ZoomLevelSet]] | + | == Remarks == |
- | * **Description**:N/A | + | * //N/A// |
- | [[#Public Methods|Go Back]] | + | == Return Value == |
- | === GetType() === | + | * Type:Double |
- | N/A | + | * Description:N/A |
- | ==== Remarks ==== | + | |
- | N/A | + | |
- | **Return Value** | + | == Parameters == |
- | * **Return Type**:Type | + | * //currentScale// |
- | * **Description**:N/A | + | * Type:Double |
+ | * Description:N/A | ||
- | ==== Parameters ==== | + | * //zoomLevelSet// |
- | [[#Public Methods|Go Back]] | + | * Type:[[ThinkGeo.MapSuite.Core.ZoomLevelSet|ZoomLevelSet]] |
- | === GetZoomLevel(RectangleShape,Double,GeographyUnit) === | + | * Description:N/A |
- | This method returns the active ZoomLevel based on an extent, a map unit and a screen width. | + | |
- | ==== Remarks ==== | + | |
- | N/A | + | |
- | **Return Value** | + | <div newline></div> |
- | * **Return Type**:[[ThinkGeo.MapSuite.Core.ZoomLevel|ZoomLevel]] | + | ==== Protected Methods ==== |
- | * **Description**:This method returns the active ZoomLevel based on an extent, a map unit and a screen width. | + | ** {{wiki:ProtectedMethod.gif|}} GetSnappedZoomLevel(Double) ** |
- | ==== Parameters ==== | + | * //N/A// |
- | **extent** | + | == Remarks == |
- | * **Type**:[[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]] | + | * //N/A// |
- | * **Description**:This parameter is a world extent. | + | |
- | **screenWidth** | + | == Return Value == |
- | * **Type**:Double | + | * Type:[[ThinkGeo.MapSuite.Core.ZoomLevel|ZoomLevel]] |
- | * **Description**:This parameter is the width of the map in pixels. | + | * Description:N/A |
- | **mapUnit** | + | == Parameters == |
- | * **Type**:[[ThinkGeo.MapSuite.Core.GeographyUnit|GeographyUnit]] | + | * //scale// |
- | * **Description**:This parameter is the unit of the map. | + | * Type:Double |
+ | * Description:N/A | ||
- | [[#Public Methods|Go Back]] | + | <div newline></div> |
- | === GetZoomLevel(RectangleShape,Double,GeographyUnit,Single) === | + | ** {{wiki:ProtectedMethod.gif|}} Finalize() ** |
- | This method returns the active ZoomLevel based on an extent, a map unit and a screen width. | + | |
- | ==== Remarks ==== | + | |
- | N/A | + | |
- | **Return Value** | + | * //N/A// |
- | * **Return Type**:[[ThinkGeo.MapSuite.Core.ZoomLevel|ZoomLevel]] | + | == Remarks == |
- | * **Description**:This method returns the active ZoomLevel based on an extent, a map unit and a screen width. | + | * //N/A// |
- | ==== Parameters ==== | + | == Return Value == |
- | **extent** | + | * Type:Void |
- | * **Type**:[[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]] | + | * Description:N/A |
- | * **Description**:This parameter is a world extent. | + | |
- | **screenWidth** | + | == Parameters == |
- | * **Type**:Double | + | <div newline></div> |
- | * **Description**:This parameter is the width of the map in pixels. | + | ** {{wiki:ProtectedMethod.gif|}} MemberwiseClone() ** |
- | **mapUnit** | + | * //N/A// |
- | * **Type**:[[ThinkGeo.MapSuite.Core.GeographyUnit|GeographyUnit]] | + | == Remarks == |
- | * **Description**:This parameter is the unit of the map. | + | * //N/A// |
- | **dpi** | + | == Return Value == |
- | * **Type**:Single | + | * Type:Object |
- | * **Description**:This parameter is the dpi of the extent. | + | * Description:N/A |
- | [[#Public Methods|Go Back]] | + | == Parameters == |
- | === GetZoomLevelForDrawing(RectangleShape,Double,GeographyUnit,Single) === | + | <div newline></div> |
- | This method returns the active ZoomLevel based on an extent, a map unit and a canvas width. | + | ==== Public Properties ==== |
- | ==== Remarks ==== | + | ** {{wiki:PublicProperty.gif|}} Name ** |
- | N/A | + | |
- | **Return Value** | + | This property gets and sets the name for the ZoomSet. |
- | * **Return Type**:[[ThinkGeo.MapSuite.Core.ZoomLevel|ZoomLevel]] | + | == Remarks == |
- | * **Description**:This method returns the active ZoomLevel based on an extent, map unit and a canvas width. | + | The name is user defined. It is useful to set, as it may be used for higher level components such as legends, etc. |
- | + | == Return Value == | |
- | ==== Parameters ==== | + | * Type:String |
- | **extent** | + | |
- | * **Type**:[[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]] | + | |
- | * **Description**:This parameter is a world extent. | + | |
- | + | ||
- | **screenWidth** | + | |
- | * **Type**:Double | + | |
- | * **Description**:This parameter is the width of the canvas in pixels. | + | |
- | + | ||
- | **mapUnit** | + | |
- | * **Type**:[[ThinkGeo.MapSuite.Core.GeographyUnit|GeographyUnit]] | + | |
- | * **Description**:This parameter is the unit of the map. | + | |
- | **dpi** | + | ** {{wiki:PublicProperty.gif|}} CustomZoomLevels ** |
- | * **Type**:Single | + | |
- | * **Description**:This parameter is the dpi of the extent. | + | |
- | [[#Public Methods|Go Back]] | ||
- | === GetZoomLevelForDrawing(RectangleShape,Double,GeographyUnit) === | ||
- | This method returns the active ZoomLevel based on an extent, a map unit and a canvas width. | ||
- | ==== Remarks ==== | ||
- | N/A | ||
- | |||
- | **Return Value** | ||
- | * **Return Type**:[[ThinkGeo.MapSuite.Core.ZoomLevel|ZoomLevel]] | ||
- | * **Description**:This method returns the active ZoomLevel based on an extent, map unit and a canvas width. | ||
- | |||
- | ==== Parameters ==== | ||
- | **extent** | ||
- | * **Type**:[[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]] | ||
- | * **Description**:This parameter is a world extent. | ||
- | |||
- | **screenWidth** | ||
- | * **Type**:Double | ||
- | * **Description**:This parameter is the width of the canvas in pixels. | ||
- | |||
- | **mapUnit** | ||
- | * **Type**:[[ThinkGeo.MapSuite.Core.GeographyUnit|GeographyUnit]] | ||
- | * **Description**:This parameter is the unit of the map. | ||
- | |||
- | [[#Public Methods|Go Back]] | ||
- | === GetZoomLevels() === | ||
- | This method return all of the zoomLevels in the zoomLevelSet. | ||
- | ==== Remarks ==== | ||
- | None. | ||
- | |||
- | **Return Value** | ||
- | * **Return Type**:Collection<[[ThinkGeo.MapSuite.Core.ZoomLevel|ZoomLevel]]> | ||
- | * **Description**:This method return all of the zoomlevels in the zoomLevelSet. | ||
- | |||
- | ==== Parameters ==== | ||
- | [[#Public Methods|Go Back]] | ||
- | === ToString() === | ||
- | N/A | ||
- | ==== Remarks ==== | ||
- | N/A | ||
- | |||
- | **Return Value** | ||
- | * **Return Type**:String | ||
- | * **Description**:N/A | ||
- | |||
- | ==== Parameters ==== | ||
- | [[#Public Methods|Go Back]] | ||
- | ===== Protected Methods ===== | ||
- | === Finalize() === | ||
- | N/A | ||
- | ==== Remarks ==== | ||
- | N/A | ||
- | |||
- | **Return Value** | ||
- | * **Return Type**:Void | ||
- | * **Description**:N/A | ||
- | |||
- | ==== Parameters ==== | ||
- | [[#Protected Methods|Go Back]] | ||
- | === MemberwiseClone() === | ||
- | N/A | ||
- | ==== Remarks ==== | ||
- | N/A | ||
- | |||
- | **Return Value** | ||
- | * **Return Type**:Object | ||
- | * **Description**:N/A | ||
- | |||
- | ==== Parameters ==== | ||
- | [[#Protected Methods|Go Back]] | ||
- | === uSk=(Double) === | ||
- | N/A | ||
- | ==== Remarks ==== | ||
- | N/A | ||
- | |||
- | **Return Value** | ||
- | * **Return Type**:[[ThinkGeo.MapSuite.Core.ZoomLevel|ZoomLevel]] | ||
- | * **Description**:N/A | ||
- | |||
- | ==== Parameters ==== | ||
- | **scale** | ||
- | * **Type**:Double | ||
- | * **Description**:N/A | ||
- | |||
- | [[#Protected Methods|Go Back]] | ||
- | ===== Public Properties ===== | ||
- | === CustomZoomLevels === | ||
This property gets the custom zoom levels from the zoomLevelSet. | This property gets the custom zoom levels from the zoomLevelSet. | ||
- | ==== Remarks ==== | + | == Remarks == |
None | None | ||
- | ==== Return Value ==== | + | == Return Value == |
- | **Return Type**:Collection<[[ThinkGeo.MapSuite.Core.ZoomLevel|ZoomLevel]]> | + | * Type:Collection<[[ThinkGeo.MapSuite.Core.ZoomLevel|ZoomLevel]]> |
- | [[#Public Properties|Go Back]] | + | ** {{wiki:PublicProperty.gif|}} ZoomLevel01 ** |
- | === Name === | + | |
- | This property gets and sets the name for the ZoomSet. | + | |
- | ==== Remarks ==== | + | |
- | The name is user defined. It is useful to set, as it may be used for higher level components such as legends, etc. | + | |
- | ==== Return Value ==== | + | |
- | **Return Type**:String | + | |
- | [[#Public Properties|Go Back]] | ||
- | === ZoomLevel01 === | ||
This property gets the ZoomLevel for Level01. | This property gets the ZoomLevel for Level01. | ||
- | ==== Remarks ==== | + | == Remarks == |
None | None | ||
- | ==== Return Value ==== | + | == Return Value == |
- | **Return Type**:[[ThinkGeo.MapSuite.Core.ZoomLevel|ZoomLevel]] | + | * Type:[[ThinkGeo.MapSuite.Core.ZoomLevel|ZoomLevel]] |
+ | |||
+ | ** {{wiki:PublicProperty.gif|}} ZoomLevel02 ** | ||
- | [[#Public Properties|Go Back]] | ||
- | === ZoomLevel02 === | ||
This property gets the ZoomLevel for Level02. | This property gets the ZoomLevel for Level02. | ||
- | ==== Remarks ==== | + | == Remarks == |
None | None | ||
- | ==== Return Value ==== | + | == Return Value == |
- | **Return Type**:[[ThinkGeo.MapSuite.Core.ZoomLevel|ZoomLevel]] | + | * Type:[[ThinkGeo.MapSuite.Core.ZoomLevel|ZoomLevel]] |
+ | |||
+ | ** {{wiki:PublicProperty.gif|}} ZoomLevel03 ** | ||
- | [[#Public Properties|Go Back]] | ||
- | === ZoomLevel03 === | ||
This property gets the ZoomLevel for Level03. | This property gets the ZoomLevel for Level03. | ||
- | ==== Remarks ==== | + | == Remarks == |
None | None | ||
- | ==== Return Value ==== | + | == Return Value == |
- | **Return Type**:[[ThinkGeo.MapSuite.Core.ZoomLevel|ZoomLevel]] | + | * Type:[[ThinkGeo.MapSuite.Core.ZoomLevel|ZoomLevel]] |
+ | |||
+ | ** {{wiki:PublicProperty.gif|}} ZoomLevel04 ** | ||
- | [[#Public Properties|Go Back]] | ||
- | === ZoomLevel04 === | ||
This property gets the ZoomLevel for Level04. | This property gets the ZoomLevel for Level04. | ||
- | ==== Remarks ==== | + | == Remarks == |
None | None | ||
- | ==== Return Value ==== | + | == Return Value == |
- | **Return Type**:[[ThinkGeo.MapSuite.Core.ZoomLevel|ZoomLevel]] | + | * Type:[[ThinkGeo.MapSuite.Core.ZoomLevel|ZoomLevel]] |
+ | |||
+ | ** {{wiki:PublicProperty.gif|}} ZoomLevel05 ** | ||
- | [[#Public Properties|Go Back]] | ||
- | === ZoomLevel05 === | ||
This property gets the ZoomLevel for Level05. | This property gets the ZoomLevel for Level05. | ||
- | ==== Remarks ==== | + | == Remarks == |
None | None | ||
- | ==== Return Value ==== | + | == Return Value == |
- | **Return Type**:[[ThinkGeo.MapSuite.Core.ZoomLevel|ZoomLevel]] | + | * Type:[[ThinkGeo.MapSuite.Core.ZoomLevel|ZoomLevel]] |
+ | |||
+ | ** {{wiki:PublicProperty.gif|}} ZoomLevel06 ** | ||
- | [[#Public Properties|Go Back]] | ||
- | === ZoomLevel06 === | ||
This property gets the ZoomLevel for Level06. | This property gets the ZoomLevel for Level06. | ||
- | ==== Remarks ==== | + | == Remarks == |
None | None | ||
- | ==== Return Value ==== | + | == Return Value == |
- | **Return Type**:[[ThinkGeo.MapSuite.Core.ZoomLevel|ZoomLevel]] | + | * Type:[[ThinkGeo.MapSuite.Core.ZoomLevel|ZoomLevel]] |
+ | |||
+ | ** {{wiki:PublicProperty.gif|}} ZoomLevel07 ** | ||
- | [[#Public Properties|Go Back]] | ||
- | === ZoomLevel07 === | ||
This property gets the ZoomLevel for Level07. | This property gets the ZoomLevel for Level07. | ||
- | ==== Remarks ==== | + | == Remarks == |
None | None | ||
- | ==== Return Value ==== | + | == Return Value == |
- | **Return Type**:[[ThinkGeo.MapSuite.Core.ZoomLevel|ZoomLevel]] | + | * Type:[[ThinkGeo.MapSuite.Core.ZoomLevel|ZoomLevel]] |
+ | |||
+ | ** {{wiki:PublicProperty.gif|}} ZoomLevel08 ** | ||
- | [[#Public Properties|Go Back]] | ||
- | === ZoomLevel08 === | ||
This property gets the ZoomLevel for Level08. | This property gets the ZoomLevel for Level08. | ||
- | ==== Remarks ==== | + | == Remarks == |
None | None | ||
- | ==== Return Value ==== | + | == Return Value == |
- | **Return Type**:[[ThinkGeo.MapSuite.Core.ZoomLevel|ZoomLevel]] | + | * Type:[[ThinkGeo.MapSuite.Core.ZoomLevel|ZoomLevel]] |
+ | |||
+ | ** {{wiki:PublicProperty.gif|}} ZoomLevel09 ** | ||
- | [[#Public Properties|Go Back]] | ||
- | === ZoomLevel09 === | ||
This property gets the ZoomLevel for Level09. | This property gets the ZoomLevel for Level09. | ||
- | ==== Remarks ==== | + | == Remarks == |
None | None | ||
- | ==== Return Value ==== | + | == Return Value == |
- | **Return Type**:[[ThinkGeo.MapSuite.Core.ZoomLevel|ZoomLevel]] | + | * Type:[[ThinkGeo.MapSuite.Core.ZoomLevel|ZoomLevel]] |
+ | |||
+ | ** {{wiki:PublicProperty.gif|}} ZoomLevel10 ** | ||
- | [[#Public Properties|Go Back]] | ||
- | === ZoomLevel10 === | ||
This property gets the ZoomLevel for Level10. | This property gets the ZoomLevel for Level10. | ||
- | ==== Remarks ==== | + | == Remarks == |
None | None | ||
- | ==== Return Value ==== | + | == Return Value == |
- | **Return Type**:[[ThinkGeo.MapSuite.Core.ZoomLevel|ZoomLevel]] | + | * Type:[[ThinkGeo.MapSuite.Core.ZoomLevel|ZoomLevel]] |
+ | |||
+ | ** {{wiki:PublicProperty.gif|}} ZoomLevel11 ** | ||
- | [[#Public Properties|Go Back]] | ||
- | === ZoomLevel11 === | ||
This property gets the ZoomLevel for Level11. | This property gets the ZoomLevel for Level11. | ||
- | ==== Remarks ==== | + | == Remarks == |
None | None | ||
- | ==== Return Value ==== | + | == Return Value == |
- | **Return Type**:[[ThinkGeo.MapSuite.Core.ZoomLevel|ZoomLevel]] | + | * Type:[[ThinkGeo.MapSuite.Core.ZoomLevel|ZoomLevel]] |
+ | |||
+ | ** {{wiki:PublicProperty.gif|}} ZoomLevel12 ** | ||
- | [[#Public Properties|Go Back]] | ||
- | === ZoomLevel12 === | ||
This property gets the ZoomLevel for Level12. | This property gets the ZoomLevel for Level12. | ||
- | ==== Remarks ==== | + | == Remarks == |
None | None | ||
- | ==== Return Value ==== | + | == Return Value == |
- | **Return Type**:[[ThinkGeo.MapSuite.Core.ZoomLevel|ZoomLevel]] | + | * Type:[[ThinkGeo.MapSuite.Core.ZoomLevel|ZoomLevel]] |
+ | |||
+ | ** {{wiki:PublicProperty.gif|}} ZoomLevel13 ** | ||
- | [[#Public Properties|Go Back]] | ||
- | === ZoomLevel13 === | ||
This property gets the ZoomLevel for Level13. | This property gets the ZoomLevel for Level13. | ||
- | ==== Remarks ==== | + | == Remarks == |
None | None | ||
- | ==== Return Value ==== | + | == Return Value == |
- | **Return Type**:[[ThinkGeo.MapSuite.Core.ZoomLevel|ZoomLevel]] | + | * Type:[[ThinkGeo.MapSuite.Core.ZoomLevel|ZoomLevel]] |
+ | |||
+ | ** {{wiki:PublicProperty.gif|}} ZoomLevel14 ** | ||
- | [[#Public Properties|Go Back]] | ||
- | === ZoomLevel14 === | ||
This property gets the ZoomLevel for Level14. | This property gets the ZoomLevel for Level14. | ||
- | ==== Remarks ==== | + | == Remarks == |
None | None | ||
- | ==== Return Value ==== | + | == Return Value == |
- | **Return Type**:[[ThinkGeo.MapSuite.Core.ZoomLevel|ZoomLevel]] | + | * Type:[[ThinkGeo.MapSuite.Core.ZoomLevel|ZoomLevel]] |
+ | |||
+ | ** {{wiki:PublicProperty.gif|}} ZoomLevel15 ** | ||
- | [[#Public Properties|Go Back]] | ||
- | === ZoomLevel15 === | ||
This property gets the ZoomLevel for Level15. | This property gets the ZoomLevel for Level15. | ||
- | ==== Remarks ==== | + | == Remarks == |
None | None | ||
- | ==== Return Value ==== | + | == Return Value == |
- | **Return Type**:[[ThinkGeo.MapSuite.Core.ZoomLevel|ZoomLevel]] | + | * Type:[[ThinkGeo.MapSuite.Core.ZoomLevel|ZoomLevel]] |
+ | |||
+ | ** {{wiki:PublicProperty.gif|}} ZoomLevel16 ** | ||
- | [[#Public Properties|Go Back]] | ||
- | === ZoomLevel16 === | ||
This property gets the ZoomLevel for Level16. | This property gets the ZoomLevel for Level16. | ||
- | ==== Remarks ==== | + | == Remarks == |
None | None | ||
- | ==== Return Value ==== | + | == Return Value == |
- | **Return Type**:[[ThinkGeo.MapSuite.Core.ZoomLevel|ZoomLevel]] | + | * Type:[[ThinkGeo.MapSuite.Core.ZoomLevel|ZoomLevel]] |
+ | |||
+ | ** {{wiki:PublicProperty.gif|}} ZoomLevel17 ** | ||
- | [[#Public Properties|Go Back]] | ||
- | === ZoomLevel17 === | ||
This property gets the ZoomLevel for Level17. | This property gets the ZoomLevel for Level17. | ||
- | ==== Remarks ==== | + | == Remarks == |
None | None | ||
- | ==== Return Value ==== | + | == Return Value == |
- | **Return Type**:[[ThinkGeo.MapSuite.Core.ZoomLevel|ZoomLevel]] | + | * Type:[[ThinkGeo.MapSuite.Core.ZoomLevel|ZoomLevel]] |
+ | |||
+ | ** {{wiki:PublicProperty.gif|}} ZoomLevel18 ** | ||
- | [[#Public Properties|Go Back]] | ||
- | === ZoomLevel18 === | ||
This property gets the ZoomLevel for Level18. | This property gets the ZoomLevel for Level18. | ||
- | ==== Remarks ==== | + | == Remarks == |
None | None | ||
- | ==== Return Value ==== | + | == Return Value == |
- | **Return Type**:[[ThinkGeo.MapSuite.Core.ZoomLevel|ZoomLevel]] | + | * Type:[[ThinkGeo.MapSuite.Core.ZoomLevel|ZoomLevel]] |
+ | |||
+ | ** {{wiki:PublicProperty.gif|}} ZoomLevel19 ** | ||
- | [[#Public Properties|Go Back]] | ||
- | === ZoomLevel19 === | ||
This property gets the ZoomLevel for Level19. | This property gets the ZoomLevel for Level19. | ||
- | ==== Remarks ==== | + | == Remarks == |
None | None | ||
- | ==== Return Value ==== | + | == Return Value == |
- | **Return Type**:[[ThinkGeo.MapSuite.Core.ZoomLevel|ZoomLevel]] | + | * Type:[[ThinkGeo.MapSuite.Core.ZoomLevel|ZoomLevel]] |
+ | |||
+ | ** {{wiki:PublicProperty.gif|}} ZoomLevel20 ** | ||
- | [[#Public Properties|Go Back]] | ||
- | === ZoomLevel20 === | ||
This property gets the ZoomLevel for Level20. | This property gets the ZoomLevel for Level20. | ||
- | ==== Remarks ==== | + | == Remarks == |
None | None | ||
- | ==== Return Value ==== | + | == Return Value == |
- | **Return Type**:[[ThinkGeo.MapSuite.Core.ZoomLevel|ZoomLevel]] | + | * Type:[[ThinkGeo.MapSuite.Core.ZoomLevel|ZoomLevel]] |
- | [[#Public Properties|Go Back]] | + | ==== Protected Properties ==== |
- | ===== Protected Properties ===== | + | ==== Public Events ==== |
- | ===== Public Events ===== | + | |