본문으로 건너뛰기

Calendar (캘린더) Widget Control

Calendar(캘린더) 위젯을 스크립트에서 제어할 때 사용하는 Widget Control(Property · Method · Event) 목록입니다. 위젯 소개와 사용법은 Calendar 문서를 참고하세요.

정보

아래 예시의 calendarID는 캔버스에서 Calendar 위젯에 지정한 이름(ID)입니다. 스크립트에서는 위젯ID.멤버 형태로 접근합니다.

Widget Control 요약

Widget Control종류시그니처설명
selectedDateProperty (읽기 전용)calendarID.selectedDate현재 선택된 날짜를 yyyyMMdd 문자열로 반환
eventDateProperty (쓰기 전용)calendarID.eventDate = [...]이벤트 점으로 표시할 날짜 목록 설정
goToDayMethodcalendarID.goToDay(date)지정한 날짜로 이동
goToTodayMethodcalendarID.goToToday()오늘로 이동
expandMethodcalendarID.expand()월 전체 보기로 확장
collapseMethod (Deprecated)calendarID.collapse()주간 보기로 축소 (deprecated)
onPageChangedEventonPageChanged = (date) => { ... }보이는 월(페이지)이 바뀔 때 실행
onDateSelectedEventonDateSelected = (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(사용 권장하지 않음) 메서드입니다. 스튜디오 스크립트 자동완성 목록에서 취소선으로 표시되는 것도 이 때문입니다. 지금은 정상 동작하지만(주간 보기로 전환) 이후 버전에서 제거될 수 있습니다. 달력의 월/주 표시 형식은 위젯의 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)을 사용할 수 있습니다. 공통 레퍼런스 문서(작성 예정)를 참고하세요.