@debut/plugin-report v1.4.2

@debut/plugin-report

Debut plugin, for setting targets and stops in manual mode. Allows you to set or change the stop and take prices for open positions at any time, using their identifier. It also allows you to optionally make additions instead of closing unprofitable positions. By default, the plugin draws balance changes and the used margin (if the strategy has more than 1 trade at a time). It has some API to customize it.

Install

npm install @debut/plugin-report --save

Settings

Creation of indicators

During initialization, you can pass an array of data to the plugin to build a chart of indicators. To do this, create a method, for example getIndicators that returns the indicators plotting scheme IndicatorsSchema

import { ReportPluginAPI, IndicatorsSchema } from '@debut/plugin-report';
// ...

// In Debut context.
public getIndicators = (): IndicatorsSchema => {
    return [{
        // Indicator name
        name: 'cci',
        // array of lines
        lines: [{
            name: 'cci',
            getValue: () => {
                return this.cciValue;
            },
        }],
        // levels
        levels: [-100, 100],
    }];

Initialize plugin

In the create method in the meta file of the strategy, add to the tester environment for initialization

// ...
async create(transport: BaseTransport, cfg: MyStrategyNameOptions, env: WorkingEnv) {
    const bot = new MyStrategyName(transport, cfg);
    // ...
    // environment-specific plugins
    if (env === WorkingEnv.tester) {
        // Plugin registration
        bot.registerPlugins([reportPlugin()]);

        // installing the indicators
        bot.plugins.report.addIndicators(bot.getIndicators());
    }

    // ...
    return bot;
},

Web server for viewing statistics

The server is started with the command npm run serve to do this, add the appropriate command to the scripts section in the package.json file.

// ...
"scripts": {
    "serve": 'report-serve',
    // ...
}

Description of indicator circuit `Indicator

API description

All API is available through the call this.plugins.report.method_name, you can read more about how the API works in the documentation.

Example MACD indicator

public getIndicators = (): IndicatorsSchema => {
    return [
        {
            name: `MACD Indicator',
            shapes: [
                {
                    name: 'signal',
                    fill: FillType.tozeroy,
                    getValue: () => {
                        return this.macdValue.signal;
                    },
                    color: 'red',
                    fillcolor: 'rgba(255, 0, 0, 0.2)',
                },
                {
                    name: 'macd',
                    fill: FillType.tozeroy,
                    getValue: () => {
                        return this.macdValue.macd;
                    },
                },
                {
                    name: 'histogram',
                    type: FigureType.bar,
                    getValue: () => {
                        return this.macdValue.histogram;
                    },
                },
            ],
        },
    ];
};