[]
デモ ヘルプ APIリファレンス
トライアル版
(Showing Draft Content)

Inputman.HolidayGroup

HolidayGroup クラス

休日グループのクラスです。

階層

  • HolidayGroup

コンストラクタ

プロパティ

メソッド

コンストラクタ

constructor

  • new HolidayGroup(name?: string, isActive?: boolean): HolidayGroup

  • 引数

    • オプション name: string
    • オプション isActive: boolean

    戻り値 HolidayGroup

プロパティ

読み取り専用 count

count: number

保持されている休日の個数を取得します。

参照：getHolidaysCount

isActive

isActive: boolean

休日スタイルをアクティブにするかどうかの値を取得または設定します。

参照：getIsActive 参照：setIsActive

メソッド

addHoliday

  • 休日を追加します。

    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);

    引数

    戻り値 void

clearHolidays

  • clearHolidays(): void

  • すべての休日を削除します。

    戻り値 void

getHoliday

  • getHoliday(index: number): Holiday

  • 特定の休日を取得します。

    引数

    • index: number

    戻り値 Holiday

getHolidayIndex

  • getHolidayIndex(item: Holiday): void

  • 特定の休日のインデックスを取得します。

    引数

    戻り値 void

    インデックス。

getHolidaysCount

  • getHolidaysCount(): number

  • 保持されている休日の個数を取得します。
    参照：count

    戻り値 number

    休日の個数

getIsActive

  • getIsActive(): boolean

  • 休日スタイルをアクティブにするかどうかを取得します。
    参照：isActive

    戻り値 boolean

    アクティブにする場合はtrue、それ以外はfalse。

getOverride

  • 休日が休日と設定された曜日と重なった場合に翌日に振り替えるかどうかを取得します。

    引数

    • weekday: string

      休日と設定された曜日（"sunday"、"monday"、"tuesday"、"wednesday"、"thursday"、"friday"、"saturday"）。

    戻り値 HolidayOverride

    振り替える方法を示す値

getWeekFlags

  • どの週の曜日を対象とするかを取得または設定します。

    引数

    • weekday: string

      休日にする曜日（"sunday"、"monday"、"tuesday"、"wednesday"、"thursday"、"friday"、"saturday"）。

    戻り値 WeekFlags

    対象となる週を示す値（WeekFlags列挙体）

insertHoliday

  • insertHoliday(index: number, item: Holiday): void

  • 指定のインデックスに休日を追加します。

    引数

    • index: number

      休日を追加するインデックス。

    • item: Holiday

      Holidayオブジェクト。

    戻り値 void

removeHoliday

  • removeHoliday(item: Holiday): void

  • 特定の休日を削除します。

    引数

    • item: Holiday

      削除するHolidayオブジェクト。

    戻り値 void

removeHolidayAt

  • removeHolidayAt(index: number): void

  • 特定のインデックスにある休日を削除します。

    引数

    • index: number

      削除する休日のインデックス。

    戻り値 void

setIsActive

  • setIsActive(isActive: boolean): void

  • 休日スタイルをアクティブにするかどうかを設定します。
    参照：isActive

    引数

    • isActive: boolean

      アクティブにする場合はtrue、それ以外はfalse。

    戻り値 void

setOverride

  • 休日が休日と設定された曜日と重なった場合に翌日に振り替えるかどうかを設定します。

    引数

    • weekday: string

      休日と設定された曜日（"sunday"、"monday"、"tuesday"、"wednesday"、"thursday"、"friday"、"saturday"）。

    • overrideFlag: HolidayOverride

      振り替える方法を示す値（HolidayOverride列挙体）。

    戻り値 void

setWeekFlags

  • setWeekFlags(weekday: string, flags: WeekFlags): void

  • どの週の曜日を対象とするかを取得または設定します。

    引数

    • weekday: string

      休日にする曜日（"sunday"、"monday"、"tuesday"、"wednesday"、"thursday"、"friday"、"saturday"）。

    • flags: WeekFlags

      対象となる週を示す値（WeekFlags列挙体）。

    戻り値 void