Inputman.GcCalendar

GcCalendar クラス

カレンダーコントロールを表します。

階層

GcCalendar

コンストラクタ

constructor

プロパティ

メソッド

イベント

コンストラクタ

constructor

new GcCalendar(container: HTMLElement, config?: GcCalendarConfig): GcCalendar

引数
- container: HTMLElement
  
  GcCalendarコントロールのコンテナとなるHTML要素
- オプション config: GcCalendarConfig
  
  It's a optional setting object to init GcCalendar.
戻り値 GcCalendar

プロパティ

allowSelection

allowSelection: AllowSelection

選択する日付の種別を設定または取得します。

参照：setAllowSelection

autoSwitch

autoSwitch: boolean

カレンダーの自動切り替えを有効するかどうかを設定または取得します。

参照：setOverrideTipText

calendarType

calendarType: CalendarType

カレンダーのタイプを設定または取得します。

参照：setCalendarType

calendarYear

calendarYear: CalendarYear

カレンダーを会計年度の形式で表示するかどうかを設定または取得します。

参照：setCalendarYear

読み取り専用 calendarZoomRange

calendarZoomRange: CalendarZoomRange

カレンダーのズーム範囲をMonthDayまたはLargeScaleYearに設定するかを取得します。

読み取り専用 componentName

componentName: string

コンポーネント名（'GcCalendar'）を取得します。

dimensions

dimensions: Dimensions

コントロールに表示する月数を設定または取得します。

参照：setCalendarDimensions

emptyRows

emptyRows: EmptyRows

その月の日付を含まない空白行の描画方法を設定または取得します。

参照：setEmptyRows

enabled

enabled: boolean

コントロールやオブジェクトを有効にするかどうかを示す値を設定または取得します。

参照：setEnabled

firstDayOfWeek

firstDayOfWeek: DayOfWeek

カレンダーの最初の列に表示する曜日を設定または取得します。

参照：setFirstDayOfWeek

firstFiscalMonth

firstFiscalMonth: Months

会計年度の最初の月を設定または取得します。

参照：setFirstFiscalMonth

firstMonthInView

firstMonthInView: Months

12か月分のカレンダーを表示している場合に、左上に配置する最初の月を設定または取得します。

参照：setFirstMonthInView

focusDate

focusDate: Date

フォーカスを持っている日付を取得または設定します。

参照：getFocusDate 参照：setFocusDate

headerFormat

headerFormat: string

カレンダーのヘッダに使用する書式を設定または取得します。

参照：setHeaderFormat

読み取り専用 holidayGroupsCount

holidayGroupsCount: number

カレンダーに設定されている休日グループの個数を取得します。

参照：getHolidayGroupsCount

maxDate

maxDate: Date

選択可能な日付の最大値を設定または取得します。

参照：setMaxDate

maxSelectionCount

maxSelectionCount: number

ユーザーが選択できる最大日数を設定または取得します。

参照：setMaxSelectionCount

minDate

minDate: Date

選択可能な日付の最小値を設定または取得します。

参照：setMinDate

navigatorOrientation

navigatorOrientation: NavigatorOrientation

ナビゲータを表示する位置を設定または取得します。

参照：setNavigatorOrientation

overrideTipText

overrideTipText: string

振替休日のためのツールチップテキストを設定または取得します。

参照：setOverrideTipText

scrollRate

scrollRate: number

ナビゲータのスキップボタン１回の操作で移動する月の数を取得または設定します。通常、dimensionsと一緒に使用されます。たとえば、dimensionsが3 * 2の場合、このプロパティ値を6に設定できます。その結果、スキップボタンをクリックすると６ヵ月移動します。

selectedDate

selectedDate: Date

選択されている日付を取得または設定します。

参照：getSelectedDate 参照：setSelectedDate

selectionMode

selectionMode: CalendarSelectionMode

カレンダー内で日付を選択する方法を設定または取得します。

参照：setSelectionMode

selections

selections: Date[]

複数選択モードのとき、選択された日付の配列を取得または設定します。

参照：getSelections 参照：setSelections

showAnimation

showAnimation: boolean

アニメーション効果を適用するかどうかを設定または取得します。

参照：setOverrideTipText

showHeader

showHeader: boolean

カレンダーのヘッダを表示するかどうかを設定または取得します。

参照：setShowHeader

showNavigator

showNavigator: CalendarNavigators

表示するナビゲータの種類を設定または取得します。

参照：setShowNavigator

showRokuyou

showRokuyou: Rokuyou

日付領域に表示する六曜を設定または取得します。

参照：setShowRokuyou

showToday

showToday: boolean

カレンダーの下側に今日の日付を表示するかどうかを設定または取得します。

参照：setShowToday

showTrailing

showTrailing: boolean

前後の月の隣接日をカレンダーに表示するかどうかを設定または取得します。

参照：setShowTrailing

showWeekNumber

showWeekNumber: boolean

各週の左側に通年で第何週に相当するかを表示するかどうかを設定または取得します。

参照：setShowWeekNumber

showZoomButton

showZoomButton: boolean

カレンダータイプを切り替えるズームボタンを表示するかどうかを設定または取得します。

参照：setShowZoomButton

visible

visible: boolean

コントロールをページに表示するかどうかを示す値を設定または取得します。

参照：setVisible

weekNumberSelect

weekNumberSelect: boolean

週番号のクリックで週全体を選択するかどうか設定または取得します。

参照：setWeekNumberSelect

weekTitleSelect

weekTitleSelect: boolean

曜日タイトルのクリックで、その曜日全部を選択するかどうか設定または取得します。

参照：setWeekTitleSelect

yearMonthFormat

yearMonthFormat: string

年-月カレンダーの年と月の書式を設定または取得します。

参照：setYearMonthFormat

メソッド

addHolidayGroup

addHolidayGroup(item: HolidayGroup): void

カレンダーに休日グループを追加します。

var gcCalendar1 = new GC.InputMan.GcCalendar(document.getElementById("gcCalendar1"));
var holidayGroup1 = new GC.InputMan.HolidayGroup("holiday-group-1", true);
gcCalendar1.addHolidayGroup(holidayGroup1);

// 1月1日から1月10日までを休日にします。
var holiday1 = new GC.InputMan.Holiday("holiday1", 1, 1, 1, 10);
holidayGroup1.addHoliday(holiday1);

引数

item: HolidayGroup

戻り値 void

clearHolidayGroups

clearHolidayGroups(): void

カレンダーからすべての休日グループを削除します。

戻り値 void

getFocusDate

getFocusDate(): Date

フォーカスを持っている日付を取得します。
参照：focusDate

戻り値 Date

フォーカスを持つ日付。

getHolidayGroup

getHolidayGroup(item: string | number): HolidayGroup

休日グループをインデックスまたは名前で取得します。

引数
- item: string | number
  
  休日グループのインデックスまたは名前
戻り値 HolidayGroup

getHolidayGroupIndex

getHolidayGroupIndex(item: HolidayGroup): number

特定の休日グループを表すゼロベースのインデックスを取得します。

引数
- item: HolidayGroup
  
  休日グループ
戻り値 number

休日グループのインデックス

getHolidayGroupsCount

getHolidayGroupsCount(): number

カレンダーに設定されている休日グループの個数を取得します。
参照：holidayGroupsCount

戻り値 number

休日グループの個数

getSelectedDate

getSelectedDate(): Date

選択されている日付を取得します。
参照：selectedDate

戻り値 Date

選択されている日付。

getSelections

getSelections(): Date[]

複数選択モードのとき、選択された日付の配列を取得します。
参照：selections

戻り値 Date []

Dateオブジェクトの配列。

getWeekday

getWeekday(weekday: string): WeekDay

日付スタイル設定の対象となる曜日を取得します。

引数
- weekday: string
  
  対象となる曜日を示す値（"sunday"、"monday"、"tuesday"、"wednesday"、"thursday"、"friday"、"saturday"）。
戻り値 WeekDay

日付スタイル設定の対象となる曜日（WeekDayオブジェクト）。

insertHolidayGroup

insertHolidayGroup(index: number, item: HolidayGroup): void

カレンダーの特定のインデックスの位置に休日グループを挿入します。

引数
- index: number
  
  休日グループを挿入する位置のインデックス
- item: HolidayGroup
  
  挿入する休日を定義したHolidayGroupオブジェクト
戻り値 void

removeHolidayGroup

removeHolidayGroup(item: HolidayGroup): void

特定の休日グループを削除します。

引数
- item: HolidayGroup
  
  削除する休日グループ
戻り値 void

removeHolidayGroupAt

removeHolidayGroupAt(index: number): void

特定のインデックス位置にある休日グループを削除します。

引数
- index: number
  
  削除する休日グループの位置を表すインデックス
戻り値 void

scrollMonth

scrollMonth(value: number): this

指定した月数だけカレンダーをスクロールします。

引数
- value: number
  
  スクロールする月数。
戻り値 this

scrollYear

scrollYear(value: number): this

指定した年数だけカレンダーをスクロールします。

引数
- value: number
  
  スクロールする年数。
戻り値 this

setAllowSelection

setAllowSelection(value: AllowSelection): void

選択する日付の種別を設定します。
参照：allowSelection

引数
- value: AllowSelection
  
  選択する日付の種別を示す値（AllowSelection列挙体）。
戻り値 void

setCalendarDimensions

setCalendarDimensions(width: number, height: number): void

コントロールに表示する月数を設定します。
参照：dimensions

引数
- width: number
  
  水平方向に表示する月数。
- height: number
  
  垂直方向に表示する月数。
戻り値 void

setCalendarType

setCalendarType(value: CalendarType): this

カレンダーのタイプを設定します。
参照：calendarType

引数
- value: CalendarType
  
  カレンダータイプを示す値（CalendarType列挙体）。
戻り値 this

setCalendarYear

setCalendarYear(value: CalendarYear): void

カレンダーを会計年度の形式で表示するかどうかを設定します。
参照：calendarYear

引数
- value: CalendarYear
  
  カレンダーの年度表示を示す値（CalendarYear列挙体）。
戻り値 void

setEmptyRows

setEmptyRows(value: EmptyRows): void

その月の日付を含まない空白行の描画方法を設定します。
参照：emptyRows

引数
- value: EmptyRows
  
  空白行の描画方法を示す値（EmptyRows列挙体）。
戻り値 void

setEnabled

setEnabled(value: boolean): this

コントロールやオブジェクトを有効にするかどうかを示す値を設定します。
参照：enabled

引数
- value: boolean
  
  有効にする場合はtrue、それ以外はfalse。
戻り値 this

setFirstDayOfWeek

setFirstDayOfWeek(value: DayOfWeek): void

カレンダーの最初の列に表示する曜日を設定します。
参照：firstDayOfWeek

引数
- value: DayOfWeek
  
  曜日を示す値（DayOfWeek列挙体）。
戻り値 void

setFirstFiscalMonth

setFirstFiscalMonth(value: Months): void

会計年度の最初の月を設定します。
参照：firstFiscalMonth

引数
- value: Months
  
  月を示す値（Months列挙体）。
戻り値 void

setFirstMonthInView

setFirstMonthInView(value: Months): void

12か月分のカレンダーを表示している場合に、左上に配置する最初の月を設定します。
参照：firstMonthInView

引数
- value: Months
  
  月を示す値（Months列挙体）。
戻り値 void

setFocusDate

setFocusDate(value: Date): this

フォーカスを持っている日付を設定します。
参照：focusDate

引数
- value: Date
  
  フォーカスを持つ日付。
戻り値 this

setHeaderFormat

setHeaderFormat(value: string): void

カレンダーのヘッダに使用する書式を設定します。
参照：headerFormat

var gcCalendar1 = new GC.InputMan.GcCalendar(document.getElementById("gcCalendar1"));
gcCalendar1.setCalendarType(GC.InputMan.CalendarType.MonthDay);
gcCalendar1.setHeaderFormat("ggg e年 M月");

引数

value: string

ヘッダに使用する書式。

戻り値 void

setMaxDate

setMaxDate(value: Date): void

選択可能な日付の最大値を設定します。
参照：maxDate

引数
- value: Date
  
  選択可能な最大日付。
戻り値 void

setMaxSelectionCount

setMaxSelectionCount(value: number): void

ユーザーが選択できる最大日数を設定します。
参照：maxSelectionCount

引数
- value: number
  
  選択可能な最大日数。
戻り値 void

setMinDate

setMinDate(value: Date): void

選択可能な日付の最小値を設定します。
参照：minDate

引数
- value: Date
  
  選択可能な最小日付。
戻り値 void

setNavigatorOrientation

setNavigatorOrientation(value: NavigatorOrientation): void

ナビゲータを表示する位置を設定します。
参照：navigatorOrientation

引数
- value: NavigatorOrientation
  
  ナビゲータの表示位置を示す値（NavigatorOrientation列挙体）。
戻り値 void

setOverrideTipText

setOverrideTipText(value: string): void

振替休日のためのツールチップテキストを設定します。
参照：overrideTipText

引数
- value: string
  
  振替休日のためのツールチップテキスト。
戻り値 void

setSelectedDate

setSelectedDate(value: Date, disableEvents?: boolean): this

選択されている日付を設定します。
参照：selectedDate

引数
- value: Date
  
  選択する日付。
- オプション disableEvents: boolean
  
  onSelectedDateChangedイベントを発生させない場合はtrue、それ以外はfalse。省略した場合はfalse。
戻り値 this

setSelectionMode

setSelectionMode(value: CalendarSelectionMode): void

カレンダー内で日付を選択する方法を設定します。
参照：selectionMode

引数
- value: CalendarSelectionMode
  
  選択方法を示す値（CalendarSelectionMode列挙体）。
戻り値 void

setSelections

setSelections(value: Date[]): any

複数選択モードのときに、複数の日付を選択します。
参照：selections

引数
- value: Date[]
  
  Dateオブジェクトの配列。
戻り値 any

setShowHeader

setShowHeader(value: boolean): void

カレンダーのヘッダを表示するかどうかを設定します。
参照：showHeader

引数
- value: boolean
  
  表示する場合はtrue、それ以外はfalse。
戻り値 void

setShowNavigator

setShowNavigator(value: CalendarNavigators): void

表示するナビゲータの種類を設定します。
参照：showNavigator

引数
- value: CalendarNavigators
  
  ナビゲータの種類を示す値（CalendarNavigators列挙体）。
戻り値 void

setShowRokuyou

setShowRokuyou(value: Rokuyou): void

日付領域に表示する六曜を設定します。
参照：showRokuyou

引数
- value: Rokuyou
  
  六曜を示す値（Rokuyou列挙体）。
戻り値 void

setShowToday

setShowToday(value: boolean): void

カレンダーの下側に今日の日付を表示するかどうかを設定します。
参照：showToday

引数
- value: boolean
  
  表示する場合はtrue、それ以外はfalse。
戻り値 void

setShowTrailing

setShowTrailing(value: boolean): void

前後の月の隣接日をカレンダーに表示するかどうかを設定します。
参照：showTrailing

引数
- value: boolean
  
  隣接日を表示する場合はtrue、それ以外はfalse。
戻り値 void

setShowWeekNumber

setShowWeekNumber(value: boolean): void

各週の左側に通年で第何週に相当するかを表示するかどうかを設定します。
参照：showWeekNumber

引数
- value: boolean
  
  週番号を表示する場合はtrue、それ以外はfalse。
戻り値 void

setShowZoomButton

setShowZoomButton(value: boolean): void

カレンダータイプを切り替えるズームボタンを表示するかどうかを設定します。
参照：showZoomButton

引数
- value: boolean
  
  ズームボタンを表示する場合はtrue、それ以外はfalse。
戻り値 void

setVisible

setVisible(value: boolean): this

カレンダーを表示するかどうかを設定します。
参照：visible

引数
- value: boolean
  
  表示する場合はtrue、それ以外はfalse。
戻り値 this

setWeekNumberSelect

setWeekNumberSelect(value: boolean): void

週番号のクリックで週全体を選択するかどうか設定します。
参照：weekNumberSelect

引数
- value: boolean
  
  週全体を選択する場合はtrue、それ以外はfalse。
戻り値 void

setWeekTitleSelect

setWeekTitleSelect(value: boolean): void

曜日タイトルのクリックで、その曜日全部を選択するかどうか設定します。
参照：weekTitleSelect

引数
- value: boolean
  
  曜日全部を選択する場合はtrue、それ以外はfalse。
戻り値 void

setYearMonthFormat

setYearMonthFormat(value: string): void

年-月カレンダーの年と月の書式を設定します。
参照：yearMonthFormat
```
var gcCalendar1 = new GC.InputMan.GcCalendar(document.getElementById("gcCalendar1"));
gcCalendar1.setCalendarType(GC.InputMan.CalendarType.YearMonth);
gcCalendar1.setYearMonthFormat("ggg e年,M月");
```
引数
- value: string
  
  書式を示すキーワード。年の書式と月の書式はコンマ(,)で区切ります。
戻り値 void

イベント

ClickDate

ClickDate(callback: (sender: GcCalendar): void): any

日付がクリックされたときに発生します。
```
var gcCalendar1 = new GC.InputMan.GcCalendar(document.getElementById("gcCalendar1"));
gcCalendar1.onClickDate(gcCalendar1_onClickDate);
function gcCalendar1_onClickDate(sender, eArgs){
    alert("onClickDate");
}
```
引数
- callback: (sender: GcCalendar): void
  
  イベントハンドラ
  - - (sender: GcCalendar): void
    - 引数
      - sender: GcCalendar
        
        イベントが発生したコントロールのオブジェクト
      戻り値 void
戻り値 any

FocusDateChanged

FocusDateChanged(callback: (sender: GcCalendar): void): any

カレンダー上でフォーカス枠が移動したときに発生します。
```
var gcCalendar1 = new GC.InputMan.GcCalendar(document.getElementById("gcCalendar1"));
gcCalendar1.onFocusDateChanged(gcCalendar1_onFocusDateChanged);
function gcCalendar1_onFocusDateChanged(sender, eArgs){
    alert("onFocusDateChanged");
}
```
引数
- callback: (sender: GcCalendar): void
  
  イベントハンドラ
  - - (sender: GcCalendar): void
    - 引数
      - sender: GcCalendar
        
        イベントが発生したコントロールのオブジェクト
      戻り値 void
戻り値 any

Scrolled

Scrolled(callback: (sender: GcCalendar): void): any

カレンダーをスクロールしたときに発生します。

引数
- callback: (sender: GcCalendar): void
  
  イベントハンドラ
  - - (sender: GcCalendar): void
    - 引数
      - sender: GcCalendar
        
        イベントが発生したコントロールのオブジェクト
      戻り値 void
戻り値 any

SelectedDateChanged

SelectedDateChanged(callback: (sender: GcCalendar): void): any

直前に選択されていた日付とは異なる日付が選択されたときに発生します。
```
var gcCalendar1 = new GC.InputMan.GcCalendar(document.getElementById("gcCalendar1"));
gcCalendar1.onSelectedDateChanged(gcCalendar1_onSelectedDateChanged);
function gcCalendar1_onSelectedDateChanged(sender, eArgs){
    var selDate = sender.getSelectedDate();
    alert(selDate);
}
```
引数
- callback: (sender: GcCalendar): void
  
  コールバック
  - - (sender: GcCalendar): void
    - 引数
      - sender: GcCalendar
        
        イベントが発生したコントロールのオブジェクト
      戻り値 void
戻り値 any

Inputman.GcCalendar

GcCalendar クラス

階層

コンストラクタ

プロパティ

メソッド

イベント

コンストラクタ

constructor

引数

container: HTMLElement

オプション config: GcCalendarConfig

戻り値 GcCalendar

プロパティ

allowSelection

autoSwitch

calendarType

calendarYear

読み取り専用 calendarZoomRange

読み取り専用 componentName

dimensions

emptyRows

enabled

firstDayOfWeek

firstFiscalMonth

firstMonthInView

focusDate

headerFormat

読み取り専用 holidayGroupsCount

maxDate

maxSelectionCount

minDate

navigatorOrientation

overrideTipText

scrollRate

selectedDate

selectionMode

selections

showAnimation

showHeader

showNavigator

showRokuyou

showToday

showTrailing

showWeekNumber

showZoomButton

visible

weekNumberSelect

weekTitleSelect

yearMonthFormat

メソッド

addHolidayGroup

引数

item: HolidayGroup

戻り値 void

clearHolidayGroups

戻り値 void

getFocusDate

戻り値 Date

getHolidayGroup

引数

item: string | number

戻り値 HolidayGroup

getHolidayGroupIndex

引数

item: HolidayGroup

戻り値 number

getHolidayGroupsCount

戻り値 number

getSelectedDate

戻り値 Date

getSelections

戻り値 Date []

getWeekday

引数

weekday: string

戻り値 WeekDay

insertHolidayGroup

引数

index: number