Superalgos/Projects/Superalgos/Schemas/Docs-Nodes/plotter-module.json

{
    "type": "Plotter Module",
    "definition": {
        "text": "A plotter module is a device within a plotter that contains the definitions to create the visualization for a product definition."
    },
    "paragraphs": [
        {
            "style": "Block",
            "text": "Content"
        },
        {
            "style": "Text",
            "text": "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."
        },
        {
            "style": "Gif",
            "text": "GIFs/Superalgos/Docs/inner-foder/plotter-module-01.gif"
        },
        {
            "style": "Important",
            "text": "For a bot to use a plotter, the corresponding product definition must establish a reference with the plotter module built to interpret the dataset."
        },
        {
            "style": "Gif",
            "text": "GIFs/Superalgos/Docs/inner-foder/plotter-module-02-product-link.gif"
        },
        {
            "style": "Block",
            "text": "Configuring"
        },
        {
            "style": "Title",
            "text": "Configuring Plotter Module"
        },
        {
            "style": "Text",
            "text": "Select Configure Plotter Module on the menu to access the configuration."
        },
        {
            "style": "Text",
            "text": "{"
        },
        {
            "style": "Text",
            "text": "    \"codeName\": \"Module Name\","
        },
        {
            "style": "Text",
            "text": "    \"isLegacy\": true,"
        },
        {
            "style": "Text",
            "text": "        \"icon\": \"histogram\""
        },
        {
            "style": "Text",
            "text": "}"
        },
        {
            "style": "List",
            "text": "codeName is the name used in the code to refer to the module."
        },
        {
            "style": "List",
            "text": "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."
        },
        {
            "style": "Text",
            "text": "| Value | Image|"
        },
        {
            "style": "Text",
            "text": "| :---: | :---: |"
        },
        {
            "style": "Png",
            "text": "| default | PNGs/Superalgos/Docs/inner-foder/default-banner.png |"
        },
        {
            "style": "Png",
            "text": "| histogram | PNGs/Superalgos/Docs/inner-foder/histogram-banner.png |"
        },
        {
            "style": "Png",
            "text": "| band | PNGs/Superalgos/Docs/inner-foder/bands-banner.png |"
        },
        {
            "style": "Png",
            "text": "| moving-average | PNGs/Superalgos/Docs/inner-foder/moving-average-banner.png |"
        },
        {
            "style": "Png",
            "text": "| oscillator | PNGs/Superalgos/Docs/inner-foder/oscillator-banner.png |"
        },
        {
            "style": "Png",
            "text": "| trend | PNGs/Superalgos/Docs/inner-foder/trends-banner.png |"
        },
        {
            "style": "Text",
            "text": "Custom images may be added too. To do that:"
        },
        {
            "style": "Text",
            "text": "1. name the image in the following format: image-name.png;"
        },
        {
            "style": "Text",
            "text": "1. place images in the WebServer\\Images\\Icons folder;"
        },
        {
            "style": "Text",
            "text": "1. in the configuration of the module, use the name as is (e.g.: \"icon\": \"image-name\")"
        }
    ]
}