Important version information!

You are browsing a class reference for Version 2 of the JavaScript Charts. If you are using Version 3 (current), please click here.

ImagesSettings

ImagesSettings is a class which holds common settings of all MapImage objects.

Properties

PropertyTypeDefaultDescription
alphaNumber1Opacity of the image.
balloonTextString[[title]]Text which is displayed in a roll-over balloon. You can use the following tags: [[title]], [[description]], [[value]] and [[percent]].
centeredBooleantrueSpecifies if the image's center should be placed in the provided coordinates. If false, top-left corner will be at provided coordinates.
colorString#000000Color 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.
descriptionWindowHeightNumberHeight of a description window.
descriptionWindowWidthNumber250Width of a description window.
descriptionWindowXNumberX position of a description window.
descriptionWindowYNumberY position of a description window.
labelColorString#000000Label color.
labelFontSizeNumber11Font size of a label.
labelPositionStringrightPosition of the label. Allowed values are: left, right, top, bottom and middle.
labelRollOverColorString#00CC00Label roll-over color.
outlineAlphaNumber0Opacity 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.
outlineColorStringColor 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.
outlineThicknessNumber1Thickness 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.
rollOverColorStringColor 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.
rollOverScaleNumber1Scale of the image when hovered. Use value like 1.5 - 2 to enlarge image when user rolls-over it.
selectedLabelColorStringLabel color in case the image is selected.
selectedScaleNumber1Scale of the image if it is selected. Use value like 1.5 - 2 to enlarge selected image.

Methods

NameParametersReturnsDescription
descriptionWindowXX position of a description window.

Events

ImagesSettings class does not have any events.