yeartodate - スクリプトおよびチャート関数
この関数は、入力したタイムスタンプがスクリプトが最後にロードされた日付の年に該当するかどうかを算出し、該当する場合は True を返し、該当しない場合は False を返します。
構文:
YearToDate(timestamp[ , yearoffset [ , firstmonth [ , todaydate] ] ])
戻り値データ型: ブール値
オプションのパラメータがどれも使用されていない場合、年初から当日までとは、さかのぼって直近の 1 月 1 日からスクリプトを最後に実行した日付までを含む 1 暦年以内のいずれかの日付を意味します。
引数:
引数 | 説明 |
---|---|
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 を指定することにより (省略した場合は最後にスクリプトを実行したタイムスタンプ)、期間の上限として使用する日付を移動できます。 |