ImagesSettings

Type class

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

Example

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

Inheritance

ImagesSettings does not extend any other symbol.

ImagesSettings is not extended by any other symbol.

Properties

accessibleLabel
#

Type string

Default [[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
#

Type boolean

Default false

If you set it to true, images along the lines will adjust the speed of animation corresponding the distance between lines.

alpha
#

Type number

Default 1

Opacity of the image.

animationDuration
#

Type number

Default 3

Defines duration of animation, in seconds. Custom animationDuration can also be set directly on MapImage.

balloonText
#

Type string

Default [[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
#

Type number

Default 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
#

Type boolean

Default true

Specifies if image should change it's z-index to the most top when user hovers it.

centered
#

Type boolean

Default 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
#

Type color

Default #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
#

Type 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
#

Type number

Height of a description window.

descriptionWindowLeft
#

Type 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
#

Type 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
#

Type number

Default 250

Width of a description window.

easingFunction
#

Default 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
#

Type color

Default #000000

Label color.

labelFontSize
#

Type number

Default 11

Font size of a label.

labelPosition
#

Type string

Default right

Position of the label. Allowed values are: left, right, top, bottom and middle.

labelRollOverColor
#

Type color

Default #00CC00

Label roll-over color.

outlineAlpha
#

Type number

Default 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
#

Type 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
#

Type number

Default 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
#

Type number

Default 0

Defines pause between animations (if a line has more than one segment or animation is looped or flipped).

rollOverColor
#

Type 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
#

Type number

Thickness of rolled-over image outline.

rollOverScale
#

Type number

Default 1

Scale of the image when hovered. Use value like 1.5 - 2 to enlarge image when user rolls-over it.

selectable
#

Type boolean

Default false

Specifies if all images on the map can be selected. You can also override this setting for each individual image individually.

selectedLabelColor
#

Type color

Label color in case the image is selected.

selectedOutlineColor
#

Type color

Color of selected image outline.

selectedOutlineThickness
#

Type number

Outline thickness of selected image.

selectedScale
#

Type number

Default 1

Scale of the image if it is selected. Use value like 1.5 - 2 to enlarge selected image.

tabIndex
#

Type 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

descriptionWindowX()

#

Returns void

X position of a description window.

Events

ImagesSettings does not have any events.

Adapters

ImagesSettings does not have any adapters.