openhab · ghys · Feb 5, 2021 · Jan 29, 2021 · Jan 29, 2021 · Jan 30, 2021
@@ -0,0 +1,135 @@
+# Component Reference
+
+## System Widget Library
+
+| Component | Name | Description |
+|--------|------|-------------|
+| [`oh-button`](./oh-button.html) | Button | Button performing an action |
+| [`oh-chart`](./oh-chart.html) | Chart | Visualize series of data |
+| [`oh-colorpicker`](./oh-colorpicker.html) | Colorpicker | Control to pick a color |
+| [`oh-gauge`](./oh-gauge.html) | Gauge | Circular or semi-circular read-only gauge |
+| [`oh-icon`](./oh-icon.html) | Icon | Display an openHAB icon |
+| [`oh-image`](./oh-image.html) | Image | Displays an image from a URL or an item |
+| [`oh-input`](./oh-input.html) | Input | Displays an input field, used to set a variable |
+| [`oh-knob`](./oh-knob.html) | Knob | Knob control, allow to change a number value on a circular track |
+| [`oh-link`](./oh-link.html) | Link | Link performing an action |
+| [`oh-list`](./oh-list.html) | List | List control, hosts list items |
+| [`oh-player`](./oh-player.html) | Media player | Media player controls, with previous track/pause/play/next buttons |
+| [`oh-repeater`](./oh-repeater.html) | Repeater | Iterate over an array and repeat the children components in the default slot |
+| [`oh-rollershutter`](./oh-rollershutter.html) | Rollershutter | Rollershutter control, with up/down/stop buttons |
+| [`oh-slider`](./oh-slider.html) | Slider | Slider control, allows to pick a number value on a scale |
+| [`oh-stepper`](./oh-stepper.html) | Stepper | Stepper control, allows to input a number or decrement/increment it using buttons |
+| [`oh-swiper`](./oh-swiper.html) | Swiper | Swiper control, allows to display multiple swipeable slides |
+| [`oh-toggle`](./oh-toggle.html) | Toggle | Toggle control, allows to switch on or off |
+| [`oh-trend`](./oh-trend.html) | Trend line | Trend line to display the overall recent evoluation of an item |
+| [`oh-video`](./oh-video.html) | Video | Displays a video player from a URL or an item |
+| [`oh-webframe`](./oh-webframe.html) | Web frame | Displays a web page in a frame |
+
+
+## Standard Widget Library (Standalone Cards)
+
+| Component | Name | Description |
+|--------|------|-------------|
+| [`oh-clock-card`](./oh-clock-card.html) | Digital Clock Card | Display a digital clock in a card |
+| [`oh-colorpicker-card`](./oh-colorpicker-card.html) | Color Picker Card | Display a color picker in a card |
+| [`oh-gauge-card`](./oh-gauge-card.html) | Gauge Card | Display a read-only gauge in a card to visualize a quantifiable item |
+| [`oh-image-card`](./oh-image-card.html) | Image Card | Display an image (URL or Image item ) in a card |
+| [`oh-input-card`](./oh-input-card.html) | Input Card | Display an input in a card |
+| [`oh-knob-card`](./oh-knob-card.html) | Knob Card | Display a knob in a card to visualize and control a quantifiable item |
+| [`oh-label-card`](./oh-label-card.html) | Label Card | Display the state of an item in a card |
+| [`oh-list-card`](./oh-list-card.html) | List Card | Display a list in a card |
+| [`oh-player-card`](./oh-player-card.html) | Player Card | Display player controls in a card |
+| [`oh-rollershutter-card`](./oh-rollershutter-card.html) | Rollershutter Card | Display rollershutter controls in a card |
+| [`oh-slider-card`](./oh-slider-card.html) | Slider Card | Display a slider in a card to control an item |
+| [`oh-stepper-card`](./oh-stepper-card.html) | Stepper Card | Display a stepper in a card to control an item |
+| [`oh-swiper-card`](./oh-swiper-card.html) | Swiper Card | Display a swiper allowing to browse slides, in a card |
+| [`oh-toggle-card`](./oh-toggle-card.html) | Toggle Card | Display a toggle swtich in a card to send ON/OFF commands |
+| [`oh-video-card`](./oh-video-card.html) | Video Card | Display a video (URL or URL from String item) in a card |
+| [`oh-webframe-card`](./oh-webframe-card.html) | Web Frame Card | Display a web page in a card |
+
+
+## Standard Widget Library (List Items)
+
+| Component | Name | Description |
+|--------|------|-------------|
+| [`oh-colorpicker-item`](./oh-colorpicker-item.html) | Color Picker List Item | Display a color picker in a list |
+| [`oh-input-item`](./oh-input-item.html) | Input List Item | Display an input field in a list |
+| [`oh-label-item`](./oh-label-item.html) | Label List Item | Display the state of an item in a list |
+| [`oh-list-item`](./oh-list-item.html) | List Item | A list item |
+| [`oh-player-item`](./oh-player-item.html) | Player List Item | Display player controls in a list |
+| [`oh-rollershutter-item`](./oh-rollershutter-item.html) | Rollershutter List Item | Display rollershutter controls in a list |
+| [`oh-slider-item`](./oh-slider-item.html) | Slider List Item | Display a slider control in a list |
+| [`oh-stepper-item`](./oh-stepper-item.html) | Stepper List Item | Display a stepper control in a list |
+| [`oh-toggle-item`](./oh-toggle-item.html) | Toggle List Item | Display a toggle switch in a list |
+
+
+## Standard Widget Library (Cells)
+
+| Component | Name | Description |
+|--------|------|-------------|
+| [`oh-cell`](./oh-cell.html) | Cell | A regular or expandable cell |
+| [`oh-colorpicker-cell`](./oh-colorpicker-cell.html) | Colorpicker Cell | A cell expanding to a color picker |
+| [`oh-knob-cell`](./oh-knob-cell.html) | Knob Cell | A cell expanding to a knob control |
+| [`oh-label-cell`](./oh-label-cell.html) | Label Cell | A cell with a big label to show a short item state value |
+| [`oh-rollershutter-cell`](./oh-rollershutter-cell.html) | Rollershutter Cell | A cell expanding to rollershutter controls |
+| [`oh-slider-cell`](./oh-slider-cell.html) | Slider Cell | A cell expanding to a big vertical slider |
+
+
+## Layout Components
+
+| Component | Name | Description |
+|--------|------|-------------|
+| [`oh-block`](./oh-block.html) | Layout Grid Block | A block in a grid layout |
+| [`oh-grid-col`](./oh-grid-col.html) | Layout Grid Column | A column in a grid layout |
+| [`oh-grid-row`](./oh-grid-row.html) | Layout Grid Row | A row in a grid layout |
+| [`oh-masonry`](./oh-masonry.html) | Masonry Layout | Arranges widgets automatically depending on the screen size |
+
+
+## Map Page & Markers
+
+| Component | Name | Description |
+|--------|------|-------------|
+| [`oh-map-circle-marker`](./oh-map-circle-marker.html) | Circle Marker | A circle on a map, to represent a radius |
+| [`oh-map-marker`](./oh-map-marker.html) | Map Marker | An icon on a map |
+| [`oh-map-page`](./oh-map-page.html) | Map page | Displays markers on a map |
+
+
+## Floorplan Page & Markers
+
+| Component | Name | Description |
+|--------|------|-------------|
+| [`oh-plan-marker`](./oh-plan-marker.html) | Floor Plan Marker | A marker on a floor plan |
+| [`oh-plan-page`](./oh-plan-page.html) | Floor plan | Displays markers on an image overlay |
+
+
+## Chart Page & Components
+
+| Component | Name | Description |
+|--------|------|-------------|
+| [`oh-chart-page`](./oh-chart-page.html) | Chart Page | Visualize historical series |
+| [`oh-chart-grid`](./oh-chart-grid.html) | Cartesian Grid |  |
+| [`oh-category-axis`](./oh-category-axis.html) | Category Axis |  |
+| [`oh-value-axis`](./oh-value-axis.html) | Value Axis |  |
+| [`oh-time-axis`](./oh-time-axis.html) | Time Axis |  |
+| [`oh-calendar-axis`](./oh-calendar-axis.html) | Calendar |  |
+| [`oh-data-series`](./oh-data-series.html) | Data Series |  |
+| [`oh-time-series`](./oh-time-series.html) | Time Series |  |
+| [`oh-aggregate-series`](./oh-aggregate-series.html) | Aggregate Series |  |
+| [`oh-calendar-series`](./oh-calendar-series.html) | Calendar Series |  |
+| [`oh-chart-tooltip`](./oh-chart-tooltip.html) | Tooltip |  |
+| [`oh-chart-visualmap`](./oh-chart-visualmap.html) | Visual Map |  |
+| [`oh-chart-datazoom`](./oh-chart-datazoom.html) | Data Zoom |  |
+| [`oh-chart-legend`](./oh-chart-legend.html) | Legend |  |
+| [`oh-chart-title`](./oh-chart-title.html) | Title |  |
+| [`oh-chart-toolbox`](./oh-chart-toolbox.html) | Toolbox |  |
+
+
+## Home Page Cards
+
+| Component | Name | Description |
+|--------|------|-------------|
+| [`oh-location-card`](./oh-location-card.html) | Location Card | A card showing model items in a certain location |
+| [`oh-equipment-card`](./oh-equipment-card.html) | Equipment Class Card | A card showing model items belonging to a certain equipment class |
+| [`oh-property-card`](./oh-property-card.html) | Property Card | A card showing model items related to a certain property |
+
+
@@ -0,0 +1,112 @@
+# oh-aggregate-series - Aggregate Series
+
+<!-- GENERATED componentDescription -->
+
+<!-- GENERATED /componentDescription -->
+
+## Configuration
+
+<!-- GENERATED props -->
+
+- `name` <small>TEXT</small> _Name_
+
+  A name which will appear on tooltips and labels
+
+- `item` <small>TEXT</small> _Item_
+
+  The item whose persisted data to display
+
+- `service` <small>TEXT</small> _Persistence Service_
+
+  The identifier of the persistence service to retrieve the data from. Leave blank to the use the default.
+
+- `offsetAmount` <small>INTEGER</small> _Offset Amount_
+
+  Offset to <em>subtract</em> from the displayed period, use if you want to do period comparisons (see also Offset Unit).
+
+- `offsetUnit` <small>STRING</small> _Offset Unit_
+
+  Offset to <em>subtract</em> from the displayed period, use if you want to do period comparisons (see also Offset Amount).
+
+  | Option | Label |
+  |--------|-------|
+  | `hour` | Hour |
+  | `minute` | Minute |
+  | `day` | Day |
+  | `week` | Week |
+  | `month` | Month |
+  | `year` | Year |
+
+
+- `type` <small>TEXT</small> _Type_
+
+  The type of the series.<br/><em>Note: heatmap needs a configured visual map and is not supported for time series</em>
+
+  | Option | Label |
+  |--------|-------|
+  | `line` | Line |
+  | `bar` | Bar |
+  | `heatmap` | Heatmap |
+  | `scatter` | Scatter |
+
+
+- `dimension1` <small>TEXT</small> _First Dimension_
+
+  The largest data point cluster size.<br />It should be consistent with the chart type, and match the type of a category axis where this series will appear.
+
+  | Option | Label |
+  |--------|-------|
+  | `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` <small>TEXT</small> _Second Dimension_
+
+  The smallest data point cluster size.<br />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.
+
+  | Option | Label |
+  |--------|-------|
+  | `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` <small>BOOLEAN</small> _Transpose_
+
+  Enable when the first dimension should be mapped to the Y axis instead of the X axis
+
+- `aggregationFunction` <small>TEXT</small> _Aggregation Function_
+
+  How to reduce the data points in a same aggregation cluster to a single value. If not specified, the average function will be used.
+
+  | Option | Label |
+  |--------|-------|
+  | `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` <small>INTEGER</small> _X Axis Index_
+
+  The index of the X axis for this series
+
+- `yAxisIndex` <small>INTEGER</small> _Y Axis Index_
+
+  The index of the Y axis for this series
+
+<!-- GENERATED /props -->
@@ -0,0 +1,15 @@
+# oh-block - Layout Grid Block
+
+<!-- GENERATED componentDescription -->
+A block in a grid layout
+<!-- GENERATED /componentDescription -->
+
+## Configuration
+
+<!-- GENERATED props -->
+
+- `title` <small>TEXT</small> _Title_
+
+  Title of the block, displayed above it
+
+<!-- GENERATED /props -->