CalendarInfoオブジェクト非推奨

代替オブジェクトはありません。

コンポーネント情報

コンポーネント概要

カレンダデータオブジェクト。

カレンダデータオブジェクトは下記のプロパティを持つObject型のオブジェクトです。

オブジェクト作成方法

   var obj = new Object();
   obj.id = "";
   obj.type = CalendarManager.TYPE_CONFIG;
   obj.name = "";
   obj.displayName = new Object();
   obj.displayName["ja"] = "";
   obj.displayName["en"] = "";
   obj.description = "";
   obj.year = 2005;
   obj.month = 1;
   obj.day = 1;
   obj.dayWeek = -1;
   obj.times = -1;
   obj.week = -1;
   obj.color = "#00ffff";
   obj.plugin = "";
   obj.validStartYear = 2000;
   obj.validEndYear = 9999;

オブジェクト作成方法(JSON方式)

    {
      "id"  : "",
      "type"  : CalendarManager.TYPE_CONFIG ,
      "name"  : "",
      "displayName"  : {
        "ja"  : "",
        "en"  : ""
        },
      "description"  : "",
      "year"  : 2005,
      "month"  : 1,
      "day"  : 1,
      "dayWeek"  : -1,
      "times"  : -1,
      "week"  : -1,
      "color"  : "#00ffff",
      "plugin"  : "",
      "validStartYear"  : 2000,
      "validEndYear"  : 9999
    }

オブジェクトの構造

var calendarInfo = {
    color : String, // 背景色。
    day : Number, // 日。
    dayWeek : Number, // 曜日。
    description : String, // 説明。
    displayName : String, // データ表示名。
    id : String, // [必須] データID。
    month : Number, // 月。
    name : String, // [必須] データ名。
    plugin : String, // プラグインID。
    times : Number, // 第ｎ？曜日。
    type : String, // [必須] データタイプ。
    validEndYear : Number, // 有効終了年。
    validStartYear : Number, // 有効開始年。
    week : Number, // 第ｎ週。
    year : Number // 年。
}

var calendarInfo = {
    color : String, // 背景色。
    day : Number, // 日。
    dayWeek : Number, // 曜日。
    description : String, // 説明。
    displayName : String, // データ表示名。
    id : String, // [必須] データID。
    month : Number, // 月。
    name : String, // [必須] データ名。
    plugin : String, // プラグインID。
    times : Number, // 第ｎ？曜日。
    type : String, // [必須] データタイプ。
    validEndYear : Number, // 有効終了年。
    validStartYear : Number, // 有効開始年。
    week : Number, // 第ｎ週。
    year : Number // 年。
}

プロパティの概要

型	プロパティ名	アクセス権
String	color 背景色。	通常
Number	day 日。	通常
Number	dayWeek 曜日。	通常
String	description 説明。	通常
String	displayName データ表示名。	通常
String	id [必須] データID。	通常
Number	month 月。	通常
String	name [必須] データ名。	通常
String	plugin プラグインID。	通常
Number	times 第ｎ？曜日。	通常
String	type [必須] データタイプ。	通常
Number	validEndYear 有効終了年。	通常
Number	validStartYear 有効開始年。	通常
Number	week 第ｎ週。	通常
Number	year 年。	通常

プロパティの詳細

String color 通常

背景色。

Number day 通常

日。

設定できる値は、1から31までです。
上記の値以外を設定した場合は、-1に設定されます。
この設定を無効にするには-1を設定します。

Number dayWeek 通常

曜日。

設定できる値は、0(日曜日)から6(土曜日)までです。
上記の値以外を設定した場合は、-1に設定されます。
この設定を無効にするには-1を設定します。

設定した曜日(日)を特定したい場合は、第ｎ？曜日の設定(times)
または第ｎ週の設定(week)と共に設定してください。
第ｎ？曜日の設定、第ｎ週の設定、共に設定を行わなかった場合は、すべての指定曜日の設定となります。

String description 通常

説明。

String displayName 通常

データ表示名。

displayName[ロケール]で指定したロケールの表示名が取得できます。

String id 通常

[必須] データID。

カレンダーデータを一意に識別するIDです。

Number month 通常

月。

設定できる値は、1から12までです。
上記の値以外を設定した場合は、-1に設定されます。
この設定を無効にするには-1を設定します。

String name 通常

[必須] データ名。

String plugin 通常

プラグインID。

この設定を無効にするにはnullまたは空文字列を設定します。

Number times 通常

第ｎ？曜日。

設定できる値は、1から5までです。
上記の値以外を設定した場合は、-1に設定されます。
この設定を無効にするには-1を設定します。

曜日の設定(dayWeek) と共に設定すると、日を特定できます。

String type 通常

[必須] データタイプ。

設定できる値は、
CalendarManager#TYPE_CONFIG ：名称
CalendarManager#TYPE_HOLIDAY ：休日
CalendarManager#TYPE_NATIONAL_HOLDAY：祝祭日
CalendarManager#TYPE_WEEKDAY ：非休日
のいずれかです。
上記以外の値が設定された場合は、 CalendarManager#TYPE_CONFIG(名称) に設定されます。

Number validEndYear 通常

有効終了年。

この設定を無効にするには-1を設定します。

Number validStartYear 通常

有効開始年。

この設定を無効にするには-1を設定します。

Number week 通常

第ｎ週。

設定できる値は、1から6までです。
上記の値以外を設定した場合は、-1に設定されます。
この設定を無効にするには-1を設定します。

曜日の設定(dayWeek) と共に設定すると、日が特定できます。

Number year 通常

年。

この設定を無効にするには-1を設定します。