yeartodate – função de script e gráfico

Esta função descobre se o carimbo de data e hora de entrada cai dentro de um ano da data em que o script foi carregado pela última vez, e retorna True se cair, False se não cair.

Syntax:  

YearToDate(timestamp[ , yearoffset [ , firstmonth [ , todaydate] ] ])

 

Return data type: Booleano

Se nenhum dos parâmetros opcionais for usado, o acumulado no ano será qualquer data que ocorrer dentro de um ano civil, a partir de 1º de janeiro até a data da última execução do script, inclusive.

Arguments:  

Argumento Descrição
timestamp O carimbo de data e hora para avaliar, por exemplo, '2012-10-12'.
yearoffset

Ao especificar um yearoffset, yeartodate retorna True para o mesmo período em outro ano. Um yearoffset negativo indica um ano anterior e um offset positivo um ano futuro. O year-to-date mais recente é alcançado ao especificar yearoffset = -1. Se omitido, o valor 0 é assumido.
firstmonth

Ao especificar um firstmonth entre 1 e 12 (1, se omitido), o início do ano pode avançar para o primeiro dia de qualquer mês. Por exemplo, para trabalhar com um ano fiscal que inicia em 1º de maio, especifique firstmonth = 5.

todaydate Ao especificar um todaydate (carimbo de data/hora da execução do último script, se omitido), é possível mover o dia usado como o limite superior do período.