引数

• e: Element

  クラスを追加する要素。

• className: string

  要素に追加するクラス（またはスペースで区切られたクラスのリスト）。

戻り値 void

import { animate } from '@grapecity/wijmo';
const element = document.getElementById('someElement');
animate(pct => {
    element.style.opacity = pct;
}, 1000);

import { animate } from '@grapecity/wijmo';
const element = document.getElementById('someElement');
if (this._animInterval) {
    clearInterval(this._animInterval);
}
this._animInterval = animate(pct => {
    element.style.opacity = pct;
    if (pct == 1) {
        self._animInterval = null;
    }
}, 1000);

引数

• apply: IAnimateCallback

  ドキュメントを変更するコールバック関数。 この関数は、パーセンテージを表す1つのパラメーターをとります。

• オプション duration: number

  アニメーションの持続時間（ミリ秒単位）。

• オプション step: number

  アニメーションフレームの間隔（ミリ秒単位）。

戻り値 any

アニメーションを中止するために使用できる期間 ID。

引数

• value: any

  配列であるはずの値。

• オプション nullOK: boolean

  nullが許容されるかどうか。

戻り値 any[]

渡された配列。

引数

• value: boolean

  ブール値であるはずの値。

• オプション nullOK: boolean

  nullが許容されるかどうか。

戻り値 boolean

渡されたブール値。

引数

• value: any

  配列または ICollectionView。

• オプション nullOK: boolean

  nullが許容されるかどうか。

戻り値 ICollectionView

渡されたICollectionViewまたは渡された配列から作成されたCollectionView

引数

• value: Date

  日付であるはずの値。

• オプション nullOK: boolean

  nullが許容されるかどうか。

戻り値 Date

渡された日付。

引数

• value: number

  列挙体のメンバであるはずの値。

• enumType: any

  テストする列挙体。

• オプション nullOK: boolean

  nullが許容されるかどうか。

戻り値 number

渡された値。

引数

• value: any

  関数であるはずの値。

• オプション nullOK: boolean

  nullが許容されるかどうか。

戻り値 Function

渡された関数。

引数

• value: number

  整数であるはずの値。

• オプション nullOK: boolean

  nullが許容されるかどうか。

• オプション positive: boolean

  正の整数のみを受け入れるかどうか。

戻り値 number

渡された数値。

引数

• value: number

  数値であるはずの値。

• オプション nullOK: boolean

  nullが許容されるかどうか。

• オプション positive: boolean

  正の数値のみを受け入れるかどうか。

戻り値 number

渡された数値。

引数

• value: string

  文字列であるはずの値。

• オプション nullOK: boolean

  nullが許容されるかどうか。

戻り値 string

渡された文字列。

引数

• value: any

  チェックする値。

• type: any

  期待される値の型。

• オプション nullOK: boolean

  nullが許容されるかどうか。

戻り値 any

渡された値。

引数

• condition: boolean

  真であることが期待される条件。

• msg: string

  条件が真でない場合の例外メッセージ。

戻り値 void

引数

• value: any

  変換する値。

• type: DataType

  値の変換先のDataType。

• オプション format: string

  文字列に変換、または文字列から変換するときに使用する書式。

• オプション refDate: Date

  情報が不足している文字列を解析するときに使用する参照日。

戻り値 any

変換後の値、または変換できなかった場合は元の値。

引数

• value: number

  元の値。

• min: number

  許容される最小値。

• max: number

  許容される最大値。

戻り値 number

引数

• e: any

  検索を開始する要素。

• selector: string

  セレクター式を含む文字列に対する要素を一致させます。

戻り値 Element

セレクターを満たす最も近い祖先。見つからない場合はnull。

引数

• e: any

  検索を開始する要素。

• className: string

  クラス名を含む文字列に対する要素を一致させます。

戻り値 Node

指定されたクラス名を含む最も近い祖先。見つからない場合はnull。

引数

• parent: any

  親要素。

• child: any

  子要素。

• オプション popup: boolean

  Wijmoポップアップを考慮に入れるかどうか。

戻り値 boolean

親要素に子要素が含まれている場合はTrue。

引数

• dst: any

  コピー先オブジェクト。

• src: any

  コピー元オブジェクト。

戻り値 any

コピー先オブジェクト。

引数

• html: string

  HTMLElementに変換するHTMLフラグメント。

• オプション appendTo: HTMLElement

  新しい要素を付加する先のオプションのHTMLElement。

• オプション css: any

  新しい要素のルートに適用するオプションのCSS属性。

戻り値 HTMLElement

新しい要素。

引数

• e: HTMLInputElement

  入力要素。

戻り値 void

引数

• e: HTMLElement

  有効または無効にする要素。

• value: boolean

  要素を有効にするか無効にするか。

戻り値 void

引数

• text: string

  エスケープするテキスト。

戻り値 string

元の文字列のHTMLでエスケープされたバージョン。

引数

• text: string

  エスケープするテキスト。

戻り値 string

元の文字列の正規表現でエスケープされたバージョン。

import { evalTemplate } from '@grapecity/wijmo';
const msg = evalTemplate('hello ${user}, want some ${Math.PI}:n2?', { user: 'Chris' }));
console.log(msg);
> hello Chris, want some 3.14?

引数

• template: string

  テンプレートリテラル表記ないの文字列。

• オプション ctx: any

  テンプレートにアクセス可能なプロパティを持つオブジェクト。

戻り値 string

結果を含む文字列。

import { format } from '@grapecity/wijmo';
let data = { name: 'Joe', amount: 123456 },
    msg = format('Hello {name}, you won {amount:n2}!', data);

import { format } from '@grapecity/wijmo';
fmtObj fmt = {
    count: 'count',
    when: {
        0: 'No items selected.',
        1: 'One item is selected.',
        2: 'A pair is selected.',
        'other': '{count:n0} items are selected.'
    }
};
let fmt = JSON.stringify(fmtObj);
console.log(format(fmt, { count: 0 }));  // 項目が選択されていません。
console.log(format(fmt, { count: 1 }));  // 項目が1つ選択されています。
console.log(format(fmt, { count: 2 }));  // 項目が2つ選択されています。
console.log(format(fmt, { count: 12 })); // 項目が12つ選択されています。

import { format, isString, escapeHtml } from '@grapecity/wijmo';
let data = { name: 'Joe', amount: 123456 },
    msg = format('Hello {name}, you won {amount:n2}!', data,
    (data, name, fmt, val) => {
        if (isString(data[name])) {
            val = escapeHtml(data[name]);
        }
        return val;
    }
);

引数

• format: string

  各種要素から成る複合的な書式文字列。

• data: any

  文字列の構築に使用するデータオブジェクト。

• オプション formatFunction: Function

  （オプション）コンテキストに応じて項目を書式設定する場合に使用する関数。

戻り値 string

書式設定された文字列。

戻り値 HTMLElement

引数

• aggType: Aggregate

  計算する集計のタイプ。

• items: any[]

  集計する項目を含む配列。

• オプション binding: string

  集計するプロパティの名前（項目が単純な値でない場合）。

戻り値 any

引数

• selector: any

  要素、セレクター文字列、またはjQueryオブジェクト。

戻り値 HTMLElement

引数

• e: Element

戻り値 Rect

引数

• value: any

  テストする値。

戻り値 DataType

渡される値の型を表すDataType値。

引数

• arr: any[]

  データ項目を含む配列。

• オプション limit: number

  スキャンする配列の項目数（デフォルトでは1000）。 ゼロまたは負の値に指定すると、関数はすべてのアイテムをスキャンします。

戻り値 IBindingInfo[]

入力配列にある項目の各プリミティブプロパティの連結と種類を含むオブジェクトを含む配列。

引数

• baseId: string

  一意IDを生成するためのベースとして使用する文字列。

戻り値 string

戻り値 string

import { glbz } from '@grapecity/wijmo';
let num = 42,
    dt = new Date(),
    msg = glbz`the number is ${num}:n2, and the date is ${dt}:'MMM d, yyyy'!`;

引数

• Rest ...args: any[]

戻り値 string

引数

• e: Element

  チェックする要素。

• className: string

  チェックするクラス。

戻り値 boolean

引数

• value: ICollectionView

  チェックする ICollectionView。

戻り値 boolean

引数

• popup: HTMLElement

  非表示にするポップアップ要素。

• オプション remove: any

  DOMからポップアップを削除するか、またはポップアップを非表示にするかを決定します。 このパラメータは、ポップアップがDOMから削除された後で呼び出されるコールバック関数またはブール値です。

• オプション fadeOut: boolean

  ポップアップを徐々に非表示にするフェードアウトアニメーションを使用するかどうか。

戻り値 any

フェードアウトを中止するために使用できる期間 ID。

import { httpRequest } from '@grapecity/wijmo';
httpRequest('https://services.odata.org/Northwind/Northwind.svc/Customers?$format=json', {
  success: xhr => {
    let response = JSON.parse(xhr.responseText),
        customers = response.value;
    // 顧客に対して何らかの処理を行います。
  }
});

引数

• url: string

  要求が送信されるURLを含む文字列です。

• オプション options: IHttpRequestOptions

  リクエストの構築に使用する任意指定のIHttpRequestOptionsオブジェクト。

戻り値 XMLHttpRequest

要求の実行に使用されるXMLHttpRequestオブジェクト。

引数

• value: any

  テストする値。

戻り値 boolean

引数

• value: any

  テストする値。

戻り値 boolean

引数

• value: any

  テストする値。

戻り値 boolean

引数

• obj: any

  テストするオブジェクト。

戻り値 boolean

引数

• value: any

  テストする値。

戻り値 boolean

引数

• value: any

  テストする値。

戻り値 boolean

引数

• value: string

  テストする値。

戻り値 boolean

引数

• value: any

  テストする値。

戻り値 boolean

引数

• value: any

  テストする値。

戻り値 boolean

引数

• value: any

  テストする値。

戻り値 boolean

引数

• value: any

  テストする値。

戻り値 boolean

引数

• value: any

  テストする値。

戻り値 boolean

引数

• e: any

戻り値 Point

引数

• parent: HTMLElement

  親要素。

• offset: number

  フォーカスを移動するときに使用するオフセット（フォーカス可能な最初の子要素にフォーカスする場合は、0を使用）。

戻り値 boolean

フォーカスが設定されている場合はtrue、フォーカス可能な要素が見つからない場合はfalse。

引数

• e: Node

  DOMツリーから削除する要素。

戻り値 Node

引数

• e: Element

  クラスを削除する要素。

• className: string

  要素から削除するクラス（またはスペースで区切られたクラスのリスト）。

戻り値 void

引数

• content: string | Blob

  ファイルに保存される文字列またはBlobオブジェクト。

• fileName: string

  保存するファイルの名前（拡張子を含む）。

• オプション type: string

  content引数が文字列の場合に使用されるオプションのファイルMIMEの種類。

  saveFileメソッドを使用して、テキストファイル（txt、csv、html）および画像ファイルを作成できます。

  たとえば、次のサンプルコードはFlexGrid内の現在の選択範囲をCSVファイルに保存します。

  import { saveFile } from '@grapecity/wijmo';
  const clipString = theGrid.getClipString(null, true, true, false);
  saveFile(clipString, 'grid.csv', 'text/csv');

  また、次のサンプルコードは、canvas要素の内容をJPGファイルに保存します。

  import { saveFile } from '@grapecity/wijmo';
  
  canvas.toBlob(blob => {
     saveFile(blob, 'image.jpg');
  }, 'image/jpeg');

戻り値 void

引数

• e: Element

  更新する要素。

• オプション value: string

  aria labelの値。要素からラベルを削除するにはnull。

戻り値 void

引数

• e: Element

  更新する要素。

• name: string

  追加または削除する属性の名前。

• オプション value: any

  属性の値。要素から属性を削除するにはnull。

• オプション keep: boolean

  存在する場合、元の属性を保持するかどうか。

戻り値 void

引数

• cb: HTMLInputElement

  チェックボックス要素。

• checked: boolean

  checkedの場合はtrue、uncheckedの場合はfalse、またはindeterminateの場合はnull。

戻り値 void

引数

• e: any

  スタイルを変更する要素または要素の配列。

• css: any

  要素に適用するスタイルプロパティを含むオブジェクト。

戻り値 void

引数

• licenseKey: string

  このアプリケーションで使用するライセンスキーを含む文字列。

戻り値 void

引数

• e: any

  選択するHTMLInputElementまたはHTMLTextAreaElement。

• start: number

  選択範囲の開始のテキストフィールドへのオフセット。

• オプション end: number

  選択範囲の終了のテキストフィールドへのオフセット。

戻り値 boolean

引数

• e: HTMLElement

  内容が更新されている要素。

• text: string

  要素に割り当るテキスト。

戻り値 void

引数

• popup: HTMLElement

  ポップアップとして表示する要素。

• オプション ref: any

  ポップアップの配置に使用される参照要素または矩形。

• オプション position: PopupPosition | Boolean

  参照要素に対するポップアップの位置。

• オプション fadeIn: boolean

  フェードインアニメーションを使用してポップアップを徐々に表示します。

• オプション copyStyles: any

  参照要素からフォントと色のスタイルをコピーするか、要素をスタイルソースとして使用するかどうか。

• オプション hideOnScroll: Function

  親要素のスクロールの結果として、ポップアップが非表示になったときに呼び出されるオプションの関数。

戻り値 any

フェードインアニメーションを中止するために使用できる期間 ID。

引数

• value: number

  切り上げまたは切り捨てる値。

• prec: number

  結果の桁数。

• truncate: boolean

  元の値を切り捨てるか、切り上げるか。

戻り値 number

引数

• text: string

  ヘッダタイプの文字列に変換する文字列。

戻り値 string

引数

• html: string

  プレーンテキストに変換するHTML文字列。

戻り値 string

文字列のプレーンテキストバージョン。

引数

• e: Element

  クラスを追加する要素。

• className: string

  追加または削除するクラス。

• オプション addOrRemove: boolean

  クラスを追加するか削除するか。 指定しない場合は、クラスを切り替えます。

戻り値 void

引数

• value: any

  キャストする値。

• type: any

  キャスト先の型またはインタフェース名。

戻り値 any

キャストが成功した場合に渡される値、それ以外の場合はnull。