Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/tvjsx/tvjs-overlays

💴 Collection of overlays made by the TradingVueJs community
https://github.com/tvjsx/tvjs-overlays

ez good indicators money trading trading-algorithms trading-platform trading-strategies trading-systems tradingview tvjs-overlays vue vuejs

Last synced: 3 months ago
JSON representation

💴 Collection of overlays made by the TradingVueJs community

Host: GitHub
URL: https://github.com/tvjsx/tvjs-overlays
Owner: tvjsx
License: mit
Created: 2020-03-29T15:03:57.000Z (over 4 years ago)
Default Branch: master
Last Pushed: 2023-01-07T04:37:12.000Z (almost 2 years ago)
Last Synced: 2024-07-20T12:05:02.384Z (4 months ago)
Topics: ez, good, indicators, money, trading, trading-algorithms, trading-platform, trading-strategies, trading-systems, tradingview, tvjs-overlays, vue, vuejs
Language: Vue
Homepage: https://github.com/tvjsx/trading-vue-js
Size: 3.12 MB
Stars: 98
Watchers: 7
Forks: 58
Open Issues: 22
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE.md

Awesome Lists containing this project

README

        



  



# TVJS Overlay Pack ![npm](https://img.shields.io/npm/v/tvjs-overlays.svg?color=brightgreen&label=version) ![license](https://img.shields.io/badge/license-MIT-blue.svg) ![GRUGLIKE](https://img.shields.io/badge/GRUG-LIKE-yellow.svg) ![build](https://img.shields.io/badge/build-passing-brightgreen.svg) ![size](https://img.shields.io/github/size/tvjsx/tvjs-overlays/dist/tvjs-overlays.min.js.svg)

**TVJS Overlays** is a collection of overlays made by the [TradingVue.js](https://github.com/tvjsx/trading-vue-js) community.

## List

| Name | Author | Type | Description | Version |

|---|---|---|---|---|

| [ALMA](https://github.com/tvjsx/tvjs-overlays/tree/master/src/overlays/ALMA) | StdSquad | OV+Script | Arnaud Legoux Moving Average | 1.0.0 |

| [ATR](https://github.com/tvjsx/tvjs-overlays/tree/master/src/overlays/ATR) | StdSquad | OV+Script | Average True Range | 1.0.0 |

| [ATRp](https://github.com/tvjsx/tvjs-overlays/tree/master/src/overlays/ATRp) | StdSquad | OV+Script | Average True Range, % | 1.0.0 |

| [Area51](https://github.com/tvjsx/tvjs-overlays/tree/master/src/overlays/Area51) | 👽 | OV | Gradient area chart | 1.0.0 |

| [BB](https://github.com/tvjsx/tvjs-overlays/tree/master/src/overlays/BB) | StdSquad | OV+Script | Bollinger Bands | 1.0.0 |

| [BBW](https://github.com/tvjsx/tvjs-overlays/tree/master/src/overlays/BBW) | StdSquad | OV+Script | Bollinger Bands Width | 1.0.0 |

| [CCI](https://github.com/tvjsx/tvjs-overlays/tree/master/src/overlays/CCI) | StdSquad | OV+Script | Commodity Channel Index | 1.0.0 |

| [CMO](https://github.com/tvjsx/tvjs-overlays/tree/master/src/overlays/CMO) | StdSquad | OV+Script | Chande Momentum Oscillator | 1.0.0 |

| [COG](https://github.com/tvjsx/tvjs-overlays/tree/master/src/overlays/COG) | StdSquad | OV+Script | Center of Gravity | 1.0.0 |

| [DHistogram](https://github.com/tvjsx/tvjs-overlays/tree/master/src/overlays/DHistogram) | Acid3croco | OV | Double Histogram Plot | 1.0.0 |

| [DMI](https://github.com/tvjsx/tvjs-overlays/tree/master/src/overlays/DMI) | StdSquad | OV+Script | Directional Movement Index | 1.0.0 |

| [EMA](https://github.com/tvjsx/tvjs-overlays/tree/master/src/overlays/EMA) | StdSquad | OV+Script | Exponential Moving Average | 1.0.0 |

| [HMA](https://github.com/tvjsx/tvjs-overlays/tree/master/src/overlays/HMA) | StdSquad | OV+Script | Hull Moving Average | 1.0.0 |

| [Histogram](https://github.com/tvjsx/tvjs-overlays/tree/master/src/overlays/Histogram) | StdSquad | OV | Histogram plot | 1.0.0 |

| [Ichi](https://github.com/tvjsx/tvjs-overlays/tree/master/src/overlays/Ichi) | C451 | OV+Script | Ichimoku Cloud based on scripts | 1.0.0 |

| [Ichimoku](https://github.com/tvjsx/tvjs-overlays/tree/master/src/overlays/Ichimoku) | Sudeep Batra | OV |  | 1.0.0 |

| [KC](https://github.com/tvjsx/tvjs-overlays/tree/master/src/overlays/KC) | StdSquad | OV+Script | Keltner Channels | 1.0.0 |

| [KCW](https://github.com/tvjsx/tvjs-overlays/tree/master/src/overlays/KCW) | StdSquad | OV+Script | Keltner Channels Width | 1.0.0 |

| [LongShortTrades](https://github.com/tvjsx/tvjs-overlays/tree/master/src/overlays/LongShortTrades) | Sudeep Batra | OV |  | 1.0.1 |

| [MACD](https://github.com/tvjsx/tvjs-overlays/tree/master/src/overlays/MACD) | StdSquad | OV+Script | Moving Average Convergence/Divergence | 1.0.2 |

| [MFI](https://github.com/tvjsx/tvjs-overlays/tree/master/src/overlays/MFI) | StdSquad | OV+Script | Money Flow Index | 1.0.0 |

| [MOM](https://github.com/tvjsx/tvjs-overlays/tree/master/src/overlays/MOM) | StdSquad | OV+Script | Momentum | 1.0.0 |

| [Markers](https://github.com/tvjsx/tvjs-overlays/tree/master/src/overlays/Markers) | C451 | OV | Interactive markers | 1.0.1 |

| [PlotCross](https://github.com/tvjsx/tvjs-overlays/tree/master/src/overlays/PlotCross) | StdSquad | OV | Plot line with crosses | 1.0.0 |

| [ROC](https://github.com/tvjsx/tvjs-overlays/tree/master/src/overlays/ROC) | StdSquad | OV+Script | Rate of Change | 1.0.0 |

| [RSI](https://github.com/tvjsx/tvjs-overlays/tree/master/src/overlays/RSI) | StdSquad | OV+Script | Relative Strength Index | 1.0.0 |

| [Ribbon](https://github.com/tvjsx/tvjs-overlays/tree/master/src/overlays/Ribbon) | StdSquad | OV+Script | Moving Average Ribbon | 1.0.0 |

| [SAR](https://github.com/tvjsx/tvjs-overlays/tree/master/src/overlays/SAR) | StdSquad | OV+Script | Parabolic SAR | 1.0.0 |

| [SMA](https://github.com/tvjsx/tvjs-overlays/tree/master/src/overlays/SMA) | StdSquad | OV+Script | Simple Moving Average | 1.0.0 |

| [SWMA](https://github.com/tvjsx/tvjs-overlays/tree/master/src/overlays/SWMA) | StdSquad | OV+Script | Symmetrically Weighted Moving Average | 1.0.0 |

| [Stoch](https://github.com/tvjsx/tvjs-overlays/tree/master/src/overlays/Stoch) | StdSquad | OV+Script | Stochastic | 1.0.0 |

| [TSI](https://github.com/tvjsx/tvjs-overlays/tree/master/src/overlays/TSI) | StdSquad | OV+Script | True Strength Index | 1.0.0 |

| [TradesPlus](https://github.com/tvjsx/tvjs-overlays/tree/master/src/overlays/TradesPlus) | C451 | OV | Trades overlay with stops | 1.0.1 |

| [VWMA](https://github.com/tvjsx/tvjs-overlays/tree/master/src/overlays/VWMA) | StdSquad | OV+Script | Volume Weighted Moving Average | 1.0.0 |

| [WilliamsR](https://github.com/tvjsx/tvjs-overlays/tree/master/src/overlays/WilliamsR) | StdSquad | OV+Script | Williams %R | 1.0.0 |

| [XOhlcBars](https://github.com/tvjsx/tvjs-overlays/tree/master/src/overlays/XOhlcBars) | X | OV | Bar Chart | 1.3.0 |

## Install

**NPM**

```

npm i tvjs-overlays

```

**In browser**

```

```

## How to use

**NPM**

```html

import TradingVue from 'trading-vue-js'

import Overlays from 'tvjs-overlays'

export default {

    name: 'app',

    components: { TradingVue },

    data() {

        return {

            overlays: Object.values(Overlays),

            data: new DataCube(...)

        }

    }

}

```

**In browser**

```html





app = new Vue({

    el: '#app',

    data: {

        overlays: Object.values(TvjsOverlays),

        data: new TradingVueJs.DataCube(...)

    }

})

```

## Adding new overlay

1. Create a folder in `src/overlays` named just like your overlay: `YourOverlayName`

2. Your main code must be in `YourOverlayName.vue`, but you can use .js and .json imports

3. Add your data sample `data.json`

4. Make sure that the following conditions are met:

```

    * folder name === .vue file name === overlay name

    * required functions: draw, use_for

    * use_for includes the name

    * use_for.length === 1

    * name is unique (format: CapitalizedWords, Numbers_123)

    * required meta: author, version

    * data.json < 1MB

```

5. `npm run check` to check that everything is OK

6. `npm run compile` to build the development index

7. `npm run dev` to test your overlays

8. Add a short README.md ([example](https://github.com/tvjsx/tvjs-overlays/tree/master/src/overlays/TestOverlay1))

9. Submit a PR request to this repo