openHAB

This page is part of archived documentation for openHAB 4.0. Go to the current stable version

# oh-aggregate-series - Aggregate Series

# Configuration

# General

# name Name TEXT

A name which will appear on tooltips and labels

# item Item TEXT item

The item whose persisted data to display

# service Persistence Service TEXT persistenceService

The identifier of the persistence service to retrieve the data from. Leave blank to the use the default.

# offsetAmount Offset Amount INTEGER

Offset to subtract from the displayed period, use if you want to do period comparisons (see also Offset Unit).

# offsetUnit Offset Unit STRING offsetUnit

Offset to subtract from the displayed period, use if you want to do period comparisons (see also Offset Amount).

Options:
hour
Hour
minute
Minute
day
Day
week
Week
month
Month
year
Year

# type Type TEXT

The type of the series.
Note: heatmap needs a configured visual map and is not supported for time series

Options:
line
Line
bar
Bar
heatmap
Heatmap
scatter
Scatter

# dimension1 First Dimension TEXT

The largest data point cluster size.
It should be consistent with the chart type, and match the type of a category axis where this series will appear.

Options:
minute
Minute of Hour
hour
Hour of Day
isoWeekday
Day of Week (starting on Monday)
weekday
Day of Week (starting on Sunday)
date
Day of Month
month
Month of Year

# dimension2 Second Dimension TEXT

The smallest data point cluster size.
Set only when you have 2 category axes (for instance day of the week and hour of the day), and make sure to match the type of the 2nd axis.

Options:
minute
Minute of Hour
hour
Hour of Day
isoWeekday
Day of Week (starting on Monday)
weekday
Day of Week (starting on Sunday)
date
Day of Month
month
Month of Year

# transpose Transpose BOOLEAN

Enable when the first dimension should be mapped to the Y axis instead of the X axis

# aggregationFunction Aggregation Function TEXT

How to reduce the data points in a same aggregation cluster to a single value. If not specified, the average function will be used.

Options:
average
Average
sum
Sum
min
Minimum
max
Maximum
first
First (earliest)
last
Last (latest)
diff_first
Difference of firsts
diff_last
Difference of lasts

# Axis and Coordinate System Assignments

# xAxisIndex X Axis Index INTEGER xAxis

The index of the X axis for this series

# yAxisIndex Y Axis Index INTEGER yAxis

The index of the Y axis for this series

# Action

Action to perform when the element 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.

Caught a mistake or want to contribute to the documentation? Edit this page on GitHub (opens new window)

←