openhab-webui/bundles/org.openhab.ui/doc/components/oh-gauge-card.md

14 KiB

title component label description source prev
oh-gauge-card - Gauge Card oh-gauge-card Gauge Card Display a read-only gauge in a card to visualize a quantifiable item https://github.com/openhab/openhab-webui/edit/main/bundles/org.openhab.ui/doc/components/oh-gauge-card.md /docs/ui/components/

oh-gauge-card - Gauge Card

toc

Display a read-only gauge in a card to visualize a quantifiable item

Configuration

Card

Parameters of the card Title of the card Footer of the card Do not render the card border Do not render a shadow effect to the card Show the card outline

Gauge

Parameters are passed to the underlying gauge Item to control Minimum value (default 0) Maximum value (default 100) Type of the gauge Value, if the item is not set - between min & max (for instance, defined with an expression) Visual size of the control in px (default 200) Gauge background color. Can be any valid color string, e.g. #ff00ff, rgb(0,0,255), etc. Main border/stroke background color Main border/stroke color Main border/stroke width Value text, if the item is not set (for instance, defined with an expression) Value text color Value text font size Value text font weight Label text, displayed below the value (optional) Label text color Label text font size Label text font weight

Action

Action to perform when the gauge is clicked Type of action to perform URL to navigate to or to send HTTP request to Open the URL in the same tab/window instead of a new one. This will exit the app. HTTP method to use for the request Body to send with the request Item to perform the action on Command to send to the Item. If "Toogle 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. Scene, Script or Rule to run Object representing the optional context to pass. Edit in YAML or provide a JSON object, e.g. { "param1": "value1", "param2": { "subkey1": "testing", "subkey2": 123 } }. 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, 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. 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 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" } 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 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.