Skip to content

Commit

Permalink
chore(release): 2.0.0 [skip ci]
Browse files Browse the repository at this point in the history
## [2.0.0](v1.10.0...v2.0.0) (2022-04-23)

### ⚠ BREAKING CHANGES

* `extend_to_end` has been removed and replaced by `extend_to` with support for `now` and `end`.

### Features

* `extend_to` replaces `extend_to_end` with new options ([4bb1dd2](4bb1dd2)), closes [#318](#318)
* add state type to long term statistics ([#329](#329)) ([3fad4f0](3fad4f0))
* Apply a `time_delta` to all the datapoints of your serie ([435e381](435e381)), closes [#277](#277)
* display only the min or max extrema ([3db982b](3db982b)), closes [#319](#319)
* follow Home Assistant number format ([9204de2](9204de2)), closes [#307](#307)
* support actions on the title with `title_actions` ([a9f406e](a9f406e)), closes [#323](#323)
* Support for HA long-term statistics ([#208](#208)) ([29aaa7c](29aaa7c)), closes [#308](#308)

### Bug Fixes

* `last_updated` date format was not following the configuration ([3dd4904](3dd4904))
* `update_interval` was broken ([31d2fb7](31d2fb7))
* annotations with time were not following the time format configuration ([5d08853](5d08853))
* another caching issue with statistics ([b93ee75](b93ee75))
* caching issue for statistics ([8daff2f](8daff2f))
* hidden by default would not work without a name ([9c75ce8](9c75ce8)), closes [#280](#280)
* last caching issue with statistics ([2e528f7](2e528f7))
* median function fails if it receives an empty table ([#316](#316)) ([12f8d2e](12f8d2e))
* Support for fire-dom-event with browser-mod ([3dc9625](3dc9625)), closes [#196](#196)
* Update apexcharts.js to the the latest version ([dd0bf6f](dd0bf6f))
  • Loading branch information
semantic-release-bot committed Apr 23, 2022
1 parent 35fc100 commit 8024ae8
Show file tree
Hide file tree
Showing 4 changed files with 45 additions and 14 deletions.
31 changes: 31 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,34 @@
## [2.0.0](https://github.com/RomRider/apexcharts-card/compare/v1.10.0...v2.0.0) (2022-04-23)


### ⚠ BREAKING CHANGES

* `extend_to_end` has been removed and replaced by `extend_to` with support for `now` and `end`.

### Features

* `extend_to` replaces `extend_to_end` with new options ([4bb1dd2](https://github.com/RomRider/apexcharts-card/commit/4bb1dd2464927c1dea66d422474cacaef7c89a16)), closes [#318](https://github.com/RomRider/apexcharts-card/issues/318)
* add state type to long term statistics ([#329](https://github.com/RomRider/apexcharts-card/issues/329)) ([3fad4f0](https://github.com/RomRider/apexcharts-card/commit/3fad4f05cb8bcd95f33ba8426ccb21e61c6e42fe))
* Apply a `time_delta` to all the datapoints of your serie ([435e381](https://github.com/RomRider/apexcharts-card/commit/435e381ceeb467261501bf471010ac3c029064c5)), closes [#277](https://github.com/RomRider/apexcharts-card/issues/277)
* display only the min or max extrema ([3db982b](https://github.com/RomRider/apexcharts-card/commit/3db982b88ea7d3568f253e63fb7626cc3153c7ad)), closes [#319](https://github.com/RomRider/apexcharts-card/issues/319)
* follow Home Assistant number format ([9204de2](https://github.com/RomRider/apexcharts-card/commit/9204de2578b9310d1ea2276d2b4118292404b2dd)), closes [#307](https://github.com/RomRider/apexcharts-card/issues/307)
* support actions on the title with `title_actions` ([a9f406e](https://github.com/RomRider/apexcharts-card/commit/a9f406ed8fd4b873825def74774df6dc672f8639)), closes [#323](https://github.com/RomRider/apexcharts-card/issues/323)
* Support for HA long-term statistics ([#208](https://github.com/RomRider/apexcharts-card/issues/208)) ([29aaa7c](https://github.com/RomRider/apexcharts-card/commit/29aaa7c1763f5f50196ae3ad4ab04666a7d60e98)), closes [#308](https://github.com/RomRider/apexcharts-card/issues/308)


### Bug Fixes

* `last_updated` date format was not following the configuration ([3dd4904](https://github.com/RomRider/apexcharts-card/commit/3dd4904a72b55cba94a3951a83dc2bd0d7caee09))
* `update_interval` was broken ([31d2fb7](https://github.com/RomRider/apexcharts-card/commit/31d2fb770555d0ec58d03de89bc0b4512ed03f68))
* annotations with time were not following the time format configuration ([5d08853](https://github.com/RomRider/apexcharts-card/commit/5d088532f933991ccdf3c8b876ba8c921fe5f233))
* another caching issue with statistics ([b93ee75](https://github.com/RomRider/apexcharts-card/commit/b93ee75148e55dfa591d1987c5eee44b3f4314b6))
* caching issue for statistics ([8daff2f](https://github.com/RomRider/apexcharts-card/commit/8daff2ff7b70a1973ff7fb154f56ea7492c7b922))
* hidden by default would not work without a name ([9c75ce8](https://github.com/RomRider/apexcharts-card/commit/9c75ce89dfdf59ed72c3235d8be6d7c501b50ff5)), closes [#280](https://github.com/RomRider/apexcharts-card/issues/280)
* last caching issue with statistics ([2e528f7](https://github.com/RomRider/apexcharts-card/commit/2e528f77f974a2b5b68ef89725311d70fbf35a0e))
* median function fails if it receives an empty table ([#316](https://github.com/RomRider/apexcharts-card/issues/316)) ([12f8d2e](https://github.com/RomRider/apexcharts-card/commit/12f8d2edb9cd8cb7ba56c30af65b3372aa242624))
* Support for fire-dom-event with browser-mod ([3dc9625](https://github.com/RomRider/apexcharts-card/commit/3dc962522d1e776202acea8be7e2b2dafe1fdd23)), closes [#196](https://github.com/RomRider/apexcharts-card/issues/196)
* Update apexcharts.js to the the latest version ([dd0bf6f](https://github.com/RomRider/apexcharts-card/commit/dd0bf6f03405e41be3dc9efdebb95d265f27ea63))

## [2.0.0-dev.8](https://github.com/RomRider/apexcharts-card/compare/v2.0.0-dev.7...v2.0.0-dev.8) (2022-04-23)


Expand Down
22 changes: 11 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -88,7 +88,7 @@ This card is available in [HACS](https://hacs.xyz/) (Home Assistant Community St
2. Grab `apexcharts-card.js`:

```
$ wget https://github.com/RomRider/apexcharts-card/releases/download/v1.10.0/apexcharts-card.js
$ wget https://github.com/RomRider/apexcharts-card/releases/download/v2.0.0/apexcharts-card.js
```

3. Add the resource reference as decribed below.
Expand All @@ -99,7 +99,7 @@ If you configure Lovelace via YAML, add a reference to `apexcharts-card.js` insi

```yaml
resources:
- url: /local/apexcharts-card.js?v=1.10.0
- url: /local/apexcharts-card.js?v=2.0.0
type: module
```

Expand Down Expand Up @@ -167,18 +167,18 @@ The card stricly validates all the options available (but not for the `apex_conf
| `stroke_width` | number | `5` | v1.6.0 | Change the width of the line. Only works for `area` and `line` |
| `type` | string | `line` | v1.0.0 | `line`, `area` or `column` are supported for now |
| `curve` | string | `smooth` | v1.0.0 | `smooth` (nice curve), `straight` (direct line between points) or `stepline` (flat line until next point then straight up or down) |
| ~~`extend_to_end`~~ | ~~boolean~~ | ~~`true`~~ | ~~v1.0.0~~ | **DEPRECATED since NEXT_VERSION** ~~If the last data is older than the end time displayed on the graph, setting to true will extend the value until the end of the timeline. Only works for `line` and `area` types.~~ |
| `extend_to` | boolean or string | `end` | NEXT_VERSION | If value is `end`, it will extend the line/area to the end of the chart. With `now`, it will extend it to the current time (usefull for chart showing current and future data). If `false` it will not do anything. Only available for `line` and `area` types. |
| ~~`extend_to_end`~~ | ~~boolean~~ | ~~`true`~~ | ~~v1.0.0~~ | **DEPRECATED since v2.0.0** ~~If the last data is older than the end time displayed on the graph, setting to true will extend the value until the end of the timeline. Only works for `line` and `area` types.~~ |
| `extend_to` | boolean or string | `end` | v2.0.0 | If value is `end`, it will extend the line/area to the end of the chart. With `now`, it will extend it to the current time (usefull for chart showing current and future data). If `false` it will not do anything. Only available for `line` and `area` types. |
| `unit` | string | | v1.0.0 | Override the unit of the sensor |
| `float_precision` | number | `1` | v1.2.0 | The precision used to display data in the legend and the tooltip. It doesn't impact how the data is displayed on the graph |
| `fill_raw` | string | `'null'` | v1.5.0 | If there is any missing value in the history, `last` will replace them with the last non-empty state, `zero` will fill missing values with `0`, `'null'` will fill missing values with `null`. This is applied before `group_by` options |
| `group_by` | object | | v1.0.0 | See [group_by](#group_by-options) |
| `invert` | boolean | `false` | v1.2.0 | Negates the data (`1` -> `-1`). Usefull to display opposites values like network in (standard)/out (inverted) |
| `transform` | string | | v1.5.0 | Transform your raw data in any way you like. See [transform](#transform-option) |
| `data_generator` | string | | v1.2.0 | See [data_generator](#data_generator-option) |
| `statistics` | object | | NEXT_VERSION | Use HA statistical data (long-term). See [statistics](#statistics-options) |
| `statistics` | object | | v2.0.0 | Use HA statistical data (long-term). See [statistics](#statistics-options) |
| `offset` | string | | v1.3.0 | This is different from the main `offset` parameter. This is at the series level. It is only usefull if you want to display data from for eg. yesterday on top of the data from today for the same sensor and compare the data. The time displayed in the tooltip will be wrong as will the x axis information. Valid values are any negative time string, eg: `-1h`, `-12min`, `-1d`, `-1h25`, `-10sec`, ... `month` (365.25 days / 12) and `year` (365.25 days) as unit will generate inconsistent result, you should use days instead. |
| `time_delta` | string | | NEXT_VERSION | This applies a time delta to all the datapoints of your chart **after** fetching them. You can cumulate it with `offset`. Valid values are any time strings starting with `+` or `-`, eg: `-30min`, `+2h`, `-2d`, ... |
| `time_delta` | string | | v2.0.0 | This applies a time delta to all the datapoints of your chart **after** fetching them. You can cumulate it with `offset`. Valid values are any time strings starting with `+` or `-`, eg: `-30min`, `+2h`, `-2d`, ... |
| `min` | number | `0` | v1.4.0 | Only used when `chart_type = radialBar`, see [chart_type](#chart_type-options). Used to convert the value into a percentage. Minimum value of the sensor |
| `max` | number | `100` | v1.4.0 | Only used when `chart_type = radialBar`, see [chart_type](#chart_type-options). Used to convert the value into a percentage. Maximum value of the sensor |
| `color_threshold` | object | | v1.6.0 | See [experimental](#experimental-features) |
Expand All @@ -198,7 +198,7 @@ The card stricly validates all the options available (but not for the `apex_conf
| `in_chart` | boolean | `true` | v1.4.0 | If `false`, hides the serie from the chart |
| `datalabels` | boolean or string | `false` | v1.5.0 | If `true` will show the value of each point for this serie directly in the chart. Don't use it if you have a lot of points displayed, it will be a mess. If you set it to `total` (introduced in v1.7.0), it will display the stacked total value (only works when `stacked: true`). If you set it to `percent`, it will display the percentage of the serie instead of the value in the case of a `pie` or `donut` chart. |
| `hidden_by_default` | boolean | `false` | v1.6.0 | See [experimental](#hidden_by_default-experimental-feature) |
| `extremas` | boolean or string | `false` | v1.7.0 | If `true`, will show the min and the max of the serie in the chart. If the value is `time`, it will display also the time of the min/max value on top of the value. From NEXT_VERSION, `min` or `max` will display the min or the max only and `min+time` or `max+time` will display the time of the min or the max. Displaying the time doesn't work with `stacked: true`. |
| `extremas` | boolean or string | `false` | v1.7.0 | If `true`, will show the min and the max of the serie in the chart. If the value is `time`, it will display also the time of the min/max value on top of the value. From v2.0.0, `min` or `max` will display the min or the max only and `min+time` or `max+time` will display the time of the min or the max. Displaying the time doesn't work with `stacked: true`. |
| `in_brush` | boolean | `false` | v1.8.0 | See [brush](#brush-experimental-feature) |
| `offset_in_name` | boolean | `true` | v1.8.0 | If `true`, appends the offset information to the name of the serie. If `false`, it doesn't |

Expand Down Expand Up @@ -267,9 +267,9 @@ series:

| Name | Type | Default | Since | Description |
| ---- | :--: | :-----: | :---: | ----------- |
| `type` | string | `mean` | NEXT_VERSION | Type of long term statistic to pull. Can be one of `min`, `max`, `mean`, `sum` or `state` |
| `period` | string | `hour` | NEXT_VERSION | Period of statistics to pull. Can be one of `5minute`, `hour`, `day` or `month` |
| `align` | string | `middle` | NEXT_VERSION | Align the data points to the `start`, `end` or `middle` of the period of the statistics |
| `type` | string | `mean` | v2.0.0 | Type of long term statistic to pull. Can be one of `min`, `max`, `mean`, `sum` or `state` |
| `period` | string | `hour` | v2.0.0 | Period of statistics to pull. Can be one of `5minute`, `hour`, `day` or `month` |
| `align` | string | `middle` | v2.0.0 | Align the data points to the `start`, `end` or `middle` of the period of the statistics |

### Main `show` Options

Expand All @@ -284,7 +284,7 @@ series:
| ---- | :--: | :-----: | :---: | ----------- |
| `show` | boolean | `false` | v1.0.0 | Show or hide the header |
| `title` | string | | v1.1.0 | The title of the chart you want to display |
| `title_actions` | object | NEXT_VERSION | Actions to perform while taping the title of the chart. See [title_actions](#header_actions-or-title_actions-options) |
| `title_actions` | object | v2.0.0 | Actions to perform while taping the title of the chart. See [title_actions](#header_actions-or-title_actions-options) |
| `floating` | boolean | `false` | v1.0.0 | Makes the header float above the graph. Positionning will be supported later |
| `show_states` | boolean | `false` | v1.1.0 | Show or hide the states in the header |
| `colorize_states` | boolean | `false` | v1.1.0 | Colorize the states based on the color of the serie |
Expand Down
4 changes: 2 additions & 2 deletions package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "apexcharts-card",
"version": "2.0.0-dev.8",
"version": "2.0.0",
"description": "A Home Assistant Lovelace card using ApexCharts to render graphs",
"main": "src/apexcharts-card.ts",
"scripts": {
Expand Down

0 comments on commit 8024ae8

Please sign in to comment.