Calendar (캘린더) Widget Control
スクリプトからCalendarウィジェットを制御するときに使用するWidget Control(Property · Method · Event)の一覧です。ウィジェットの紹介と使い方はCalendarをご覧ください。
下記の例のcalendarIDは、キャンバスでCalendarウィジェットに指定した名前(ID)です。スクリプトではwidgetID.memberの形式でアクセスします。
Widget Control一覧
| Widget Control | 種類 | シグネチャ | 説明 |
|---|---|---|---|
selectedDate | Property(読み取り専用) | calendarID.selectedDate | 現在選択されている日付をyyyyMMdd形式の文字列で返す |
eventDate | Property(書き込み専用) | calendarID.eventDate = [...] | イベントドットとして表示する日付リストを設定 |
goToDay | Method | calendarID.goToDay(date) | 指定した日付へ移動 |
goToToday | Method | calendarID.goToToday() | 今日へ移動 |
expand | Method | calendarID.expand() | 月全体表示に展開 |
collapse | Method(Deprecated) | calendarID.collapse() | 週表示に縮小(deprecated) |
onPageChanged | Event | onPageChanged = (date) => { ... } | 表示中の月(ページ)が変わったときに実行 |
onDateSelected | Event | onDateSelected = (date) => { ... } | 日付を選択したときに実行 |
Property
selectedDate
現在選択されている日付をyyyyMMdd形式の文字列で返します。選択された日付がない場合は空文字列('')を返します。
- 種類: Property(読み取り専用)
- 型:
string(yyyyMMdd形式)
Example
const date = calendarID.selectedDate; // 例: "20260622" または ""
eventDate
カレンダーにイベントドットとして表示する日付リストを設定します。各日付はyyyyMMdd形式の文字列でなければなりません。
- 種類: Property(書き込み専用)
- 型: 文字列の配列(
string[]、各要素はyyyyMMdd形式)
Example
calendarID.eventDate = ["20260622", "20260625"];
Method
goToDay(date)
カレンダーを指定した日付へ移動させます。値を日付として解釈できない場合は何も起こりません。
- Parameters:
date- 移動先の日付(yyyyMMdd形式の文字列) - Returns: なし(
void)
Example
calendarID.goToDay("20260622");
goToToday()
カレンダーを今日の日付へ移動させます。
- Parameters: なし
- Returns: なし(
void)
Example
calendarID.goToToday();
expand()
カレンダーを月全体表示に展開します。
- Parameters: なし
- Returns: なし(
void)
Example
calendarID.expand();
collapse()
カレンダーを週表示に縮小します。
collapse()はdeprecated(非推奨)なメソッドです。Lucy Studioのスクリプト自動補完リストで取り消し線が表示されるのもこのためです。現在は正常に動作し週表示に切り替わりますが、今後のバージョンで削除される可能性があります。カレンダーの月/週の表示形式は、ウィジェットのcalendarFormatプロパティ(month/week)で制御することをおすすめします。
- Parameters: なし
- Returns: なし(
void)
Example
calendarID.collapse();
Event
onPageChanged
表示中の月(ページ)が変わったときに実行されます。実行する動作はコールバック関数で指定します。
- 種類: Event
- ハンドラー:
(date) => { ... }-dateは新しく表示されたページの基準日(yyyyMMdd形式) - Returns: なし
Example
calendarID.onPageChanged = (date) => {
// ページ(月)が変わったときに実行するコード
};
onDateSelected
ユーザーが日付を選択したときに実行されます。実行する動作はコールバック関数で指定します。
- 種類: Event
- ハンドラー:
(date) => { ... }-dateは選択された日付(yyyyMMdd形式) - Returns: なし
Example
calendarID.onDateSelected = (date) => {
// 日付を選択したときに実行するコード
};
共通Widget Control(すべてのウィジェット)
すべてのウィジェットは、setProperty / getProperty / setStylePropertyのような名前ベースの共通Widget Control(Method)を使用できます。共通リファレンスドキュメント(作成予定)をご覧ください。