openHAB

# oh-plan-marker - Floor Plan Marker

A marker on a floor plan

# Configuration

# Marker Settings

# name Name TEXT

The name of the marker (for identification)

# coords Coordinates TEXT

The coordinates of this marker in the floor plan Coordinate Reference System; usually set by dragging the marker at design time

# item Item TEXT item

The item whose state to display on this marker

# visible Visibility TEXT

Enter an expression to dynamically show the marker, see Building Pages: visible

# Icon

You can customize the styles further with CSS attributes in the iconStyle parameter (in YAML only)

# icon Icon TEXT

Use oh:iconName (openHAB icon), f7:iconName (Framework7 icon), material:iconName (Material icon) or iconify:iconSet:iconName (Iconify icon, requires being online if not in cache)

# iconUseState Icon depends on state BOOLEAN

Use the state of the Item to get a dynamic icon (enabled by default for Contact, Dimmer, Rollershutter & Switch Item types) (for openHAB icons only)

# iconSize Icon Size INTEGER

Size of the icon in pixels (40 by default)

# iconWidth Icon Width INTEGER

Width of the icon in pixels (for openHAB icons only, 40 by default)

# iconHeight Icon Height INTEGER

Height of the icon in pixels (for openHAB icons only, 40 by default)

# iconColor Icon Color TEXT

Color of the icon (for Framework7/Material/certain Iconify icons); use expression for dynamic colors

# iconRotation Icon Rotation INTEGER

Rotation of the icon in degrees

# Tooltip

You can customize the styles further with CSS attributes in the tooltipStyle parameter (in YAML only)

# tooltip Tooltip Text TEXT

The tooltip text - leave blank to display the state of the item

# tooltipPermanent Always display the tooltip BOOLEAN

# useTooltipAsLabel Use Tooltip as Label BOOLEAN

Put the tooltip text directly over the plan instead of displaying an icon

# tooltipFontSize Tooltip Font Size TEXT

Font size of the tooltip text

# tooltipColor Tooltip color TEXT

Color of the tooltip

# tooltipDirection Tooltip Direction TEXT

The direction of the tooltip

Options:
top
Top
bottom
Bottom
left
Left
right
Right
center
Center
auto
Auto

# tooltipOffsetX Tooltip Offset X INTEGER

The X offset of the tooltip from the marker in pixels

# tooltipOffsetY Tooltip Offset Y INTEGER

The Y offset of the tooltip from the marker in pixels

# tooltipOpacity Tooltip Opacity DECIMAL

The opacity of the tooltip (0-1)

# Zoom Visibility

Hide this marker outside certain zoom labels

# zoomVisibilityMin Zoom Visibility Minimum INTEGER

Visible only when zoomed to above this level (no limit if empty)

# zoomVisibilityMax Zoom Visibility Maximum INTEGER

Visible only when zoomed to below this level (no limit if empty)

# Action

Action to perform when the marker is clicked

# action Action TEXT

Type of action to perform

Options:
navigate
Navigate to page
command
Send command
toggle
Toggle Item
options
Command options
rule
Run scene, script or rule
popup
Open popup
popover
Open popover
sheet
Open sheet
photos
Open photo browser
group
Group details
analyzer
Analyze item(s)
url
External URL
variable
Set Variable

# actionUrl Action URL TEXT url

URL to navigate to

# actionUrlSameWindow Open in same tab/window BOOLEAN

Open the URL in the same tab/window instead of a new one. This will exit the app.

# actionItem Action Item TEXT item

Item to perform the action on

# actionCommand Action Command TEXT

Command to send to the Item. If "Toogle Item" is selected as the action, only send the command when the state is different

# actionCommandAlt Action Toggle Command TEXT

Command to send to the Item when "Toggle Item" is selected as the action, and the Item's state is equal to the command above

# actionOptions Command Options TEXT

Comma-separated list of options; if omitted, retrieve the command options from the Item dynamically. Use value=label format to provide a label different than the option.

# actionRule Scene, Script or Rule TEXT rule

Scene, Script or Rule to run

# actionRuleContext Context TEXT script

Object representing the optional context to pass. Edit in YAML or provide a JSON object, e.g. { "param1": "value1", "param2": { "subkey1": "testing", "subkey2": 123 } }.

# actionPage Page TEXT page

Page to navigate to

# actionPageTransition Transition Effect TEXT

Use a specific page transition animation

Options:
f7-circle
Circle
f7-cover
Cover
f7-cover-v
Cover from bottom
f7-dive
Dive
f7-fade
Fade
f7-flip
Flip
f7-parallax
Parallax
f7-push
Push

# actionModal Modal Page or Widget TEXT pagewidget

Page or widget to display in the modal

# actionModalConfig Modal component configuration TEXT props

Configuration (prop values) for the target modal page or widget

# actionPhotos Images to show TEXT

Array of URLs or objects representing the images. Auto-refresh is not supported.
Edit in YAML, e.g.

- item: ImageItem1
  caption: Camera
or provide a JSON array, e.g.
[ "url1", { "item": "ImageItem1", "caption": "Camera" } ]
Objects are in the photos array format with an additional item property to specify an item to view.

# actionPhotoBrowserConfig Photo browser configuration TEXT

Configuration for the photo browser.
Edit in YAML or provide a JSON object, e.g.
{ "exposition": false, "type": "popup", "theme": "dark" }
See photo browser parameters (not all are supported).

# actionGroupPopupItem Group Popup Item TEXT item

Group Item whose members to show in a popup

# actionAnalyzerItems Item(s) to Analyze* TEXT item

Start analyzing with the specified (set of) Item(s)

# actionAnalyzerChartType Chart Type TEXT

The initial analyzing period - dynamic or a predefined fixed period: day, week, month or year

Options:
(empty)
Dynamic
day
Day
isoWeek
Week (starting on Mondays)
month
Month
year
Year

# actionAnalyzerCoordSystem Initial Coordinate System TEXT

The initial coordinate system of the analyzer - time, aggregate or calendar (only time is supported for dynamic periods)

Options:
time
Time
aggregate
Aggregate
calendar
Calendar

# actionFeedback Action feedback TEXT

Shows a toast popup when the action has been executed. Can either be a text to show or a JSON object including some of the supported parameters

# actionVariable Variable TEXT

The variable name to set

# actionVariableValue Variable Value TEXT

The value to set the variable to

# actionVariableKey Variable Key TEXT

Consider the variable value is an object and set the corresponding deep property within that object using a key syntax. Examples: user.name, user[0].address[1].street, [0], [0].label. The inner property and its parent hierarchy will be created if missing.

# Examples

note that you must not have semicolons at the end of the css style

# iconStyle:

iconStyle:
  padding: 10px
  border-radius: 4px
  border: 5px solid #f00

# tooltipStyle:

tooltipStyle:
  textShadow: 0 0 15px red
  fontSize: 40px
  color: yellow
Caught a mistake or want to contribute to the documentation? Edit this page on GitHub (opens new window)

←