efsExternal()

ICE Data Services -

efsExternal() Series Functions

Returns a Series Object representing the values as calculated from the given external EFS script.

Syntax
efsExternal( sFilePath [, parameters ][, sym() | inv() ] )

Parameters
Parameter: Description: Default:
sFilePath Required. 
String of the path and file name to be called.

 

n/a parameters [Optional]  Function parameters separated by commas that are expected by the called formula (if any).

 

n/a sym() or        inv() [Optional]  Function of sym() or inv() to determine source for series' return values.

 

n/a
Return Value(s)
Returns a Series Object or an array of Series Objects.

Notes
This function in only available in version 7.9 (build 719) or later.

This function is not compatible with setComputeOnClose() or the global set compute on close option listed in EFS Settings (Tools-->EFS-->Settings).

If function parameters are being passed, all parameters must be passed that the formula is expecting.

For a code example used to access the individual Series Objects that are returned in an array from efsExternal(), see getSeries().


Code Examples

var xStudy = null;function main() {    //call an external EFS called "myCustomEFS.efs" and load it into    //the context of IBM 15-min bars. we also pass three parameters    //to the script.    if (xStudy == null) xStudy = efsExternal( "myCustomEFS.efs", 20, 5, sym( "IBM,15" ) );    //assuming that "myCustomEFS.efs" returns only one data series   var myPlot = xStudy.getValue(0);    return myPlot;}


See Also
Series Functions
eSignal Bulletin Board Search Engine
Help Guides and Tutorials