From 3e069577e13bd0f4cf29fdcc7deaedaec7b7808f Mon Sep 17 00:00:00 2001 From: TheGreyDiamond Date: Wed, 13 Oct 2021 00:08:34 +0200 Subject: [PATCH] Adds things as outlined in the PR's comments --- .../doc/components/oh-gauge-card.md | 148 ++++++++++++++++++ .../definitions/widgets/standard/cards.js | 1 + 2 files changed, 149 insertions(+) diff --git a/bundles/org.openhab.ui/doc/components/oh-gauge-card.md b/bundles/org.openhab.ui/doc/components/oh-gauge-card.md index d1531a6434..da105afbc9 100644 --- a/bundles/org.openhab.ui/doc/components/oh-gauge-card.md +++ b/bundles/org.openhab.ui/doc/components/oh-gauge-card.md @@ -158,6 +158,154 @@ Display a read-only gauge in a card to visualize a quantifiable item +### Action +
+ + Action to perform when the element is clicked + + + Type of action to perform + + + + + + + + + + + + + + + + + + + + URL to navigate to + + + + + Open the URL in the same tab/window instead of a new one. This will exit the app. + + + + + Item to perform the action on + + + + + Command to send to the item. If "toggle item" is selected as the action, only send the command when the state is different + + + + + 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 + + + + + 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. + + + + + Rule to run + + + + + Page to navigate to + + + + + Use a specific page transition animation + + + + + + + + + + + + + + + Page or widget to display in the modal + + + + + Configuration (prop values) for the target modal page or widget + + + + + Array of URLs or objects representing the images. Auto-refresh is not supported.
Edit in YAML 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. + + + + + 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). + + + + + Group item whose members to show in a popup + + + + + Start analyzing with the specified (set of) item(s) + + + + + The initial analyzing period - dynamic or a predefined fixed period: day, week, month or year + + + + + + + + + + + + The initial coordinate system of the analyzer - time, aggregate or calendar (only time is supported for dynamic periods) + + + + + + + + + + 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 + + + + + The variable name to set + + + + + The value to set the variable to + + + +
diff --git a/bundles/org.openhab.ui/web/src/assets/definitions/widgets/standard/cards.js b/bundles/org.openhab.ui/web/src/assets/definitions/widgets/standard/cards.js index 6611286cb0..ce227f12bd 100644 --- a/bundles/org.openhab.ui/web/src/assets/definitions/widgets/standard/cards.js +++ b/bundles/org.openhab.ui/web/src/assets/definitions/widgets/standard/cards.js @@ -80,6 +80,7 @@ import GaugeParameters from '../system/gauge.js' export const OhGaugeCardDefinition = () => new WidgetDefinition('oh-gauge-card', 'Gauge Card', 'Display a read-only gauge in a card to visualize a quantifiable item') .paramGroup(CardParameterGroup(), CardParameters()) .paramGroup(pg('gauge', 'Gauge', 'Parameters are passed to the underlying Gauge control'), GaugeParameters()) + .paramGroup(actionGroup(null, 'Action to perform when the gauge is clicked'), actionParams()) // OhKnobCard import KnobParameters from '../system/knob.js'