diff --git a/bundles/org.openhab.ui/doc/components/index.md b/bundles/org.openhab.ui/doc/components/index.md index da45efbb4..cafc45677 100644 --- a/bundles/org.openhab.ui/doc/components/index.md +++ b/bundles/org.openhab.ui/doc/components/index.md @@ -131,6 +131,7 @@ Refer to the [`oh-card` Style](./oh-card.html#style) documentation to learn abou | [`oh-calendar-axis`](./oh-calendar-axis.html) | [Calendar](./oh-calendar-axis.html) | | | [`oh-data-series`](./oh-data-series.html) | [Data Series](./oh-data-series.html) | | | [`oh-time-series`](./oh-time-series.html) | [Time Series](./oh-time-series.html) | | +| [`oh-state-series`](./oh-state-series.html) | [State Series](./oh-state-series.html) | | | [`oh-aggregate-series`](./oh-aggregate-series.html) | [Aggregate Series](./oh-aggregate-series.html) | | | [`oh-calendar-series`](./oh-calendar-series.html) | [Calendar Series](./oh-calendar-series.html) | | | [`oh-chart-tooltip`](./oh-chart-tooltip.html) | [Tooltip](./oh-chart-tooltip.html) | | diff --git a/bundles/org.openhab.ui/doc/components/oh-canvas-layout.md b/bundles/org.openhab.ui/doc/components/oh-canvas-layout.md index 048e63ca3..9447573bc 100644 --- a/bundles/org.openhab.ui/doc/components/oh-canvas-layout.md +++ b/bundles/org.openhab.ui/doc/components/oh-canvas-layout.md @@ -67,6 +67,22 @@ Position widgets on a canvas layout with arbitrary position and size down to pix +### SVG Embedding +
+ + + + Embed SVG image directly into the page (default false) + + + + + Flashes SVG elements on hovering in run-mode as well (default false) + + + +
+ ### Appearance
diff --git a/bundles/org.openhab.ui/doc/components/oh-category-axis.md b/bundles/org.openhab.ui/doc/components/oh-category-axis.md index 5bf6f2a0b..505ec9abb 100644 --- a/bundles/org.openhab.ui/doc/components/oh-category-axis.md +++ b/bundles/org.openhab.ui/doc/components/oh-category-axis.md @@ -43,6 +43,7 @@ prev: /docs/ui/components/ + @@ -69,6 +70,11 @@ prev: /docs/ui/components/ + + + Category values to display + +
diff --git a/bundles/org.openhab.ui/doc/components/oh-state-series.md b/bundles/org.openhab.ui/doc/components/oh-state-series.md new file mode 100644 index 000000000..425bcb8e3 --- /dev/null +++ b/bundles/org.openhab.ui/doc/components/oh-state-series.md @@ -0,0 +1,336 @@ +--- +title: oh-state-series - State Series +component: oh-state-series +label: State Series +description: Reference documentation for the oh-state-series component +source: https://github.com/openhab/openhab-webui/edit/main/bundles/org.openhab.ui/doc/components/oh-state-series.md +prev: /docs/ui/components/ +--- + +# oh-state-series - State Series + + + +[[toc]] + + + + + + + +## Configuration + + + +### General +
+ + + + A name which will appear on tooltips and labels + + + + + The item whose persisted data to display + + + + + The identifier of the persistence service to retrieve the data from. Leave blank to the use the default. + + + + + Do not get one value before and after the requested period and move them to the start and end of the period + + + + + Do not add the current Item state into the requested period (the item state will be before or at the end time) + + + + + Offset to subtract from the displayed period, use if you want to do period comparisons (see also Offset Unit). + + + + + Offset to subtract from the displayed period, use if you want to do period comparisons (see also Offset Amount). + + + + + + + + + + + + + The position the state timeline should appear on the Y axis (in graph coordinates). If Y axis is a category axis, this should be the index of the category + + + + + The height the state timeline bar in graph coordinates (default is 0.6) + + + +
+ +### Axis and Coordinate System Assignments +
+ + + + The index of the X axis for this series + + + + + The index of the Y axis for this series + + + +
+ +### Action +
+ + Action to perform when the element 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. + + + +
+ + + + + + + + + + +