This shows you the differences between two versions of the page.
Both sides previous revision Previous revision Next revision | Previous revision | ||
thinkgeo.mapsuite.portablecore.zoomlevelset [2015/09/21 08:22] admin |
thinkgeo.mapsuite.portablecore.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 ===== | ||
*System.Object | *System.Object | ||
***ThinkGeo.MapSuite.Core.ZoomLevelSet** | ***ThinkGeo.MapSuite.Core.ZoomLevelSet** | ||
- | *[[ThinkGeo.MapSuite.Core.SphericalMercatorZoomLevelSet]] | ||
*[[ThinkGeo.MapSuite.Core.BingMapsZoomLevelSet]] | *[[ThinkGeo.MapSuite.Core.BingMapsZoomLevelSet]] | ||
*[[ThinkGeo.MapSuite.Core.GoogleMapsZoomLevelSet]] | *[[ThinkGeo.MapSuite.Core.GoogleMapsZoomLevelSet]] | ||
- | *[[ThinkGeo.MapSuite.Core.PrinterZoomLevelSet]] | ||
*[[ThinkGeo.MapSuite.Core.OpenStreetMapsZoomLevelSet]] | *[[ThinkGeo.MapSuite.Core.OpenStreetMapsZoomLevelSet]] | ||
+ | *[[ThinkGeo.MapSuite.Core.SphericalMercatorZoomLevelSet]] | ||
===== Members Summary ===== | ===== Members Summary ===== | ||
==== Public Constructors ==== | ==== Public Constructors ==== | ||
** {{wiki:PublicMethod.gif|}} ZoomLevelSet() ** | ** {{wiki:PublicMethod.gif|}} ZoomLevelSet() ** | ||
- | This is the default constructor. | + | * //This is the default constructor.// |
== Remarks == | == 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. | + | * //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 == | == Parameters == | ||
<div newline></div> | <div newline></div> | ||
Line 22: | Line 24: | ||
** {{wiki:PublicMethod.gif|}} GetZoomLevel(RectangleShape,Double,GeographyUnit) ** | ** {{wiki:PublicMethod.gif|}} GetZoomLevel(RectangleShape,Double,GeographyUnit) ** | ||
- | This method returns the active ZoomLevel based on an extent, a map unit and a screen width. | + | * //This method returns the active ZoomLevel based on an extent, a map unit and a screen width.// |
== Remarks == | == Remarks == | ||
- | N/A | + | * //N/A// |
== Return Value == | == Return Value == | ||
Line 46: | Line 48: | ||
** {{wiki:PublicMethod.gif|}} GetZoomLevel(RectangleShape,Double,GeographyUnit,Single) ** | ** {{wiki:PublicMethod.gif|}} GetZoomLevel(RectangleShape,Double,GeographyUnit,Single) ** | ||
- | This method returns the active ZoomLevel based on an extent, a map unit and a screen width. | + | * //This method returns the active ZoomLevel based on an extent, a map unit and a screen width.// |
== Remarks == | == Remarks == | ||
- | N/A | + | * //N/A// |
== Return Value == | == Return Value == | ||
Line 74: | Line 76: | ||
** {{wiki:PublicMethod.gif|}} GetZoomLevelForDrawing(RectangleShape,Double,GeographyUnit,Single) ** | ** {{wiki:PublicMethod.gif|}} GetZoomLevelForDrawing(RectangleShape,Double,GeographyUnit,Single) ** | ||
- | This method returns the active ZoomLevel based on an extent, a map unit and a canvas width. | + | * //This method returns the active ZoomLevel based on an extent, a map unit and a canvas width.// |
== Remarks == | == Remarks == | ||
- | N/A | + | * //N/A// |
== Return Value == | == Return Value == | ||
Line 102: | Line 104: | ||
** {{wiki:PublicMethod.gif|}} GetZoomLevelForDrawing(RectangleShape,Double,GeographyUnit) ** | ** {{wiki:PublicMethod.gif|}} GetZoomLevelForDrawing(RectangleShape,Double,GeographyUnit) ** | ||
- | This method returns the active ZoomLevel based on an extent, a map unit and a canvas width. | + | * //This method returns the active ZoomLevel based on an extent, a map unit and a canvas width.// |
== Remarks == | == Remarks == | ||
- | N/A | + | * //N/A// |
== Return Value == | == Return Value == | ||
Line 126: | Line 128: | ||
** {{wiki:PublicMethod.gif|}} GetZoomLevels() ** | ** {{wiki:PublicMethod.gif|}} GetZoomLevels() ** | ||
- | This method return all of the zoomLevels in the zoomLevelSet. | + | * //This method return all of the zoomLevels in the zoomLevelSet.// |
== Remarks == | == Remarks == | ||
- | None. | + | * //None.// |
== Return Value == | == Return Value == | ||
Line 138: | Line 140: | ||
** {{wiki:PublicMethod.gif|}} ToString() ** | ** {{wiki:PublicMethod.gif|}} ToString() ** | ||
- | N/A | + | * //N/A// |
== Remarks == | == Remarks == | ||
- | N/A | + | * //N/A// |
== Return Value == | == Return Value == | ||
Line 150: | Line 152: | ||
** {{wiki:PublicMethod.gif|}} Equals(Object) ** | ** {{wiki:PublicMethod.gif|}} Equals(Object) ** | ||
- | N/A | + | * //N/A// |
== Remarks == | == Remarks == | ||
- | N/A | + | * //N/A// |
== Return Value == | == Return Value == | ||
Line 166: | Line 168: | ||
** {{wiki:PublicMethod.gif|}} GetHashCode() ** | ** {{wiki:PublicMethod.gif|}} GetHashCode() ** | ||
- | N/A | + | * //N/A// |
== Remarks == | == Remarks == | ||
- | N/A | + | * //N/A// |
== Return Value == | == Return Value == | ||
Line 178: | Line 180: | ||
** {{wiki:PublicMethod.gif|}} GetType() ** | ** {{wiki:PublicMethod.gif|}} GetType() ** | ||
- | N/A | + | * //N/A// |
== Remarks == | == Remarks == | ||
- | N/A | + | * //N/A// |
== Return Value == | == Return Value == | ||
Line 190: | Line 192: | ||
** {{wiki:PublicMethod.gif|}}{{wiki:Static.gif|}} GetLowerZoomLevelScale(Double,ZoomLevelSet) ** | ** {{wiki:PublicMethod.gif|}}{{wiki:Static.gif|}} GetLowerZoomLevelScale(Double,ZoomLevelSet) ** | ||
- | ZoomToScale in, the result is less than input | + | * //ZoomToScale in, the result is less than input// |
== Remarks == | == Remarks == | ||
- | N/A | + | * //N/A// |
== Return Value == | == Return Value == | ||
Line 210: | Line 212: | ||
** {{wiki:PublicMethod.gif|}}{{wiki:Static.gif|}} GetHigherZoomLevelScale(Double,ZoomLevelSet) ** | ** {{wiki:PublicMethod.gif|}}{{wiki:Static.gif|}} GetHigherZoomLevelScale(Double,ZoomLevelSet) ** | ||
- | ZoomToScale out, the result is greater than input | + | * //ZoomToScale out, the result is greater than input// |
== Remarks == | == Remarks == | ||
- | N/A | + | * //N/A// |
== Return Value == | == Return Value == | ||
Line 229: | Line 231: | ||
<div newline></div> | <div newline></div> | ||
==== Protected Methods ==== | ==== Protected Methods ==== | ||
- | ** {{wiki:ProtectedMethod.gif|}} uSk=(Double) ** | + | ** {{wiki:ProtectedMethod.gif|}} GetSnappedZoomLevel(Double) ** |
- | N/A | + | * //N/A// |
== Remarks == | == Remarks == | ||
- | N/A | + | * //N/A// |
== Return Value == | == Return Value == | ||
Line 247: | Line 249: | ||
** {{wiki:ProtectedMethod.gif|}} Finalize() ** | ** {{wiki:ProtectedMethod.gif|}} Finalize() ** | ||
- | N/A | + | * //N/A// |
== Remarks == | == Remarks == | ||
- | N/A | + | * //N/A// |
== Return Value == | == Return Value == | ||
Line 259: | Line 261: | ||
** {{wiki:ProtectedMethod.gif|}} MemberwiseClone() ** | ** {{wiki:ProtectedMethod.gif|}} MemberwiseClone() ** | ||
- | N/A | + | * //N/A// |
== Remarks == | == Remarks == | ||
- | N/A | + | * //N/A// |
== Return Value == | == Return Value == | ||
Line 272: | Line 274: | ||
** {{wiki:PublicProperty.gif|}} Name ** | ** {{wiki:PublicProperty.gif|}} Name ** | ||
- | This property gets and sets the name for the ZoomSet. | + | * //This property gets and sets the name for the ZoomSet.// |
== Remarks == | == Remarks == | ||
- | The name is user defined. It is useful to set, as it may be used for higher level components such as legends, etc. | + | * //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 Value == | ||
* Type:String | * Type:String | ||
Line 280: | Line 282: | ||
** {{wiki:PublicProperty.gif|}} CustomZoomLevels ** | ** {{wiki:PublicProperty.gif|}} 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 == | ||
* Type:Collection<[[ThinkGeo.MapSuite.Core.ZoomLevel|ZoomLevel]]> | * Type:Collection<[[ThinkGeo.MapSuite.Core.ZoomLevel|ZoomLevel]]> | ||
Line 288: | Line 290: | ||
** {{wiki:PublicProperty.gif|}} ZoomLevel01 ** | ** {{wiki:PublicProperty.gif|}} ZoomLevel01 ** | ||
- | This property gets the ZoomLevel for Level01. | + | * //This property gets the ZoomLevel for Level01.// |
== Remarks == | == Remarks == | ||
- | None | + | * //None// |
== Return Value == | == Return Value == | ||
* Type:[[ThinkGeo.MapSuite.Core.ZoomLevel|ZoomLevel]] | * Type:[[ThinkGeo.MapSuite.Core.ZoomLevel|ZoomLevel]] | ||
Line 296: | Line 298: | ||
** {{wiki:PublicProperty.gif|}} ZoomLevel02 ** | ** {{wiki:PublicProperty.gif|}} ZoomLevel02 ** | ||
- | This property gets the ZoomLevel for Level02. | + | * //This property gets the ZoomLevel for Level02.// |
== Remarks == | == Remarks == | ||
- | None | + | * //None// |
== Return Value == | == Return Value == | ||
* Type:[[ThinkGeo.MapSuite.Core.ZoomLevel|ZoomLevel]] | * Type:[[ThinkGeo.MapSuite.Core.ZoomLevel|ZoomLevel]] | ||
Line 304: | Line 306: | ||
** {{wiki:PublicProperty.gif|}} ZoomLevel03 ** | ** {{wiki:PublicProperty.gif|}} ZoomLevel03 ** | ||
- | This property gets the ZoomLevel for Level03. | + | * //This property gets the ZoomLevel for Level03.// |
== Remarks == | == Remarks == | ||
- | None | + | * //None// |
== Return Value == | == Return Value == | ||
* Type:[[ThinkGeo.MapSuite.Core.ZoomLevel|ZoomLevel]] | * Type:[[ThinkGeo.MapSuite.Core.ZoomLevel|ZoomLevel]] | ||
Line 312: | Line 314: | ||
** {{wiki:PublicProperty.gif|}} ZoomLevel04 ** | ** {{wiki:PublicProperty.gif|}} ZoomLevel04 ** | ||
- | This property gets the ZoomLevel for Level04. | + | * //This property gets the ZoomLevel for Level04.// |
== Remarks == | == Remarks == | ||
- | None | + | * //None// |
== Return Value == | == Return Value == | ||
* Type:[[ThinkGeo.MapSuite.Core.ZoomLevel|ZoomLevel]] | * Type:[[ThinkGeo.MapSuite.Core.ZoomLevel|ZoomLevel]] | ||
Line 320: | Line 322: | ||
** {{wiki:PublicProperty.gif|}} ZoomLevel05 ** | ** {{wiki:PublicProperty.gif|}} ZoomLevel05 ** | ||
- | This property gets the ZoomLevel for Level05. | + | * //This property gets the ZoomLevel for Level05.// |
== Remarks == | == Remarks == | ||
- | None | + | * //None// |
== Return Value == | == Return Value == | ||
* Type:[[ThinkGeo.MapSuite.Core.ZoomLevel|ZoomLevel]] | * Type:[[ThinkGeo.MapSuite.Core.ZoomLevel|ZoomLevel]] | ||
Line 328: | Line 330: | ||
** {{wiki:PublicProperty.gif|}} ZoomLevel06 ** | ** {{wiki:PublicProperty.gif|}} ZoomLevel06 ** | ||
- | This property gets the ZoomLevel for Level06. | + | * //This property gets the ZoomLevel for Level06.// |
== Remarks == | == Remarks == | ||
- | None | + | * //None// |
== Return Value == | == Return Value == | ||
* Type:[[ThinkGeo.MapSuite.Core.ZoomLevel|ZoomLevel]] | * Type:[[ThinkGeo.MapSuite.Core.ZoomLevel|ZoomLevel]] | ||
Line 336: | Line 338: | ||
** {{wiki:PublicProperty.gif|}} ZoomLevel07 ** | ** {{wiki:PublicProperty.gif|}} ZoomLevel07 ** | ||
- | This property gets the ZoomLevel for Level07. | + | * //This property gets the ZoomLevel for Level07.// |
== Remarks == | == Remarks == | ||
- | None | + | * //None// |
== Return Value == | == Return Value == | ||
* Type:[[ThinkGeo.MapSuite.Core.ZoomLevel|ZoomLevel]] | * Type:[[ThinkGeo.MapSuite.Core.ZoomLevel|ZoomLevel]] | ||
Line 344: | Line 346: | ||
** {{wiki:PublicProperty.gif|}} ZoomLevel08 ** | ** {{wiki:PublicProperty.gif|}} ZoomLevel08 ** | ||
- | This property gets the ZoomLevel for Level08. | + | * //This property gets the ZoomLevel for Level08.// |
== Remarks == | == Remarks == | ||
- | None | + | * //None// |
== Return Value == | == Return Value == | ||
* Type:[[ThinkGeo.MapSuite.Core.ZoomLevel|ZoomLevel]] | * Type:[[ThinkGeo.MapSuite.Core.ZoomLevel|ZoomLevel]] | ||
Line 352: | Line 354: | ||
** {{wiki:PublicProperty.gif|}} ZoomLevel09 ** | ** {{wiki:PublicProperty.gif|}} ZoomLevel09 ** | ||
- | This property gets the ZoomLevel for Level09. | + | * //This property gets the ZoomLevel for Level09.// |
== Remarks == | == Remarks == | ||
- | None | + | * //None// |
== Return Value == | == Return Value == | ||
* Type:[[ThinkGeo.MapSuite.Core.ZoomLevel|ZoomLevel]] | * Type:[[ThinkGeo.MapSuite.Core.ZoomLevel|ZoomLevel]] | ||
Line 360: | Line 362: | ||
** {{wiki:PublicProperty.gif|}} ZoomLevel10 ** | ** {{wiki:PublicProperty.gif|}} ZoomLevel10 ** | ||
- | This property gets the ZoomLevel for Level10. | + | * //This property gets the ZoomLevel for Level10.// |
== Remarks == | == Remarks == | ||
- | None | + | * //None// |
== Return Value == | == Return Value == | ||
* Type:[[ThinkGeo.MapSuite.Core.ZoomLevel|ZoomLevel]] | * Type:[[ThinkGeo.MapSuite.Core.ZoomLevel|ZoomLevel]] | ||
Line 368: | Line 370: | ||
** {{wiki:PublicProperty.gif|}} ZoomLevel11 ** | ** {{wiki:PublicProperty.gif|}} ZoomLevel11 ** | ||
- | This property gets the ZoomLevel for Level11. | + | * //This property gets the ZoomLevel for Level11.// |
== Remarks == | == Remarks == | ||
- | None | + | * //None// |
== Return Value == | == Return Value == | ||
* Type:[[ThinkGeo.MapSuite.Core.ZoomLevel|ZoomLevel]] | * Type:[[ThinkGeo.MapSuite.Core.ZoomLevel|ZoomLevel]] | ||
Line 376: | Line 378: | ||
** {{wiki:PublicProperty.gif|}} ZoomLevel12 ** | ** {{wiki:PublicProperty.gif|}} ZoomLevel12 ** | ||
- | This property gets the ZoomLevel for Level12. | + | * //This property gets the ZoomLevel for Level12.// |
== Remarks == | == Remarks == | ||
- | None | + | * //None// |
== Return Value == | == Return Value == | ||
* Type:[[ThinkGeo.MapSuite.Core.ZoomLevel|ZoomLevel]] | * Type:[[ThinkGeo.MapSuite.Core.ZoomLevel|ZoomLevel]] | ||
Line 384: | Line 386: | ||
** {{wiki:PublicProperty.gif|}} ZoomLevel13 ** | ** {{wiki:PublicProperty.gif|}} ZoomLevel13 ** | ||
- | This property gets the ZoomLevel for Level13. | + | * //This property gets the ZoomLevel for Level13.// |
== Remarks == | == Remarks == | ||
- | None | + | * //None// |
== Return Value == | == Return Value == | ||
* Type:[[ThinkGeo.MapSuite.Core.ZoomLevel|ZoomLevel]] | * Type:[[ThinkGeo.MapSuite.Core.ZoomLevel|ZoomLevel]] | ||
Line 392: | Line 394: | ||
** {{wiki:PublicProperty.gif|}} ZoomLevel14 ** | ** {{wiki:PublicProperty.gif|}} ZoomLevel14 ** | ||
- | This property gets the ZoomLevel for Level14. | + | * //This property gets the ZoomLevel for Level14.// |
== Remarks == | == Remarks == | ||
- | None | + | * //None// |
== Return Value == | == Return Value == | ||
* Type:[[ThinkGeo.MapSuite.Core.ZoomLevel|ZoomLevel]] | * Type:[[ThinkGeo.MapSuite.Core.ZoomLevel|ZoomLevel]] | ||
Line 400: | Line 402: | ||
** {{wiki:PublicProperty.gif|}} ZoomLevel15 ** | ** {{wiki:PublicProperty.gif|}} ZoomLevel15 ** | ||
- | This property gets the ZoomLevel for Level15. | + | * //This property gets the ZoomLevel for Level15.// |
== Remarks == | == Remarks == | ||
- | None | + | * //None// |
== Return Value == | == Return Value == | ||
* Type:[[ThinkGeo.MapSuite.Core.ZoomLevel|ZoomLevel]] | * Type:[[ThinkGeo.MapSuite.Core.ZoomLevel|ZoomLevel]] | ||
Line 408: | Line 410: | ||
** {{wiki:PublicProperty.gif|}} ZoomLevel16 ** | ** {{wiki:PublicProperty.gif|}} ZoomLevel16 ** | ||
- | This property gets the ZoomLevel for Level16. | + | * //This property gets the ZoomLevel for Level16.// |
== Remarks == | == Remarks == | ||
- | None | + | * //None// |
== Return Value == | == Return Value == | ||
* Type:[[ThinkGeo.MapSuite.Core.ZoomLevel|ZoomLevel]] | * Type:[[ThinkGeo.MapSuite.Core.ZoomLevel|ZoomLevel]] | ||
Line 416: | Line 418: | ||
** {{wiki:PublicProperty.gif|}} ZoomLevel17 ** | ** {{wiki:PublicProperty.gif|}} ZoomLevel17 ** | ||
- | This property gets the ZoomLevel for Level17. | + | * //This property gets the ZoomLevel for Level17.// |
== Remarks == | == Remarks == | ||
- | None | + | * //None// |
== Return Value == | == Return Value == | ||
* Type:[[ThinkGeo.MapSuite.Core.ZoomLevel|ZoomLevel]] | * Type:[[ThinkGeo.MapSuite.Core.ZoomLevel|ZoomLevel]] | ||
Line 424: | Line 426: | ||
** {{wiki:PublicProperty.gif|}} ZoomLevel18 ** | ** {{wiki:PublicProperty.gif|}} ZoomLevel18 ** | ||
- | This property gets the ZoomLevel for Level18. | + | * //This property gets the ZoomLevel for Level18.// |
== Remarks == | == Remarks == | ||
- | None | + | * //None// |
== Return Value == | == Return Value == | ||
* Type:[[ThinkGeo.MapSuite.Core.ZoomLevel|ZoomLevel]] | * Type:[[ThinkGeo.MapSuite.Core.ZoomLevel|ZoomLevel]] | ||
Line 432: | Line 434: | ||
** {{wiki:PublicProperty.gif|}} ZoomLevel19 ** | ** {{wiki:PublicProperty.gif|}} ZoomLevel19 ** | ||
- | This property gets the ZoomLevel for Level19. | + | * //This property gets the ZoomLevel for Level19.// |
== Remarks == | == Remarks == | ||
- | None | + | * //None// |
== Return Value == | == Return Value == | ||
* Type:[[ThinkGeo.MapSuite.Core.ZoomLevel|ZoomLevel]] | * Type:[[ThinkGeo.MapSuite.Core.ZoomLevel|ZoomLevel]] | ||
Line 440: | Line 442: | ||
** {{wiki:PublicProperty.gif|}} ZoomLevel20 ** | ** {{wiki:PublicProperty.gif|}} ZoomLevel20 ** | ||
- | This property gets the ZoomLevel for Level20. | + | * //This property gets the ZoomLevel for Level20.// |
== Remarks == | == Remarks == | ||
- | None | + | * //None// |
== Return Value == | == Return Value == | ||
* Type:[[ThinkGeo.MapSuite.Core.ZoomLevel|ZoomLevel]] | * Type:[[ThinkGeo.MapSuite.Core.ZoomLevel|ZoomLevel]] |