tvjs-overlays v0.5.0

TVJS Overlay Pack

TVJS Overlays is a collection of overlays made by the TradingVue.js community.

List

Install

NPM

npm i tvjs-overlays

In browser

<script src="tvjs-overlays.min.js"></script>

How to use

NPM

<template>
<trading-vue :data="data" :overlays="overlays"/>
</template>
<script>

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(...)
        }
    }
}

</script>

In browser

<div id="app">
<trading-vue :data="data" :overlays="overlays"/>
</div>
<script>
app = new Vue({
    el: '#app',
    data: {
        overlays: Object.values(TvjsOverlays),
        data: new TradingVueJs.DataCube(...)
    }
})
</script>

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)
9. Submit a PR request to this repo