Information on this website refers to a deprecated product, and is provided only for historical reference. Please use the Version Switcher above to select an appropriate documentation website for the product you are using.

ImagesSettings

Type class

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

Inheritance

ImagesSettings does not extend any other symbol.

ImagesSettings is not extended by any other symbol.

Properties

alpha
#

Type number

Default 1

Opacity of the image.

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]].

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 string

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.

descriptionWindowHeight
#

Type number

Height of a description window.

descriptionWindowWidth
#

Type number

Default 250

Width of a description window.

descriptionWindowX
#

Type number

X position of a description window.

descriptionWindowY
#

Type number

Y position of a description window.

labelColor
#

Type string

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 string

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 string

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.

rollOverColor
#

Type string

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.

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.

selectedLabelColor
#

Type string

Label color in case the image is selected.

selectedScale
#

Type number

Default 1

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

Methods

descriptionWindowX()

#

Returns void

X position of a description window.

Events

ImagesSettings does not have any events.

Adapters

ImagesSettings does not have any adapters.