## :cd: Installation
```shell
npm i vue-trend-chart
```
## :rocket: Usage
```js
import TrendChart from "vue-trend-chart";
app.use(TrendChart);
```
_Example:_
```html
```
## :wrench: Props
### **`datasets`**
**Required**
Type: **Array**
_Array of objects with [properties for each dataset](#chart_with_upwards_trend-dataset-props)._
### **`grid`**
Type: **Object**
_[Grid properties](#hash-grid-props)_
### **`labels`**
Type: **Object**
_[Labels properties](#abc-labels-props)_
### **`min`**
Type: **Number**
Default: min value from datasets
### **`max`**
Type: **Number**
Default: max value from datasets
### **`padding`**
Type: **String**
Default: "5"
*If you set a large *stroke-width* on your lines, you may notice that it gets "cropped" towards the edges. It's similar to "padding" CSS property but without specifying units.*
Examples:
`"5"` apply to all four sides
`"5 10"` vertical | horizontal
`"5 15 10"` top | horizontal | bottom
`"5 10 15 20"` top | right | bottom | left
### **`interactive`**
Type: **Boolean**
Default: **false**
_Allows to set onmousemove interaction. Set to `true` to enable._
## :zap: Events
### **`mouse-move`**
_Callback function for **onmouseover** interaction.
Receives an **object** `{index: Number, data: Array}` parameter based on current active line.
This function has no effect if `interactive` isn't set to `true`._
## :chart_with_upwards_trend: Dataset Props
Chart line (curve) properties
### **`data`**
Type: **Number|Object**
_Example: `[70, 100, 400, 180, 100]` or `[{ value: 70 }, { value: 100 }, { value: 400 }, { value: 180 }, { value: 100 }]`
For object type you can also add other properties to use them in `interactive` mode._
### **`className`**
Type: **String**
_Allows to append custom class to chart line for future styling._
### **`smooth`**
Type: **Boolean**
Default: **false**
_Allows the peaks to be 'rounded' out._
### **`stroke`**
Type: **Boolean**
Default: **true**
_If `false`, the line is not drawn for this dataset._
### **`fill`**
Type: **Boolean**
Default: **false**
_Allows to fill the area under the line. Set to `true` to enable._
### **`showPoints`**
Type: **Boolean**
Default: **false**
_Allows to show points. Set to `true` to enable._
## :hash: Grid Props
### **`verticalLines`**
Type: **Boolean**
Default: false
_Allows to show vertical gridlines. Set to `true` to enable._
### **`verticalLinesNumber`**
Type: **Number**
Default: number of `xLabels`
_Allows to set custom number of vertical gridlines.
This prop has no effect if `verticalLines` isn't set to `true`._
### **`horizontalLines`**
Type: **Boolean**
Default: false
_Allows to show horizontal gridlines. Set to `true` to enable._
### **`horizontalLinesNumber`**
Type: **Number**
Default: number of `yLabels`
_Allows to set custom number of horizontal gridlines.
This prop has no effect if `horizontalLines` isn't set to `true`._
## :abc: Labels Props
### **`xLabels`**
Type: **Array**
_X axis labels.
Example: `["Mon", "Tue", "Wed", "Thu", "Fri", "Sat", "Sun"]`_
### **`yLabels`**
Type: **Number**
_Number of Y axis labels. Labels text is based on data values._
### **`yLabelsTextFormatter`**
Type: **Function**
_Allows to format Y axis labels text.
Example: `val => "$" + Math.round(val * 100) / 100`.
This function has no effect if `yLabels` prop has no value._
## :art: Styling
Just use CSS to style your charts.
_Here is an example of a tree structure with available class names:_
```html
```
## :hammer: Development
```shell
npm install
npm run dev
```
## :two_hearts: Contributing
Pull requests are welcome!
## :lock: License
MIT
