Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: add grid lines #1179

Open
wants to merge 12 commits into
base: dev
Choose a base branch
from
5 changes: 4 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -116,7 +116,6 @@ We recommend looking at the [Example usage section](#example-usage) to understan
| value_factor | number | 0 | v0.9.4 | Scale value by order of magnitude (e.g. convert Watts to kilo Watts), use negative value to scale down.
| logarithmic | boolean | `false` | v0.10.0 | Use a Logarithmic scale for the graph


#### Entities object
Entities may be listed directly (as per `sensor.temperature` in the example below), or defined using
properties of the Entity object detailed in the following table (as per `sensor.pressure` in the example below).
Expand Down Expand Up @@ -168,6 +167,8 @@ All properties are optional.
| labels_secondary | `hover` | `true` / `false` / `hover` | Display secondary Y-axis labels.
| name_adaptive_color | `false` | `true` / `false` | Make the name color adapt with the primary entity color.
| icon_adaptive_color | `false` | `true` / `false` | Make the icon color adapt with the primary entity color.
| grid_lines_type | `hour` | `5minute` / `hour` / `day` / `week` | Show grid lines dependently on `hours_to_show` value.
| grid_lines_ratio | 2 | | Grid lines: thin / thick lines amount ratio (0 - no thin lines)

#### Line color object
See [dynamic line color](#dynamic-line-color) for example usage.
Expand Down Expand Up @@ -259,6 +260,8 @@ The following theme variables can be set in your HA theme to customize the appea
|------|:-------:|-------------|
| mcg-title-letter-spacing | | Letter spacing of the card title (`name` option).
| mcg-title-font-weight | 500 | Font weight of the card title.
| mcg-grid-line-thick-color | rgb(from var(--divider-color) R G B /0.5) | Grid "thick" line color.
| mcg-grid-line-thin-color | var(--divider-color) | Grid "thin" line color.

### Example usage

Expand Down
52 changes: 51 additions & 1 deletion src/main.js
Original file line number Diff line number Diff line change
Expand Up @@ -507,11 +507,13 @@ class MiniGraphCard extends LitElement {
}

renderSvg() {
const { height } = this.config;
const { height, show } = this.config;
const grid_lines_type = show.grid_lines_type ? show.grid_lines_type : false;
return svg`
<svg width='100%' height=${height !== 0 ? '100%' : 0} viewBox='0 0 500 ${height}'
@click=${e => e.stopPropagation()}>
<g>
${grid_lines_type ? this.renderGridLines() : ''}
JulienDeveaux marked this conversation as resolved.
Show resolved Hide resolved
<defs>
${this.renderSvgGradient(this.gradient)}
</defs>
Expand All @@ -525,6 +527,54 @@ class MiniGraphCard extends LitElement {
</svg>`;
}

renderGridLines() {
const {
height, hours_to_show, show,
} = this.config;
const grid_lines_type = show.grid_lines_type ? show.grid_lines_type : false;
const grid_lines_ratio = (show.grid_lines_ratio && Number.isInteger(show.grid_lines_ratio))
? show.grid_lines_ratio
: 2;

const containerWidth = 500;
let spanInHours;

switch (grid_lines_type) {
case '5minute':
spanInHours = 1 / 12;
break;
case 'hour':
default:
spanInHours = 1;
break;
case 'day':
spanInHours = 24;
break;
case 'week':
spanInHours = 168;
}

let numLines = hours_to_show / spanInHours;
const spanFactor = Math.ceil(hours_to_show / spanInHours) / (hours_to_show / spanInHours);
const thickPart = containerWidth * spanFactor / Math.ceil(numLines);
const thinPart = thickPart / (grid_lines_ratio + 1);
numLines *= (grid_lines_ratio + 1);

const lines = [];
for (let i = 0; i < numLines - 1; i += 1) {
const x = containerWidth - thinPart * (i + 1);
// const timeLabel = hours_to_show / numLines * (i + 1);

if ((i + 1) % (grid_lines_ratio + 1) > 0) {
Copy link
Collaborator

@ildar170975 ildar170975 Dec 14, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can we simplify this?
Untested (please check if it is OK):

      let stroke;
      if ((i + 1) % (grid_lines_ratio + 1) > 0) {
        stroke = "var(--mcg-grid-line-thin-color, var(--divider-color))";
      } else {
        stroke = "var(--mcg-grid-line-thick-color, rgb(from var(--divider-color) R G B /0.5))";
      }
      lines.push(svg`<line x1=${x} y1="0" x2=${x} y2=${height} stroke="${stroke}" stroke-width="0.5"/>`);

lines.push(svg`<line x1=${x} y1="0" x2=${x} y2=${height} stroke="var(--mcg-grid-line-thin-color, var(--divider-color))" stroke-width="0.5"/>`);
} else {
lines.push(svg`<line x1=${x} y1="0" x2=${x} y2=${height} stroke="var(--mcg-grid-line-thick-color, rgb(from var(--divider-color) R G B /0.5))" stroke-width="0.5"/>`);
}
}

return lines;
}

setTooltip(entity, index, value, label = null) {
const {
group_by,
Expand Down
Loading