ThinkGeo Wiki

This page is read only. You can view the source, but not change it. Ask your administrator if you think this is wrong.
====== ThinkGeo.MapSuite.Core.ZoomLevelSet ======




This class represents a collection of ZoomLevels.
=== Remarks ===
This class represents a collection of ZoomLevels. Each ZoomLevel has a different scale and can store Styles that determine how InternalFeatures draw.
===== Inheritance Hierarchy =====
  *System.Object
    *[[ThinkGeo.MapSuite.Core.ZoomLevelSet]]
      *[[ThinkGeo.MapSuite.Core.BingMapsZoomLevelSet]]
      *[[ThinkGeo.MapSuite.Core.GoogleMapsZoomLevelSet]]
      *[[ThinkGeo.MapSuite.Core.OpenStreetMapsZoomLevelSet]]
      *[[ThinkGeo.MapSuite.Core.PrinterZoomLevelSet]]
      *[[ThinkGeo.MapSuite.Core.SphericalMercatorZoomLevelSet]]
===== Members Summary =====
==== Public Constructors ====
^ Name ^ Parameters ^ DeclaringType ^ Summary ^
| {{wiki:PublicMethod.gif|Public Method}}[[#ZoomLevelSet()|ZoomLevelSet]]   |    |    | This is the default constructor.   |

==== Protected Constructors ====
^ Name ^ Parameters ^ DeclaringType ^ Summary ^

==== Public Methods ====
^ Name ^ Parameters ^ DeclaringType ^ Summary ^
| {{wiki:PublicMethod.gif|Public Method}}[[#Equals(Object)|Equals]]   | Object   | Object   |    |
| {{wiki:PublicMethod.gif|Public Method}}[[#GetHashCode()|GetHashCode]]   |    | Object   |    |
| {{wiki:PublicMethod.gif|Public Method}}{{wiki:Static.gif|Static Member}}[[#GetHigherZoomLevelScale(Double, ZoomLevelSet)|GetHigherZoomLevelScale]]   | Double, [[ThinkGeo.MapSuite.Core.ZoomLevelSet|ZoomLevelSet]]   |    | ZoomToScale out, the result is greater than input   |
| {{wiki:PublicMethod.gif|Public Method}}{{wiki:Static.gif|Static Member}}[[#GetLowerZoomLevelScale(Double, ZoomLevelSet)|GetLowerZoomLevelScale]]   | Double, [[ThinkGeo.MapSuite.Core.ZoomLevelSet|ZoomLevelSet]]   |    | ZoomToScale in, the result is less than input   |
| {{wiki:PublicMethod.gif|Public Method}}[[#GetType()|GetType]]   |    | Object   |    |
| {{wiki:PublicMethod.gif|Public Method}}[[#GetZoomLevel(RectangleShape, Double, GeographyUnit)|GetZoomLevel]]   | [[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]], Double, [[ThinkGeo.MapSuite.Core.GeographyUnit|GeographyUnit]]   |    | This method returns the active ZoomLevel based on an extent, a map unit and a screen width.   |
| {{wiki:PublicMethod.gif|Public Method}}[[#GetZoomLevel(RectangleShape, Double, GeographyUnit, Single)|GetZoomLevel]]   | [[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]], Double, [[ThinkGeo.MapSuite.Core.GeographyUnit|GeographyUnit]], Single   |    | This method returns the active ZoomLevel based on an extent, a map unit and a screen width.   |
| {{wiki:PublicMethod.gif|Public Method}}[[#GetZoomLevelForDrawing(RectangleShape, Double, GeographyUnit, Single)|GetZoomLevelForDrawing]]   | [[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]], Double, [[ThinkGeo.MapSuite.Core.GeographyUnit|GeographyUnit]], Single   |    | This method returns the active ZoomLevel based on an extent, a map unit and a canvas width.   |
| {{wiki:PublicMethod.gif|Public Method}}[[#GetZoomLevelForDrawing(RectangleShape, Double, GeographyUnit)|GetZoomLevelForDrawing]]   | [[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]], Double, [[ThinkGeo.MapSuite.Core.GeographyUnit|GeographyUnit]]   |    | This method returns the active ZoomLevel based on an extent, a map unit and a canvas width.   |
| {{wiki:PublicMethod.gif|Public Method}}[[#GetZoomLevels()|GetZoomLevels]]   |    |    | This method return all of the zoomLevels in the zoomLevelSet.   |
| {{wiki:PublicMethod.gif|Public Method}}[[#ToString()|ToString]]   |    | Object   |    |

==== Protected Methods ====
^ Name ^ Parameters ^ DeclaringType ^ Summary ^
| {{wiki:ProtectedMethod.gif|Protected Method}}[[#Finalize()|Finalize]]   |    | Object   |    |
| {{wiki:ProtectedMethod.gif|Protected Method}}[[#MemberwiseClone()|MemberwiseClone]]   |    | Object   |    |

==== Public Properties ====
^ Name ^ Return ^ DeclaringType ^ Summary ^
| {{wiki:PublicProperty.gif|Public Property}}[[#CustomZoomLevels|CustomZoomLevels]]   | Collection<[[ThinkGeo.MapSuite.Core.ZoomLevel|ZoomLevel]]>   |    | This property gets the custom zoom levels from the zoomLevelSet.   |
| {{wiki:PublicProperty.gif|Public Property}}[[#Name|Name]]   | String   |    | This property gets and sets the name for the ZoomSet.   |
| {{wiki:PublicProperty.gif|Public Property}}[[#ZoomLevel01|ZoomLevel01]]   | [[ThinkGeo.MapSuite.Core.ZoomLevel|ZoomLevel]]   |    | This property gets the ZoomLevel for Level01.   |
| {{wiki:PublicProperty.gif|Public Property}}[[#ZoomLevel02|ZoomLevel02]]   | [[ThinkGeo.MapSuite.Core.ZoomLevel|ZoomLevel]]   |    | This property gets the ZoomLevel for Level02.   |
| {{wiki:PublicProperty.gif|Public Property}}[[#ZoomLevel03|ZoomLevel03]]   | [[ThinkGeo.MapSuite.Core.ZoomLevel|ZoomLevel]]   |    | This property gets the ZoomLevel for Level03.   |
| {{wiki:PublicProperty.gif|Public Property}}[[#ZoomLevel04|ZoomLevel04]]   | [[ThinkGeo.MapSuite.Core.ZoomLevel|ZoomLevel]]   |    | This property gets the ZoomLevel for Level04.   |
| {{wiki:PublicProperty.gif|Public Property}}[[#ZoomLevel05|ZoomLevel05]]   | [[ThinkGeo.MapSuite.Core.ZoomLevel|ZoomLevel]]   |    | This property gets the ZoomLevel for Level05.   |
| {{wiki:PublicProperty.gif|Public Property}}[[#ZoomLevel06|ZoomLevel06]]   | [[ThinkGeo.MapSuite.Core.ZoomLevel|ZoomLevel]]   |    | This property gets the ZoomLevel for Level06.   |
| {{wiki:PublicProperty.gif|Public Property}}[[#ZoomLevel07|ZoomLevel07]]   | [[ThinkGeo.MapSuite.Core.ZoomLevel|ZoomLevel]]   |    | This property gets the ZoomLevel for Level07.   |
| {{wiki:PublicProperty.gif|Public Property}}[[#ZoomLevel08|ZoomLevel08]]   | [[ThinkGeo.MapSuite.Core.ZoomLevel|ZoomLevel]]   |    | This property gets the ZoomLevel for Level08.   |
| {{wiki:PublicProperty.gif|Public Property}}[[#ZoomLevel09|ZoomLevel09]]   | [[ThinkGeo.MapSuite.Core.ZoomLevel|ZoomLevel]]   |    | This property gets the ZoomLevel for Level09.   |
| {{wiki:PublicProperty.gif|Public Property}}[[#ZoomLevel10|ZoomLevel10]]   | [[ThinkGeo.MapSuite.Core.ZoomLevel|ZoomLevel]]   |    | This property gets the ZoomLevel for Level10.   |
| {{wiki:PublicProperty.gif|Public Property}}[[#ZoomLevel11|ZoomLevel11]]   | [[ThinkGeo.MapSuite.Core.ZoomLevel|ZoomLevel]]   |    | This property gets the ZoomLevel for Level11.   |
| {{wiki:PublicProperty.gif|Public Property}}[[#ZoomLevel12|ZoomLevel12]]   | [[ThinkGeo.MapSuite.Core.ZoomLevel|ZoomLevel]]   |    | This property gets the ZoomLevel for Level12.   |
| {{wiki:PublicProperty.gif|Public Property}}[[#ZoomLevel13|ZoomLevel13]]   | [[ThinkGeo.MapSuite.Core.ZoomLevel|ZoomLevel]]   |    | This property gets the ZoomLevel for Level13.   |
| {{wiki:PublicProperty.gif|Public Property}}[[#ZoomLevel14|ZoomLevel14]]   | [[ThinkGeo.MapSuite.Core.ZoomLevel|ZoomLevel]]   |    | This property gets the ZoomLevel for Level14.   |
| {{wiki:PublicProperty.gif|Public Property}}[[#ZoomLevel15|ZoomLevel15]]   | [[ThinkGeo.MapSuite.Core.ZoomLevel|ZoomLevel]]   |    | This property gets the ZoomLevel for Level15.   |
| {{wiki:PublicProperty.gif|Public Property}}[[#ZoomLevel16|ZoomLevel16]]   | [[ThinkGeo.MapSuite.Core.ZoomLevel|ZoomLevel]]   |    | This property gets the ZoomLevel for Level16.   |
| {{wiki:PublicProperty.gif|Public Property}}[[#ZoomLevel17|ZoomLevel17]]   | [[ThinkGeo.MapSuite.Core.ZoomLevel|ZoomLevel]]   |    | This property gets the ZoomLevel for Level17.   |
| {{wiki:PublicProperty.gif|Public Property}}[[#ZoomLevel18|ZoomLevel18]]   | [[ThinkGeo.MapSuite.Core.ZoomLevel|ZoomLevel]]   |    | This property gets the ZoomLevel for Level18.   |
| {{wiki:PublicProperty.gif|Public Property}}[[#ZoomLevel19|ZoomLevel19]]   | [[ThinkGeo.MapSuite.Core.ZoomLevel|ZoomLevel]]   |    | This property gets the ZoomLevel for Level19.   |
| {{wiki:PublicProperty.gif|Public Property}}[[#ZoomLevel20|ZoomLevel20]]   | [[ThinkGeo.MapSuite.Core.ZoomLevel|ZoomLevel]]   |    | This property gets the ZoomLevel for Level20.   |

==== Protected Properties ====
^ Name ^ Return ^ DeclaringType ^ Summary ^

==== Public Events ====
^ Name ^ Event Arguments ^ DeclaringType ^ Summary ^

===== 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 ===
^  Name ^  Type ^  Description ^

[[#Public Constructors|Go Back]]
===== Protected Constructors =====
===== Public Methods =====
==== Equals(Object) ====
=== Return Value ===
^ Return Type ^ Description ^
| Boolean   |    |

=== Parameters ===
^  Name ^  Type ^  Description ^
| obj   | Object   |    |


[[#Public Methods|Go Back]]
==== GetHashCode() ====
=== Return Value ===
^ Return Type ^ Description ^
| Int32   |    |

=== Parameters ===
^  Name ^  Type ^  Description ^


[[#Public Methods|Go Back]]
==== GetHigherZoomLevelScale(Double, ZoomLevelSet) ====

ZoomToScale out, the result is greater than input
=== Return Value ===
^ Return Type ^ Description ^
| Double   |    |

=== Parameters ===
^  Name ^  Type ^  Description ^
| currentScale   | Double   |    |
| zoomLevelSet   | [[ThinkGeo.MapSuite.Core.ZoomLevelSet|ZoomLevelSet]]   |    |


[[#Public Methods|Go Back]]
==== GetLowerZoomLevelScale(Double, ZoomLevelSet) ====

ZoomToScale in, the result is less than input
=== Return Value ===
^ Return Type ^ Description ^
| Double   |    |

=== Parameters ===
^  Name ^  Type ^  Description ^
| currentScale   | Double   |    |
| zoomLevelSet   | [[ThinkGeo.MapSuite.Core.ZoomLevelSet|ZoomLevelSet]]   |    |


[[#Public Methods|Go Back]]
==== GetType() ====
=== Return Value ===
^ Return Type ^ Description ^
| Type   |    |

=== Parameters ===
^  Name ^  Type ^  Description ^


[[#Public Methods|Go Back]]
==== GetZoomLevel(RectangleShape, Double, GeographyUnit) ====
This method returns the active ZoomLevel based on an extent, a map unit and a screen width.
=== Return Value ===
^ Return Type ^ Description ^
| [[ThinkGeo.MapSuite.Core.ZoomLevel|ZoomLevel]]   | This method returns the active ZoomLevel based on an extent, a map unit and a screen width.   |

=== Parameters ===
^  Name ^  Type ^  Description ^
| extent   | [[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]]   | This parameter is a world extent.   |
| screenWidth   | Double   | This parameter is the width of the map in pixels.   |
| mapUnit   | [[ThinkGeo.MapSuite.Core.GeographyUnit|GeographyUnit]]   | This parameter is the unit of the map.   |


[[#Public Methods|Go Back]]
==== GetZoomLevel(RectangleShape, Double, GeographyUnit, Single) ====
This method returns the active ZoomLevel based on an extent, a map unit and a screen width.
=== Return Value ===
^ Return Type ^ Description ^
| [[ThinkGeo.MapSuite.Core.ZoomLevel|ZoomLevel]]   | This method returns the active ZoomLevel based on an extent, a map unit and a screen width.   |

=== Parameters ===
^  Name ^  Type ^  Description ^
| extent   | [[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]]   | This parameter is a world extent.   |
| screenWidth   | Double   | This parameter is the width of the map in pixels.   |
| mapUnit   | [[ThinkGeo.MapSuite.Core.GeographyUnit|GeographyUnit]]   | This parameter is the unit of the map.   |
| dpi   | Single   | This parameter is the dpi of the extent.   |


[[#Public Methods|Go Back]]
==== GetZoomLevelForDrawing(RectangleShape, Double, GeographyUnit, Single) ====
This method returns the active ZoomLevel based on an extent, a map unit and a canvas width.
=== Return Value ===
^ Return Type ^ Description ^
| [[ThinkGeo.MapSuite.Core.ZoomLevel|ZoomLevel]]   | This method returns the active ZoomLevel based on an extent, map unit and a canvas width.   |

=== Parameters ===
^  Name ^  Type ^  Description ^
| extent   | [[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]]   | This parameter is a world extent.   |
| screenWidth   | Double   | This parameter is the width of the canvas in pixels.   |
| mapUnit   | [[ThinkGeo.MapSuite.Core.GeographyUnit|GeographyUnit]]   | This parameter is the unit of the map.   |
| dpi   | Single   | 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.
=== Return Value ===
^ Return Type ^ Description ^
| [[ThinkGeo.MapSuite.Core.ZoomLevel|ZoomLevel]]   | This method returns the active ZoomLevel based on an extent, map unit and a canvas width.   |

=== Parameters ===
^  Name ^  Type ^  Description ^
| extent   | [[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]]   | This parameter is a world extent.   |
| screenWidth   | Double   | This parameter is the width of the canvas in pixels.   |
| mapUnit   | [[ThinkGeo.MapSuite.Core.GeographyUnit|GeographyUnit]]   | This parameter is the unit of the map.   |


[[#Public Methods|Go Back]]
==== GetZoomLevels() ====
This method return all of the zoomLevels in the zoomLevelSet.
=== Return Value ===
^ Return Type ^ Description ^
| Collection<[[ThinkGeo.MapSuite.Core.ZoomLevel|ZoomLevel]]>   | This method return all of the zoomlevels in the zoomLevelSet.   |

=== Parameters ===
^  Name ^  Type ^  Description ^


[[#Public Methods|Go Back]]
==== ToString() ====
=== Return Value ===
^ Return Type ^ Description ^
| String   |    |

=== Parameters ===
^  Name ^  Type ^  Description ^


[[#Public Methods|Go Back]]
===== Protected Methods =====
==== Finalize() ====
=== Return Value ===
^ Return Type ^ Description ^
| Void   |    |

=== Parameters ===
^  Name ^  Type ^  Description ^


[[#Protected Methods|Go Back]]
==== MemberwiseClone() ====
=== Return Value ===
^ Return Type ^ Description ^
| Object   |    |

=== Parameters ===
^  Name ^  Type ^  Description ^


[[#Protected Methods|Go Back]]
===== Public Properties =====
==== CustomZoomLevels ====
This property gets the custom zoom levels from the zoomLevelSet.
=== Return Value ===
^ Return Type ^
| Collection<[[ThinkGeo.MapSuite.Core.ZoomLevel|ZoomLevel]]>   |


[[#Public Properties|Go Back]]
==== 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.
=== Return Value ===
^ Return Type ^
| [[ThinkGeo.MapSuite.Core.ZoomLevel|ZoomLevel]]   |


[[#Public Properties|Go Back]]
==== ZoomLevel02 ====
This property gets the ZoomLevel for Level02.
=== Return Value ===
^ Return Type ^
| [[ThinkGeo.MapSuite.Core.ZoomLevel|ZoomLevel]]   |


[[#Public Properties|Go Back]]
==== ZoomLevel03 ====
This property gets the ZoomLevel for Level03.
=== Return Value ===
^ Return Type ^
| [[ThinkGeo.MapSuite.Core.ZoomLevel|ZoomLevel]]   |


[[#Public Properties|Go Back]]
==== ZoomLevel04 ====
This property gets the ZoomLevel for Level04.
=== Return Value ===
^ Return Type ^
| [[ThinkGeo.MapSuite.Core.ZoomLevel|ZoomLevel]]   |


[[#Public Properties|Go Back]]
==== ZoomLevel05 ====
This property gets the ZoomLevel for Level05.
=== Return Value ===
^ Return Type ^
| [[ThinkGeo.MapSuite.Core.ZoomLevel|ZoomLevel]]   |


[[#Public Properties|Go Back]]
==== ZoomLevel06 ====
This property gets the ZoomLevel for Level06.
=== Return Value ===
^ Return Type ^
| [[ThinkGeo.MapSuite.Core.ZoomLevel|ZoomLevel]]   |


[[#Public Properties|Go Back]]
==== ZoomLevel07 ====
This property gets the ZoomLevel for Level07.
=== Return Value ===
^ Return Type ^
| [[ThinkGeo.MapSuite.Core.ZoomLevel|ZoomLevel]]   |


[[#Public Properties|Go Back]]
==== ZoomLevel08 ====
This property gets the ZoomLevel for Level08.
=== Return Value ===
^ Return Type ^
| [[ThinkGeo.MapSuite.Core.ZoomLevel|ZoomLevel]]   |


[[#Public Properties|Go Back]]
==== ZoomLevel09 ====
This property gets the ZoomLevel for Level09.
=== Return Value ===
^ Return Type ^
| [[ThinkGeo.MapSuite.Core.ZoomLevel|ZoomLevel]]   |


[[#Public Properties|Go Back]]
==== ZoomLevel10 ====
This property gets the ZoomLevel for Level10.
=== Return Value ===
^ Return Type ^
| [[ThinkGeo.MapSuite.Core.ZoomLevel|ZoomLevel]]   |


[[#Public Properties|Go Back]]
==== ZoomLevel11 ====
This property gets the ZoomLevel for Level11.
=== Return Value ===
^ Return Type ^
| [[ThinkGeo.MapSuite.Core.ZoomLevel|ZoomLevel]]   |


[[#Public Properties|Go Back]]
==== ZoomLevel12 ====
This property gets the ZoomLevel for Level12.
=== Return Value ===
^ Return Type ^
| [[ThinkGeo.MapSuite.Core.ZoomLevel|ZoomLevel]]   |


[[#Public Properties|Go Back]]
==== ZoomLevel13 ====
This property gets the ZoomLevel for Level13.
=== Return Value ===
^ Return Type ^
| [[ThinkGeo.MapSuite.Core.ZoomLevel|ZoomLevel]]   |


[[#Public Properties|Go Back]]
==== ZoomLevel14 ====
This property gets the ZoomLevel for Level14.
=== Return Value ===
^ Return Type ^
| [[ThinkGeo.MapSuite.Core.ZoomLevel|ZoomLevel]]   |


[[#Public Properties|Go Back]]
==== ZoomLevel15 ====
This property gets the ZoomLevel for Level15.
=== Return Value ===
^ Return Type ^
| [[ThinkGeo.MapSuite.Core.ZoomLevel|ZoomLevel]]   |


[[#Public Properties|Go Back]]
==== ZoomLevel16 ====
This property gets the ZoomLevel for Level16.
=== Return Value ===
^ Return Type ^
| [[ThinkGeo.MapSuite.Core.ZoomLevel|ZoomLevel]]   |


[[#Public Properties|Go Back]]
==== ZoomLevel17 ====
This property gets the ZoomLevel for Level17.
=== Return Value ===
^ Return Type ^
| [[ThinkGeo.MapSuite.Core.ZoomLevel|ZoomLevel]]   |


[[#Public Properties|Go Back]]
==== ZoomLevel18 ====
This property gets the ZoomLevel for Level18.
=== Return Value ===
^ Return Type ^
| [[ThinkGeo.MapSuite.Core.ZoomLevel|ZoomLevel]]   |


[[#Public Properties|Go Back]]
==== ZoomLevel19 ====
This property gets the ZoomLevel for Level19.
=== Return Value ===
^ Return Type ^
| [[ThinkGeo.MapSuite.Core.ZoomLevel|ZoomLevel]]   |


[[#Public Properties|Go Back]]
==== ZoomLevel20 ====
This property gets the ZoomLevel for Level20.
=== Return Value ===
^ Return Type ^
| [[ThinkGeo.MapSuite.Core.ZoomLevel|ZoomLevel]]   |


[[#Public Properties|Go Back]]
===== Protected Properties =====
===== Public Events =====
__NOTOC__
[[Category:MapSuiteCore]]
[[Category:ThinkGeo.MapSuite.Core]]
[[Category:UpdateDocumentation]]
User Tools

Site Tools

Page Tools
