# yeartodate — скрипт и функция диаграммы

Эта функция определяет, находится ли введенная дата в том году, в котором находится дата последней загрузки скрипта, и возвращает значение True, если это так, и False если это не так.

Синтаксис:

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

**Тип возврата данных:** Boolean

Если дополнительные параметры не используются, то значение данной функции может быть любой датой в пределах одного календарного года с 1 января до даты последнего выполнения скрипта включительно.

Аргументы:

аргументы YearToDate

| Аргумент | Описание |
| --- | --- |
| timestamp | Дата для вычисления в виде метки времени или выражения, определяемого по метке времени, для преобразования, например '2012-10-12'. |
| yearoffset | При указании элемента yearoffset, элемент yeartodate возвращает значение True для того же периода в другом году. Отрицательный элемент yearoffset указывает предыдущий год, положительное смещение — будущий год. Наиболее поздняя дата с начала года до последнего момента достигается путем указания yearoffset = -1. Если значение не указано, принимается 0. |
| firstmonth | Если в поле firstmonth задать значение от 1 до 12 (1, если значение не указано), то начало года может быть передвинуто вперед на первый день любого месяца. Если, например, необходимо работать в рамках финансового года, начинающегося 1 мая, задайте firstmonth = 5. |
| todaydate | Задав значение todaydate (метка времени последнего выполнения скрипта, если не указано), можно сместить день, используемый в качестве верхней границы периода. |

Примеры и результаты:

В следующих примерах предполагается время последней перезагрузки = 2011–11–18

Примеры и результаты

| Пример | Результат |
| --- | --- |
| `yeartodate( '2010-11-18')` | возвращает False |
| `yeartodate( '2011-02-01')` | возвращает True |
| `yeartodate( '2011-11-18')` | возвращает True |
| `yeartodate( '2011-11-19')` | возвращает False |
| `yeartodate( '2011-11-19', 0, 1, '2011-12-31')` | возвращает True |
| `yeartodate( '2010-11-18', -1)` | возвращает True |
| `yeartodate( '2011-11-18', -1)` | возвращает False |
| `yeartodate( '2011-04-30', 0, 5)` | возвращает False |
| `yeartodate( '2011-05-01', 0, 5)` | возвращает True |