Files
Superalgos/docs/_includes/data_mine/plotter-module.md
T

4.9 KiB

{% assign title = "Plotter Module" %} {% assign definition = site.data.data_mine.plotter_module %} {% assign preposition = "a" %} {% assign plural = "s" %}

{% if include.heading != "" %} {{include.heading}} {{title}} {% endif %}

{% if include.icon != "no" %}

{% if include.table == "yes" and include.icon != "no" %}

{% endif %}

{% if include.table == "yes" and include.icon != "no" %}

{% endif %}

{% endif %}

{% if include.definition == "bold" %}

{{ definition }}

{% else %}

{{ definition }}

{% endif %}

{% if include.table == "yes" and include.icon != "no" %}

{% endif %}

{% if include.more == "yes" and include.content == "more" %}

Click to learn more about {{ title | downcase }}{{plural}} {% endif %}

{% if include.content != "no" %}

A single plotter may have several modules. Different modules may be used to plot each product of the bot, or as best suits the expected use-pattern.

Plotter-Module-01

{% include important.html content="For a bot to use a plotter, the corresponding product definition must establish a reference with the plotter module built to interpret the dataset." %}

Plotter-Module-02-Product-Link

{% endif %}

{% if include.more == "yes" and include.content != "more" %}

Click to learn more about {{ title | downcase }}{{plural}} {% endif %}

{% if include.adding != "" %}

{{include.adding}} Adding {{preposition}} {{title}} Node

To add a plotter module, select Add Plotter Module on the plotter node menu.

{% endif %}

{% if include.configuring != "" %}

{{include.configuring}} Configuring the {{title}}

Select Configure Plotter Module on the menu to access the configuration.

{
    "codeName": "Module Name",
    "isLegacy": true,
        "icon": "histogram"
}
  • codeName is the name used in the code to refer to the module.

  • isLegacy is true for plotters modules developed entirely in JavaScript, and is false or doesn't show in the configuration for plotters built with the tools featured in the data mine hierarchy.

  • icon is the name of the image that illustrates the corresponding layer in the Layers Panel. In case the banner is not specified, the default banner is used. Current possible values are:

Value Image
Default Default-Banner
Histogram Histogram-Banner
Band Bands-Banner
Moving Average Moving-Average-Banner
Oscillator Oscillator-Banner
Trend trends-banner

Custom images may be added too. To do that:

  1. name the image in the following format: The-Image-Name-Icon.png;

  2. place images in the WebServer\Images\ folder;

  3. in the configuration of the module, use the name without the -Icon ending (e.g.: "icon": "The-Image-Name")

{% endif %}

{% if include.starting != "" %}

{{include.starting}} Starting {{preposition}} {{title}}

XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX

{% endif %}

{% if include.more == "yes" %}

{% endif %}