🚀 Release: v2.0.0

[github-actions[bot]]

🚀 New Release: v2.0.0

View full release and download on GitHub

---

Chartdeck 2.0 brings everything left on the chart roadmap in one release: 44 chart styles in all, up from eleven in 1.3. It includes the charts that briefly went out as 1.4.0 and 1.5.0 (pie and donut, rings, pictograph, waffle, histogram, scatter, bubble, heatmap and box plot); those two releases have been withdrawn and their notes are folded in below. New in 2.0 itself are the funnel, waterfall, treemap, sunburst and icicle charts, radar and polar area, grouped bars, bullet, lollipop, slope and dumbbell comparisons, and a set of history charts: range area, sparklines, streamgraph, candlestick, violin and raincloud, beeswarm, state timeline, climate, Sankey, wind rose, a 24-hour clock and a compact trend card. The line chart gains zoom and pan, annotations, value labels you can choose, synced charts, small multiples, highest/lowest/average marks and a log scale, and the ring, arc and needle gauges get their own angles, centre text and scale numbers. It is a major version for one reason: on number charts, on and off states now read as 1 and 0, so a binary sensor on a line, area or column chart draws a step where it used to draw nothing (see Changed). Every other existing card draws as before.

Fixed

These were found while bringing all the charts together and fixed before release; none of them reached a published version.

• Small multiples on a log scale break the line at zero. Each small chart drew its zero and negative readings on the log axis; they are now gaps, as on the full-size chart, and a chart with nothing above zero says so. (#111)
• Switching style no longer leaves a group_by the new chart can't read. group_by groups entities by floor or area on the treemap, sunburst, icicle and radar, and readings by hour or day on the history charts. Picking one kind of style on a card set up for the other kept the old value and showed an error; the editor now drops it. (#111)
• Editor labels no longer change depending on which charts loaded first. Editor strings are shared, and several charts registered the same one with different text, so the last to load relabelled the others: the line chart's value-labels switch could read "Highest and lowest labels", the gauges' start angle the rings' text, and the cases below. Each field now keeps its own label. (#111)
  • Rings and pie cards with center: total (or average) were rejected as "center must be one of: value, band, name, text, none" once the gauge options went in, because the gauge options were checked on every card. They are now read only by the ring, arc and needle styles.
  • The dumbbell, slope and waterfall editors offered calendar periods, period offsets, previous/next buttons and grouping, which those charts ignore. Their Chart section now shows only how far back and the source.
  • The treemap, sunburst, icicle and radar editors labelled Group by as "Group readings by" (the history charts' label) depending on which charts loaded first. They now keep their own label.
  • Direction options read differently from chart to chart (Rows, Columns, Up, On their side) and could swap labels with each other. The dumbbell, waterfall, lollipop and box plot now all say Direction, with Across and Upright.
  • The slope chart's per-entity Group could be relabelled by the trend card's "No background" option; it now keeps its own label.
  • The pie's "In the middle" choices could be relabelled by the 24-hour clock's ("Time on" for Total); each now keeps its own.
• The beeswarm's hover names the lowest and highest readings when dots are placed by value, instead of "Earliest – latest", which now shows only for time of day. (#111)
• The 24-hour clock draws a text sensor as states. An entity without a unit got a ring of number bars even when its state was a word (a washer's "washing"), so the ring stayed empty. (#111)
• A long sunburst total wraps its unit under the number instead of running over the inner ring. (#111)
• The log scale is offered on the line chart only. It had landed in the axis options every history chart shares, so columns, stacked areas and the climate chart offered it although their bars and fills stand on zero. (#111)

Added

Each chart in one line; the release notes have every option with a YAML example.

• Pie and donut (wiki): A card can now show how a total splits into parts as a pie or a donut.
• Rings (wiki): Several values can now share one dial as concentric rings.
• Pictograph (wiki): A count can now be drawn as a row of icons, so "7 of 10" reads at a glance.
• Waffle (wiki): A share can now be shown as a waffle: a 10 by 10 grid where each square is 1 %.
• Funnel (wiki): A card can now show stages that narrow down as a funnel or a pyramid.
• Waterfall (wiki): A card can now show how a total is built up or worn down, step by step.
• Treemap (wiki): A card can now show many parts of a whole as a treemap, grouped by floor, room or your own groups.
• Sunburst and icicle (wiki): Two new charts draw the card's entities as a hierarchy, such as house, floor, room and device power.
• Radar (wiki): A card can now compare profiles of several values on a radar chart.
• Polar area (wiki): A card can now compare values as slice lengths on a polar area chart.
• Grouped bars (wiki): A card can now compare categories with several values each, in grouped, stacked or 100 % stacked bars.
• Bullet and lollipop (wiki): Two new charts compare values against their targets: bullet and lollipop.
• Slope (wiki): A card can now compare each entity then and now on a slope chart.
• Dumbbell (wiki): A card can now compare two or three values per entity on a dumbbell chart.
• Gauges (wiki): Ring, arc and needle gauges can now set their angles, what sits in the middle, and numbers along the scale.
• Histogram (wiki): A card can now show how long a sensor spent in each range of values.
• Scatter (wiki): One sensor can now be plotted against another as dots.
• Bubble (wiki): A scatter can now size each dot by a third sensor.
• Heatmap (wiki): A card can now show when something happens, as a grid of coloured cells.
• Box plot (wiki): A card can now show how a sensor's readings spread, as box plots.
• Range area (wiki): A history chart can now shade each period's lowest to highest reading, with the average drawn through it.
• Sparklines (wiki): A card can now list its entities with a tiny trend beside each name and value.
• Streamgraph (wiki): A card can now show how several entities share a total over time, as flowing layers.
• Candlestick (wiki): A card can now draw open, high, low and close for each day, hour, week or month as candles.
• Violin and raincloud (wiki): A card can now show how a sensor's readings are spread as a violin, or as a raincloud with every reading.
• Beeswarm (wiki): A card can now draw every reading as a dot, packed so none overlap, or every time something turned on by time of day.
• State timeline (wiki): A card can now show when each entity was on, off, home, heating or anything else, as rows of coloured bars.
• Climate (wiki): A card can now chart a thermostat: the room temperature, its set point, and shading wherever it was heating or cooling.
• Sankey (wiki): A card can now draw power or energy flowing between sources and loads, each band as wide as its flow.
• Wind rose (wiki): A card can now show where the wind came from and how hard, as a wind rose.
• 24-hour clock (wiki): A card can now draw a day on a 24-hour dial, one ring per entity: when things were on, and numbers by the hour.
• Trend (wiki): A card can now be a compact tile: the name, the value in large type, and its history filling the bottom edge to edge.
• Line chart (wiki): zoom and pan with an overview strip, annotations, value labels you choose, synced charts, small multiples, highest/lowest/average marks and a logarithmic value scale.

Changed

• Breaking: on and off now read as 1 and 0 on number charts. On a number chart (line, area, column, combined, histogram, beeswarm and the rest), an entity's history state on now reads as 1 and off as 0, so a binary sensor, switch or light draws as a 0/1 step on a line chart instead of nothing. Only the exact lowercase words on and off are read this way; other words (open, closed, home, heating) still read as no value. The same applies to live updates. Text charts (state timeline, 24-hour clock rings) keep the words. (#111, from #37)
• The column chart's Rounded tops switch is now labelled Rounded ends. The pie's switch for round slice ends uses the same label, so the two editors read the same. The option is still rounded, and nothing about the columns changes. (#104)
• Value labels on the line chart hide the ones that would overlap. labels: true used to drop every label on a series with more than 40 readings; it now shows as many as fit, and labels_overlap: true lets them overlap instead. (#111, closes #42)

Upgrading

Update via HACS, or download chartdeck-card.js from the latest release and copy it to /config/www/.

After updating, hard-refresh your browser (Ctrl/Cmd+Shift+R) so the new card module loads instead of a cached one.

---

💬 Questions or issues with this release? Reply below or open an issue.