Skip to content

ImagesSettings

Type class

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

Sources

This information about ImagesSettings is provided for reference only and is not available through exported packages and thus should not be imported or used on its own.

Inheritance

ImagesSettings does not extend any other symbol.

ImagesSettings is not extended by any other symbol.

Properties

alpha

Type numberDefault 1

Opacity of the image.

balloonText

Type stringDefault [[title]]

Text which is displayed in a roll-over balloon. You can use the following tags: title, description, value and percent.

centered

Type booleanDefault 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 stringDefault #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 numberDefault 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 stringDefault #000000

Label color.

labelFontSize

Type numberDefault 11

Font size of a label.

labelPosition

Type stringDefault right

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

labelRollOverColor

Type stringDefault #00CC00

Label roll-over color.

outlineAlpha

Type numberDefault 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 numberDefault 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 numberDefault 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 numberDefault 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.