Wijmo
- Binding
- Canceleventargs
- Arraybase
- Clipboard
- Collectionview
- Collectionviewgroup
- Color
- Control
- Datetime
- Event
- Interop
- Eventargs
- Globalize
- Groupdescription
- Notifycollectionchangedeventargs
- Observablearray
- Pagechangingeventargs
- Point
- Printdocument
- Propertychangedeventargs
- Propertygroupdescription
- Rect
- Requesterroreventargs
- Size
- Sortdescription
- Tooltip
- Tooltipeventargs
- Aggregate
- Datatype
- Key
- Notifycollectionchangedaction
- Popupposition
- Sortnulls
- Ibindinginfo
- Icollectionview
- Ieditablecollectionview
- Ihttprequestoptions
- Inotifycollectionchanged
- Ipagedcollectionview
- Iqueryinterface
- Barcode
- Chart
- Cloud
- Gauge
- Grid
- Input
- Nav
- Odata
- Olap
- Pdf
- Rest
- Touch
- Undo
- Viewer
- Xlsx
Interops

Index

wijmo モジュール

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

変数

culture

インターフェイス

列挙型

メソッド

変数

culture

culture: any

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

カルチャセレクターは、<a href=''https://ja.wikipedia.org/wiki/ISO_639-1コード一覧''>ISO 639カルチャを表す2文字の文字列です。

メソッド

addClass

addClass(e: Element, className: string): void

要素にクラスを追加します。

引数
- e: Element
  
  クラスを追加する要素。
- className: string
  
  要素に追加するクラス（またはスペースで区切られたクラスのリスト）。
戻り値 void

animate

animate(apply: IAnimateCallback, duration?: number, step?: number): any

パラメーターが0から1まで変化するタイマーを使用して関数を呼び出します。

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

たとえば、以下のコードは、要素の不透明度を1秒間で0から1に変更します。
```
import { animate } from '@grapecity/wijmo';
const element = document.getElementById('someElement');
animate(pct => {
    element.style.opacity = pct;
}, 1000);
```
この関数は、アニメーションの停止に使用できる内部IDを返します。アニメーションの停止は通常、新しいアニメーションを開始するときや、同じ要素で現在実行されている他のアニメーションを中止するときに行います。たとえば、以下のコードは、内部IDを追跡して新しいアニメーションを開始する前にIDをクリアします。
```
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。

asArray

asArray(value: any, nullOK?: boolean): any[]

値が配列であることを表明します。

引数
- value: any
  
  配列であるはずの値。
- オプション nullOK: boolean
  
  nullが許容されるかどうか。
戻り値 any[]

渡された配列。

asBoolean

asBoolean(value: boolean, nullOK?: boolean): boolean

値がブール値であることを表明します。

引数
- value: boolean
  
  ブール値であるはずの値。
- オプション nullOK: boolean
  
  nullが許容されるかどうか。
戻り値 boolean

渡されたブール値。

asCollectionView

asCollectionView(value: any, nullOK?: boolean): ICollectionView

値がICollectionView または配列であることを表明します。

引数
- value: any
  
  配列または ICollectionView。
- オプション nullOK: boolean
  
  nullが許容されるかどうか。
戻り値 ICollectionView

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

asDate

asDate(value: Date, nullOK?: boolean): Date

値が日付であることを表明します。

引数
- value: Date
  
  日付であるはずの値。
- オプション nullOK: boolean
  
  nullが許容されるかどうか。
戻り値 Date

渡された日付。

asEnum

asEnum(value: number, enumType: any, nullOK?: boolean): number

値が列挙体の有効な設定であることを表明します。

引数
- value: number
  
  列挙体のメンバであるはずの値。
- enumType: any
  
  テストする列挙体。
- オプション nullOK: boolean
  
  nullが許容されるかどうか。
戻り値 number

渡された値。

asFunction

asFunction(value: any, nullOK?: boolean): Function

値が関数であることを表明します。

引数
- value: any
  
  関数であるはずの値。
- オプション nullOK: boolean
  
  nullが許容されるかどうか。
戻り値 Function

渡された関数。

asInt

asInt(value: number, nullOK?: boolean, positive?: boolean): number

値が整数であることを表明します。

引数
- value: number
  
  整数であるはずの値。
- オプション nullOK: boolean
  
  nullが許容されるかどうか。
- オプション positive: boolean
  
  正の整数のみを受け入れるかどうか。
戻り値 number

渡された数値。

asNumber

asNumber(value: number, nullOK?: boolean, positive?: boolean): number

値が数値であることを表明します。

引数
- value: number
  
  数値であるはずの値。
- オプション nullOK: boolean
  
  nullが許容されるかどうか。
- オプション positive: boolean
  
  正の数値のみを受け入れるかどうか。
戻り値 number

渡された数値。

asString

asString(value: string, nullOK?: boolean): string

値が文字列であることを表明します。

引数
- value: string
  
  文字列であるはずの値。
- オプション nullOK: boolean
  
  nullが許容されるかどうか。
戻り値 string

渡された文字列。

asType

asType(value: any, type: any, nullOK?: boolean): any

値が指定した型のインスタンスであることを表明します。

引数
- value: any
  
  チェックする値。
- type: any
  
  期待される値の型。
- オプション nullOK: boolean
  
  nullが許容されるかどうか。
戻り値 any

渡された値。

assert

assert(condition: boolean, msg: string): void

条件が偽の場合、例外をスローします。

引数
- condition: boolean
  
  真であることが期待される条件。
- msg: string
  
  条件が真でない場合の例外メッセージ。
戻り値 void

changeType

changeType(value: any, type: DataType, format?: string, refDate?: Date): any

値の型を変更します。

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

引数
- value: any
  
  変換する値。
- type: DataType
  
  値の変換先のDataType。
- オプション format: string
  
  文字列に変換、または文字列から変換するときに使用する書式。
- オプション refDate: Date
  
  情報が不足している文字列を解析するときに使用する参照日。
戻り値 any

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

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

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

closestClass

closestClass(e: any, className: string): Node

クラスセレクターを満たす最も近い祖先（元の要素を含む）を検索します。

引数
- e: any
  
  検索を開始する要素。
- className: string
  
  クラス名を含む文字列に対する要素を一致させます。
戻り値 Node

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

contains

contains(parent: any, child: any, popup?: boolean): boolean

HTML要素に別の要素が含まれているかどうかをチェックします。

引数
- parent: any
  
  親要素。
- child: any
  
  子要素。
- オプション popup: boolean
  
  Wijmoポップアップを考慮に入れるかどうか。
戻り値 boolean

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

copy

copy(dst: any, src: any): any

オブジェクトのプロパティを別のオブジェクトにコピーします。

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

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

引数
- dst: any
  
  コピー先オブジェクト。
- src: any
  
  コピー元オブジェクト。
戻り値 any

コピー先オブジェクト。

createElement

createElement(html: string, appendTo?: HTMLElement, css?: any): HTMLElement

HTML文字列から要素を作成します。

引数
- html: string
  
  HTMLElementに変換するHTMLフラグメント。
- オプション appendTo: HTMLElement
  
  新しい要素を付加する先のオプションのHTMLElement。
- オプション css: any
  
  新しい要素のルートに適用するオプションのCSS属性。
戻り値 HTMLElement

新しい要素。

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

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

escapeRegExp

escapeRegExp(text: string): string

特殊な正規表現文字の前にバックスラッシュを付けることにより、文字列をエスケープします。

引数
- text: string
  
  エスケープするテキスト。
戻り値 string

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

evalTemplate

evalTemplate(template: string, ctx?: any): string

テンプレートリテラル表記の文字列を評価します。

この関数を使用すると、テンプレートリテラルが宣言されているときではなく、要求した時に評価できます。

テンプレート文字列は、標準のテンプレートリテラル構文を使用します。これは、テンプレートリテラル（逆引用符で囲まれる状態）ではなく、通常の文字列（単一引用符または二重引用符で囲まれる状態）です。

テンプレート文字列には、パラメータとして渡されるコンテキストオブジェクトで提供される変数への参照を含めることができます。

テンプレート文字列には、glbzタグ関数で使用されるフォーマット情報が含まれる場合があります。

次に例を示します。
```
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

結果を含む文字列。

format

format(format: string, data: any, formatFunction?: Function): string

指定された文字列内の各書式項目をオブジェクトの値に対応するテキストに置き換えます。

この関数は、formatString 内のパターン'{name:format}'を data パラメータのプロパティに置き換えます。次に例を示します。
```
import { format } from '@grapecity/wijmo';
let data = { name: 'Joe', amount: 123456 },
    msg = format('Hello {name}, you won {amount:n2}!', data);
```
format 関数は複数形式をサポートします。書式文字列が'count'プロパティと'when'プロパティを含むJSONエンコードオブジェクトの場合、このメソッドはデータオブジェクトの'count'パラメータを使用して、 'when'プロパティから適切な書式を選択します。次に例を示します。
```
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つ選択されています。
```
オプションの formatFunction を使用すると、状況依存の書式設定を指定してコンテンツをカスタマイズできます。指定すると、書式要素ごとに書式関数が呼び出され、データオブジェクト、パラメータ名、書式、および値が渡されて、出力文字列が返されます。次に例を示します。
```
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

書式設定された文字列。

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

getType(value: any): DataType

値の型を取得します。

引数
- value: any
  
  テストする値。
戻り値 DataType

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

getTypes

getTypes(arr: any[]): IBindingInfo[]

配列内の項目の名前と項目の種類を含む配列を取得します。

引数
- arr: any[]
  
  データ項目を含む配列。
戻り値 IBindingInfo[]

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

getUniqueId

getUniqueId(baseId: string): string

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

引数
- baseId: string
  
  一意IDを生成するためのベースとして使用する文字列。
戻り値 string

getVersion

getVersion(): string

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

戻り値 string

glbz

glbz(...args: any[]): string

テンプレートリテラルで使用するタグ関数を表します。

glbzタグ関数を使用すると、テンプレートリテラル式の変数のフォーマットを指定できます。

glbzを使用してテンプレートリテラルの変数をフォーマットするには、フォーマットする変数の名前の後にコロンとフォーマット文字列を追加します。

次に例を示します。
```
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

hasClass

hasClass(e: Element, className: string): boolean

要素がクラスを持つかどうかをチェックします。

引数
- e: Element
  
  チェックする要素。
- className: string
  
  チェックするクラス。
戻り値 boolean

hasItems

hasItems(value: ICollectionView): boolean

ICollectionView が定義されていて空でないかどうかをチェックします。

引数
- value: ICollectionView
  
  チェックする ICollectionView。
戻り値 boolean

hidePopup

hidePopup(popup: HTMLElement, remove?: any, fadeOut?: boolean): any

showPopup メソッドによって表示されたポップアップ要素を非表示にします。

引数
- popup: HTMLElement
  
  非表示にするポップアップ要素。
- オプション remove: any
  
  DOMからポップアップを削除するか、またはポップアップを非表示にするかを決定します。このパラメータは、ポップアップがDOMから削除された後で呼び出されるコールバック関数またはブール値です。
- オプション fadeOut: boolean
  
  ポップアップを徐々に非表示にするフェードアウトアニメーションを使用するかどうか。
戻り値 any

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

httpRequest

httpRequest(url: string, options?: IHttpRequestOptions): XMLHttpRequest

HTTP要求を実行します。

successメソッドを使用して、コールバックのXMLHttpRequestパラメータで提供されるリクエストの結果を取得します。たとえば、次のコードは、httpRequestメソッドを使用して、ODataサービスから顧客のリストを取得します。
```
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オブジェクト。

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、フォーカス可能な要素が見つからない場合はfalse。

removeChild

removeChild(e: Node): Node

要素をDOMツリーから安全に削除します。

引数
- e: Node
  
  DOMツリーから削除する要素。
戻り値 Node

removeClass

removeClass(e: Element, className: string): void

要素からクラスを削除します。

引数
- e: Element
  
  クラスを削除する要素。
- className: string
  
  要素から削除するクラス（またはスペースで区切られたクラスのリスト）。
戻り値 void

saveFile

saveFile(content: string, fileName: string, type?: string): void

ファイルに内容を保存します。

引数
- content: string
  
  ファイルに保存される文字列。
- fileName: string
  
  保存するファイルの名前（拡張子を含む）。
- オプション type: string
  オプションのファイル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';
let dataUrl = canvas.toDataURL('image/jpg', 0.95),
    match = dataUrl.match(/^data:([^,]+),(.*)$/i);
saveFile(match[2], 'canvas.jpg', match[1]);
```
戻り値 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

setChecked

setChecked(cb: HTMLInputElement, checked: boolean): void

チェックボックス入力要素のcheckedプロパティとindeterminateプロパティを設定します。

引数
- cb: HTMLInputElement
  
  チェックボックス要素。
- checked: boolean
  
  checkedの場合はtrue、uncheckedの場合はfalse、またはindeterminateの場合はnull。
戻り値 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, position?: PopupPosition | Boolean, fadeIn?: boolean, copyStyles?: any, hideOnScroll?: Function): any

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

ポップアップ要素はボディ要素の子になり、指定されたPopupPositionに応じて参照矩形に対して配置されます。

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

HTMLElement

要素の外接矩形。

MouseEvent

イベントのターゲット要素の外接矩形。

Rect

特定の矩形。

null

参照矩形なし。ポップアップはウィンドウの中央に配置されます。

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

引数
- popup: HTMLElement
  
  ポップアップとして表示する要素。
- オプション ref: any
  
  ポップアップの配置に使用される参照要素または矩形。
- オプション position: PopupPosition | Boolean
  
  参照要素に対するポップアップの位置。
- オプション fadeIn: boolean
  
  フェードインアニメーションを使用してポップアップを徐々に表示します。
- オプション copyStyles: any
  
  参照要素からフォントと色のスタイルをコピーするか、要素をスタイルソースとして使用するかどうか。
- オプション hideOnScroll: Function
  
  親要素のスクロールの結果として、ポップアップが非表示になったときに呼び出されるオプションの関数。
戻り値 any

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

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

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

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

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

Index

wijmo モジュール

変数

クラス

インターフェイス

列挙型

メソッド

変数

culture

メソッド

addClass

引数

e: Element

className: string

戻り値 void

animate

引数

apply: IAnimateCallback

オプション duration: number

オプション step: number

戻り値 any

asArray

引数

value: any

オプション nullOK: boolean

戻り値 any[]

asBoolean

引数

value: boolean

オプション nullOK: boolean

戻り値 boolean

asCollectionView

引数

value: any

オプション nullOK: boolean

戻り値 ICollectionView

asDate

引数

value: Date

オプション nullOK: boolean

戻り値 Date

asEnum

引数

value: number

enumType: any

オプション nullOK: boolean

戻り値 number

asFunction

引数

value: any

オプション nullOK: boolean

戻り値 Function

asInt

引数

value: number

オプション nullOK: boolean

オプション positive: boolean

戻り値 number

asNumber

引数

value: number

オプション nullOK: boolean

オプション positive: boolean

戻り値 number

asString

引数

value: string

オプション nullOK: boolean

戻り値 string

asType

引数

value: any

type: any

オプション nullOK: boolean

戻り値 any

assert

引数

condition: boolean

msg: string

戻り値 void