Type class
Extension for MapObject to define individual settings for each image. it overwrites the settings obtained from ImagesSettings. It supports svg (or path), png, jpg or gif files and has three predefined types available circle, rectangle and bubble, labels can be shown as well.
Example
var map = AmCharts.makeChart("mapdiv",{ ... "dataProvider": { "map": "worldHigh", "images": [ { "type": "circle", "label": "Circle Test", "top": 100, "left": 100 } ] } });
Inheritance
MapImage extends MapObject
.
MapImage is not extended by any other symbol.
Properties
animateAlongLine # |
Type Default If you set it to true, and lineId of some line is set, the image will animate along the line. |
---|---|
animateAngle # |
Type Default Set this to |
animationDuration # |
Type Defines duration of animation (along line or when animateTo method is called, in seconds. Global animationDuration can also be set via ImagesSettings. |
bottom # |
Type Distance from bottom of a map container to the image. If centered property is false, then the distance is measured to the bottom of the image, otherwise - to the center. If you set this property, value of top property is ignored. This property can be set as a number (of pixels) or as a percent value, like: image.bottom = "10%";. The image will not be bounded to the map if this property is set. Use latitude and longitude properties if you want the image to move with the map. |
centered # |
Type Specifies if the image's center should be placed in the provided coordinates. If false, top-left corner will be at provided coordinates. This property doesn't work with images set as svgPath. |
easingFunction # |
Function which defines how the image should animate. AmCharts.easeInOutQuad. You can use these methods: AmCharts.bounce, AmCharts.easeInSine, AmCharts.easeOutSine, AmCharts.easeOutElastic. Common for all easing function is set on ImagesSettings. |
flipDirection # |
Type Default Specifies if animation along lines should be played in reverse direction when reached the end of a line. |
height # |
Type Height of an image. Works with predefined images (if type is set) and loaded images (imageURL is set). If svgPath is set, use scale property to change it's size. |
imageURL # |
Type Url of an image. Images can be svg, jpg, png or gif files. Note, you can't control color, outlineColor, outlineAlpha and outlineThickness of loaded images. Use svgPath property if you need to change these properties. |
label # |
Type Text which will be shown next to the image. |
labelBackgroundAlpha # |
Type Opacity of label background alpha. |
labelBackgroundColor # |
Type Color of label background. |
labelColor # |
Type Label color. |
labelFontSize # |
Type Font size of a label. |
labelPosition # |
Type Position of the label. Allowed values are: left, right, top, bottom and middle. |
labelRollOverColor # |
Type Label roll-over color. |
labelShiftX # |
Type Default In some cases you might want to adjust label position a bit. Use this property to shift label horizontally. |
labelShiftY # |
Type Default In some cases you might want to adjust label position a bit. Use this property to shift label vertically. |
latitude # |
Type Latitude of the image. of the image. Set this property if you want the image to be bounded to the map. Otherwise use left/right/top/bottom properties. |
left # |
Type Distance from left of a map container to the image. If centered property is false, then the distance is measured to the left of the image, otherwise - to the center. The image will not be bounded to the map if this property is set. Use latitude and longitude properties if you want the image to move with the map. This property can be set as a number (of pixels) or as a percent value, like: image.left = "10%"; |
lineId # |
Type You should add id for the line and set this id for the image if you want to use create animation along line or position image at some relative position of a line. |
longitude # |
Type Longitude of the image. Set this property if you want the image to be bounded to the map. Otherwise use left/right/top/bottom properties. |
loop # |
Type Default Specifies if animation along lines should be looped. |
outlineAlpha # |
Type Opacity of image outline. This will affect only predefined images (with "type" property set) and images with svgPath set. This property won't affect bitmap images and loaded SVG images. |
outlineColor # |
Type Color of image outline. This will affect only predefined images (with "type" property set) and images with svgPath set. This property won't affect bitmap images and loaded SVG images. |
outlineThickness # |
Type Thickness of image outline. This will affect only predefined images (with "type" property set) and images with svgPath set. This property won't affect bitmap images and loaded SVG images. |
percentHeight # |
Type Height of an image, in percents of map container. Works with predefined images (if type is set) and loaded images (imageURL is set). If svgPath is set, use scale property to change it's size. |
percentWidth # |
Type Width of an image, in percents of map container. Works with predefined images (if type is set) and loaded images (imageURL is set). If svgPath is set, use scale property to change it's size. |
positionOnLine # |
Type Default If you set lineId of some line and then set positionOnLine to 0.5, the image will be placed in the middle of the line. Allowed values are from 0 to 1. |
positionScale # |
Type Default If you set it to 2, the image will scale 2x in the middle of the animation. |
right # |
Type Distance from right of a map container to the image. If centered property is false, then the distance is measured to the right of the image, otherwise - to the center. If you set this property, value of left property is ignored. The image will not be bounded to the map if this property is set. This property can be set as a number (of pixels) or as a percent value, like: image.right= "10%"; Use latitude and longitude properties if you want the image to move with the map. |
rollOverScale # |
Type Scale of the image when hovered. Use value like 1.5 - 2 to enlarge image when user rolls-over it. |
scale # |
Type Default Scale of the image. Works only with images created using svgPath. Use width/height properties for all other images. |
selectedLabelColor # |
Type Color of a label when image is selected. |
selectedScale # |
Type Scale of the image if it is selected. Use value like 1.5 - 2 to enlarge selected image. |
svgPath # |
Type SVG path, for example: M9,0C4.029,0,0,4.029,0,9s4.029,9,9,9s9-4.029,9-9S13.971,0,9,0z M9,15.93 c-3.83,0-6.93-3.1-6.93-6.93S5.17,2.07,9,2.07s6.93,3.1,6.93,6.93S12.83,15.93,9,15.93 M12.5,9c0,1.933-1.567,3.5-3.5,3.5S5.5,10.933,5.5,9S7.067,5.5,9,5.5 S12.5,7.067,12.5,9z The line above will create a target icon. For more icons we recommend visiting this page: http://raphaeljs.com/icons/ Simply click on an icon you like and you will get SVG path in the bottom. This is the recommended way to create icons/images in AmMap. |
top # |
Type Distance from top of a map container to the image. If centered property is false, then the distance is measured to the top bound of the image, otherwise - to the center. The image will not be bounded to the map if this property is set. This property can be set as a number (of pixels) or as a percent value, like: image.top = "10%"; Use latitude and longitude properties if you want the image to move with the map. |
type # |
Type Type of a predefined image. Allowed values are: circle, rectangle, bubble and hexagon. |
width # |
Type Width of an image. Works with predefined images (if type is set) and loaded images (imageURL is set). If svgPath is set, use scale property to change it's size. |
widthAndHeightUnits # |
Type Default You can set miles or kilometers as a unit of width/height of an image. This works only with predefined images (type is set). |
accessibleLabel # |
Type Inherited from Text which screen readers will read if user rolls-over the object or sets focus using tab key (this is possible only if tabIndex property of object settings or individual object is set to some number). Text is added as aria-label tag. Note - not all screen readers and browsers support this. |
alpha # |
Type Inherited from Opacity of map object. |
balloonText # |
Type Inherited from Text which is displayed in a roll-over balloon. You can use the following tags: [[title]], [[description]], [[value]] and [[percent]]. To disable the balloons, set it to an empty string. |
bringForwardOnHover # |
Type Inherited from Specifies if the object should change it's z-index to the top-most when user hovers it. |
color # |
Type Inherited from Color of MapObject |
customData # |
Type Inherited from A custom data holder. |
description # |
Type Inherited from Description of MapObject. Description is displayed in DescriptionWindow (when user clicks on an object). It can also be displayed in a roll-over balloon. DescriptionWindow can display HTML formatted code. |
descriptionWindowBottom # |
Inherited from Distance from the bottom side of map container to the description window. In case it is not set (also if descriptionWindowTop is not set), window will be placed near the mouse pointer. |
descriptionWindowHeight # |
Type Inherited from Height of description window. |
descriptionWindowLeft # |
Type Inherited from Distance from the left side of map container to the description window. In case it is not set (also if descriptionWindowRight is not set), window will be placed near the mouse pointer. |
descriptionWindowRight # |
Inherited from Distance from the right side of map container to the description window. In case it is not set (also if descriptionWindowLeft is not set), window will be placed near the mouse pointer. |
descriptionWindowTop # |
Type Inherited from Distance from the top side of map container to the description window. In case it is not set (also if descriptionWindowBottom is not set), window will be placed near the mouse pointer. |
descriptionWindowWidth # |
Type Inherited from Width of description window. |
fixedSize # |
Type Default Inherited from 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. |
groupId # |
Type Inherited from Id of a group. You can group MapObjects to groups. Grouped objects will change color together with this object when you roll-over it or click it. You can show/hide them using showGroup(groupId) and hideGroup(groupId) methods of AmMap class. You can also use map.zoomToGroup(groupId) methot to zoom-in the map so that all grouped objects are visible. |
id # |
Type Inherited from Unique id of the object. In case it's area, id should match svg path id from SVG file. Id can be used with linkToObject property of MapObject - you can link one object to another using it. |
images # |
Type Inherited from Array of MapImage objects. |
lines # |
Type Inherited from Array of MapLine objects. |
linkToObject # |
Type Inherited from linkToObject can be a reference or id of some other MapObject - MapArea, MapImage or MapLine. It can also be a reference to another DataSet (but not an id). 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 linkToObject was clicked. This can also 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 linkToObject for your DataSet. When you link to another DataSet, you can build drill-down maps. |
mouseEnabled # |
Type Default Inherited from Set this to false to make the object be irresponsive to any interactions like hover or click events. |
passZoomValuesToTarget # |
Type Default Inherited from Specifies if current zoom values should be passed to target MapObject. Useful when building drill down maps. |
remainVisible # |
Type Default Inherited from Specifies if the MapObject and other objects of the same level should remain visible if it was clicked and it has children MapObjects. |
rollOverColor # |
Type Inherited from Roll over color of of the object. |
selectable # |
Type Default Inherited from Specifies if the object can be selected even if it is not clickable. Map object is 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. |
selectedColor # |
Type Inherited from Color of an object when it is selected (somebody clicked on it). |
showAsSelected # |
Type Default Inherited from 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, images, lines) have to look like they are selected. By setting this property to true, you will be able to produce this result. |
showInList # |
Type Inherited from Specifies if this object must be displayed in ObjectsList Title should be defined in order the object to appear there. |
tabIndex # |
Type Inherited from In case you set it to some number, the map will set focus on this object when user clicks tab key. When a focus is set, screen readers like NVDA Screen reader will read label which is set using accessibleLabel property of object settings or individual object. If object is clickable, pressing Enter/Return while focus is set will select the object. Note, not all browsers and readers support this. |
title # |
Type Inherited from Title of a MapObject. It can be displayed in the roll-over balloon and in the header of description window. All areas in SVG maps distributed with amMap has country names (titles) hard coded in the SVG file. |
url # |
Type Inherited from Url of an object. The application will go to this url when you click on the object. |
urlTarget # |
Type Default Inherited from Target of an URL, if URL is a string, for example: "_blank", "_top". |
useTargetsZoomValues # |
Type Default Inherited from If set to |
zoomLatitude # |
Type Inherited from Specifies latitude to which map should be moved when this object is clicked |
zoomLevel # |
Type Inherited from Specifies map scale to which map should be rescaled when this object is clicked. |
zoomLongitude # |
Type Inherited from Specifies longitude to which map should be moved when this object is clicked. |
zoomX # |
Type Inherited from 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 zoomX and zoomY. |
zoomY # |
Type Inherited from 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 zoomX and zoomY. |
There are 37 inherited items currently hidden from this list. |
Methods
animateAlong( |
Returns Triggers animation along a line. Duration and easingFunction attributes are optional. lineId, duration, easingFunction |
---|---|
animateTo( |
Returns You can animate images to any coordinates (instead of longitude/latitude you can use top/left/right/bottom coordinates). longitude, latitude, duration, easingFunction |
deleteObject() |
Returns Deletes the image. |
fixToMap() |
Returns Fixes the image to the map instead of the stage. To do this, left/top/right/bottom coordinates are changed to latitude/longitude. |
fixToStage() |
Returns Fixes the image to the stage instead of the map. To do latitude and longitude are changed to top/left coordinates. |
updatePosition() |
Returns Updates position of an image. |
validate() |
Returns Redraws the image. |
Events
#animationEnd |
Param Dispatched when animation ends. |
---|---|
#animationStart |
Param Dispatched when animation starts. |
Adapters
MapImage does not have any adapters.