Packagecom.ammap.mapClasses
Classpublic class MapMovie
InheritanceMapMovie Inheritance MapObject Inheritance flash.events.EventDispatcher

MapMovie is a class where properties of movies are defined. MapMovie can be:
external swf or image file;
class;
component;
predefined movie (circle, rectangle or bubble).

MapMovie can also display labels.

In case some property is not defined in this class, MapMovie will use MoviesSettings class property with the same name.



Public Properties
 PropertyDefined by
 Inheritedalpha : Number
Opacity of MapObject
MapObject
 InheritedballoonText : String
Text which is displayed in a roll-over balloon.
MapObject
  borderColor : Number
Color of a predefined movie border (only rectangle and circle)
MapMovie
  borderThickness : Number
Thickness of a predefined movie border (only rectangle and circle)
MapMovie
 InheritedbringForwardOnHover : Boolean
Specifies if movie or line should be moved to front level when user rolls-over it
MapObject
  callBackDataObject : Object
callBackObject is passed to the callBackFunction when this method is called.
MapMovie
  callBackFunction : Function
callBackFunction is a method which is called when the MapMovie appears on stage.
MapMovie
  centered : Boolean
Specifies if the movies center should be placed at the specified postion.
MapMovie
 Inheritedcolor : Number
Color of MapObject
MapObject
  component : UIComponent
MapMovie can display a component
MapMovie
 InheritedcustomData : Object
a custom data holder
MapObject
 Inheriteddescription : String
Description of MapObject.
MapObject
 InheriteddescriptionWindowHeight : Number
Height of description window
MapObject
 InheriteddescriptionWindowY : Number
y position of description window
MapObject
 InheriteddescriptionWindowWidth : Number
Width of description window
MapObject
 InheriteddescriptionWindowX : Number
x position of description window
MapObject
 InheriteddisplayObject : DisplayObject
DisplayObject of a MapObject
MapObject
 Inheritedfilters : Array
Array of filters which will be applied to the object.
MapObject
 InheritedfixedSize : Boolean
Specifies if the object should change the size together with the map or keep fixed size.
MapObject
 InheritedgroupId : String
id of a group.
MapObject
  height : Number
Height of a movie
MapMovie
  y : Number
Distance from top of a map container to the movie.
MapMovie
  label : String
Label is a text positioned next to the movie.
MapMovie
  labelAlign : String
Alignment of a label
MapMovie
  labelBackgroundAlpha : Number
Opacity of label background
MapMovie
  labelBackgroundColor : Number
Background color of a label.
MapMovie
  labelColor : Number
Color of a label
MapMovie
  labelFontSize : Number
Font size of a label
MapMovie
  labelInactive : Boolean
Specifies if label of a movie receives same mouse events as movie does
MapMovie
  labelPercentWidth : Number
Width of label's text field, in percents
MapMovie
  labelPosition : String
Position of a label Available options are: left, right, above, below
MapMovie
  labelRollOverColor : Number
Label roll-over color.
MapMovie
  labelWidth : Number
Width of label's text field
MapMovie
  lat : Number
Latitude of a movie.
MapMovie
 Inheritedlines : Array
Array of MapLine objects
MapObject
 InheritedlinkWith : Array
Array of object id's with which this object is linked.
MapObject
  long : Number
Longitude of a movie.
MapMovie
  marginBottom : Number
Distance from bottom of a map container to the movie.
MapMovie
  marginLeft : Number
Distance from left side of a map container to the movie.
MapMovie
  marginRight : Number
Distance from right side of a map container to the movie.
MapMovie
  marginTop : Number
Distance from top of a map container to the movie.
MapMovie
 InheritedmouseEnabled : Boolean
If you want to preserve original mouse events of your movie, set this to false.
MapObject
  movieClass : Class
MapMovie can instantiate a new Object from a Class
MapMovie
 Inheritedmovies : Array
Array of MapMovie objects.
MapObject
  movieURL : String
MapMovie can load swf or an image from a specified URL
MapMovie
 Inheritedoid : String
unique id of map object
MapObject
 InheritedpassZoomValuesToTarget : Boolean
Specifies if current zoom values should be passed to target MapObject Useful when building drill down maps.
MapObject
  percentHeight : Number
Height of a movie in percents
MapMovie
  percentMarginBottom : Number
Distance from bottom of a map container to the movie, in percents.
MapMovie
  percentMarginLeft : Number
Distance from left side of a map container to the movie, in percents.
MapMovie
  percentMarginRight : Number
Distance from right side of a map container to the movie, in percents.
MapMovie
  percentMarginTop : Number
Distance from top of a map container to the movie, in percents.
MapMovie
  percentWidth : Number
Width of a movie in percents
MapMovie
 InheritedremainVisible : Boolean
Specifies if the MapObject should remain visible if it was clicked and it has children MapObjects.
MapObject
 InheritedrollOverAlpha : Number
Roll over opacity
MapObject
 InheritedrollOverColor : Number
Roll over color of of the object
MapObject
 InheritedrollOverFilter : Object
filter to be applied for an object when the mouse is over it
MapObject
  rotation : Number
angle of rotation
MapMovie
 Inheritedselectable : Boolean
Specifies if the object can be selected even if it is not clickable.
MapObject
 InheritedselectedColor : Number
Color of an object when it is selected (somebody clicked on it)
MapObject
 InheritedshowAsSelected : Boolean
Specifies if selectedColor should be applied to the object.
MapObject
 InheritedshowInList : Boolean
Specifies if this object must be displayed in ObjectsList Title should be defined in order the object to appear there.
MapObject
  type : String
Type of a predefined movie
MapMovie
 Inheritedtitle : String
Title of a MapObject
MapObject
 Inheritedurl : Object
url of an object.
MapObject
 InheritedurlTarget : String
Target of an URL, if URL is a string.
MapObject
 InheriteduseTargetsZoomValues : Boolean
Specifies if MapObject's, specified in the url zoom values should be used.
MapObject
 Inheritedvalue : Number
Value of the object.
MapObject
 Inheritedvisible : Boolean
specifies if map object is visible
MapObject
  width : Number
Width of a movie
MapMovie
  widthAndHeightUnits : String
You can set miles or kilometers as a unit of width/height of a movie.
MapMovie
  x : Number
Distance from left side of a map container to the movie.
MapMovie
 InheritedzoomY : 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
 InheritedzoomLat : Number
Specifies Latitude to which map should be moved when this object is clicked
MapObject
 InheritedzoomLevel : Number
Specifies map scale to which map should be rescaled when this object is clicked
MapObject
 InheritedzoomLong : Number
Specifies Longitude to which map should be moved when this object is clicked
MapObject
 InheritedzoomX : Number
Specifies x position (in percents of stage width) to which map should be moved when this object is clicked.
MapObject
Public Methods
 MethodDefined by
  
Constructor.
MapMovie
 Inherited
addObject(object:MapObject):void
adds MapObject
MapObject
 Inherited
removeObject(object:MapObject):void
removes MapObject
MapObject
Events
 EventSummaryDefined by
 Inherited Dispatched when user clicks this map object MapObject
 Inherited Dispatched when user rolls-out off a map object MapObject
 Inherited Dispatched when user rolls-over a map object MapObject
Property detail
borderColorproperty
borderColor:Number  [read-write]

Color of a predefined movie border (only rectangle and circle)

Implementation
    public function get borderColor():Number
    public function set borderColor(value:Number):void
borderThicknessproperty 
borderThickness:Number  [read-write]

Thickness of a predefined movie border (only rectangle and circle)

Implementation
    public function get borderThickness():Number
    public function set borderThickness(value:Number):void
callBackDataObjectproperty 
callBackDataObject:Object  [read-write]

callBackObject is passed to the callBackFunction when this method is called.

Implementation
    public function get callBackDataObject():Object
    public function set callBackDataObject(value:Object):void
callBackFunctionproperty 
callBackFunction:Function  [read-write]

callBackFunction is a method which is called when the MapMovie appears on stage.

Implementation
    public function get callBackFunction():Function
    public function set callBackFunction(value:Function):void
centeredproperty 
centered:Boolean  [read-write]

Specifies if the movies center should be placed at the specified postion. Note, you should set this to false when using default amMap icons (included in the package), as the center of the image in these icons is already at 0,0 position.

The default value is true.

Implementation
    public function get centered():Boolean
    public function set centered(value:Boolean):void
componentproperty 
component:UIComponent  [read-write]

MapMovie can display a component

Implementation
    public function get component():UIComponent
    public function set component(value:UIComponent):void
heightproperty 
height:Number  [read-write]

Height of a movie

Implementation
    public function get height():Number
    public function set height(value:Number):void
yproperty 
y:Number  [read-write]

Distance from top of a map container to the movie. If centered property is false, then the distance is measured to the top of the movie, otherwise - to the center. The movie will not be bounded to the map if x and y is set

Implementation
    public function get y():Number
    public function set y(value:Number):void
labelproperty 
label:String  [read-write]

Label is a text positioned next to the movie.

Implementation
    public function get label():String
    public function set label(value:String):void
labelAlignproperty 
labelAlign:String  [read-write]

Alignment of a label

Implementation
    public function get labelAlign():String
    public function set labelAlign(value:String):void
labelBackgroundAlphaproperty 
labelBackgroundAlpha:Number  [read-write]

Opacity of label background

Implementation
    public function get labelBackgroundAlpha():Number
    public function set labelBackgroundAlpha(value:Number):void
labelBackgroundColorproperty 
labelBackgroundColor:Number  [read-write]

Background color of a label. In order for background to be visible, set labelBackgroundAlpha > 0

Implementation
    public function get labelBackgroundColor():Number
    public function set labelBackgroundColor(value:Number):void
labelColorproperty 
labelColor:Number  [read-write]

Color of a label

Implementation
    public function get labelColor():Number
    public function set labelColor(value:Number):void
labelFontSizeproperty 
labelFontSize:Number  [read-write]

Font size of a label

Implementation
    public function get labelFontSize():Number
    public function set labelFontSize(value:Number):void
labelInactiveproperty 
labelInactive:Boolean  [read-write]

Specifies if label of a movie receives same mouse events as movie does

The default value is false.

Implementation
    public function get labelInactive():Boolean
    public function set labelInactive(value:Boolean):void
labelPercentWidthproperty 
labelPercentWidth:Number  [read-write]

Width of label's text field, in percents

Implementation
    public function get labelPercentWidth():Number
    public function set labelPercentWidth(value:Number):void
labelPositionproperty 
labelPosition:String  [read-write]

Position of a label Available options are: left, right, above, below

The default value is right.

Implementation
    public function get labelPosition():String
    public function set labelPosition(value:String):void
labelRollOverColorproperty 
labelRollOverColor:Number  [read-write]

Label roll-over color.

Implementation
    public function get labelRollOverColor():Number
    public function set labelRollOverColor(value:Number):void
labelWidthproperty 
labelWidth:Number  [read-write]

Width of label's text field

Implementation
    public function get labelWidth():Number
    public function set labelWidth(value:Number):void
latproperty 
lat:Number  [read-write]

Latitude of a movie. Set this property if you want the movie to be bound to the map.

Implementation
    public function get lat():Number
    public function set lat(value:Number):void
longproperty 
long:Number  [read-write]

Longitude of a movie. Set this property if you want the movie to be bound to the map.

Implementation
    public function get long():Number
    public function set long(value:Number):void
marginBottomproperty 
marginBottom:Number  [read-write]

Distance from bottom of a map container to the movie. If centered property is false, then the distance is measured to the bottom of the movie, otherwise - to the center. When movie position is set using margins, movie is not bound to the map.

Implementation
    public function get marginBottom():Number
    public function set marginBottom(value:Number):void
marginLeftproperty 
marginLeft:Number  [read-write]

Distance from left side of a map container to the movie. If centered property is false, then the distance is measured to the left side of the movie, otherwise - to the center. When movie position is set using margins, movie is not bound to the map.

Implementation
    public function get marginLeft():Number
    public function set marginLeft(value:Number):void
marginRightproperty 
marginRight:Number  [read-write]

Distance from right side of a map container to the movie. If centered property is false, then the distance is measured to the right side of the movie, otherwise - to the center. When movie position is set using margins, movie is not bound to the map.

Implementation
    public function get marginRight():Number
    public function set marginRight(value:Number):void
marginTopproperty 
marginTop:Number  [read-write]

Distance from top of a map container to the movie. If centered property is false, then the distance is measured to the top of the movie, otherwise - to the center. When movie position is set using margins, movie is not bound to the map.

Implementation
    public function get marginTop():Number
    public function set marginTop(value:Number):void
movieClassproperty 
movieClass:Class  [read-write]

MapMovie can instantiate a new Object from a Class

Implementation
    public function get movieClass():Class
    public function set movieClass(value:Class):void
movieURLproperty 
movieURL:String  [read-write]

MapMovie can load swf or an image from a specified URL

Implementation
    public function get movieURL():String
    public function set movieURL(value:String):void
percentHeightproperty 
percentHeight:Number  [read-write]

Height of a movie in percents

Implementation
    public function get percentHeight():Number
    public function set percentHeight(value:Number):void
percentMarginBottomproperty 
percentMarginBottom:Number  [read-write]

Distance from bottom of a map container to the movie, in percents.

Implementation
    public function get percentMarginBottom():Number
    public function set percentMarginBottom(value:Number):void
percentMarginLeftproperty 
percentMarginLeft:Number  [read-write]

Distance from left side of a map container to the movie, in percents.

Implementation
    public function get percentMarginLeft():Number
    public function set percentMarginLeft(value:Number):void
percentMarginRightproperty 
percentMarginRight:Number  [read-write]

Distance from right side of a map container to the movie, in percents.

Implementation
    public function get percentMarginRight():Number
    public function set percentMarginRight(value:Number):void
percentMarginTopproperty 
percentMarginTop:Number  [read-write]

Distance from top of a map container to the movie, in percents.

Implementation
    public function get percentMarginTop():Number
    public function set percentMarginTop(value:Number):void
percentWidthproperty 
percentWidth:Number  [read-write]

Width of a movie in percents

Implementation
    public function get percentWidth():Number
    public function set percentWidth(value:Number):void
rotationproperty 
rotation:Number  [read-write]

angle of rotation

The default value is 0.

Implementation
    public function get rotation():Number
    public function set rotation(value:Number):void
typeproperty 
type:String  [read-write]

Type of a predefined movie

Implementation
    public function get type():String
    public function set type(value:String):void
widthproperty 
width:Number  [read-write]

Width of a movie

Implementation
    public function get width():Number
    public function set width(value:Number):void
widthAndHeightUnitsproperty 
widthAndHeightUnits:String  [read-write]

You can set miles or kilometers as a unit of width/height of a movie. This works only with predefined movies (type is set). rightLongitude and bottomLatitude should be set with real values in order this to work properly. fixedSize will be set to false if miles or kilometers is set here.

The default value is pixels.

Implementation
    public function get widthAndHeightUnits():String
    public function set widthAndHeightUnits(value:String):void
xproperty 
x:Number  [read-write]

Distance from left side of a map container to the movie. If centered property is false, then the distance is measured to the left side of the movie, otherwise - to the center. When movie position is set using margins, movie is not bound to the map.

Implementation
    public function get x():Number
    public function set x(value:Number):void
Constructor detail
MapMovie()constructor
public function MapMovie()

Constructor.