5.20193.637
WjCalendar Wijmo API クラス

WjCalendar クラス

wijmo.input.Calendar コントロールに対応するAngular 2コンポーネント。

wj-calendarコンポーネントを使用して、Angular 2アプリケーションにCalendarコントロールを追加します。 Angular 2マークアップの構文については、 「Angular 2マークアップ構文」を参照してください。

WjCalendarコンポーネントは、Calendarコントロールから派生され、 そのすべてのプロパティ、イベント、およびメソッドを継承しています。

階層

プロパティ

asyncBindings

asyncBindings: boolean

この特定のコンポーネントのグローバルなWjOptions.asyncBindingsの設定をオーバーライドできます。 詳細については、WjOptions. WjOptions.asyncBindings プロパティの説明を参照してください。

displayMonth

displayMonth: Date

カレンダーに表示されている月を取得または設定します。

displayMonthChangedNg

displayMonthChangedNg: EventEmitter<any>

プログラムによるアクセスに使用されるWijmo displayMonthChangedイベントのAngular(EventEmitter)バージョン。 コードでこのイベントのAngularバージョンをサブスクライブする場合は、このイベント名を使用してください。 テンプレート連結では、通常のdisplayMonthChanged Wijmoイベント名を使用してください。

firstDayOfWeek

firstDayOfWeek: number

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

このプロパティをnullに設定すると、現在のカルチャのデフォルトが使用されます。 週の最初の曜日は、英語カルチャでは日曜日(0)であり、 ほとんどのヨーロッパカルチャでは月曜日(1)です。

formatDayHeaders

formatDayHeaders: string

月表示で、曜日の上に表示されるヘッダーの書式を取得または設定します。

このプロパティのデフォルト値は'ddd''です。

formatDays

formatDays: string

月表示で、日の表示書式を取得または設定します。

このプロパティのデフォルト値は 'd 'です('d'の後のスペースは、 短い日付パターンを表す標準な書式'd'と解釈されないようにします)。

formatItemNg

formatItemNg: EventEmitter<any>

プログラムによるアクセスに使用されるWijmo formatItemイベントのAngular(EventEmitter)バージョン。 コードでこのイベントのAngularバージョンをサブスクライブする場合は、このイベント名を使用してください。 テンプレート連結では、通常のformatItem Wijmoイベント名を使用してください。

formatMonths

formatMonths: string

年表示で、月の表示書式を取得または設定します。

このプロパティのデフォルト値は'MMM'です。

formatYear

formatYear: string

年表示で、月の上に表示される年の書式を取得または設定します。

このプロパティのデフォルト値は'yyyy'です。

formatYearMonth

formatYearMonth: string

月表示で、カレンダーの上に表示される月と年の書式を取得または設定します。

このプロパティのデフォルト値は'y'です。

gotFocusNg

gotFocusNg: EventEmitter<any>

プログラムによるアクセスに使用されるWijmo gotFocusイベントのAngular(EventEmitter)バージョン。 コードでこのイベントのAngularバージョンをサブスクライブする場合は、このイベント名を使用してください。 テンプレート連結では、通常のgotFocus Wijmoイベント名を使用してください。

hostElement

hostElement: HTMLElement

コントロールをホストしているDOM要素を取得します。

initialized

initialized: EventEmitter<any>

このイベントは、コンポーネントがAngularによって初期化された後、つまり すべての連結プロパティが割り当てられ、子コンポーネント(ある場合)が初期化された後にトリガされます。

isDisabled

isDisabled: boolean

コントロールが無効かどうかを判定する値を取得または設定します。

無効化されたコントロールは、マウスイベントやキーボードイベントを取得できません。

isInitialized

isInitialized: boolean

コンポーネントがAngularによって初期化されているかどうかを示します。 この値は、initializedイベントをトリガする直前にfalseからtrueになります。

isReadOnly

isReadOnly: boolean

ユーザーがマウスとキーボードを使用してコントロール値を変更できるかどうかを示す値を取得または設定します。

このプロパティのデフォルト値はfalse です。

isTouching

isTouching: boolean

現在、コントロールがタッチイベントを処理しているかどうかを示す値を取得します。

isUpdating

isUpdating: boolean

コントロールが現在更新中かどうかを示す値を取得します。

itemFormatter

itemFormatter: IDateFormatter

カレンダーの日付をカスタマイズするフォーマッター関数を取得または設定します。

このフォーマッター関数は、任意の日付に任意の内容を追加できます。そのため、カレンダーの外観と動作を全面的にカスタマイズすることが可能です。

この関数は以下の2つのパラメーターをとります。

  • 書式設定する日付
  • 日付を表すHTML要素

以下のサンプルコードは週末を無効な状態で表示します。

calendar.itemFormatter = function(date, element) {
  var day = date.getDay();
  element.style.backgroundColor = day == 0 || day == 6 ? 'yellow' : '';
}

itemValidator

itemValidator: IDateValidator

日付が選択可能かどうかを決定するバリデーター関数を取得または設定します。

このバリデーター関数は、調べる日付を表す1つのパラメーターを受け取り、その日付が無効で選択できない場合、falseを返す必要があります。

以下のサンプルコードは、週末を無効な状態で表示し、ユーザーがそれらの日付を選択できないようにします。

calendar.itemValidator = function(date) {
  var weekday = date.getDay();
  return weekday != 0 && weekday != 6;
}

lostFocusNg

lostFocusNg: EventEmitter<any>

プログラムによるアクセスに使用されるWijmo lostFocusイベントのAngular(EventEmitter)バージョン。 コードでこのイベントのAngularバージョンをサブスクライブする場合は、このイベント名を使用してください。 テンプレート連結では、通常のlostFocus Wijmoイベント名を使用してください。

max

max: Date

ユーザーがカレンダーで選択できる最も遅い日付を取得または設定します。

このプロパティのデフォルト値は nullです。これは、最新のが定義されていないことを意味します。

min およびmax プロパティの使用方法については、 「minおよびmaxプロパティの使用<」トピックを参照してください。

min

min: Date

ユーザーがカレンダーで選択できる最も早い日付を取得または設定します。

ユーザーが入力できる最も早い日付を取得または設定します。

このプロパティのデフォルト値は nullです。これは、最も早い日付が定義されていないことを意味します。

min およびmax プロパティの使用方法については、 「minおよびmaxプロパティの使用<」トピックを参照してください。

monthView

monthView: boolean

カレンダーに1か月と1年のどちらを表示するかを示す値を取得または設定します。

このプロパティのデフォルト値はtrueです。

refreshedNg

refreshedNg: EventEmitter<any>

プログラムによるアクセスに使用されるWijmo refreshedイベントのAngular(EventEmitter)バージョン。 コードでこのイベントのAngularバージョンをサブスクライブする場合は、このイベント名を使用してください。 テンプレート連結では、通常のrefreshed Wijmoイベント名を使用してください。

refreshingNg

refreshingNg: EventEmitter<any>

プログラムによるアクセスに使用されるWijmo refreshingイベントのAngular(EventEmitter)バージョン。 コードでこのイベントのAngularバージョンをサブスクライブする場合は、このイベント名を使用してください。 テンプレート連結では、通常のrefreshing Wijmoイベント名を使用してください。

repeatButtons

repeatButtons: boolean

カレンダーボタンがリピートボタン(押された状態で繰り返し実行するボタン)として動作するかどうかを決定する値を取得または設定します。

このプロパティのデフォルト値はtrueです。

rightToLeft

rightToLeft: boolean

要素内のコントロールを右から左のレイアウトでホストするかどうかを示す値を取得します。

selectionMode

selectionMode: DateSelectionMode

ユーザーが日や月を選択できるか、またはどの値も選択できないかを示す値を取得または設定します。

このプロパティのデフォルト値はDateSelectionMode.Dayです。

showHeader

showHeader: boolean

現在の月とナビゲーションボタンを含むヘッダ領域をコントロールに表示するかどうかを示す値を取得または設定します。

このプロパティのデフォルト値はtrueです。

showYearPicker

showYearPicker: boolean

ユーザーが年カレンダーのヘッダー要素をクリックすると、ドロップダウンカレンダーに 年のリストを表示するかどうかを決定する値を取得または設定します。

このプロパティのデフォルト値はtrueです。

value

value: Date

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

このプロパティのデフォルト値は現在の日付です。

valueChangedNg

valueChangedNg: EventEmitter<any>

プログラムによるアクセスに使用されるWijmo valueChangedイベントのAngular(EventEmitter)バージョン。 コードでこのイベントのAngularバージョンをサブスクライブする場合は、このイベント名を使用してください。 テンプレート連結では、通常のvalueChanged Wijmoイベント名を使用してください。

wjModelProperty

wjModelProperty: string

[(ngModel)]ディレクティブ(指定されている場合)によって表されるプロパティの名前を定義します。 デフォルト値は'value'です。

静的 controlTemplate

controlTemplate: string

Calendar コントロールのインスタンス化に使用されるテンプレートを取得または設定します。

メソッド

applyTemplate

  • applyTemplate(classNames: string, template: string, parts: Object, namePart?: string): HTMLElement
  • コントロールの新しいインスタンスにテンプレートを適用し、ルート要素を返します。

    このメソッドはテンプレート化されたコントロールのコンストラクターによって呼び出され、 テンプレートのパーツを対応するコントロールメンバにバインドする役割を持ちます。 以下のサンプルコードは、InputNumber コントロールのインスタンスにテンプレートを適用します。 このテンプレートには、'wj-part'属性が'input'、'btn-inc'、および'btn-dec'に設定された要素を含める必要があります。 コントロールのメンバである'_tbx'、'_btnUp'、'_btnDn'には、これらの要素への参照が割り当てられます。

    this.applyTemplate('wj-control wj-inputnumber', template, {
      _tbx: 'input',
      _btnUp: 'btn-inc',
      _btnDn: 'btn-dec'
    }, 'input');

    引数

    • classNames: string

      コントロールのホスト要素に追加するクラスの名前。

    • template: string

      コントロールのテンプレートを定義するHTML文字列。

    • parts: Object

      パーツ変数とその名前のディクショナリー。

    • オプション namePart: string

      ホスト要素にちなんで名付けられたパーツの名前。 これにより、コントロールがフォームで使用されたときにデータをどのように送信するかが決まります。

    戻り値 HTMLElement

beginUpdate

  • beginUpdate(): void

created

  • created(): void
  • Wijmoコンポーネントから継承されるカスタムコンポーネントを作成する場合は、このメソッドを
    オーバーライドして、通常はクラスコンストラクタで行う必要な初期化を行うことができます。 このメソッドは、Wijmoコンポーネントコンストラクタの最後の行で呼び出され、 カスタムコンポーネントのコンストラクタを宣言しなくて済むようにします。これにより、 コンストラクタのパラメータを保持したり、Wijmoコンポーネントのコンストラクタパラメータとの同期を維持する必要がなくなります。

    戻り値 void

deferUpdate

  • deferUpdate(fn: Function): void
  • beginUpdate/endUpdate ブロック内で関数を実行します。

    この関数の実行が完了するまでコントロールは更新されません。 このメソッドは、関数が例外を生成した場合でも endUpdate が呼び出されるようにします。

    引数

    • fn: Function

      実行する関数。

    戻り値 void

endUpdate

  • endUpdate(): void

focus

  • focus(): void
  • このコントロールにフォーカスを設定します。

    戻り値 void

getTemplate

  • getTemplate(): string
  • コントロールのインスタンスの作成に使用されたHTMLテンプレートを取得します。

    このメソッドは、クラス階層をさかのぼってコントロールのテンプレートを指定する最も近い祖先を探します。 たとえば、ComboBox コントロールのプロトタイプを指定した場合、 そのプロトタイプによってDropDown 基本クラスで定義されたテンプレートがオーバーライドされます。

    戻り値 string

hasOwnProperty

  • hasOwnProperty(v: PropertyKey): boolean
  • オブジェクトが指定されたプロパティを持つかどうかを判定します。

    引数

    • v: PropertyKey

      プロパティの名前。

    戻り値 boolean

initialize

  • initialize(options: any): void
  • 指定したオブジェクトからプロパティをコピーしてコントロールを初期化します。

    このメソッドを使用すると、各プロパティの値をコードで設定する代わりにプレーンなデータオブジェクトを使用してコントロールを初期化できます。

    例:

    grid.initialize({
      itemsSource: myList,
      autoGenerateColumns: false,
      columns: [
        { binding: 'id', header: 'Code', width: 130 },
        { binding: 'name', header: 'Name', width: 60 }
      ]
    });
    // これは以下と同等です。
    grid.itemsSource = myList;
    grid.autoGenerateColumns = false;
    // など
    

    初期化データは適用時に型チェックされます。 初期化オブジェクトに不明なプロパティ名または無効なデータ型が含まれている場合、このメソッドは例外をスローします。

    引数

    • options: any

      初期化データを含むオブジェクト。

    戻り値 void

invalidate

  • invalidate(fullUpdate?: boolean): void
  • 非同期更新を発生させるため、コントロールを無効にします。

    引数

    • オプション fullUpdate: boolean

      内容だけでなくコントロールのレイアウトも更新するかどうか。

    戻り値 void

isPrototypeOf

  • isPrototypeOf(v: Object): boolean
  • オブジェクトが別のオブジェクトのプロトタイプチェーンに存在するかどうかを判定します。

    引数

    • v: Object

      プロトタイプチェーンが判定される別のオブジェクト。

    戻り値 boolean

onDisplayMonthChanged

onFormatItem

onGotFocus

onLostFocus

onRefreshed

onRefreshing

onValueChanged

propertyIsEnumerable

  • propertyIsEnumerable(v: PropertyKey): boolean
  • 指定されたプロパティが列挙可能かどうかを判断します。

    引数

    • v: PropertyKey

      プロパティの名前。

    戻り値 boolean

removeEventListener

  • removeEventListener(target?: EventTarget, type?: string, fn?: any, capture?: boolean): number
  • このControl が所有する要素にアタッチされている1つまたは複数のイベントリスナーを解除します。

    引数

    • オプション target: EventTarget

      イベントのターゲット要素。 nullの場合、すべてのターゲットにアタッチされているリスナーが解除されます。

    • オプション type: string

      イベントを指定する文字列。 nullの場合、すべてのイベントにアタッチされているリスナーが解除されます。

    • オプション fn: any

      削除するハンドラ。 nullの場合は、すべてのハンドラが削除されます。

    • オプション capture: boolean

      リスナーがキャプチャリスナーかどうか。 nullの場合、キャプチャリスナーと非キャプチャリスナーの両方が解除されます。

    戻り値 number

    The number of listeners removed.

toLocaleString

  • toLocaleString(): string
  • 現在のロケールを使用して文字列に変換された日付を返します。

    戻り値 string

toString

  • toString(): string
  • オブジェクトの文字列表現を返します。

    戻り値 string

valueOf

  • valueOf(): Object
  • 指定されたオブジェクトのプリミティブ値を返します。

    戻り値 Object

静的 disposeAll

  • disposeAll(e?: HTMLElement): void
  • HTML要素に含まれるすべてのWijmoコントロールを破棄します。

    引数

    • オプション e: HTMLElement

      コンテナー要素。

    戻り値 void

静的 getControl

  • getControl(element: any): Control
  • 指定したDOM要素でホストされているコントロールを取得します。

    引数

    • element: any

      コントロールをホストするDOM要素、またはホスト要素のCSS セレクター(例: '#theCtrl')。

    戻り値 Control

静的 invalidateAll

  • invalidateAll(e?: HTMLElement): void
  • 指定したHTML要素に含まれるすべてのWijmoコントロールを無効化します。

    このメソッドは、コントロールの表示状態やサイズを変更する 動的なパネルをアプリケーションで使用している場合に使用します。 たとえば、スプリッタ、アコーディオン、およびタブコントロールは通常、 その中の要素の表示状態を変更します。この場合、その要素に含まれるコントロールに通知しないと、 それらのコントロールが適切に機能しなくなる可能性があります。 これが起こる場合は、動的コンテナーで適切なイベントを処理し、 Control.invalidateAll メソッドを呼び出してコンテナー内のWijmoコントロールの レイアウト情報が適切に更新されるようにする必要があります。

    引数

    • オプション e: HTMLElement

      コンテナー要素。nullに設定すると、ページ上に存在するすべてのWijmoコントロールが無効化されます。

    戻り値 void

静的 refreshAll

  • refreshAll(e?: HTMLElement): void
  • HTML要素で存在するすべてのWijmoコントロールを更新する。

    コントロールが時間おいて更新される代わりに直ちに更新されること以外はinvalidateAll メソッドと同様です。

    引数

    • オプション e: HTMLElement

      コンテナー要素。nullに設定すると、ページ上に存在するすべてのWijmoコントロールが無効化されます。

    戻り値 void

イベント

displayMonthChanged

displayMonthChanged: Event<Calendar, EventArgs>

displayMonth プロパティが変更された後に発生します。

formatItem

カレンダーの日を表す要素が作成されたときに発生します。

このイベントを使用してカレンダーの項目を表示用に書式設定できます。このイベントは、目的はitemFormatter プロパティと同じですが、複数の独立したハンドラを使用できる利点があります。

以下のサンプルコードは、formatItem イベントを使用して週末を無効な状態にし、 カレンダーにグレーで表示されるようにします。

// 日曜日と土曜日を無効にします
calendar.formatItem.addHandler(function (s, e) {
  var day = e.data.getDay();
  if (day == 0 || day == 6) {
    wijmo.addClass(e.item, 'wj-state-disabled');
  }
});

gotFocus

gotFocus: Event<Control, EventArgs>

コントロールがフォーカスを取得したときに発生します。

lostFocus

lostFocus: Event<Control, EventArgs>

コントロールがフォーカスを失ったときに発生します。

refreshed

refreshed: Event<Control, EventArgs>

コントロールが内容を更新した後で発生します。

refreshing

refreshing: Event<Control, EventArgs>

コントロールが内容を更新する直前に発生します。

valueChanged

valueChanged: Event<Calendar, EventArgs>

ユーザーアクションの結果として、またはコードでの割り当てにより、value プロパティの値が変化すると発生します。