Class AGMapOptions
This class represents optional arguments to the AGMap constructor.
Constructor
| Constructor |
Description |
| AGMapOptions(string backgroundColour?, string draggableCursor?, string draggingCursor?, boolean loadInitialMap? Boolean showCrossHair?, string staticCursor?) |
Create AGMapOptions. |
Properties
| Property name |
Type |
Description |
| backgroundColour |
string |
This property specifies the color to display behind the map tiles. |
| draggableCursor |
string |
|
| draggingCursor |
string |
|
| loadInitialMap |
boolean |
This property specifies whether the initial map is loaded or not. |
| showCrossHair |
boolean |
|
| staticCursor |
string |
|
Class AGMapTypeControl
This class represents optional arguments to the AGMap constructor.
Constructor
| Constructor |
Description |
| AGMapTypeControl() |
Create AGMapTypeControl. |
Properties
| Property name |
Type |
Description |
| show() |
none |
This property sets the AGMapTypeControl to visible. |
| hide() |
none |
This property sets the AGMapTypeControl to invisible. |
| isVisible() |
boolean |
This property check whether the AGMaptypeControl is visible or not. |
Class AGMapTypeOptions
This class represents optional arguments to the AGMap constructor.
Constructor
| Constructor |
Description |
| AGMapTypeOptions(strBGColour,strSelectedBGColour) |
Create AGMapTypeOptions. |
Properties
| Property name |
Type |
Description |
| bgColour |
none |
This property sets the color of the background. |
| bgSelectedColour |
none |
This property sets the color of the background that is selected. |
Class AGInfoDisplay
This class has no constructor. It is created by AGMap and API user can access
through AGMap.getInfoDisplay().
Methods
| Method |
Return |
Description |
| hide() |
none |
Makes the info display invisible. NOTE: This doesn't close the info display. It
can be made visible again using show(). |
| show() |
none |
Makes the info display visible if its currently invisible. |
| isVisible() |
boolean |
Returns true if infodisplay is visible. |
| getPoint () |
AGCoord |
Returns the geographical point at which the info display is anchored. |
| getPixelOffset () |
AGPoint |
Returns the offset, in pixels, of the tip of the info display from the point on
the map at whose geographical coordinates the info display is anchored. |
| getSelectedPanel () |
int |
Returns the index, of the current selected panel. |
| getPanels () |
AGInfoDisplayPanel |
Returns the array of AGInfoDisplayPanel in this info display. |
| reset (AGCoord coord, string[] arrPanels, AGSize oSize?, AGPoint oPixelOffset?,
int iSelectedPanel?) |
none |
Resets the state of the info display. |
| getContentContainers() |
Node[ ] |
|
| enableMaximize() |
none |
|
| disableMaximize() |
none |
|
| maximizeEnabled() |
boolean |
|
| maximize() |
none |
|
| restore() |
none |
|
Events
| Event Name |
Parameters |
Description |
| oncloseclick |
none |
This event is fired when info display closed. |
| onmaximizeclick |
none |
|
| onmaximizeend |
none |
|
| onrestoreclick |
none |
|
| onrestoreend |
none |
|
| onpanelchange |
none |
|
Class AGPoint
It is a pixel coordinate represents a point on map.
Constructor
| Constructor |
Description |
| AGPoint(int x, int y) |
AGPoint represents a point on the map by its pixel
coordinates. |
Properties
| Property Name |
Type |
Description |
| x |
int |
x coordinate. |
| y |
int |
y coordinate. |
Methods
| Method |
Return |
Description |
| equals (AGPoint otherPoint) |
boolean |
Returns true if given point is equel to the point. |
| toString () |
string |
Returns a string that contains the x and y coordinates, in this order, separated
by a comma. |
Class AGInfoDisplayPanel
An array of instances of this class can be passed as panel argument to the method
AGMap.openInfoDisplayPanels(), AGMap.openInfoDisplayPanelsHTML(),
AGMarker.openInfoDisplayPanels(), AGMarker.openInfoDisplayPanelsHTML (),
AGMarker.bindInfoDisplayPanels() and AGMarker.bindInfoDisplayPanelsHTML().
Constructor
| Constructor |
Description |
| AGInfoDisplayPanel(string label, Object content) |
Creates an info display panel data structure that can be passed in the panels
argument to openInfoDisplayPanels() methods. |
Properties
| Property Name |
Type |
Description |
| label |
string |
Header text of the AGInfoDisplayPanel. |
| content |
object |
object as a content of the AGInfoDisplayPanel |
Class AGInfoDisplayPanel
An array of instances of this class can be passed as panel argument to the method
AGMap.openInfoDisplayPanels(), AGMap.openInfoDisplayPanelsHTML(),
AGMarker.openInfoDisplayPanels(), AGMarker.openInfoDisplayPanelsHTML (),
AGMarker.bindInfoDisplayPanels() and AGMarker.bindInfoDisplayPanelsHTML().
Constructor
| Constructor |
Description |
| AGInfoDisplayPanel(string label, Object content) |
Creates an info display panel data structure that can be passed in the panels
argument to openInfoDisplayPanels() methods. |
Properties
| Property Name |
Type |
Description |
| label |
string |
Header text of the AGInfoDisplayPanel. |
| content |
object |
object as a content of the AGInfoDisplayPanel |
Class AGInfoDisplayPanelOptions
This class represents optional parameter in the argument of method
AGMap.openInfoDisplayPanels().
Constructor
| Constructor |
Description |
| AGInfoDisplayPanelOptions() |
Create AGInfoDisplayPanelOptions object. |
Properties
| Property Name |
Type |
Description |
| activePanelStyle |
Css object |
Set the style of the active panel |
| inactivePanelStyle |
Css object |
Set the style of the inactive panel. |
Class AGInfoDisplayOptions
This class represents optional parameter in the argument of methods
AGMap.openInfoDisplayPanels(), AGMap.openInfoDisplayPanelsHTML(),
AGMarker.openInfoDisplayPanels(), AGMarker.openInfoDisplayPanelsHTML (),
AGMarker.bindInfoDisplayPanels() and AGMarker.bindInfoDisplayPanelsHTML().
Constructor
| Constructor |
Description |
| AGInfoDisplayOptions(int iWidth?, int iHeight?, float dOpacity?, AGPoint
oAGPointPixelOffset?, int iSelectedPanel?, boolean bNoCloseOnClick?, function
fnOnOpenFn?, function fnOnCloseFn?, int iZoomLevel?, boolean bStationary?) |
Create AGInfoDisplayOptions object. |
Properties
| Property Name |
Type |
Description |
| selectedPanel |
int |
Selects the panel with the given index |
| width |
int |
Maximum width of the info display panel, in pixels. |
| height |
int |
Maximum height of the info display panel, in pixels. |
| opacity |
float |
Opacity of the info display panel. |
| noCloseOnClick |
boolean |
|
| onOpenFn |
function |
|
| onCloseFn |
function |
|
| zoomLevel |
int |
This property is for AGMap.showEnlargedMap(). zoom level of enlarge map of info
display. |
| pixelOffset |
AGPoint |
Specifies a number of pixels in the up (x) and right (y) direction to move the
infodiplay away from the given coord. |
| stationary |
boolean |
Make the info display stationary. |
Class AGSize
This class represents the size in pixels of a rectangular area of the map. The
size object has two parameters, width and height. Width is a difference in the
x-coordinate; height is a difference in the y-coordinate, of points.
Constructor
| Constructor |
Description |
| AGSize(int width, int height) |
Create a instance of AGSize with width and height. |
Properties
| Property Name |
Type |
Description |
| width |
int |
The width of the size. |
| height |
int |
The height of the size. |
Methods
| Method |
Return |
Description |
| equals(AGSize otherSize) |
boolean |
Returns true iff other size is equal to the size. |
| toString() |
string |
Returns a string that contains the wdith and height parameter, in this order,
separated by a comma. |
Class AGRectangle
This class is a rectangular area of the map in pixel coordinates
Constructor
| Constructor |
Description |
| AGRectangle (AGPoint point1, AGPoint point2) |
Constructs a rectangle with two given points. |
Methods
| Method |
Return |
Description |
| toString() |
string |
Returns a string that contains the coordinates of the upper left and the lower
right corner points of the box, in this order, separated by comma. |
| equals(AGRectangle otherRectanlge) |
boolean |
Returns true iff other rectangle is equal to the size. |
| mid() |
AGPoint |
Returns the center of the rectangular area. |
| min() |
AGPoint |
Returns upper left corner of the rectangular area. |
| max() |
AGPoint |
Returns lower right corner of the rectangular area. |
| containsRectangle (AGRectangle otherRectangle) |
boolean |
Returns true if the passed rectangular area is entirely contained in this
rectangular area. |
| containsPoint (AGPoint otherPoint) |
boolean |
Returns true if otherPoint is inside the rectangle. |
| extend (AGPoint otherPoint) |
none |
Extends the rectangle that contanis the otherPoint. |
Class AGCoord
This class represents a point in geographical coordinates longitude and latitude.
Constructor
| Constructor |
Description |
| AGCoord(float latitude, float longitude) |
Creates a coord object with latitude and longitude. |
Methods
| Method |
Return |
Description |
| latitude() |
float |
Returns the latitude coordinate. |
| longitude() |
float |
Returns the longitude coordinate. |
| equals(AGCoord coord) |
boolean |
Returns true if coord is equal to the component within certain roundoff margins. |
| latitudeRadians() |
float |
|
| longitudeRadians() |
float |
|
| distanceFrom(AGCoord coord) |
float |
|
| toString() |
string |
|
Class AGBoundingBox
Class AGBoundingBox is represents a rectangle in geographical coordinates
Constructor
| Constructor |
Description |
| AGBoundingBox(AGCoord coord1, AGCoord coord2) |
Constructs a rectangle from the points at its south-west and north-east corners. |
Methods
| Method |
Return |
Description |
| equals(AGBoundingBox bbox) |
boolean |
Returns true if the object is equal to the given bbox. |
| containsCoord(AGCoord coord) |
boolean |
Returns true if the rectangle contains the coord. |
| intersects (AGCoord otherRectangle) |
boolean |
Returns true if otherRectangle intersect with the rectangle object. |
| containsBoundingBox (AGBoundingBox bbox) |
boolean |
Returns true if the bounding box contains bbox in full. |
| extend (AGCoord coord) |
none |
Extends the bounding box tant contains the coord. |
| getSouthWest() |
AGCoord |
Returns the point at the south-west corner of the rectangle. |
| getNorthEast() |
AGCoord |
Returns the point at the north-east corner of the rectangle. |
| getSouthEast() |
AGCoord |
Returns the point at the south-east corner of the rectangle. |
| getNorthWest() |
AGCoord |
Returns the point at the north-west corner of the rectangle. |
| toSpan() |
AGCoord |
Returns a coord whose coordinates represent the size of this rectangle. |
| isEmpty() |
boolean |
Returns true if the rectangle is empty. |
| getCentre() |
AGCoord |
Returns the point at the center of the rectangle. |
| isFullLatitude() |
boolean |
|
| isFullLongitude() |
boolean |
|
Class AGCircle
Class AGCircle represents a circle drawn on the map.
Constructor
| Constructor |
Description |
|
AGCircle(AGCoord centre, float radiusInMeter, AGVectorStyleOptions options? ,
AGCircleOptions options?)
|
Constructs a circle at the coordinates specified, with the diameter of the circle set to fRadiusInMeter. oVectorStyleOptions sets the color scheme and opacity of the circle object. |
Methods
| Method |
Return |
Description |
|
moveCentre (AGCoord centre)
|
|
|
| setRadius (float radiusInMeter) |
|
|
| setStyle (AGVectorStyleOptions options) |
|
|
| show() |
none |
|
| hide() |
none |
|
| isVisible() |
boolean |
|
| getBoundingBox() |
AGBoundingBox |
Returns the the visible rectangular region of the map view in geographical
coordinates. |
| insideCircle() |
boolean |
|
Events
| Event Name |
Return |
Description |
|
onvisibilitychanged |
|
|
| onremove |
|
|
| onclick |
|
This event is fired when the circle is clicked. |
| onmouseover |
|
This event is fired when the mouse moves over the circle. |
| onmouseout |
|
This event is fired when the mouse leaves the circle area. |
| onlineupdated |
|
|
Class AGCircleOptions
Class AGCircleOptions represents the options of a circle.
Constructor
| Constructor |
Description |
|
AGCircleOptions(boolean clickable)
|
Set the options for a cricle. |
Methods
| Method |
Return |
Description |
| clickable |
boolean |
Sets whether circle is clickable or not. |