# 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.
# noBoundary Don't Include Boundary BOOLEAN
Do not get one value before and after the requested period and move them to the start and end of the period
# noItemState Don't Include Item State BOOLEAN
Do not add the current Item state into the requested period (the item state will be before or at the end time)
# displayState Use Display State BOOLEAN
If set to true, formatting from the state description is applied to the values. For QuantityType states, the unit from the state description is respected, but no formatting is applied.
# 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 TEXT offsetUnit
Offset to subtract from the displayed period, use if you want to do period comparisons (see also Offset Amount).
Options:
# type Type TEXT
The type of the series.
Note: heatmap needs a configured visual map or uses the default and is not supported for time series!
Options:
# color Color TEXT color
The color of the series
# showSymbol Show Symbol BOOLEAN
Whether to always show the datapoint symbol. It will always be shown during tooltip hover.
# barBorderRadius Bar Border Radius INTEGER
The radius of the border of the bar.
# 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:
# 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:
# 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:
# Axis and Coordinate System Assignments
# Action
# actionUrl Action URL TEXT url
URL to navigate to or to send HTTP request 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.
# actionHttpBody HTTP Body TEXT
Body to send with the request
# actionItem Action Item TEXT item
Item to perform the action on
# actionCommand Action Command TEXT
Command to send to the Item. If "Toggle 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
# actionPageDefineVars Define Page Variables TEXT
An object { [variableName]: [variableValue] } where variableValue also supports expressions
# 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[ "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:
# actionAnalyzerCoordSystem Initial Coordinate System TEXT
The initial coordinate system of the analyzer - time, aggregate or calendar (only time is supported for dynamic periods)
Options:
# actionAnalyzerAggregation Initial Aggregation TEXT
The initial aggregation of the analyzer -
Options:
# actionConfirmation Action Confirmation TEXT
Shows a dialog or sheet to ask for confirmation before the action is executed. Can either be a text to show in the dialog or a JSON object { type: "dialog", title: "Confirm", text: "Are you sure?" } or { type: "sheet", text: "Confirm", color: "green" }
# 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.