AtlasCT.com
User Manual v5.0
Index
$#! · 0-9 · A · B · C · D · E · F · G · H · I · J · K · L · M · N · O · P · Q · R · S · T · U · V · W · X · Y · Z
A
 addAdvancedNavigationBar
 addCompass
 addDefaultNavigationBar
 addDragBar
 addItem
 addLayer
 addListener
 addLocation
 addOverlayToMap
 addOverlayToScreen
 Address
 addressToCoordinate
 addShape
 addVertex
 ALIGN_BOTTOM_CENTER, Map
 ALIGN_BOTTOM_LEFT, Map
 ALIGN_BOTTOM_RIGHT, Map
 ALIGN_CENTER_CENTER, Map
 ALIGN_CENTER_LEFT, Map
 ALIGN_CENTER_RIGHT, Map
 ALIGN_TOP_CENTER, Map
 ALIGN_TOP_LEFT, Map
 ALIGN_TOP_RIGHT, Map
 alpha
 Application Development
 assignSettingsFrom
 AutoSuggest
B
 bottomRight
 Bounds
 BrushStyle
C
 Circle
 CIRCLE, Shape
 CircleIcon
 city
 clear
 clearLocations
 clearRoute
 clientToMap
 Clustering Levels
 CLUSTERING_HIGH, LocalVectorLayer
 CLUSTERING_LOW, LocalVectorLayer
 CLUSTERING_MEDIUM, LocalVectorLayer
 CLUSTERING_NONE, LocalVectorLayer
 color
 Constants
 Constructors
 ContextMenu
 coordinate
 Coordinate
 coordinatesString
 coordinateToAddress
 country
 createLocalVectorLayer
 createRemoteVectorLayer
D
 Debug
 description
 direction
 disableAutoRedraw
 disableClickPanning
 disableCounter
 disableGrayScale
 disableMouseWheelZooming
 disablePanning
E
 enableAutoRedraw
 enableClickPanning
 enableCounter
 enableGrayScale
 enableMouseWheelZooming
 enablePanning
 EVENT_GEO_RESULT, Map
 EVENT_MAP_CLICK, Map
 EVENT_MAP_DOUBLE_CLICK, Map
 EVENT_MAP_MOUSE_MOVE, Map
 EVENT_MAP_DRAG_END, Map
 EVENT_MAP_DRAG_START, Map
 EVENT_MAP_INITIALIZE, Map
 EVENT_MAP_LOADED, Map
 EVENT_MAP_MODIFIED, Map
 EVENT_MAP_RESIZE, Map
 EVENT_POLYGON_BUILD, LayersManager
 EVENT_SHAPE_CLICK, LayersManager
 EVENT_SHAPE_EDITED, LayersManager
 EVENT_SHAPE_MOUSE_OUT, LayersManager
 EVENT_SHAPE_MOUSE_OVER, LayersManager
 EVENT_SHAPE_SELECTED, LayersManager
 EventListener
 Examples
 execute
 ExternalIcon
F
 fitMap
 fitToRoute
 fullAddress
 Functions
t.addItem =function(caption,
callbackFunction,
separatorBefore)
Adds a new item to the context menu.
t.addLayer = function(layer)
Adds a new layer to the existing layers collection.
t.addListener = function (evt,
callFunction)
Adds a new listener for the specified event and call for the specified function when it occurs.
Adds a new location by an address.
t.addOverlayToMap=function(overlay,
mapCoordinate,
centerMap,
zIndex)
Adds an overlay on top of the map referenced to the Map.
addAdvancedNavigationBar(ScreenPoint screenPoint)
Add the advanced navigation bar to the map.
addCompass(ScreenPoint screenPoint)
Add a compass to the map.
addDefaultNavigationBar(ScreenPoint screenPoint)
Add the basic navigation bar to the map.
addDragBar(ScreenPoint screenPoint)
Add the drag bar to the map.
disableGrayScale()
Disable the grayscale mode.
enableGrayScale()
Enable the grayscale mode.
t.addOverlayToScreen=function(overlay,
_anchor,
screenCoordinate,
zIndex)
Adds an overlay on top of the map referenced to the client screen.[{BR}] The overlay position is fixed to screen (it won’t move in any map dragging).[{BR}] The anchor and the offsetPosition parameters are used to determine alignment of the overlay above the map.[{BR}] The offsetPosition is relative to the given anchor.[{BR}]
The Address class represent a specific address information, with its coordinates.
t.addressToCoordinate = function (address)
Convert an address to geographical location.
Adds marker to the layer.
t.addVertex =function(vertex)
Adds a new vertex to the poly.
Map.ALIGN_BOTTOM_CENTER
The object will be aligned to the map bottom center.
Map.ALIGN_BOTTOM_LEFT
The object will be aligned to the bottom left corner of the map.
Map.ALIGN_BOTTOM_RIGHT
The object will be anchored at the bottom right corner of the map.
Map.ALIGN_CENTER_CENTER
The object will be aligned to the map center.
Map.ALIGN_CENTER_LEFT
The object will be aligned to the map left center.
Map.ALIGN_CENTER_RIGHT
The object will be aligned to the map right center.
Map.ALIGN_TOP_CENTER
The object will be aligned to the map top center.
Map.ALIGN_TOP_LEFT
The object will be aligned to the top left corner of the map.
Map.ALIGN_TOP_RIGHT
The object will be aligned to the top right corner of the map.
An integer that contains the brush transparency.
The web developer utilizes the AtlasWeb SDK function sets to build his application on customer side by using the various package functions in his code.
t.assignSettingsFrom = function(_map)
Assign map settings from a specific map.
The AutoSuggest class adds a pulldown menu of suggested street and cities to a text fields.[{BR}] The user can either click directly on a suggestion to enter it into the field, or navigate the list using the up and down arrow keys.
A Coordinate object that contains the bottom right coordinate.
The Bounds class represent a rectangular area of the map in geographical coordinates.[{BR}]
This class defines a brush style.
[{B}][{U}]Inheritance[{/U}][{/B}]: Shape > Circle
Shape.CIRCLE
A Circle type.
[{B}][{U}]Inheritance[{/U}][{/B}]: Icon > CircleIcon
The city name of the address.
Debug.clear = function(_close)
Clears the debug window.
t.clearLocations = function ()
Clears all route locations.
t.clearRoute=function()
Clears the displayed route from the map.
t.clientToMap = function(screenCoordinate)
Converts a screen coordinate (in pixels) to a map coordinate (geographical coordinate).
LocalVectorLayer.CLUSTERING_HIGH
Set the layer clustering to be high.
LocalVectorLayer.CLUSTERING_LOW
Set the layer clustering to be low.
LocalVectorLayer.CLUSTERING_MEDIUM
Set the layer clustering to be medium.
LocalVectorLayer.CLUSTERING_NONE
Disable the layer clustering.
A string that contains the brush color (In hex format: XXXXXX).
The ContextMenu class allows you to add a right click context menu to the map.[{BR}] You should define a ContextMenu object and then attach the instance to the required map(s).
The geographical location of the address.
This is the base class of the provided coordinates classes.
A string that contains the maneuver coordinates separated by the character ^ @VarDesc Array coordinatesString
t.coordinateToAddress = function (coordinate)
Convert a geographical location to an address.
The country name of the address.
t.createLocalVectorLayer = function(layerName)
Creates a new local vector layer and add it as a child of the existing layers collection.
t.createRemoteVectorLayer =function(layerName)
Creates a new remote vector layer and add it as a child of the existing layers collection.
The Debug class is a static class allows you to track and debug the JavaScript code during run time.
A string that contains the maneuver description text.
A string that contains the maneuver direction.
t.disableAutoRedraw =function()
Remove the automatic redraw of the layer.[{BR}] NOTE: [{BR}] Enable the layer auto redraw if you use a small amount of shapes[{BR}] If you have a massive use of shapes in your layer it’s recommended to call the redraw method manually after any change in the layer.
t.disableClickPanning = function()
Disable panning the map to the location the user clicks on the map.
t.disableCounter = function()
Set the icon counter to be disabled.
t.disableMouseWheelZooming = function()
Disable the option to zoom the map in and out by the mouse wheel.
t.disablePanning = function()
Disables the map panning.
t.enableAutoRedraw =function()
Sets the layer to be automatically redrawn after each change of its content.[{BR}] NOTE: [{BR}] Enable the layer auto redraw if you use a small amount of shapes[{BR}] If you have a massive use of shapes in your layer it’s recommended to call the redraw method manually after any change in the layer.
t.enableClickPanning = function()
Enable panning the map to the location the user clicks on the map.
t.enableCounter = function()
Set the icon counter to be enabled.
t.enableMouseWheelZooming = function()
Enable the option to zoom the map in and out by the mouse wheel.
t.enablePanning = function()
Enables the map panning.
This event dispatches after a geocode response has arrived from the server.
Map.EVENT_MAP_CLICK
This event dispatches when the user clicks on the map.
Map.EVENT_MAP_DRAG_END
This event dispatches when the user stops dragging the map.
Map.EVENT_MAP_DRAG_START
This event dispatches when the user starts dragging the map.
Map.EVENT_MAP_INITIALIZE
This event dispatches after the map has succsesfully initialized.[{BR}] The event occurs only once during the application run time.
Map.EVENT_MAP_LOADED
This event dispatches after the map has succsesfully loaded.
Map.EVENT_MAP_MODIFIED
This event dispatches after the map has been modified with a new position.
Map.EVENT_MAP_RESIZE
This event dispatches after the map has been resized.
LayersManager.EVENT_POLYGON_BUILD
This event dispatches after the user finishes to build/draw a polygon.
LayersManager.EVENT_SHAPE_CLICK
This event dispatches after the user clicks on a shape.
LayersManager.EVENT_SHAPE_EDITED
This event dispatches after the user finishes to edit a shape (polygons, polylines, circles).
LayersManager.EVENT_SHAPE_MOUSE_OUT
This event dispatches after the user moves the mouse cursor out of a shape.
LayersManager.EVENT_SHAPE_MOUSE_OVER
This event dispatches after the user moves the mouse cursor over a shape.
Map.EVENT_MAP_DOUBLE_CLICK
This event dispatches when the user double click on the map.
Map.EVENT_MAP_MOUSE_MOVE
This event dispatches when the user moves on the map.
LayersManager.EVENT_SHAPE_SELECTED
This event dispatches after the user selects one shape or more (polygons, polylines, circles).
The EventListener class helps you to register event handlers defined by this API.[{BR}] Some of the classes that inherit from this class are: Map, OverviewMap, LayersManager
In order to help you get started faster, below you can find a list of examples.
t.execute = function (coordinate)
Execute the route with the initialized locations.
[{B}][{U}]Inheritance[{/U}][{/B}]: Icon > ExternalIcon
Fits the map view to a list of specified coordinates.
t.fitToRoute=function()
Fits the map view to the displayed route.
The full address value.