Map Marker

Map marker item, placed inside a map object.

Attributes

Common

Type

Specifies the marker type.

Attribute Values

Value	Description
marker	Default value. Standard marker.
button	Button marker.
camera	Camera marker.
shape	Shape marker.
text	Text marker.
image	Image marker.

The default value is: marker.

Position

Lat

Specifies the marker latitude.

Attribute Values

Value	Description	Example
<float>	Latitude.	45.07

Lng

Specifies the marker longitude.

Attribute Values

Value	Description	Example
<float>	Longitude.	7.69

Content

Marker Tooltip

Specifies the marker tooltip label.

Attribute Values

Value	Description
<string>	Marker label.

This attribute is available when type is "marker".

Popup

Specifies the marker popup content.

Attribute Values

Value	Description
<string>	Popup text.

This attribute is available when type is "marker".

Size

Width

Sets the object's width in pixels.

Minimum value is 1.

This attribute is available when type is one of "button", "camera", "shape", "text", or "image".

Height

Sets the object's height in pixels.

Minimum value is 1.

This attribute is available when type is one of "button", "camera", "shape", "text", or "image".

Button

Label

Specifies the button's label.

Attribute Values

Value	Description
<string>	Button's label.

This attribute is available when type is "button".

Description

Specifies a description displayed below the label.

Attribute Values

Value	Description
<string>	Button's description.

This attribute is available when type is "button".

Color

Specifies the button color.

Attribute Values

Value	Description
default	Default value. Default color.
primary	Primary color, used to highlight action buttons.
warning	Warning color, used to highlight warning buttons.
success	Success color, used to highlight success buttons.
error	Error color, used to highlight error buttons.
light	Light color.
dark	Dark color.
red,blue,yellow,green,yellow,purple,orange,green	Palette colors.
custom	Custom color, defined in the "Custom Color" attribute.

This attribute is available when type is "button".

The default value is: default.

Look

Specifies the button's look.

Attribute Values

Value	Description
filled	Default value. Filled look, with a solid background.
clear	Clear look, no background or border.
outlined	Outlined look, with a solid border.
glass	Glass look, with a semi-transparent background.

This attribute is available when type is "button".

The default value is: filled.

Shape

Specifies the button's shape.

Attribute Values

Value	Description
default	Default value. Default shape.
rounded	Rounded shape.
pill	Pill or circle shape.
rectangle	Rectangle shape.

This attribute is available when type is "button".

The default value is: default.

Icon

Specifies the button icon.

Attribute Values

Value	Description
<icon>	Icon name.

This attribute is available when type is "button".

Button Action

Action

Specifies the action performed when clicked/tapped.

Attribute Values

Value	Description
none	Default value. No action.
command	Sends a command to the server, with the specified name and parameter. See the Command API.
link	Changes page, shows a popup or opens a URL.

This attribute is available when type is "button".

The default value is: none.

Name

Specifies the command name that is sent to the server.

If the name starts with $, then the server will automatically set a variable with the same name as the command, containing the command's parameter.

Attribute Values

Value	Description	Example
<string>	A command name.
$[variable name]	A command name that sets a variable.	$myvar
$[variable name]!	A command name that sets a persistent variable.	$myvar!

This attribute is available when type is "button" and action is "command".

When type is "button" and action is "command", this attribute defaults to the id attribute.

Parameter

Specifies the command parameter that is sent to the server.

Attribute Values

Value	Description
<string>	A command parameter.

This attribute is available when type is "button" and action is "command".

Link

Specifies a page, navigation command or external URL to follow.

Attribute Values

Value	Description	Example
<Page ID>	The page ID.
<URL>	A url starting with "http://", "https://", "ftp://" or "www.".
back	Navigate backward in browsing history.
forward	Navigate forward in browsing history.
close	Closes the last opened popup.
close-all	Closes all open popups.
logout	Opens the logout popup.
adminclock	Opens the admin clock page, where the user can set the system time.
adminpwd	Opens the admin password page, where the user can change its puk or password.
adminusers	Opens the admin users page, where the user can manage users and groups.
<comma-separated list>	Consequently opens a list of links. Useful for example to open multiple modals in sequence, or to open a page and then a popup.	close-all,mymodal

This attribute is available when type is "button" and action is "link".

Link Target

Specifies where to open the linked URL. Available only for URL links.

Attribute Values

Value	Description
_self	Default value. Opens the linked URL in the same window or tab.
_blank	Opens the linked URL in a new window or tab.
<string>	Opens the linked URL in a named window or tab. Use this to open multiple links in the same window or tab.

This attribute is available when action is link and link is a valid URL or path.

When action is link and link is a valid URL or path, this attribute defaults to _self.

Camera

Camera

Specifies the displayed camera name.

Attribute Values

Value	Description
<string>	Camera name.

This attribute is available when type is "camera".

Target

Specifies a target camera that replicates the view of the current camera when clicked. The target is used only when the displayed camera does not support PTZ. This feature can be used on larger camera objects to magnify the image.

Attribute Values

Value	Description
<string>	Target camera object ID.

This attribute is available when type is "camera".

note

This attribute is static. Its value can't be changed dynamically with a uiSet command or with a value binding.

Shape

Corners

Specifies the number of corners.

Attribute Values

Value	Description
0	Circle.
3	Default value. Triangle.
4	Rectangle.
5	Pentagon.
6	Hexagon.
7	Heptagon.
8	Octagon.
9	Nonagon.
10	Decagon.
11	Hendecagon.
12	Dodecagon.

This attribute is available when type is "shape".

When type is "shape", this attribute defaults to 3.

Stretch

Specifies whether the shape is stretched to fill the object.

Attribute Values

Value	Description
false	Default value. Shape is not stretched.
true	Shape is stretched.

This attribute is available when type is "shape".

The default value is: false.

Corner Radius

Specifies the radius of the rectangle's corners are rounded.

Attribute Values

Value	Description	Example
0	Default value. Corners are not rounded.
int	Corner radius.	4

This attribute is available when type is "shape" and corners is "4".

When type is "shape" and corners is "4", this attribute defaults to 0.

Stroke Width

Specifies the stroke width.

Attribute Values

Value	Description
<string>	Stroke width in pixels.

This attribute is available when type is "shape".

When type is "shape", this attribute defaults to 1.

Stroke Dash

Specifies the pattern of dashes and gaps used to form the shape of the stroke.

The value is a list of comma and/or white space separated lengths or percentages. Each value specifies a length along the line for which the stroke is a dash or a gap.

Attribute Values

Value	Description	Example
<comma-separated list>	Dash pattern.	5,3

This attribute is available when type is "shape".

Stroke Color

Specifies the stroke color.

Attribute Values

Value	Description	Example
<html color>	Color in any html accepted format.	#ff0000

This attribute is available when type is "shape".

Fill Color

Specifies the fill color.

Attribute Values

Value	Description
<html color>	Any valid HTML color.

This attribute is available when type is "shape".

Rotation

Specifies the degrees by which the shape is rotated.

This attribute is available when type is "shape".

When type is "shape", this attribute defaults to 0.

Rotation Origin

Specifies the rotation origin.

Attribute Values

Value	Description
center	Default value. Center.
start	Start Point.
end	End Point.

This attribute is available when type is "shape".

The default value is: center.

Text

Text

Specifies the text.

This attribute is available when type is "text".

Scrollable

Controls the appearance of scrolling bars.

Attribute Values

Value	Description
false	Default value. No scrolling.
auto	Shows scrolling bars if content doesn't fit.
vertical	Shows the vertical scrolling bar.
horizontal	Shows the horizontal scrolling bar.
autovertical	Shows the vertical scrolling bar if the content doesn't fit.
autohorizontal	Shows the horizontal scrolling bar if the content doesn't fit.

This attribute is available when type is "text".

The default value is: false.

Overflow

Specifies the text's overflow behavior.

Attribute Values

Value	Description
auto	Default value. The text breaks automatically if a size is specified.
break-word	The text breaks automatically on whole words.
break-all	The text breaks automatically on any character.
ellipsis	The text won't break and will be truncated with an ellipsis.
no-wrap	The text won't automatically break.
hidden	The text won't break and the overflowing part will be hidden.

This attribute is available when type is "text".

The default value is: auto.

Template

Defines an HTML template. The text parameter is split with pipe character (|) and each part is inserted in the template, replacing the %1;, %2;, $3;, etc. placeholders.

Attribute Values

Value	Description	Example
<string>	HTML template.	<b>%1;</b> - %2;

This attribute is available when type is "text".

Format

Specifies the text's format.

Attribute Values

Value	Description	Example
<JSON object>	Format configuration object.	{"format":"datetime","datestyle":"medium","timestyle":"short"}

This attribute is available when type is "text".

Selectable

Makes the text selectable.

Attribute Values

Value	Description
false	Default value. False.
true	True.

This attribute is available when type is "text".

The default value is: false.

Auto Links

Detects urls, emails and phone numbers and displays them as hyperlinks. Phone numbers can be: E.164 format, [+]XXX XXX XXXX or [+]XXX-XXX-XXXX.

Attribute Values

Value	Description
false	Default value. Disabled.
true	Enabled.

This attribute is available when type is "text".

The default value is: false.

CSS Style

This attribute is available when type is "text".

note

This attribute has been deprecated since ver. 4.0

Font Family

Specifies the font family.

This attribute is available when type is "text".

Default behavior:

• When type is "text", this attribute defaults to default.
• When type is "image", this attribute defaults to default.

Font Size

Specifies the font size in pixels or percentage (relative to the project's font size).

Attribute Values

Value	Description	Example
<integer>	Font size in pixels.
<percentage>%	Relative font size in percentage.	90%

This attribute is available when type is "text".

Default behavior:

• When type is "text", this attribute defaults to 14.
• When type is "image", this attribute defaults to 14.

Font Color

Specifies the text CSS color.

Attribute Values

Value	Description	Example
<html color>	Color in any html accepted format.	#ff0000

This attribute is available when type is "text".

Font Weight

Specifies the weight of the font.

Attribute Values

Value	Description
normal	Default value. Normal.
bold	Bold.
bolder	Bolder.
lighter	Lighter.

This attribute is available when type is "text".

The default value is: normal.

Italic

Show the text in italics.

Attribute Values

Value	Description
false	Default value. Normal.
true	Italics.

This attribute is available when type is "text".

The default value is: false.

Small Caps

Sets the font to small caps.

Attribute Values

Value	Description
false	Default value. Normal.
true	Small caps.

This attribute is available when type is "text".

The default value is: false.

Decoration

Specifies the text decoration.

Attribute Values

Value	Description
none	Default value. No decoration.
underline	Underline.
overline	Overline.
line-through	Line through.

This attribute is available when type is "text".

The default value is: none.

Text Align

Sets the horizontal alignment of the text.

Attribute Values

Value	Description
none	Default value. No alignment.
left	Left alignment.
right	Right alignment.
center	Center alignment.
justify	Justified alignment.

This attribute is available when type is "text".

The default value is: none.

Line Height

Sets the line height of the text.

Attribute Values

Value	Description
<float>	Specify the line height as a multiple of the font size.

This attribute is available when type is "text".

Default behavior:

• When type is "text", this attribute defaults to 1.0.
• When type is "image", this attribute defaults to 1.0.

Vertical Align

Sets the vertical alignment of the text.

Attribute Values

Value	Description
top	Default value. Aligns the text to the top.
middle	Aligns the text to the middle.
bottom	Aligns the text to the bottom.

This attribute is available when type is "text".

The default value is: top.

Padding

Specifies the text's padding.

Attribute Values

Value	Description	Example
<int>	Padding in pixels.	10
<integer list>	A list of integer values, separated by comma or space, that specify the sides' pixel padding in the following order: top, right, bottom, left.	10 20 10 20

This attribute is available when type is "text".

Panel

Shows a panel that frames the object. Its style can be modified.

Attribute Values

Value	Description
true	Shows the panel.
false	Default value. Hides the panel.

This attribute is available when type is "text".

When type is "text", this attribute defaults to false.

Panel Color

Specifies the panel color.

Attribute Values

Value	Description
default	Default value. Default color.
primary	Primary color, used to highlight important areas.
warning	Warning color, used to highlight warning areas.
success	Success color, used to highlight success areas.
error	Error color, used to highlight error areas.
red,blue,yellow,green,yellow,purple,orange,green	Palette colors.
custom	Custom color, defined in the "Custom Color" attribute.

This attribute is available when type is "text".

The default value is: default.

Panel Custom Color

Specifies the panel custom color.

Attribute Values

Value	Description	Example
<html color>	Color in any html accepted format.	#ff0000

This attribute is available when type is "text".

Image

Image

Specifies the relative path of the image file to show.

Attribute Values

Value	Description
<image>	Relative path to the image file.

This attribute is available when type is "image".

Fit

Specifies how the image should be resized to fit its container.

Attribute Values

Value	Description
fill	The image is resized to fill the given dimension.
contain	Default value. The image keeps its aspect ratio, but is resized to fit within the given dimension.
cover	The image keeps its aspect ratio and fills the given dimension.
none	The image is not resized.
scale-down	The image is scaled down to the smallest version of none or contain.

This attribute is available when type is "image" and image is neither "", "icon:%", nor "loader:%".

When type is "image" and image is neither "", "icon:%", nor "loader:%", this attribute defaults to contain.

Icon Color

Specifies the icon color.

This attribute is available when type is "image" and image is one of "icon:%" or "%.svg".

Label

Specifies a label.

Attribute Values

Value	Description
<string>	Label.

This attribute is available when type is "image".

Font Family

Specifies the font family.

This attribute is available when type is "image".

Default behavior:

• When type is "text", this attribute defaults to default.
• When type is "image", this attribute defaults to default.

Font Size

Specifies the font size in pixels or percentage (relative to the project's font size).

Attribute Values

Value	Description	Example
<integer>	Font size in pixels.
<percentage>%	Relative font size in percentage.	90%

This attribute is available when type is "image".

Default behavior:

• When type is "text", this attribute defaults to 14.
• When type is "image", this attribute defaults to 14.

Font Color

Specifies the text CSS color.

Attribute Values

Value	Description	Example
<html color>	Color in any html accepted format.	#ff0000

This attribute is available when type is "image".

Font Weight

Specifies the weight of the font.

Attribute Values

Value	Description
normal	Default value. Normal.
bold	Bold.
bolder	Bolder.
lighter	Lighter.

This attribute is available when type is "image".

The default value is: normal.

Italic

Show the text in italics.

Attribute Values

Value	Description
false	Default value. Normal.
true	Italics.

This attribute is available when type is "image".

The default value is: false.

Small Caps

Sets the font to small caps.

Attribute Values

Value	Description
false	Default value. Normal.
true	Small caps.

This attribute is available when type is "image".

The default value is: false.

Decoration

Specifies the text decoration.

Attribute Values

Value	Description
none	Default value. No decoration.
underline	Underline.
overline	Overline.
line-through	Line through.

This attribute is available when type is "image".

The default value is: none.

Text Align

Sets the horizontal alignment of the text.

Attribute Values

Value	Description
none	Default value. No alignment.
left	Left alignment.
right	Right alignment.
center	Center alignment.
justify	Justified alignment.

This attribute is available when type is "image".

The default value is: none.

Line Height

Sets the line height of the text.

Attribute Values

Value	Description
<float>	Specify the line height as a multiple of the font size.

This attribute is available when type is "image".

Default behavior:

• When type is "text", this attribute defaults to 1.0.
• When type is "image", this attribute defaults to 1.0.

Label CSS

This attribute is available when type is "image".

note

This attribute has been deprecated since ver. 4.0

Tooltip

Specifies a tooltip text that appears on mouseover.

Attribute Values

Value	Description
<string>	Tooltip text.

This attribute is available when type is "image".