# yeartodate - スクリプトおよびチャート関数

この関数は、入力した日付がスクリプトが最後にロードされた日付の年に該当するかどうかを算出し、該当する場合は True を返し、該当しない場合は False を返します。

構文:

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

**戻り値データ型：**ブール値

オプションのパラメータがどれも使用されていない場合、年初から当日までとは、さかのぼって直近の 1 月 1 日からスクリプトを最後に実行した日付までを含む 1 暦年以内のいずれかの日付を意味します。

引数：

YearToDate 引数

| 引数 | 説明 |
| --- | --- |
| timestamp | 例えば、'2012-10-12' のように、変換するタイムスタンプまたは計算結果がタイムスタンプになる数式として評価する日付。 |
| yearoffset | yearoffset を指定することで、yeartodate は、別の年の同じ期間について True を返します。負の値の yearoffset は過去の年を示し、正の値の場合は将来の年を示します。前年 1 年間を取得するときは、yearoffset = -1 を指定します。省略された場合は、0 として処理されます。 |
| firstmonth | firstmonth を 1 から 12 の間で指定することにより (省略した場合は 1)、年の始めを任意の月の 1 日に移動することができます。例えば、会計年度を 5 月 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 |