Interface DrawingTool

Definition for a Custom Drawing Tool for use in the Trader application. This is the module.exports portion of the Custom Drawing Tool.

 //an example drawing tool export

 module.exports = {
     name: 'MyCustomDrawingTool',
     drawing: MyDrawingImplementation,
     description: 'My Custom Tool',
     params: {
         period: predef.paramSpecs.period(13)
     }
 }

Hierarchy

DrawingTool

Properties

description

drawing

maxN

minN

name

params

plots

Properties

description: string

Readable text that is used in the UI. Optional.

drawing: DrawingToolImplementation

Calculation algorithms

maxN: number

Maximum number of anchors that this drawing tool can have.

minN: number

Minimum number of anchors that this drawing tool can have.

name: string

Unique identifier associated with the indicator.

params: ParameterDefinitions

Set of input parameters. Optional.

plots: Plots

Output results for displaying. Optional. If not specified, the application will expect a numeric output or value field of the output object.

tags: readonly string[]

How to group with other similar indicators in UI dropdown menu.

Generated using TypeDoc