@freezystem/mjml-bar-chart

1.1.1 • Public • Published

MJML Bar Chart

Getting started

First you'll have to install mjml-bar-chart in your project.

npm i -S @freezystem/mjml-bar-chart

Then add the package to your .mjmlconfig file:

{
  "packages": [
    "mjml-bar-chart/lib/index.js"
  ]
}

You can now use the mjml-bar-chart component in your MJML templates:

<mjml>
  <mj-body>
    <mj-section>
      <mj-column>
        <mj-bar-chart
          title="Sum of Requests by Department"
          dataset-labels="January,February,March" 
          datasets="33 14 27,18 66 42,7 15 21"
          groups="Support,Sales,Tech"
          colors="#d8f3dc,#95d5b2,#52b788"/>
      </mj-column>
    </mj-section>
  </mj-body>
</mjml>

Yay, you're all set !

Basic mjml-bar-chart rendering

Customize

attribute required default description
title ✖️ null Chart title, if null will not display
dataset-labels ✔️ null Comma separated labels of each dataset
datasets ✔️ null Comma separated values of each dataset, must contain space separted integers
groups ✔️ null Comma separated data group names
colors ✔️ null Comma separated CSS colors of each group
axis-color ✖️ #d4d4d4 CSS color of axis and scale numbers
height ✖️ 200 Chart height in pixel
bar-width ✖️ 30 Bar width in pixel
separator-width ✖️ 30 Separator width in pixel between datasets
step-count ✖️ 5 Step number on the chart scale, below 2 no steps will be displayed
show-values ✖️ true Whether or not it should display values above each bar

Readme

Keywords

none

Package Sidebar

Install

npm i @freezystem/mjml-bar-chart

Weekly Downloads

0

Version

1.1.1

License

MIT

Unpacked Size

36.8 kB

Total Files

15

Last publish

Collaborators

  • freezystem