Class ImagesSettings

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

Index

Properties

Properties

public alpha: number

Opacity of the image.

default

1

public balloonText: string

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

public centered: boolean

Specifies if the image's center should be placed in the provided coordinates. If false, top-left corner will be at provided coordinates.

default

true

public color: string

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. #000000

public descriptionWindowHeight: number

Height of a description window.

public descriptionWindowWidth: number

Width of a description window.

default

250

public descriptionWindowX: number

X position of a description window.

public descriptionWindowY: number

Y position of a description window.

public labelColor: string

Label color. #000000

public labelFontSize: number

Font size of a label.

default

11

public labelPosition: string

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

public labelRollOverColor: string

Label roll-over color. #00CC00

public outlineAlpha: number

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.

public outlineColor: 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.

public outlineThickness: number

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.

default

1

public rollOverColor: 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.

public rollOverScale: number

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

default

1

public selectedScale: number

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

default

1