Custom Command Helpers¶
DefineCommand¶
This defines the name and description of the custom command. This information will reflect in commands/block lists and help models.
Syntax: DefineCommand(name, description)
Return type: Void
| Parameter Name | Parameter Type | Required | Suggestions |
|---|---|---|---|
| name | String | True | |
| description | String | True |
DefineEasyIndicatorOutput¶
Defines the signal output for the custom indicator.
Syntax: DefineEasyIndicatorOutput(result)
Return type: Void
| Parameter Name | Parameter Type | Required | Suggestions |
|---|---|---|---|
| result | Enum | True | Equals,DoSignal,PlotSignalEnum,ConvertSignal,IgnoreSignalIf,UseSignalIf,ReverseSignal,SignalWeight,SignalToBool,SignalMapper,SignalProperties,GetWeightedConsensusSignal,GetUnanimousSignal,GetConsensusSignal,IndicatorContainer,TradeBotContainer,EasyABANDS,EasyADOSC,EasyAO,EasyAPO,EasyAROON,EasyAROONOSC,EasyBBANDS,EasyBOP,EasyCCI,EasyCMO,EasyCOPPOCK,EasyCRSI,EasyDMI,EasyDONCHIAN,EasyDPO,EasyDX,EasyICHIMOKU,EasyIMI,EasyKELTNER,EasyKRI,EasyLINEARREG,EasyMA,EasyMACD,EasyMFI,EasyMOM,EasyOBV,EasyPPO,EasyROC,EasyRSI,EasySSTOCH,EasySTOCH,EasySTOCHF,EasyTRIX,EasyTSI,EasyUDRSI,EasyWILLR,EasyZLMA,EasyAlice,EasyCDL,EasySLOWRSI,EasyFASTRSI,EasyBBANDSB,EasyBBANDSW,EasySTOCHRSI,EasyFIBONACCI,EasyKST,EasySAR,EasyDynamicLongShortLevels,EasyFixedLongShortLevels,EasyULTOSC |
DefineEasyIndicatorParameters¶
Defines the chartIndex and interval parameter.
Syntax: DefineEasyIndicatorParameters([ chartIndex ])
Returns a list with values.
Return type: Dynamic
| Parameter Name | Parameter Type | Required | Suggestions |
|---|---|---|---|
| chartIndex | Number | False | Input,Number,SessionGet |
DefineIntervalOptimization¶
Optimizes the custom command for back tests. Only use this if the command needs updates once every interval tick.
Syntax: DefineIntervalOptimization(interval)
Return type: Void
| Parameter Name | Parameter Type | Required | Suggestions |
|---|---|---|---|
| interval | Number | True | DefineParameter,DefineEasyIndicatorOutput |
DefineOutput¶
Defines the output type and data.
Syntax: DefineOutput(type, [ value ], [ description ], [ outputSuggestions ])
Return type: Void
| Parameter Name | Parameter Type | Required | Suggestions |
|---|---|---|---|
| type | Enum | True | NumberType,ListNumberType,BooleanType,ListDynamicType,StringType,DynamicType,VoidType,EnumType |
| value | Dynamic | False | |
| description | String | False | |
| outputSuggestions | String | False |
DefineOutputIndex¶
Creates an index based output connection to be used in the visual editor.
Syntax: DefineOutputIndex(index, type, name, description, [ outputSuggestions ])
Return type: Void
| Parameter Name | Parameter Type | Required | Suggestions |
|---|---|---|---|
| index | Number | True | |
| type | Enum | True | NumberType,ListNumberType,BooleanType,ListDynamicType,StringType,DynamicType,VoidType,EnumType |
| name | String | True | |
| description | String | True | |
| outputSuggestions | String | False |
DefineParameter¶
Defines the parameter for a custom command.
Syntax: DefineParameter(type, name, description, isRequired, defaultValue, [ inputSuggestions ])
Returns the giving parameter or default value.
Return type: Dynamic
| Parameter Name | Parameter Type | Required | Suggestions |
|---|---|---|---|
| type | Enum | True | NumberType,ListNumberType,BooleanType,ListDynamicType,StringType,DynamicType,VoidType,EnumType |
| name | String | True | |
| description | String | True | Text |
| isRequired | Boolean | True | True,False |
| defaultValue | Dynamic | True | Text,Number,SessionGet,Load |
| inputSuggestions | String | False |