Available translations
loading results
Plotter Module
A plotter module is a device within a plotter that contains the definitions to create the visualization for a product definition.
Content
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.
Important: For a bot to use a plotter, the corresponding Product Definition must establish a reference with the plotter module built to interpret the dataset.
Configuring
Plotter Module Configuration
Properties
-
codeNameis the name used in the code to refer to the module.
-
isLegacyis 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 icon is not specified, the default icon is used. Possible values are...
layer-moving-averages
layer-bands
layer-candles
layer-histogram
layer-oscilator
layer-resistance
layer-support
layer-trends
layer-volume Custom images may be added too. To do that:
1. Name the image in the following format: image-name.png;
2. Place images in the WebServer\Images\Icons folder;
3. In the configuration of the module, use the name as is (e.g.: "icon": "image-name")
Initial Values
These are the Initial Values for Plotter Module configuration:
{
"codeName": "Module-Name",
"icon": "histogram|band|moving-average|oscillator|trend"
} Examples
This is a list of properties featured by the Plotter Module configuration. Expanding a property shows sample values for the property extracted from the current Workspace.
Plotter Module Menu
The Plotter Module node has the following Node Menu items:
The Configure menu item has the following properties:
- action: Configure
- actionFunction:
uiObject.configEditor.activate
- label: Configure
- iconPathOn: configuration
- iconPathOff: configuration
The Add Shapes menu item has the following properties:
- action: Add UI Object
- disableIfPropertyIsDefined: true
- propertyToCheckFor: shapes
- actionFunction:
payload.executeAction
- label: Add Shapes
- relatedUiObject: Shapes
- actionProject: Visual-Scripting
- relatedUiObjectProject: Foundations
The Add Javascript Code menu item has the following properties:
- action: Add UI Object
- disableIfPropertyIsDefined: true
- propertyToCheckFor:
plotterModuleJavascriptCode
- actionFunction:
payload.executeAction
- label: Add Javascript Code
- relatedUiObject: Plotter Module Javascript Code
- actionProject: Visual-Scripting
- relatedUiObjectProject: Foundations
The Add Plotter Panel menu item has the following properties:
- action: Add UI Object
- actionFunction:
payload.executeAction
- label: Add Plotter Panel
- relatedUiObject: Plotter Panel
- actionProject: Visual-Scripting
- relatedUiObjectProject: Foundations
The Add Missing Children menu item has the following properties:
- action: Add Missing Children
- label: Add Missing Children
- relatedUiObject: Trading Parameters
- actionFunction:
payload.executeAction
- actionProject: Visual-Scripting
- relatedUiObjectProject: Foundations
The Delete menu item has the following properties:
- action: Delete UI Object
- actionProject: Visual-Scripting
- askConfirmation: true
- confirmationLabel: Confirm to Delete
- actionFunction:
payload.executeAction
- label: Delete
- iconPathOn: delete-entity
- iconPathOff: delete-entity
Tip: When a menu item is grayed out, it means that Plotter Module already has the required child type that the menu item may add, and only that child is allowed for that case.
Plotter Module Children
The Plotter Module node has the following childrenNodesProperties:
The Plotter Module Javascript Code node property features the following properties:
- name:
plotterModuleJavascriptCode
- type: node
- childType: Plotter Module Javascript Code
The Shapes node property features the following properties:
- name: shapes
- type: node
- childType: Shapes
- autoAdd: true
The Panels node property features the following properties:
- name: panels
- type: array
- childType: Plotter Panel
- autoAdd: true
The Nodes Values node property features the following properties:
- name:
nodesValues
- type: node
- childType: Nodes Values
- autoAdd: false
The Nodes Highlights node property features the following properties:
- name:
nodesHighlights
- type: node
- childType: Nodes Highlights
- autoAdd: false
The Nodes Errors node property features the following properties:
- name:
nodesErrors
- type: node
- childType: Nodes Errors
- autoAdd: false
The Nodes Warnings node property features the following properties:
- name:
nodesWarnings
- type: node
- childType: Nodes Warnings
- autoAdd: false
The Nodes Infos node property features the following properties:
- name:
nodesInfos
- type: node
- childType: Nodes Infos
- autoAdd: false
The Nodes Status node property features the following properties:
- name:
nodesStatus
- type: node
- childType: Nodes Status
- autoAdd: false
The Nodes Progress node property features the following properties:
- name:
nodesProgress
- type: node
- childType: Nodes Progress
- autoAdd: false
The Nodes Running node property features the following properties:
- name:
nodesRunning
- type: node
- childType: Nodes Running
- autoAdd: false
The Nodes Announcements node property features the following properties:
- name:
nodesAnnouncements
- type: node
- childType: Nodes Announcements
- autoAdd: false
The Record Values node property features the following properties:
- name:
recordValues
- type: node
- childType: Record Values
- autoAdd: false
Plotter Module Attaching Rules
The following are the Node Attaching Rules that govern the attachment of Plotter Module with other nodes:
Compatible Types: