v5.20191.603
|

wijmo モジュール

すべてのコントロールおよびモジュールによって使用されるユーティリティと Control および Event クラスが含まれます。

変数

culture

culture: any

Wijmoライブラリ内のすべてのローカライズ可能な文字列を含むオブジェクトを取得または設定します。

カルチャセレクターは、ISO 639カルチャを表す2文字の文字列です。

メソッド

addClass

  • addClass(e: Element, className: string): void
  • 要素にクラスを追加します。

    引数

    • e: Element

      クラスを追加する要素。

    • className: string

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

    戻り値 void

animate

  • animate(apply: Function, duration?: number, step?: number): any
  • パラメーターが0から1まで変化するタイマーを使用して関数を呼び出します。

    この関数を使用すると、ドキュメントのプロパティまたはスタイルを タイマーで変更することによってアニメーションを作成できます。

    たとえば、以下のコードは、要素の不透明度を1秒間で0から1に変更します。

    var element = document.getElementById('someElement');
    animate(function(pct) {
      element.style.opacity = pct;
    }, 1000);

    この関数は、アニメーションの停止に使用できる内部IDを返します。 アニメーションの停止は通常、新しいアニメーションを開始するときや、 同じ要素で現在実行されている他のアニメーションを中止するときに行います。 たとえば、以下のコードは、内部IDを追跡して新しいアニメーションを開始する前にIDをクリアします。

    var element = document.getElementById('someElement');
    if (this._animInterval) {
      clearInterval(this._animInterval);
    }
    var self = this;
    self._animInterval = animate(function(pct) {
      element.style.opacity = pct;
      if (pct == 1) {
    self._animInterval = null;
      }
    }, 1000);

    引数

    • apply: Function

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

    • オプション duration: number

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

    • オプション step: number

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

    戻り値 any

    An interval id that you can use to suspend the animation.

asArray

  • asArray(value: any, nullOK?: boolean): any[]
  • 値が配列であることを表明します。

    引数

    • value: any

      配列であるはずの値。

    • オプション nullOK: boolean

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

    戻り値 any[]

    The array passed in.

asBoolean

  • asBoolean(value: boolean, nullOK?: boolean): boolean
  • 値がブール値であることを表明します。

    引数

    • value: boolean

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

    • オプション nullOK: boolean

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

    戻り値 boolean

    The Boolean passed in.

asCollectionView

asDate

  • asDate(value: Date, nullOK?: boolean): Date
  • 値が日付であることを表明します。

    引数

    • value: Date

      日付であるはずの値。

    • オプション nullOK: boolean

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

    戻り値 Date

    The Date passed in.

asEnum

  • asEnum(value: number, enumType: any, nullOK?: boolean): number
  • 値が列挙体の有効な設定であることを表明します。

    引数

    • value: number

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

    • enumType: any

      テストする列挙体。

    • オプション nullOK: boolean

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

    戻り値 number

    The value passed in.

asFunction

  • asFunction(value: any, nullOK?: boolean): Function
  • 値が関数であることを表明します。

    引数

    • value: any

      関数であるはずの値。

    • オプション nullOK: boolean

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

    戻り値 Function

    The function passed in.

asInt

  • asInt(value: number, nullOK?: boolean, positive?: boolean): number
  • 値が整数であることを表明します。

    引数

    • value: number

      整数であるはずの値。

    • オプション nullOK: boolean

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

    • オプション positive: boolean

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

    戻り値 number

    The number passed in.

asNumber

  • asNumber(value: number, nullOK?: boolean, positive?: boolean): number
  • 値が数値であることを表明します。

    引数

    • value: number

      数値であるはずの値。

    • オプション nullOK: boolean

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

    • オプション positive: boolean

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

    戻り値 number

    The number passed in.

asString

  • asString(value: string, nullOK?: boolean): string
  • 値が文字列であることを表明します。

    引数

    • value: string

      文字列であるはずの値。

    • オプション nullOK: boolean

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

    戻り値 string

    The string passed in.

asType

  • asType(value: any, type: any, nullOK?: boolean): any
  • 値が指定した型のインスタンスであることを表明します。

    引数

    • value: any

      チェックする値。

    • type: any

      期待される値の型。

    • オプション nullOK: boolean

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

    戻り値 any

    The value passed in.

assert

  • assert(condition: boolean, msg: string): void
  • 条件が偽の場合、例外をスローします。

    引数

    • condition: boolean

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

    • msg: string

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

    戻り値 void

changeType

  • changeType(value: any, type: DataType, format?: string): any
  • 値の型を変更します。

    変換が失敗した場合は元の値が返されます。変換が成功したかどうかを確認するには、戻り値の型をチェックします。

    引数

    • value: any

      変換する値。

    • type: DataType

      値の変換先のDataType

    • オプション format: string

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

    戻り値 any

    The converted value, or the original value if a conversion was not possible.

clamp

  • clamp(value: number, min: number, max: number): number
  • 最小値から最大値までの範囲に値をクランプします。

    引数

    • value: number

      元の値。

    • min: number

      許容される最小値。

    • max: number

      許容される最大値。

    戻り値 number

closest

  • closest(e: any, selector: string): Element
  • セレクターを満たす最も近い祖先(元の要素を含む)を検索します。

    引数

    • e: any

      検索を開始する要素。

    • selector: string

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

    戻り値 Element

    The closest ancestor that satisfies the selector, or null if not found.

closestClass

  • closestClass(e: any, className: string): Node
  • クラスセレクターを満たす最も近い祖先(元の要素を含む)を検索します。

    引数

    • e: any

      検索を開始する要素。

    • className: string

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

    戻り値 Node

    The closest ancestor that has the specified class name, or null if not found.

contains

  • contains(parent: any, child: any, popup?: boolean): boolean
  • HTML要素に別の要素が含まれているかどうかをチェックします。

    引数

    • parent: any

      親要素。

    • child: any

      子要素。

    • オプション popup: boolean

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

    戻り値 boolean

    True if the parent element contains the child element.

copy

  • copy(dst: any, src: any): void
  • オブジェクトのプロパティを別のオブジェクトにコピーします。

    コピー先オブジェクトでは、コピー元で定義されているすべてのプロパティが 定義されている必要があります。

    そうでなければ、エラーがスローされます。

    引数

    • dst: any

      コピー先オブジェクト。

    • src: any

      コピー元オブジェクト。

    戻り値 void

createElement

  • createElement(html: string, appendTo?: HTMLElement): HTMLElement
  • HTML文字列から要素を作成します。

    引数

    • html: string

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

    • オプション appendTo: HTMLElement

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

    戻り値 HTMLElement

    The new element.

disableAutoComplete

  • disableAutoComplete(e: HTMLInputElement): void
  • 入力要素のautocompleteプロパティ、autocorrectプロパティ、autocapitalizeプロパティ、 およびspellcheckプロパティを無効にします。

    引数

    • e: HTMLInputElement

      入力要素。

    戻り値 void

enable

  • enable(e: HTMLElement, value: boolean): void
  • 要素を有効または無効にします。

    引数

    • e: HTMLElement

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

    • value: boolean

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

    戻り値 void

escapeHtml

  • escapeHtml(text: string): string
  • HTML文字をテキストエンティティに置き換えることによって文字列をエスケープします。

    ユーザーが入力した文字列は常に、HTMLページに表示する前に エスケープする必要があります。これにより、ページの完全性が維持され、 HTML/JavaScriptインジェクション攻撃を防ぐことができます。

    引数

    • text: string

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

    戻り値 string

    An HTML-escaped version of the original string.

format

  • format(format: string, data: any, formatFunction?: Function): string
  • 指定された文字列内の各書式項目をオブジェクトの値に対応するテキストに置き換えます。

    この関数は、formatString 内のパターン'{name:format}'を data パラメータのプロパティに置き換えます。 次に例を示します。

    var data = { name: 'Joe', amount: 123456 };
    var msg = wijmo.format('Hello {name}, you won {amount:n2}!', data);
    

    format 関数は複数形式をサポートします。 書式文字列が'count'プロパティと'when'プロパティを含むJSONエンコードオブジェクトの場合、 このメソッドはデータオブジェクトの'count'パラメータを使用して、 'when'プロパティから適切な書式を選択します。次に例を示します。

    var fmt = {
    count: 'count',
    when: {
        0: 'No items selected.',
        1: 'One item is selected.',
        2: 'A pair is selected.',
        'other': '{count:n0} items are selected.'
    }
    }
    fmt = JSON.stringify(fmt);
    console.log(wijmo.format(fmt, { count: 0 })); // No items selected.
    console.log(wijmo.format(fmt, { count: 1 })); // One item is selected.
    console.log(wijmo.format(fmt, { count: 2 })); // A pair is selected.
    console.log(wijmo.format(fmt, { count: 12 })); 12 items are selected.
    

    オプションの formatFunction を使用すると、 状況依存の書式設定を指定してコンテンツをカスタマイズできます。 指定すると、書式要素ごとに書式関数が呼び出され、 データオブジェクト、パラメータ名、書式、および値が渡されて、出力文字列が返されます。次に例を示します。

    var data = { name: 'Joe', amount: 123456 };
    var msg = wijmo.format('Hello {name}, you won {amount:n2}!', data,
    function (data, name, fmt, val) {
        if (wijmo.isString(data[name])) {
            val = wijmo.escapeHtml(data[name]);
        }
        return val;
    }
    );
    

    引数

    • format: string

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

    • data: any

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

    • オプション formatFunction: Function

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

    戻り値 string

    The formatted string.

getActiveElement

  • getActiveElement(): HTMLElement
  • シャドウドキュメントフラグメントも考慮して、フォーカスを持つ要素への 参照を取得します。

    戻り値 HTMLElement

getAggregate

  • getAggregate(aggType: Aggregate, items: any[], binding?: string): any
  • 配列内の値から集計値を計算します。

    引数

    • aggType: Aggregate

      計算する集計のタイプ。

    • items: any[]

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

    • オプション binding: string

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

    戻り値 any

getElement

  • getElement(selector: any): HTMLElement
  • jQueryのセレクターから要素を取得します。

    引数

    • selector: any

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

    戻り値 HTMLElement

getElementRect

  • getElementRect(e: Element): Rect
  • 要素の外接矩形(ページ座標単位)を取得します。

    これは getBoundingClientRect 関数に似ていますが、 ビューポート座標を使用する点が異なります(ビューポート座標はドキュメントの スクロールに従って変更されます)。

    引数

    • e: Element

    戻り値 Rect

getType

  • 値の型を取得します。

    引数

    • value: any

      テストする値。

    戻り値 DataType

    A DataType value representing the type of the value passed in.

getTypes

  • getTypes(arr: any[]): any[]
  • 配列内の項目の名前と項目の種類を含む配列を取得します。

    引数

    • arr: any[]

      データ項目を含む配列。

    戻り値 any[]

    An array containing objects with the binding and type of each primitive property in the items found in the input array.

getUniqueId

  • getUniqueId(baseId: string): string
  • 指定されたベースIDに連続する数値を付加して、要素の新しい一意IDを 作成します。

    引数

    • baseId: string

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

    戻り値 string

getVersion

  • getVersion(): string
  • 現在ロードされているWijmoライブラリのバージョンを取得します。

    戻り値 string

hasClass

  • hasClass(e: Element, className: string): boolean
  • 要素がクラスを持つかどうかをチェックします。

    引数

    • e: Element

      チェックする要素。

    • className: string

      チェックするクラス。

    戻り値 boolean

hasItems

hidePopup

  • hidePopup(popup: HTMLElement, remove?: any, fadeOut?: boolean): any
  • showPopup メソッドによって表示されたポップアップ要素を非表示にします。

    引数

    • popup: HTMLElement

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

    • オプション remove: any

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

    • オプション fadeOut: boolean

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

    戻り値 any

    An interval id that you can use to suspend the fade-out animation.

httpRequest

  • httpRequest(url: string, settings?: any): XMLHttpRequest
  • HTTP要求を実行します。

    The settings parameter may contain the following:

    method The HTTP method to use for the request (e.g. "POST", "GET", "PUT"). The default is "GET".
    data Data to be sent to the server. これは、GET要求の場合はurlに付加され、他の要求の場合は 文字列に変換されます。.
    async デフォルトでは、すべての要求が非同期に送信されます(デフォルトではtrueに設定されます)。 同期要求が必要な場合は、このオプションをfalseに設定します。
    success 要求が成功した場合に呼び出される関数。 この関数には、 XMLHttpRequest 型の1つのパラメータが渡されます。
    error 要求が失敗した場合に呼び出される関数。 この関数には、 XMLHttpRequest型の1つのパラメータが渡されます。
    complete 要求の終了時(successおよびerrorコールバックが実行された後)に呼び出される関数。 この関数には、 XMLHttpRequest 型aの1つのパラメータが渡されます。
    beforeSend 要求が送信される直前に呼び出される関数。 この関数には、 XMLHttpRequest型の1つのパラメータが渡されます。
    requestHeaders 要求ヘッダーに追加されるキー/値のペアを含むJavaScriptオブジェクト。
    user HTTPアクセス認証要求に応答して XMLHttpRequest で使用されるユーザー名。
    password HTTPアクセス認証要求に応答して XMLHttpRequest で使用されるパスワード。

    success を使用して、このコールバックの XMLHttpRequest パラメータで 提供される要求の結果を取得します。 たとえば、次のコードは、 httpRequest メソッドを使用して、ODataサービスから顧客のリストを取得します。

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

    引数

    • url: string

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

    • オプション settings: any

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

    戻り値 XMLHttpRequest

    The XMLHttpRequest object used to perform the request.

isArray

  • isArray(value: any): boolean
  • オブジェクトが配列かどうかを判断します。

    引数

    • value: any

      テストする値。

    戻り値 boolean

isBoolean

  • isBoolean(value: any): boolean
  • オブジェクトがブール値かどうかを判断します。

    引数

    • value: any

      テストする値。

    戻り値 boolean

isDate

  • isDate(value: any): boolean
  • オブジェクトが日付かどうかを判断します。

    引数

    • value: any

      テストする値。

    戻り値 boolean

isEmpty

  • isEmpty(obj: any): boolean
  • オブジェクトが空(列挙可能なプロパティが含まれない)であるかどうかを判定します。

    引数

    • obj: any

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

    戻り値 boolean

isFunction

  • isFunction(value: any): boolean
  • オブジェクトが関数かどうかを判断します。

    引数

    • value: any

      テストする値。

    戻り値 boolean

isInt

  • isInt(value: any): boolean
  • オブジェクトが整数かどうかを判断します。

    引数

    • value: any

      テストする値。

    戻り値 boolean

isNullOrWhiteSpace

  • isNullOrWhiteSpace(value: string): boolean
  • 文字列がnull、空、またはホワイトスペースのみかどうかを判断します。

    引数

    • value: string

      テストする値。

    戻り値 boolean

isNumber

  • isNumber(value: any): boolean
  • オブジェクトが数値かどうかを判断します。

    引数

    • value: any

      テストする値。

    戻り値 boolean

isObject

  • isObject(value: any): boolean
  • オブジェクトが(値型または日付ではなく)オブジェクトであるかどうかを判断します。

    引数

    • value: any

      テストする値。

    戻り値 boolean

isPrimitive

  • isPrimitive(value: any): boolean
  • オブジェクトがプリミティブ型(string、number、Boolean、Date)かどうかを判断します。

    引数

    • value: any

      テストする値。

    戻り値 boolean

isString

  • isString(value: any): boolean
  • オブジェクトが文字列かどうかを判断します。

    引数

    • value: any

      テストする値。

    戻り値 boolean

isUndefined

  • isUndefined(value: any): boolean
  • オブジェクトが未定義かどうかを判断します。

    引数

    • value: any

      テストする値。

    戻り値 boolean

mouseToPage

  • mouseToPage(e: any): Point
  • マウスまたはタッチイベント引数をページ座標内の Point に変換します。

    引数

    • e: any

    戻り値 Point

moveFocus

  • moveFocus(parent: HTMLElement, offset: number): boolean
  • 指定された親要素内の次/前/最初のフォーカス可能な子にフォーカスを移動します。

    引数

    • parent: HTMLElement

      親要素。

    • offset: number

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

    戻り値 boolean

    True if the focus was set, false if a focusable element was not found.

removeChild

  • removeChild(e: Node): Node
  • 要素をDOMツリーから安全に削除します。

    引数

    • e: Node

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

    戻り値 Node

removeClass

  • removeClass(e: Element, className: string): void
  • 要素からクラスを削除します。

    引数

    • e: Element

      クラスを削除する要素。

    • className: string

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

    戻り値 void

setAriaLabel

  • setAriaLabel(e: Element, value?: string): void
  • 要素の aria-label 属性を設定またはクリアします。

    引数

    • e: Element

      更新する要素。

    • オプション value: string

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

    戻り値 void

setAttribute

  • setAttribute(e: Element, name: string, value?: any, keep?: boolean): void
  • 要素の属性を設定またはクリアします。

    引数

    • e: Element

      更新する要素。

    • name: string

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

    • オプション value: any

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

    • オプション keep: boolean

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

    戻り値 void

setCss

  • setCss(e: any, css: any): void
  • オブジェクトで指定されたプロパティを適用して、要素のスタイルを変更します。

    引数

    • e: any

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

    • css: any

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

    戻り値 void

setLicenseKey

  • setLicenseKey(licenseKey: string): void
  • ライセンス付きWijmoアプリケーションを識別するライセンスキーを設定します。

    ライセンスキーが設定されていない場合は、 Wijmoは評価モードで動作し、ページに透かしが追加されます。

    ライセンスを取得済みユーザーは、 新規ユーザー登録/ログイン のセクションからキーを入手することができます。

    Wijmoはキーやライセンス情報をどのサーバーにも送信しないことに注意してください。 提供されたキーの内部整合性のみを確認します。

    引数

    • licenseKey: string

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

    戻り値 void

setSelectionRange

  • setSelectionRange(e: any, start: number, end?: number): boolean
  • テキストフィールド内の選択の開始位置と終了位置を設定します。

    このメソッドはHTMLInputElementオブジェクトのネイティブの setSelectionRange メソッドに似ていますが、 例外を引き起こす可能性のある条件(要素がDOM内にない、 要素が無効または非表示になっている)をチェックする点が異なります。

    引数

    • e: any

      選択するHTMLInputElementまたはHTMLTextAreaElement。

    • start: number

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

    • オプション end: number

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

    戻り値 boolean

setText

  • setText(e: HTMLElement, text: string): void
  • 要素のテキストの内容を設定します。

    引数

    • e: HTMLElement

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

    • text: string

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

    戻り値 void

showPopup

  • showPopup(popup: HTMLElement, ref?: any, above?: boolean, fadeIn?: boolean, copyStyles?: any): any
  • 要素をポップアップとして表示します。

    ポップアップ要素はボディ要素の子になり、 使用可能なスペースに応じて参照矩形の上または下に配置されます。

    参照矩形は以下のいずれかとして指定できます。

    HTMLElement
    要素の外接矩形。
    MouseEvent
    イベントのターゲット要素の外接矩形。
    Rect
    特定の矩形。
    null
    参照矩形なし。ポップアップはウィンドウの中央に配置されます。

    hidePopup メソッドを呼び出してポップアップを非表示にします。

    引数

    • popup: HTMLElement

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

    • オプション ref: any

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

    • オプション above: boolean

      可能な場合、ポップアップを参照矩形の上に配置します。

    • オプション fadeIn: boolean

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

    • オプション copyStyles: any

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

    戻り値 any

    An interval id that you can use to suspend the fade-in animation.

toFixed

  • toFixed(value: number, prec: number, truncate: boolean): number
  • 数値を指定した精度に切り上げまたは切り捨てます。

    引数

    • value: number

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

    • prec: number

      結果の桁数。

    • truncate: boolean

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

    戻り値 number

toHeaderCase

  • toHeaderCase(text: string): string
  • キャメルケースの文字列をヘッダタイプの文字列に変換します。 最初の文字を大文字にし、小文字の後に大文字が続いている場合に大文字の前にスペースを追加します。

    たとえば、'somePropertyName'は'Some Property Name'になります。

    引数

    • text: string

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

    戻り値 string

toPlainText

  • toPlainText(html: string): string
  • HTML文字列をプレーンテキストに変換します。

    引数

    • html: string

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

    戻り値 string

    A plain-text version of the string.

toggleClass

  • toggleClass(e: Element, className: string, addOrRemove?: boolean): void
  • 要素にクラスを追加、または要素からクラスを削除します。

    引数

    • e: Element

      クラスを追加する要素。

    • className: string

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

    • オプション addOrRemove: boolean

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

    戻り値 void

tryCast

  • tryCast(value: any, type: any): any
  • 可能な場合、値を型にキャストします。

    引数

    • value: any

      キャストする値。

    • type: any

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

    戻り値 any

    The value passed in if the cast was successful, null otherwise.