ImagesSettings | JavaScript Maps v. 3 | amCharts

ImagesSettings is a class which defines the default settings for all MapImage objects.

### Example

    var map = AmCharts.makeChart("mapdiv",{
      ...
      "imagesSettings": {
        "alpha": 0.5
      }
    });

### Properties

Property | Type | Default | Description
--- | --- | --- | ---
accessibleLabel | String | [[title]] [[description]] | Text which screen readers will read if user rolls-over the image or sets focus using tab key (this is possible only if tabIndex property of ImagesSettings or individual image is set to some number). Text is added as aria-label tag. Note - not all screen readers and browsers support this.
adjustAnimationSpeed | Boolean | false | If you set it to true, images along the lines will adjust the speed of animation corresponding the distance between lines.
alpha | Number | 1 | Opacity of the image.
animationDuration | Number | 3 | Defines duration of animation, in seconds. Custom animationDuration can also be set directly on MapImage.
balloonText | String | [[title]] | 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.
baseAnimationDistance | Number | 500 | If adjustAnimationSpeed is set to true, the the image will move at a speed which would allow to move by 500 pixels during animationDuration. If the distance between start/end points of animation is less than baseAnimationDistance, the image will move faster, otherwise – slower.
bringForwardOnHover | Boolean | true | Specifies if image should change it's z-index to the most top when user hovers it.
centered | Boolean | true | Specifies if the image's center should be placed in the provided coordinates. If false, top-left corner will be at provided coordinates.
color | Color | #000000 | Color of image. 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.
descriptionWindowBottom | Number |  | 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 | Number |  | Height of a description window.
descriptionWindowLeft | Number |  | 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 | Number |  | 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 |  |  | 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 | Number | 250 | Width of a description window.
easingFunction |  | AmCharts.easeInOutQuad | This particular function makes the animation to be slower in the beginning and end of animation and faster in the middle. Alternatively you can use these methods: AmCharts.bounce, AmCharts.easeInSine, AmCharts.easeOutSine, AmCharts.easeOutElastic. You can also set easing function on MapImage.
labelColor | Color | #000000 | Label color.
labelFontSize | Number | 11 | Font size of a label.
labelPosition | String | right | Position of the label. Allowed values are: left, right, top, bottom and middle.
labelRollOverColor | Color | #00CC00 | Label roll-over color.
outlineAlpha | Number | 0 | 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 | Color |  | 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 | Number | 1 | 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.
pauseDuration | Number | 0 | Defines pause between animations (if a line has more than one segment or animation is looped or flipped).
rollOverColor | Color |  | Color of image when hovered. 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.
rollOverOutlineThickness | Number |  | Thickness of rolled-over image outline.
rollOverScale | Number | 1 | Scale of the image when hovered. Use value like 1.5 - 2 to enlarge image when user rolls-over it.
selectable | Boolean | false | Specifies if all images on the map can be selected. You can also override this setting for each individual image individually.
selectedLabelColor | Color |  | Label color in case the image is selected.
selectedOutlineColor | Color |  | Color of selected image outline.
selectedOutlineThickness | Number |  | Outline thickness of selected image.
selectedScale | Number | 1 | Scale of the image if it is selected. Use value like 1.5 - 2 to enlarge selected image.
tabIndex | Number |  | In case you set it to some number, the map will set focus on images (one by one) 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 ImagesSettings or individual image. If area is clickable, pressing Enter/Return while focus is set will select the image. Note, not all browsers and readers support this.

### Methods

Name | Parameters | Returns | Description
--- | --- | --- | ---
descriptionWindowX |  |  | X position of a description window.

### Events

ImagesSettings class does not have any events.