Class: modelit.mapviewer.WGS84TileSource

Extends: modelit.mapviewer.AbstractTileSource

DESCRIPTION:

modelit.mapviewer.WGS84TileSource constructor.


            

               Properties
               
            

            

               

                  baseUrl
                  string, default value: 'png'.
                  
  The tile url without parameters.

               

               

                  isWGS
                  boolean, default value true
                  
  Return true if WGS coordinate.

               

               

                  MAX_LAT
                  Maximum latitude (north) for mercator display
                  

               

               

                  maxZoomLevel
                  number
                  
  Maximum (greatest detail) zoomlevel.

               

               

                  MIN_LAT
                  Minimum latitude (south) for mercator display
                  

               

               

                  minZoomLevel
                  number
                  
  Minimum (lowest detail) zoomlevel.

               

               

                  name
                  string
                  
  The name of the tilesource.

               

               

                  numberOfThreads
                  number, default value: 2
                  
  Number of threads that can be used to download the tiles.
  Note that some of the tileproviders have a limit of the number of
  parallel requests.

               

               

                  tileSize
                  number, default value: 256.
                  
  The tilesize in pixels. Tile are assumed to be square.

               

               

                  tileType
                  string, default value: 'png'.
                  
  The image type of the tiles.

               

               

                  tileUrl
                  string|@(zoomlevel, x, y) = string>
                  
  The part of the url that defines which tile to retrieve.

               

            

         

         

            
Public Method: getName

            

               

                  DESCRIPTION:
                  
               

               
  Get name that uniquely identifies this tilesource.
                    Used for caching.
                   
                  
               

            

            

               

                  CALL:
                  
               

               

                     name = getName(obj)
                   
                  
               

            

            

               

                  INPUT:
                  
               

               

                  

                     obj
                     modelit.mapviewer.WGS84TileSource
                     

                  

               

            

            

               

                  OUTPUT:
                  
               

               

                  

                     name
                     string
                     

                  

               

            

         

         

            
Public Method: WGS84TileSource

            

               

                  DESCRIPTION:
                  
               

               
  modelit.mapviewer.WGS84TileSource constructor.
                   
                  
               

            

            

               

                  CALL:
                  
               

               

                      obj = WGS84TileSource(tileType)
                   
                  
               

            

            

               

                  INPUT:
                  
               

               

                  

                     tileType
                     string
                     
The image type of the tiles.



                  

               

            

            

               

                  OUTPUT:
                  
               

               

                  

                     obj
                     modelit.mapviewer.WGS84TileSource
                     
Documentation for modelit.mapviewer.WGS84TileSource/WGS84TileSource
   doc modelit.mapviewer.WGS84TileSource


                  

               

            

         

         

            
Public Method: YToLat

            

               

                  DESCRIPTION:
                  
               

               
  Transforms pixel coordinate Y to latitude
                   
                  
               

            

            

               

                  CALL:
                  
               

               

                     lat = YToLat(aY, aZoomlevel)
                   
                  
               

            

            

               

                  INPUT:
                  
               

               

                  

                     obj
                     modelit.mapviewer.WGS84TileSource
                     

                  

                  

                     aY
                     number
                     
y-coordinate in pixelspace.

                  

                  

                     aZoomlevel
                     integer
                     
the zoomlevel.



                  

               

            

            

               

                  OUTPUT:
                  
               

               

                  

                     lat
                     number
                     
the latitude.

                  

               

            

         

         

            
Public Method: LatToY

            

               

                  DESCRIPTION:
                  
               

               
  Transforms latitude to pixelspace.
                   
                  
               

            

            

               

                  CALL:
                  
               

               

                     y = LatToY(obj, aLatitude, aZoomlevel)
                   
                  
               

            

            

               

                  INPUT:
                  
               

               

                  

                     obj
                     modelit.mapviewer.WGS84TileSource
                     

                  

                  

                     aLatitude
                     number
                     
latitude.

                  

                  

                     aZoomlevel
                     integer
                     
zoomlevel.



                  

               

            

            

               

                  OUTPUT:
                  
               

               

                  

                     y
                     number
                     
y-coordinate in pixelspace.

                  

               

            

         

         

            
Public Method: XToLon

            

               

                  DESCRIPTION:
                  
               

               
  Transforms pixel coordinate X to longitude.
                   
                  
               

            

            

               

                  CALL:
                  
               

               

                     lon = XToLon(obj, aX, aZoomlevel)
                   
                  
               

            

            

               

                  INPUT:
                  
               

               

                  

                     obj
                     modelit.mapviewer.WGS84TileSource
                     

                  

                  

                     aX
                     number
                     
x-coordinate in pixelspace.

                  

                  

                     aZoomlevel
                     integer
                     
the zoomlevel.



                  

               

            

            

               

                  OUTPUT:
                  
               

               

                  

                     lon
                     number
                     
longitude.

                  

               

            

         

         

            
Public Method: localToPixel

            

               

                  DESCRIPTION:
                  
               

               
  Transform local coordinates to pixel coordinates.
                   
                  
               

            

            

               

                  CALL:
                  
               

               

                     xy = localToPixel(obj, xy_local, aZoomlevel)
                   
                  
               

            

            

               

                  INPUT:
                  
               

               

                  

                     obj
                     any
                     
<modelit.mapviewer.RDTileSource>

                  

                  

                     xy_local
                     any
                     
<Double> Nx2, with local coordinates(RD).

                  

                  

                     aZoomlevel
                     any
                     
<integer> with zoomlevel.



                  

               

            

            

               

                  OUTPUT:
                  
               

               

                  

                     xy
                     any
                     
<Double> NNx2, with x-coordinate in pixelspace.

                  

               

            

         

         

            
Public Method: pixelToLocal

            

               

                  DESCRIPTION:
                  
               

               
 pixel coordinates to local coordinates (WGS), all in 1
                  
               

            

         

         

            
Public Method: LonToX

            

               

                  DESCRIPTION:
                  
               

               
  Transform longitude to pixelspace.
                   
                  
               

            

            

               

                  CALL:
                  
               

               

                     x = LonToX(obj, aLongitude, aZoomlevel)
                   
                  
               

            

            

               

                  INPUT:
                  
               

               

                  

                     obj
                     any
                     
<modelit.mapviewer.WGS84TileSource>

                  

                  

                     aLongitude
                     number
                     
longitude.

                  

                  

                     aZoomlevel
                     integer
                     
the zoomlevel.



                  

               

            

            

               

                  OUTPUT:
                  
               

               

                  

                     x
                     number
                     
x-coordinate in pixelspace.

                  

               

            

         

         

            
Public Method: pixel2Zoomlevel

            

               

                  DESCRIPTION:
                  
               

               
  Determine the zoomlevel from the xlim.
                   
                  
               

            

            

               

                  CALL:
                  
               

               

                     zm = pixel2Zoomlevel(obj, x)
                   
                  
               

            

            

               

                  INPUT:
                  
               

               

                  

                     obj
                     modelit.mapviewer.WGS84TileSource
                     

                  

                  

                     x
                     number[]
                     
xlim.



                  

               

            

            

               

                  OUTPUT:
                  
               

               

                  

                     zm
                     integer
                     
the zoomlevel.



                  

               

            

         

         

            
Public Method: getMaxPixels

            

               

                  DESCRIPTION:
                  
               

               
  Get the maximum number of pixels in y or x for a zoomlevel.
                   
                  
               

            

            

               

                  CALL:
                  
               

               

                     maxPixels = getMaxPixels(aZoomlevel)
                   
                  
               

            

            

               

                  INPUT:
                  
               

               

                  

                     obj
                     modelit.mapviewer.WGS84TileSource
                     

                  

                  

                     aZoomlevel
                     integer|integer[]
                     
with zoomlevel.



                  

               

            

            

               

                  OUTPUT:
                  
               

               

                  

                     maxPixels
                     integer
                     
defined as: 2^Zoomlevel * tileSize.

                  

               

            

         

         

            
Public Static Method: WGSToLocal

            

               

                  DESCRIPTION:
                  
               

               
  Transforms WGS coordinates to local (=WGS)
                  
               

            

         

         

            
Public Static Method: localToWGS

            

               

                  DESCRIPTION:
                  
               

               
  Transforms local coordinates (=WGS) to WGS
                  
               

            

         

         

            
Private Method: falseNorthing

            

               

                  DESCRIPTION:
                  
               

               
  The linear value added to all y-coordinates of a map projection so that none of the values in the geographic region being
                  mapped are negative.
                   
                  
               

            

            

               

                  CALL:
                  
               

               

                     fn = falseNorthing(obj, aZoomlevel)
                   
                  
               

            

            

               

                  INPUT:
                  
               

               

                  

                     obj
                     modelit.mapviewer.WGS84TileSource
                     

                  

                  

                     aZoomlevel
                     integer
                     
the zoomlevel.



                  

               

            

            

               

                  OUTPUT:
                  
               

               

                  

                     fn
                     number
                     
Corrected y-coordinate.

                  

               

            

         

         

            
Private Method: falseEasting

            

               

                  DESCRIPTION:
                  
               

               
  The linear value added to all x-coordinates of a map projection so that none of the values in the geographic region being
                  mapped are negative.
                   
                  
               

            

            

               

                  CALL:
                  
               

               

                     fe = falseEasting(obj, aZoomlevel)
                   
                  
               

            

            

               

                  INPUT:
                  
               

               

                  

                     obj
                     modelit.mapviewer.WGS84TileSource
                     

                  

                  

                     aZoomlevel
                     integer
                     
the zoomlevel.



                  

               

            

            

               

                  OUTPUT:
                  
               

               

                  

                     fe
                     number
                     
Corrected x-coordinate.

                  

               

            

         

         

            
Private Method: radius

            

               

                  DESCRIPTION:
                  
               

               
  Get radius in pixels at a given zoomlevel.
                   
                  
               

            

            

               

                  CALL:
                  
               

               

                     r = radius(obj, aZoomlevel)
                   
                  
               

            

            

               

                  INPUT:
                  
               

               

                  

                     obj
                     modelit.mapviewer.WGS84TileSource
                     

                  

                  

                     aZoomlevel
                     integer
                     
with zoomlevel.



                  

               

            

            

               

                  OUTPUT:
                  
               

               

                  

                     r
                     integer
                     
radius in pixels at a given zoomlevel.

                  

               

            

         

         

            
Public Method: getTileUrl

            

               Inherited from modelit.mapviewer.AbstractTileSource
            

            

               

                  DESCRIPTION:
                  
               

               
  Get url to retrieve a specific tile at a given (x,y) index
                    and zoomlevel from the tileserver
                   
                  
               

            

            

               

                  CALL:
                  
               

               

                     url = getTileUrl(obj, zoomlevel, x, y)
                   
                  
               

            

            

               

                  INPUT:
                  
               

               

                  

                     obj
                     modelit.mapviewer.PDOKTileSource
                     

                  

                  

                     zoomlevel
                     integer
                     
the zoomlevel. Choose zoomlevel between
getMinZoomLevel and getMaxZoomLevel


                  

                  

                     x
                     number
                     
Horizontal tile index.

                  

                  

                     y
                     number
                     
Vertical tile index.



                  

               

            

            

               

                  OUTPUT:
                  
               

               

                  

                     url
                     string
                     
     url for a tile with index (x,y) and zoomlevel at the tileserver.
Help for modelit.mapviewer.WGS84TileSource/getTileUrl is inherited from superclass modelit.mapviewer.AbstractTileSource


                  

               

            

         

         

            
Public Method: getBaseUrl

            

               Inherited from modelit.mapviewer.AbstractTileSource
            

            

               

                  DESCRIPTION:
                  
               

               
  Get the base url for this TileSource, use this with getTileUrl.
                    To get the url for a specific tile at a specific coordinate and zoomlevel.
                   
                  
               

            

            

               

                  CALL:
                  
               

               

                      url = getBaseUrl(obj)
                   
                  
               

            

            

               

                  INPUT:
                  
               

               

                  

                     obj
                     modelit.mapviewer.AbstractTileSource
                     

                  

               

            

            

               

                  OUTPUT:
                  
               

               

                  

                     url
                     string
                     
        with base url.
Help for modelit.mapviewer.WGS84TileSource/getBaseUrl is inherited from superclass modelit.mapviewer.AbstractTileSource


                  

               

            

         

         

            
Public Method: getTileType

            

               Inherited from modelit.mapviewer.AbstractTileSource
            

            

               

                  DESCRIPTION:
                  
               

               
  Get the image type of the tiles.
                   
                  
               

            

            

               

                  CALL:
                  
               

               

                     type = getTileType(obj)
                   
                  
               

            

            

               

                  INPUT:
                  
               

               

                  

                     obj
                     modelit.mapviewer.AbstractTileSource
                     

                  

               

            

            

               

                  OUTPUT:
                  
               

               

                  

                     type
                     string
                     
     with image type. For OpenStreetMap tiles type='png'
Help for modelit.mapviewer.WGS84TileSource/getTileType is inherited from superclass modelit.mapviewer.AbstractTileSource


                  

               

            

         

         

            
Public Method: getMinZoomLevel

            

               Inherited from modelit.mapviewer.AbstractTileSource
            

            

               

                  DESCRIPTION:
                  
               

               
  The minimum zoom value. This value is usually 0.
                   
                  
               

            

            

               

                  CALL:
                  
               

               

                     zoom = getMinZoomLevel(obj)
                   
                  
               

            

            

               

                  INPUT:
                  
               

               

                  

                     obj
                     modelit.mapviewer.AbstractTileSource
                     

                  

               

            

            

               

                  OUTPUT:
                  
               

               

                  

                     zoom
                     integer
                     
     with the minimum (less detailed) zoomlevel.
Help for modelit.mapviewer.WGS84TileSource/getMinZoomLevel is inherited from superclass modelit.mapviewer.AbstractTileSource


                  

               

            

         

         

            
Public Method: getMaxZoomLevel

            

               Inherited from modelit.mapviewer.AbstractTileSource
            

            

               

                  DESCRIPTION:
                  
               

               
  The maximum zoom value.
                   
                  
               

            

            

               

                  CALL:
                  
               

               

                     zoom = getMaxZoomLevel(obj)
                   
                  
               

            

            

               

                  INPUT:
                  
               

               

                  

                     obj
                     modelit.mapviewer.AbstractTileSource
                     

                  

               

            

            

               

                  OUTPUT:
                  
               

               

                  

                     zoom
                     integer
                     
     with the maximum (most detailed) zoomlevel.
Help for modelit.mapviewer.WGS84TileSource/getMaxZoomLevel is inherited from superclass modelit.mapviewer.AbstractTileSource


                  

               

            

         

         

            
Public Method: getTileSize

            

               Inherited from modelit.mapviewer.AbstractTileSource
            

            

               

                  DESCRIPTION:
                  
               

               
  The tilesize of the square tiles in pixels.
                   
                  
               

            

            

               

                  CALL:
                  
               

               

                     tileSize = getTileSize(obj)
                   
                  
               

            

            

               

                  INPUT:
                  
               

               

                  

                     obj
                     modelit.mapviewer.AbstractTileSource
                     

                  

               

            

            

               

                  OUTPUT:
                  
               

               

                  

                     tileSize
                     integer
                     
     the width and height for a tile in pixels.
Help for modelit.mapviewer.WGS84TileSource/getTileSize is inherited from superclass modelit.mapviewer.AbstractTileSource