Class kaMap

Object
   |
   +--kaMap

class kaMap

Defined in kaMap.js

Constructor Detail

kaMap

kaMap( szID )

kaMap main class construct a new kaMap instance. Pass the id of the div to put the kaMap in this class is the main API for any application. Only use the functions provided by this API to ensure everything functions correctly szID - string, the id of a div to put the kaMap! into ***************************************************************************

activateTool

void activateTool( toolObj )

addMap

void addMap( oMap )

kaMap.addMap( oMap ) add a new instance of _map to kaMap. _map is an internal class that represents a map file from the configuration file. This function is intended for internal use by the init.php script. oMap - object, an instance of _map

addMapLayer

void addMapLayer( l )

addObjectGeo

Object addObjectGeo( canvas, lon, lat, obj )

kaMap.addObjectGeo( canvas, lon, lat, obj ) add an object to a drawing layer and position it at the given geographic position. This is defined as being in the projection of the map. TODO: possibly add ability to call a reprojection service (xhr request?) to convert lon/lat into the current coordinate system if not lon/lat. canvas - object, the drawing canvas to add this object to x - int, the x position in pixels y - int, the y position in pixels obj - object, the object to add (an img, div etc) returns true

addObjectPix

Object addObjectPix( canvas, x, y, obj )

kaMap.addObjectPix( canvas, x, y, obj ) add an object to the map canvas and position it at the given pixel position. The position should not include the xOrigin/yOrigin offsets canvas - object, the canvas to add this object to x - int, the x position in pixels y - int, the y position in pixels obj - object, the object to add (an img, div etc) returns true;

appendColumn

void appendColumn(layer)

internal function to append a column of images to each of the layers this function is used when the viewport is resized modified by cappu can take a single layer as input

appendRow

void appendRow(layer)

internal function to append a row of images to each of the layers this function is used when the viewport is resized modified by cappu can take a single layer as input

cancelEvent

Object cancelEvent(e)

centerObject

Object centerObject(obj)

kaMap.centerObject( obj ) slides the map to place the object at the center of the map obj - object, an object previously added to the map returns true

checkMaxExtents

Object checkMaxExtents()

kaMap.checkMaxExtents() For maps with maxExtent set, this function adjusts the position of theInsideLayer so it never shows more than the maximum extent specified in the mapfile. Called from kaMap.checkWrap() since that is called with all movement of theInsideLayer Added by tschaub

checkWrap

void checkWrap()

internal function to check if images need to be wrapped

createDrawingCanvas

Object createDrawingCanvas( idx )

kaMap.createDrawingCanvas( idx ) create a layer on which objects can be drawn (such as point objects) idx - int, the z-index of the layer. Should be < 100 but above the map layers.

createImage

Object createImage( top, left, obj )

internal function to create images for map tiles top - integer, the top of this image in pixels left - integer, the left of this image in pixels obj - object, the layer in which this image will reside

createLayers

Object createLayers()

hidden method of kaMap to initialize all the various layers needed by kaMap to draw and move the map image.

createMapLayer

Object createMapLayer( id )

deactivateTool

void deactivateTool( toolObj )

deregisterForEvent

Object deregisterForEvent( eventID, obj, func )

drawGroup

Object drawGroup(group)

geoToPix

void geoToPix( gX, gY )

kaMap.geoToPix( gX, gY ) convert geographic coordinates into pixel coordinates. Note this does not adjust for the current origin offset that is used to adjust the actual pixel location of the tiles and other images gX - float, the x coordinate in geographic units of the active projection gY - float, the y coordinate in geographic units of the active projection returns an array of pixel coordinates with element 0 being the x and element 1 being the y coordinate.

getCenter

Object getCenter()

getCurrentMap

Object getCurrentMap()

kaMap.getCurrentMap() returns the currently selected _map object. This can be used to get information about the layers (groups) and scales available in the current map.

getCurrentScale

Object getCurrentScale()

getGeoExtents

void getGeoExtents()

kaMap.getGeoExtents() returns an array of geographic extents for the current view in the form (inx, miny, maxx, maxy)

getMaps

Object getMaps()

kaMap.getMaps() return an array of all the _map objects that kaMap knows about. These can be used to generate controls to switch between maps and to get information about the layers (groups) and scales available in a given map.

getMetaExtents

Object getMetaExtents()

kaMap.getMetaExtents() returns an array of geographic extents for the loaded tiles in the form (minx, miny, maxx, maxy)

getObject

Object getObject(obj)

getObjectHeight

Object getObjectHeight(obj)

getObjectWidth

Object getObjectWidth(obj)

getRawObject

Object getRawObject(obj)

hideLayers

void hideLayers()

initialize

Object initialize()

kaMap.initialize( [szMap] ) main initialization of kaMap. This must be called after page load and should only be called once (i.e. on page load). It does not perform intialization synchronously. This means that the function will return before initialization is complete. To determine when initialization is complete, the calling application must register for the KAMAP_INITIALIZED event. szMap - string, optional, the name of a map to initialize by default. If not set, use the default configuration map file. returns true

initializeCallback

Object initializeCallback( szInit )

hidden function on callback from init.php

initializeLayers

void initializeLayers(nFactor)

internal function update the layer URLs based on their current positions

moveBy

void moveBy( x, y )

move the map by a certain amount

paintLayer

void paintLayer(l)

internal function adedd by cappu use to paint a layer calculating tile position for current exten and scale and calling the layer.seTile *************************************

pixToGeo

void pixToGeo( pX, pY )

kaMap.pixToGeo( pX, pY [, bAdjust] ) convert pixel coordinates into geographic coordinates. This can optionally adjust for the pixel offset by passing true as the third argument pX - int, the x coordinate in pixel units pY - int, the y coordinate in pixel units returns an array of geographic coordinates with element 0 being the x and element 1 being the y coordinate.

registerEventID

Object registerEventID( eventID )

registerForEvent

Object registerForEvent( eventID, obj, func )

registerTool

void registerTool( toolObj )

reloadImage

void reloadImage(id)

removeAllObjects

Object removeAllObjects(canvas)

kaMap.removeAllObjects( canvas ) removes all objects on a particular canvas canvas - a canvas that was previously created with createDrawingCanvas

removeColumn

void removeColumn(layer)

internal function to remove a column of images to each of the layers this function is used when the viewport is resized modified by cappu can take a single layer as input

removeDrawingCanvas

Object removeDrawingCanvas( canvas )

removeMapLayer

Object removeMapLayer( id )

removeObject

Object removeObject( obj )

kaMap.removeObject( obj ) removes an object previously added with one of the addObjectXxx calls obj - object, an object that has been previously added, or null to remove all objects returns true if the object was removed, false otherwise (i.e. if it was never added).

removeRow

void removeRow(layer)

internal function to remove a row of images to each of the layers this function is used when the viewport is resized modified by cappu can take a single layer as input

resetImage

void resetImage(id)

resetTile

void resetTile( id, bForce )

resize

Object resize( )

kaMap.resize() called when the viewport layer changes size. It is the responsibility of the user of this API to track changes in viewport size and call this function to update the map

seekLayer

Object seekLayer(doc, name)

selectMap

Object selectMap( name )

kaMap.selectMap( name ) select one of the maps that kaMap knows about and re-initialize kaMap with this new map. This function returns true if name is valid and false if the map is invalid. Note that a return of true does not imply that the map is fully active. You must register for the KAMAP_MAP_INITIALIZED event since the map initialization happens asynchronously. name - string, the name of the map to select zoom - (optional) array of 3 (centerx, centery, scale) or 4 (minx, miny, maxx,maxy) values to zoom to.

setBackgroundColor

Object setBackgroundColor( color )

kaMap.setBackgroundColor( color ) call this to set a background color for the inside layer. This color shows through any transparent areas of the map. This is primarily intended to be used by the initializeMap callback function to set the background to the background color in the map file. color: string, a valid HTML color string returns true;

setCursor

void setCursor(cursor)

setLayerOpacity

void setLayerOpacity( name, opacity )

setLayerQueryable

void setLayerQueryable( name, bQueryable )

setLayerVisibility

void setLayerVisibility( name, bVisible )

setMapLayers

Object setMapLayers( )

shiftObject

Object shiftObject( x, y, obj )

kaMap.shiftObject( x, y, obj ) move an object by a pixel amount x - int, the number of pixels in the x direction to move the object y - int, the number of pixels in the y direction to move the object obj - object, the object to move returns true

showLayers

void showLayers()

slide

void slide(pos)

handle individual movement within a slide

slideBy

void slideBy(x,y)

slide the map by a certain amount

triggerEvent

Object triggerEvent( eventID )

updateObjects

void updateObjects()

wrapB2T

void wrapB2T()

internal function to reuse extra images take bottom image from each column and put it at the top

wrapL2R

void wrapL2R()

internal function to reuse extra image take first image from each row and put it at the end

wrapR2L

void wrapR2L()

internal function to reuse extra images take last image from each row and put it at the beginning

wrapT2B

void wrapT2B()

internal function to reuse extra images take top image from each column and put it at the bottom

zoomByFactor

void zoomByFactor( nZoomFactor )

zoomIn

void zoomIn()

zoomOut

void zoomOut()

zoomTo

void zoomTo( cgX, cgY )

kaMap.zoomTo( lon, lat [, scale] ) zoom to some geographic point (in current projection) and optionally scale lon - the x coordinate to zoom to lat - the y coordinate to zoom to scale - optional. The scale to use

zoomToExtents

void zoomToExtents(minx, miny, maxx, maxy)

kaMap.zoomToExtents( minx, miny, maxx, maxy ) best fit zoom to extents. Center of extents will be in the center of the view and the extents will be contained within the view at the closest scale available above the scale these extents represent minx, miny, maxx, maxy - extents in units of current projection.

zoomToScale

void zoomToScale( scale )