| Package | com.ammap.mapClasses |
| Class | public class MapObject |
| Inheritance | MapObject  flash.events.EventDispatcher |
| Subclasses | DataSet, MapArea, MapLine, MapMovie |
| Property | Defined by | ||
|---|---|---|---|
| alpha : Number
Opacity of MapObject
| MapObject | ||
| balloonText : String
Text which is displayed in a roll-over balloon.
| MapObject | ||
| bringForwardOnHover : Boolean
Specifies if movie or line should be moved to front level when user rolls-over it
| MapObject | ||
| color : Number
Color of MapObject
| MapObject | ||
| customData : Object
a custom data holder
| MapObject | ||
| description : String
Description of MapObject.
| MapObject | ||
| descriptionWindowHeight : Number
Height of description window
| MapObject | ||
| descriptionWindowY : Number
y position of description window
| MapObject | ||
| descriptionWindowWidth : Number
Width of description window
| MapObject | ||
| descriptionWindowX : Number
x position of description window
| MapObject | ||
| displayObject : DisplayObject
DisplayObject of a MapObject
| MapObject | ||
| filters : Array
Array of filters which will be applied to the object.
| MapObject | ||
| fixedSize : Boolean
Specifies if the object should change the size together with the map or keep fixed size.
| MapObject | ||
| groupId : String
id of a group.
| MapObject | ||
| lines : Array
Array of MapLine objects
| MapObject | ||
| linkWith : Array
Array of object id's with which this object is linked.
| MapObject | ||
| mouseEnabled : Boolean
If you want to preserve original mouse events of your movie, set this to false.
| MapObject | ||
| movies : Array
Array of MapMovie objects.
| MapObject | ||
| oid : String
unique id of map object
| MapObject | ||
| passZoomValuesToTarget : Boolean
Specifies if current zoom values should be passed to target MapObject
Useful when building drill down maps.
| MapObject | ||
| remainVisible : Boolean
Specifies if the MapObject should remain visible if it was clicked and it has children MapObjects.
| MapObject | ||
| rollOverAlpha : Number
Roll over opacity
| MapObject | ||
| rollOverColor : Number
Roll over color of of the object
| MapObject | ||
| rollOverFilter : Object
filter to be applied for an object when the mouse is over it
| MapObject | ||
| selectable : Boolean
Specifies if the object can be selected even if it is not clickable.
| MapObject | ||
| selectedColor : Number
Color of an object when it is selected (somebody clicked on it)
| MapObject | ||
| showAsSelected : Boolean
Specifies if selectedColor should be applied to the object.
| MapObject | ||
| showInList : Boolean
Specifies if this object must be displayed in ObjectsList
Title should be defined in order the object to appear there.
| MapObject | ||
| title : String
Title of a MapObject
| MapObject | ||
| url : Object
url of an object.
| MapObject | ||
| urlTarget : String
Target of an URL, if URL is a string.
| MapObject | ||
| useTargetsZoomValues : Boolean
Specifies if MapObject's, specified in the url zoom values should be used.
| MapObject | ||
| value : Number
Value of the object.
| MapObject | ||
| visible : Boolean
specifies if map object is visible
| MapObject | ||
| zoomY : Number
Specifies y position (in percents of stage height) to which map should be moved when this object is clicked
You can also use zoomLat and zoomLong instead of zoomY and zoomY
| MapObject | ||
| zoomLat : Number
Specifies Latitude to which map should be moved when this object is clicked
| MapObject | ||
| zoomLevel : Number
Specifies map scale to which map should be rescaled when this object is clicked
| MapObject | ||
| zoomLong : Number
Specifies Longitude to which map should be moved when this object is clicked
| MapObject | ||
| zoomX : Number
Specifies x position (in percents of stage width) to which map should be moved when this object is clicked.
| MapObject | ||
| Method | Defined by | ||
|---|---|---|---|
|
Constructor.
| MapObject | ||
|
adds MapObject
| MapObject | ||
|
removeObject(object:MapObject):void
removes MapObject
| MapObject | ||
| Event | Summary | Defined by | ||
|---|---|---|---|---|
| Dispatched when user clicks this map object | MapObject | |||
| Dispatched when user rolls-out off a map object | MapObject | |||
| Dispatched when user rolls-over a map object | MapObject | |||
| alpha | property |
alpha:Number [read-write]Opacity of MapObject
Implementation public function get alpha():Number
public function set alpha(value:Number):void
| balloonText | property |
balloonText:String [read-write]Text which is displayed in a roll-over balloon. You can use the following tags: [[title]], [[description]], [[value]] and [[percents]]
Implementation public function get balloonText():String
public function set balloonText(value:String):void
| bringForwardOnHover | property |
bringForwardOnHover:Boolean [read-write]Specifies if movie or line should be moved to front level when user rolls-over it
The default value is false.
public function get bringForwardOnHover():Boolean
public function set bringForwardOnHover(value:Boolean):void
| color | property |
color:Number [read-write]Color of MapObject
Implementation public function get color():Number
public function set color(value:Number):void
| customData | property |
customData:Object [read-write]a custom data holder
Implementation public function get customData():Object
public function set customData(value:Object):void
| description | property |
description:String [read-write]Description of MapObject. Description is displayed in DescriptionWindow (when user clicks on an object). It can also be displayed in a roll-over balloon.
Implementation public function get description():String
public function set description(value:String):void
| descriptionWindowHeight | property |
descriptionWindowHeight:Number [read-write]Height of description window
Implementation public function get descriptionWindowHeight():Number
public function set descriptionWindowHeight(value:Number):void
| descriptionWindowY | property |
descriptionWindowY:Number [read-write]y position of description window
Implementation public function get descriptionWindowY():Number
public function set descriptionWindowY(value:Number):void
| descriptionWindowWidth | property |
descriptionWindowWidth:Number [read-write]Width of description window
Implementation public function get descriptionWindowWidth():Number
public function set descriptionWindowWidth(value:Number):void
| descriptionWindowX | property |
descriptionWindowX:Number [read-write]x position of description window
Implementation public function get descriptionWindowX():Number
public function set descriptionWindowX(value:Number):void
| displayObject | property |
displayObject:DisplayObject [read-write]DisplayObject of a MapObject
Implementation public function get displayObject():DisplayObject
public function set displayObject(value:DisplayObject):void
| filters | property |
filters:Array [read-write]Array of filters which will be applied to the object. MapAreas will only display these filters correctly if preserveOriginalColors property of MapArea is set to true.
Implementation public function get filters():Array
public function set filters(value:Array):void
| fixedSize | property |
fixedSize:Boolean [read-write]Specifies if the object should change the size together with the map or keep fixed size. This applies for objects with lat and long properties set, as they move together with the map.
The default value is true;.
public function get fixedSize():Boolean
public function set fixedSize(value:Boolean):void
| groupId | property |
groupId:String [read-write]id of a group. You can group MapObjects to groups and then show/hide them using showGroup(groupId) and hideGroup(groupId) methods of AmMap class.
Implementation public function get groupId():String
public function set groupId(value:String):void
| lines | property |
lines:Array [read-write]Array of MapLine objects
Implementation public function get lines():Array
public function set lines(value:Array):void
| linkWith | property |
linkWith:Array [read-write]Array of object id's with which this object is linked. Linked objects will change color together with this object when you roll-over it or click it.
Implementation public function get linkWith():Array
public function set linkWith(value:Array):void
| mouseEnabled | property |
mouseEnabled:Boolean [read-write]If you want to preserve original mouse events of your movie, set this to false.
The default value is true.
public function get mouseEnabled():Boolean
public function set mouseEnabled(value:Boolean):void
| movies | property |
movies:Array [read-write]Array of MapMovie objects.
Implementation public function get movies():Array
public function set movies(value:Array):void
| oid | property |
oid:String [read-write]unique id of map object
Implementation public function get oid():String
public function set oid(value:String):void
| passZoomValuesToTarget | property |
passZoomValuesToTarget:Boolean [read-write]Specifies if current zoom values should be passed to target MapObject Useful when building drill down maps.
Implementation public function get passZoomValuesToTarget():Boolean
public function set passZoomValuesToTarget(value:Boolean):void
| remainVisible | property |
remainVisible:Boolean [read-write]Specifies if the MapObject should remain visible if it was clicked and it has children MapObjects.
The default value is true.
public function get remainVisible():Boolean
public function set remainVisible(value:Boolean):void
| rollOverAlpha | property |
rollOverAlpha:Number [read-write]Roll over opacity
Implementation public function get rollOverAlpha():Number
public function set rollOverAlpha(value:Number):void
| rollOverColor | property |
rollOverColor:Number [read-write]Roll over color of of the object
Implementation public function get rollOverColor():Number
public function set rollOverColor(value:Number):void
| rollOverFilter | property |
rollOverFilter:Object [read-write]filter to be applied for an object when the mouse is over it
Implementation public function get rollOverFilter():Object
public function set rollOverFilter(value:Object):void
| selectable | property |
selectable:Boolean [read-write]Specifies if the object can be selected even if it is not clickable. Map objects are clickable if zoom properties are set or it has description or has children objects. Sometimes even non of the listed conditions is met you might need it to be clickable. You should set this property to true in this case.
Implementation public function get selectable():Boolean
public function set selectable(value:Boolean):void
| selectedColor | property |
selectedColor:Number [read-write]Color of an object when it is selected (somebody clicked on it)
Implementation public function get selectedColor():Number
public function set selectedColor(value:Number):void
| showAsSelected | property |
showAsSelected:Boolean [read-write]Specifies if selectedColor should be applied to the object. AmMap can have only one selected item at a time, however there might be situations when multiple objects (areas, movies, lines) have to look like they are selected. By setting this property to true, you will be able to produce this result.
Implementation public function get showAsSelected():Boolean
public function set showAsSelected(value:Boolean):void
| showInList | property |
showInList:Boolean [read-write]Specifies if this object must be displayed in ObjectsList Title should be defined in order the object to appear there.
The default value is true.
public function get showInList():Boolean
public function set showInList(value:Boolean):void
| title | property |
title:String [read-write]Title of a MapObject
Implementation public function get title():String
public function set title(value:String):void
| url | property |
url:Object [read-write]
url of an object.
url of an object can be a real URL (string) - the application will go to this url when you click on the object.
Note, this might work only if you upload the application to web server (for security restrictions).
It can also be id of other MapObject - MapArea, MapMovie, MapLine or DataSet. Then user clicks on this object
the application would zoom-in to this objects' zoom position (if it is set) and then act as if the object specified
in the url was clicked.
This can be used for selecting the object you want to be selected right after the map is initialized, as DataSet
extends MapObject class, you can specify url for your DataSets.
public function get url():Object
public function set url(value:Object):void
| urlTarget | property |
urlTarget:String [read-write]Target of an URL, if URL is a string.
The default value is _self.
public function get urlTarget():String
public function set urlTarget(value:String):void
| useTargetsZoomValues | property |
useTargetsZoomValues:Boolean [read-write]Specifies if MapObject's, specified in the url zoom values should be used. Useful when building drill down maps.
The default value is false.
public function get useTargetsZoomValues():Boolean
public function set useTargetsZoomValues(value:Boolean):void
| value | property |
value:Number [read-write]Value of the object. It affects areas only. Areas will be filled with color range from AreasSettings.color to AreasSettings.colorSolid, depending on the value.
Implementation public function get value():Number
public function set value(value:Number):void
| visible | property |
visible:Boolean [read-write]specifies if map object is visible
The default value is true.
public function get visible():Boolean
public function set visible(value:Boolean):void
| zoomY | property |
zoomY:Number [read-write]Specifies y position (in percents of stage height) to which map should be moved when this object is clicked You can also use zoomLat and zoomLong instead of zoomY and zoomY
Implementation public function get zoomY():Number
public function set zoomY(value:Number):void
| zoomLat | property |
zoomLat:Number [read-write]Specifies Latitude to which map should be moved when this object is clicked
Implementation public function get zoomLat():Number
public function set zoomLat(value:Number):void
| zoomLevel | property |
zoomLevel:Number [read-write]Specifies map scale to which map should be rescaled when this object is clicked
Implementation public function get zoomLevel():Number
public function set zoomLevel(value:Number):void
| zoomLong | property |
zoomLong:Number [read-write]Specifies Longitude to which map should be moved when this object is clicked
Implementation public function get zoomLong():Number
public function set zoomLong(value:Number):void
| zoomX | property |
zoomX:Number [read-write]Specifies x position (in percents of stage width) to which map should be moved when this object is clicked. You can also use zoomLat and zoomLong instead of zoomY and zoomY
Implementation public function get zoomX():Number
public function set zoomX(value:Number):void
| MapObject | () | constructor |
public function MapObject()Constructor.
| addObject | () | method |
| removeObject | () | method |
| click | event |
| rollOut | event |
| rollOver | event |