getYear() – EFS

The getYear() function is used to create a Series Object of the year values or to retrieve individual year values.

Syntax

getYear( [ nBarIndex ][, sym() | inv() ] )

Parameters

Parameter:	Description:	Default:
nBarIndex	[Optional] Number of bar index of series to retrieve	n/a
sym() or inv()	[Optional] Function of sym() or inv() to determine source for year values.	n/a

Return Value(s)

Returns a Series Object when nBarIndex is not specified.

Returns a single value when nBarIndex is specified.

Notes

N/A

Code Examples

function main() {
	
	//retrieve the value for the current price bar
 	myVar = getYear(0);
	//retrieve the value for the previous price bar
 	myVar = getYear(-1);
	//retrieve the current value for a specific symbol
 	myVar = getYear(0, sym("IBM") );
	//retrieve the current value for a specific symbol/interval
 	myVar = getYear(0, sym("IBM,5") );
	//retrieve the current value for a specific bar interval
 	myVar = getYear(0, inv(15) );
	//create a Series Object of the year values.
 	xYear = getYear();
	//create a Series Object of the year values for a specific symbol.
 	xYear = getYear( sym("IBM") );
	//create a Series Object of the year values for a specific symbol/interval.
 	xYear = getYear( sym("IBM,5") );
 	//create a Series Object of the year values for a specific interval.
 	xYear = getYear( inv(15) );
 
}