thinkgeo.mapsuite.portablecore.zoomlevelset
Differences
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 |
— (current) | ||
|---|---|---|---|
| Line 1: | Line 1: | ||
| - | ====== ThinkGeo.MapSuite.Core.ZoomLevelSet ====== | ||
| - | This class represents a collection of ZoomLevels. | ||
| - | ===== Inheritance Hierarchy ===== | ||
| - | *System.Object | ||
| - | ***ThinkGeo.MapSuite.Core.ZoomLevelSet** | ||
| - | *[[ThinkGeo.MapSuite.Core.SphericalMercatorZoomLevelSet]] | ||
| - | *[[ThinkGeo.MapSuite.Core.BingMapsZoomLevelSet]] | ||
| - | *[[ThinkGeo.MapSuite.Core.GoogleMapsZoomLevelSet]] | ||
| - | *[[ThinkGeo.MapSuite.Core.PrinterZoomLevelSet]] | ||
| - | *[[ThinkGeo.MapSuite.Core.OpenStreetMapsZoomLevelSet]] | ||
| - | ===== Members Summary ===== | ||
| - | ==== Public Constructors ==== | ||
| - | ** {{wiki:PublicMethod.gif|}} 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 == | ||
| - | <div newline></div> | ||
| - | ==== Protected Constructors ==== | ||
| - | ==== Public Methods ==== | ||
| - | ** {{wiki:PublicMethod.gif|}} GetZoomLevel(RectangleShape,Double,GeographyUnit) ** | ||
| - | |||
| - | This method returns the active ZoomLevel based on an extent, a map unit and a screen width. | ||
| - | == Remarks == | ||
| - | N/A | ||
| - | |||
| - | == Return Value == | ||
| - | * Type:[[ThinkGeo.MapSuite.Core.ZoomLevel|ZoomLevel]] | ||
| - | * Description:This method returns the active ZoomLevel based on an extent, a map unit and a screen 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 map in pixels. | ||
| - | |||
| - | * //mapUnit// | ||
| - | * Type:[[ThinkGeo.MapSuite.Core.GeographyUnit|GeographyUnit]] | ||
| - | * Description:This parameter is the unit of the map. | ||
| - | |||
| - | <div newline></div> | ||
| - | ** {{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. | ||
| - | == Remarks == | ||
| - | N/A | ||
| - | |||
| - | == Return Value == | ||
| - | * Type:[[ThinkGeo.MapSuite.Core.ZoomLevel|ZoomLevel]] | ||
| - | * Description:This method returns the active ZoomLevel based on an extent, a map unit and a screen 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 map in pixels. | ||
| - | |||
| - | * //mapUnit// | ||
| - | * Type:[[ThinkGeo.MapSuite.Core.GeographyUnit|GeographyUnit]] | ||
| - | * Description:This parameter is the unit of the map. | ||
| - | |||
| - | * //dpi// | ||
| - | * Type:Single | ||
| - | * Description:This parameter is the dpi of the extent. | ||
| - | |||
| - | <div newline></div> | ||
| - | ** {{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. | ||
| - | == Remarks == | ||
| - | N/A | ||
| - | |||
| - | == Return Value == | ||
| - | * 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. | ||
| - | |||
| - | * //dpi// | ||
| - | * Type:Single | ||
| - | * Description:This parameter is the dpi of the extent. | ||
| - | |||
| - | <div newline></div> | ||
| - | ** {{wiki:PublicMethod.gif|}} 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 == | ||
| - | * 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. | ||
| - | |||
| - | <div newline></div> | ||
| - | ** {{wiki:PublicMethod.gif|}} GetZoomLevels() ** | ||
| - | |||
| - | This method return all of the zoomLevels in the zoomLevelSet. | ||
| - | == Remarks == | ||
| - | None. | ||
| - | |||
| - | == Return Value == | ||
| - | * Type:Collection<[[ThinkGeo.MapSuite.Core.ZoomLevel|ZoomLevel]]> | ||
| - | * Description:This method return all of the zoomlevels in the zoomLevelSet. | ||
| - | |||
| - | == Parameters == | ||
| - | <div newline></div> | ||
| - | ** {{wiki:PublicMethod.gif|}} ToString() ** | ||
| - | |||
| - | N/A | ||
| - | == Remarks == | ||
| - | N/A | ||
| - | |||
| - | == Return Value == | ||
| - | * Type:String | ||
| - | * Description:N/A | ||
| - | |||
| - | == Parameters == | ||
| - | <div newline></div> | ||
| - | ** {{wiki:PublicMethod.gif|}} Equals(Object) ** | ||
| - | |||
| - | N/A | ||
| - | == Remarks == | ||
| - | N/A | ||
| - | |||
| - | == Return Value == | ||
| - | * Type:Boolean | ||
| - | * Description:N/A | ||
| - | |||
| - | == Parameters == | ||
| - | * //obj// | ||
| - | * Type:Object | ||
| - | * Description:N/A | ||
| - | |||
| - | <div newline></div> | ||
| - | ** {{wiki:PublicMethod.gif|}} GetHashCode() ** | ||
| - | |||
| - | N/A | ||
| - | == Remarks == | ||
| - | N/A | ||
| - | |||
| - | == Return Value == | ||
| - | * Type:Int32 | ||
| - | * Description:N/A | ||
| - | |||
| - | == Parameters == | ||
| - | <div newline></div> | ||
| - | ** {{wiki:PublicMethod.gif|}} GetType() ** | ||
| - | |||
| - | N/A | ||
| - | == Remarks == | ||
| - | N/A | ||
| - | |||
| - | == Return Value == | ||
| - | * Type:Type | ||
| - | * Description:N/A | ||
| - | |||
| - | == Parameters == | ||
| - | <div newline></div> | ||
| - | ** {{wiki:PublicMethod.gif|}}{{wiki:Static.gif|}} GetLowerZoomLevelScale(Double,ZoomLevelSet) ** | ||
| - | |||
| - | ZoomToScale in, the result is less than input | ||
| - | == Remarks == | ||
| - | N/A | ||
| - | |||
| - | == Return Value == | ||
| - | * Type:Double | ||
| - | * Description:N/A | ||
| - | |||
| - | == Parameters == | ||
| - | * //currentScale// | ||
| - | * Type:Double | ||
| - | * Description:N/A | ||
| - | |||
| - | * //zoomLevelSet// | ||
| - | * Type:[[ThinkGeo.MapSuite.Core.ZoomLevelSet|ZoomLevelSet]] | ||
| - | * Description:N/A | ||
| - | |||
| - | <div newline></div> | ||
| - | ** {{wiki:PublicMethod.gif|}}{{wiki:Static.gif|}} GetHigherZoomLevelScale(Double,ZoomLevelSet) ** | ||
| - | |||
| - | ZoomToScale out, the result is greater than input | ||
| - | == Remarks == | ||
| - | N/A | ||
| - | |||
| - | == Return Value == | ||
| - | * Type:Double | ||
| - | * Description:N/A | ||
| - | |||
| - | == Parameters == | ||
| - | * //currentScale// | ||
| - | * Type:Double | ||
| - | * Description:N/A | ||
| - | |||
| - | * //zoomLevelSet// | ||
| - | * Type:[[ThinkGeo.MapSuite.Core.ZoomLevelSet|ZoomLevelSet]] | ||
| - | * Description:N/A | ||
| - | |||
| - | <div newline></div> | ||
| - | ==== Protected Methods ==== | ||
| - | ** {{wiki:ProtectedMethod.gif|}} uSk=(Double) ** | ||
| - | |||
| - | N/A | ||
| - | == Remarks == | ||
| - | N/A | ||
| - | |||
| - | == Return Value == | ||
| - | * Type:[[ThinkGeo.MapSuite.Core.ZoomLevel|ZoomLevel]] | ||
| - | * Description:N/A | ||
| - | |||
| - | == Parameters == | ||
| - | * //scale// | ||
| - | * Type:Double | ||
| - | * Description:N/A | ||
| - | |||
| - | <div newline></div> | ||
| - | ** {{wiki:ProtectedMethod.gif|}} Finalize() ** | ||
| - | |||
| - | N/A | ||
| - | == 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|}} 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 == | ||
| - | * Type:String | ||
| - | |||
| - | ** {{wiki:PublicProperty.gif|}} CustomZoomLevels ** | ||
| - | |||
| - | This property gets the custom zoom levels from the zoomLevelSet. | ||
| - | == Remarks == | ||
| - | None | ||
| - | == Return Value == | ||
| - | * Type:Collection<[[ThinkGeo.MapSuite.Core.ZoomLevel|ZoomLevel]]> | ||
| - | |||
| - | ** {{wiki:PublicProperty.gif|}} ZoomLevel01 ** | ||
| - | |||
| - | This property gets the ZoomLevel for Level01. | ||
| - | == Remarks == | ||
| - | None | ||
| - | == Return Value == | ||
| - | * Type:[[ThinkGeo.MapSuite.Core.ZoomLevel|ZoomLevel]] | ||
| - | |||
| - | ** {{wiki:PublicProperty.gif|}} ZoomLevel02 ** | ||
| - | |||
| - | This property gets the ZoomLevel for Level02. | ||
| - | == Remarks == | ||
| - | None | ||
| - | == Return Value == | ||
| - | * Type:[[ThinkGeo.MapSuite.Core.ZoomLevel|ZoomLevel]] | ||
| - | |||
| - | ** {{wiki:PublicProperty.gif|}} ZoomLevel03 ** | ||
| - | |||
| - | This property gets the ZoomLevel for Level03. | ||
| - | == Remarks == | ||
| - | None | ||
| - | == Return Value == | ||
| - | * Type:[[ThinkGeo.MapSuite.Core.ZoomLevel|ZoomLevel]] | ||
| - | |||
| - | ** {{wiki:PublicProperty.gif|}} ZoomLevel04 ** | ||
| - | |||
| - | This property gets the ZoomLevel for Level04. | ||
| - | == Remarks == | ||
| - | None | ||
| - | == Return Value == | ||
| - | * Type:[[ThinkGeo.MapSuite.Core.ZoomLevel|ZoomLevel]] | ||
| - | |||
| - | ** {{wiki:PublicProperty.gif|}} ZoomLevel05 ** | ||
| - | |||
| - | This property gets the ZoomLevel for Level05. | ||
| - | == Remarks == | ||
| - | None | ||
| - | == Return Value == | ||
| - | * Type:[[ThinkGeo.MapSuite.Core.ZoomLevel|ZoomLevel]] | ||
| - | |||
| - | ** {{wiki:PublicProperty.gif|}} ZoomLevel06 ** | ||
| - | |||
| - | This property gets the ZoomLevel for Level06. | ||
| - | == Remarks == | ||
| - | None | ||
| - | == Return Value == | ||
| - | * Type:[[ThinkGeo.MapSuite.Core.ZoomLevel|ZoomLevel]] | ||
| - | |||
| - | ** {{wiki:PublicProperty.gif|}} ZoomLevel07 ** | ||
| - | |||
| - | This property gets the ZoomLevel for Level07. | ||
| - | == Remarks == | ||
| - | None | ||
| - | == Return Value == | ||
| - | * Type:[[ThinkGeo.MapSuite.Core.ZoomLevel|ZoomLevel]] | ||
| - | |||
| - | ** {{wiki:PublicProperty.gif|}} ZoomLevel08 ** | ||
| - | |||
| - | This property gets the ZoomLevel for Level08. | ||
| - | == Remarks == | ||
| - | None | ||
| - | == Return Value == | ||
| - | * Type:[[ThinkGeo.MapSuite.Core.ZoomLevel|ZoomLevel]] | ||
| - | |||
| - | ** {{wiki:PublicProperty.gif|}} ZoomLevel09 ** | ||
| - | |||
| - | This property gets the ZoomLevel for Level09. | ||
| - | == Remarks == | ||
| - | None | ||
| - | == Return Value == | ||
| - | * Type:[[ThinkGeo.MapSuite.Core.ZoomLevel|ZoomLevel]] | ||
| - | |||
| - | ** {{wiki:PublicProperty.gif|}} ZoomLevel10 ** | ||
| - | |||
| - | This property gets the ZoomLevel for Level10. | ||
| - | == Remarks == | ||
| - | None | ||
| - | == Return Value == | ||
| - | * Type:[[ThinkGeo.MapSuite.Core.ZoomLevel|ZoomLevel]] | ||
| - | |||
| - | ** {{wiki:PublicProperty.gif|}} ZoomLevel11 ** | ||
| - | |||
| - | This property gets the ZoomLevel for Level11. | ||
| - | == Remarks == | ||
| - | None | ||
| - | == Return Value == | ||
| - | * Type:[[ThinkGeo.MapSuite.Core.ZoomLevel|ZoomLevel]] | ||
| - | |||
| - | ** {{wiki:PublicProperty.gif|}} ZoomLevel12 ** | ||
| - | |||
| - | This property gets the ZoomLevel for Level12. | ||
| - | == Remarks == | ||
| - | None | ||
| - | == Return Value == | ||
| - | * Type:[[ThinkGeo.MapSuite.Core.ZoomLevel|ZoomLevel]] | ||
| - | |||
| - | ** {{wiki:PublicProperty.gif|}} ZoomLevel13 ** | ||
| - | |||
| - | This property gets the ZoomLevel for Level13. | ||
| - | == Remarks == | ||
| - | None | ||
| - | == Return Value == | ||
| - | * Type:[[ThinkGeo.MapSuite.Core.ZoomLevel|ZoomLevel]] | ||
| - | |||
| - | ** {{wiki:PublicProperty.gif|}} ZoomLevel14 ** | ||
| - | |||
| - | This property gets the ZoomLevel for Level14. | ||
| - | == Remarks == | ||
| - | None | ||
| - | == Return Value == | ||
| - | * Type:[[ThinkGeo.MapSuite.Core.ZoomLevel|ZoomLevel]] | ||
| - | |||
| - | ** {{wiki:PublicProperty.gif|}} ZoomLevel15 ** | ||
| - | |||
| - | This property gets the ZoomLevel for Level15. | ||
| - | == Remarks == | ||
| - | None | ||
| - | == Return Value == | ||
| - | * Type:[[ThinkGeo.MapSuite.Core.ZoomLevel|ZoomLevel]] | ||
| - | |||
| - | ** {{wiki:PublicProperty.gif|}} ZoomLevel16 ** | ||
| - | |||
| - | This property gets the ZoomLevel for Level16. | ||
| - | == Remarks == | ||
| - | None | ||
| - | == Return Value == | ||
| - | * Type:[[ThinkGeo.MapSuite.Core.ZoomLevel|ZoomLevel]] | ||
| - | |||
| - | ** {{wiki:PublicProperty.gif|}} ZoomLevel17 ** | ||
| - | |||
| - | This property gets the ZoomLevel for Level17. | ||
| - | == Remarks == | ||
| - | None | ||
| - | == Return Value == | ||
| - | * Type:[[ThinkGeo.MapSuite.Core.ZoomLevel|ZoomLevel]] | ||
| - | |||
| - | ** {{wiki:PublicProperty.gif|}} ZoomLevel18 ** | ||
| - | |||
| - | This property gets the ZoomLevel for Level18. | ||
| - | == Remarks == | ||
| - | None | ||
| - | == Return Value == | ||
| - | * Type:[[ThinkGeo.MapSuite.Core.ZoomLevel|ZoomLevel]] | ||
| - | |||
| - | ** {{wiki:PublicProperty.gif|}} ZoomLevel19 ** | ||
| - | |||
| - | This property gets the ZoomLevel for Level19. | ||
| - | == Remarks == | ||
| - | None | ||
| - | == Return Value == | ||
| - | * Type:[[ThinkGeo.MapSuite.Core.ZoomLevel|ZoomLevel]] | ||
| - | |||
| - | ** {{wiki:PublicProperty.gif|}} ZoomLevel20 ** | ||
| - | |||
| - | This property gets the ZoomLevel for Level20. | ||
| - | == Remarks == | ||
| - | None | ||
| - | == Return Value == | ||
| - | * Type:[[ThinkGeo.MapSuite.Core.ZoomLevel|ZoomLevel]] | ||
| - | |||
| - | ==== Protected Properties ==== | ||
| - | ==== Public Events ==== | ||
thinkgeo.mapsuite.portablecore.zoomlevelset.1442823722.txt.gz ยท Last modified: 2015/09/21 08:22 by admin
