addClass(e: Element, className: string): void
要素にクラスを追加します。
Element that will have the class added.
Class (or space-separated list of classes) to add to the element.
animate(apply: IAnimateCallback, duration?: number, step?: number): any
パラメーターが0から1まで変化するタイマーを使用して関数を呼び出します。
この関数を使用すると、ドキュメントのプロパティまたはスタイルをタイマーで変更することによってアニメーションを作成できます。
For example, the code below changes the opacity of an element from zero to one in one second:
```typescript import { animate } from '@grapecity/wijmo'; const element = document.getElementById('someElement'); animate(pct => { element.style.opacity = pct; }, 1000); ```
The function returns an interval ID that you can use to stop the animation. This is typically done when you are starting a new animation and wish to suspend other on-going animations on the same element. For example, the code below keeps track of the interval ID and clears if before starting a new animation:
```typescript 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); ```
Callback function that modifies the document. The function takes a single parameter that represents a percentage.
The duration of the animation, in milliseconds.
The interval between animation frames, in milliseconds.
asArray(value: any, nullOK?: boolean): any[]
値が配列であることを表明します。
Value supposed to be an array.
Whether null values are acceptable.
asBoolean(value: boolean, nullOK?: boolean): boolean
値がブール値であることを表明します。
Value supposed to be Boolean.
Whether null values are acceptable.
asCollectionView(value: any, nullOK?: boolean): ICollectionView
Asserts that a value is an ICollectionView or an Array.
Array or ICollectionView.
Whether null values are acceptable.
asDate(value: Date, nullOK?: boolean): Date
値が日付であることを表明します。
Value supposed to be a Date.
Whether null values are acceptable.
asEnum(value: number, enumType: any, nullOK?: boolean): number
値が列挙体の有効な設定であることを表明します。
Value supposed to be a member of the enumeration.
Enumeration to test for.
Whether null values are acceptable.
asFunction(value: any, nullOK?: boolean): Function
値が関数であることを表明します。
Value supposed to be a function.
Whether null values are acceptable.
asInt(value: number, nullOK?: boolean, positive?: boolean): number
値が整数であることを表明します。
Value supposed to be an integer.
Whether null values are acceptable.
Whether to accept only positive integers.
asNumber(value: number, nullOK?: boolean, positive?: boolean): number
値が数値であることを表明します。
Value supposed to be numeric.
Whether null values are acceptable.
Whether to accept only positive numeric values.
assert(condition: boolean, msg: string): void
条件が偽の場合、例外をスローします。
Condition expected to be true.
Message of the exception if the condition is not true.
asString(value: string, nullOK?: boolean): string
値が文字列であることを表明します。
Value supposed to be a string.
Whether null values are acceptable.
asType(value: any, type: any, nullOK?: boolean): any
値が指定した型のインスタンスであることを表明します。
Value to be checked.
Type of value expected.
Whether null values are acceptable.
changeType(value: any, type: DataType, format?: string, refDate?: Date): any
値の型を変更します。
If the conversion fails, the original value is returned. To check if a conversion succeeded, you should check the type of the returned value.
Value to convert.
DataType to convert the value to.
Format to use when converting to or from strings.
Reference date to use when parsing strings with missing information.
clamp(value: number, min: number, max: number): number
最小値から最大値までの範囲に値をクランプします。
closest(e: any, selector: string): Element
セレクターを満たす最も近い祖先（元の要素を含む）を検索します。
Element where the search should start.
A string containing a selector expression to match elements against.
closestClass(e: any, className: string): Node
クラスセレクターを満たす最も近い祖先（元の要素を含む）を検索します。
Element where the search should start.
A string containing the class name to match elements against.
contains(parent: any, child: any, popup?: boolean): boolean
HTML要素に別の要素が含まれているかどうかをチェックします。
Parent element.
Child element.
Whether to take Wijmo popups into account.
copy(dst: any, src: any): any
オブジェクトのプロパティを別のオブジェクトにコピーします。
このメソッドは、通常、コントロールや他のWijmoオブジェクトのプロパティを設定し、イベントハンドラを割り当てることによって、コントロールや他のWijmoオブジェクトを初期化するために使用されます。
コピー先オブジェクトでは、コピー元で定義されているすべてのプロパティが定義されている必要があります。そうでなければ、エラーがスローされます。
The destination object.
The source object.
createElement(html: string, appendTo?: HTMLElement, css?: any): HTMLElement
HTML文字列から要素を作成します。
HTML fragment to convert into an HTMLElement.
Optional HTMLElement to append the new element to.
Optional CSS attributes to apply to the root of the new element.
disableAutoComplete(e: HTMLInputElement): void
入力要素のautocompleteプロパティ、autocorrectプロパティ、autocapitalizeプロパティ、およびspellcheckプロパティを無効にします。
The input element.
enable(e: HTMLElement, value: boolean): void
要素を有効または無効にします。
Element to enable or disable.
Whether to enable or disable the element.
escapeHtml(text: string): string
HTML文字をテキストエンティティに置き換えることによって文字列をエスケープします。
Strings entered by users should always be escaped before they are displayed in HTML pages. This helps ensure page integrity and prevent HTML/javascript injection attacks.
Text to escape.
escapeRegExp(text: string): string
特殊な正規表現文字の前にバックスラッシュを付けることにより、文字列をエスケープします。
Text to escape.
evalTemplate(template: string, ctx?: any): string
Evaluates a string in template literal notation.
This function allows you to evaluate template literals on-demand, rather than when they are declared.
The template string uses the standard template literal syntax, except it is a regular string (enclosed in single or double quotes) rather than a template literal (enclosed in back-quotes).
The template string may contain references to variables provided in a context object passed as a parameter.
The template string may contain formatting information as used with the glbz tag function.
For example: ```typescript 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? ```
String in template literal notation.
Object with properties acessible to the template.
format(format: string, data: any, formatFunction?: Function): string
指定された文字列内の各書式項目をオブジェクトの値に対応するテキストに置き換えます。
The function works by replacing parts of the formatString with the pattern '{name:format}' with properties of the data parameter. For example:
```typescript import { format } from '@grapecity/wijmo'; let data = { name: 'Joe', amount: 123456 }, msg = format('Hello {name}, you won {amount:n2}!', data); ```
The format function supports pluralization. If the format string is a JSON-encoded object with 'count' and 'when' properties, the method uses the 'count' parameter of the data object to select the appropriate format from the 'when' property. For example:
```typescript 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 })); // No items selected. console.log(format(fmt, { count: 1 })); // One item is selected. console.log(format(fmt, { count: 2 })); // A pair is selected. console.log(format(fmt, { count: 12 })); // 12 items are selected. ```
The optional formatFunction allows you to customize the content by providing context-sensitive formatting. If provided, the format function gets called for each format element and gets passed the data object, the parameter name, the format, and the value; it should return an output string. For example:
```typescript 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; } ); ```
A composite format string.
The data object used to build the string.
An optional function used to format items in context.
getActiveElement(): HTMLElement
シャドウドキュメントフラグメントも考慮して、フォーカスを持つ要素への参照を取得します。
getAggregate(aggType: Aggregate, items: any[], binding?: string): void
配列内の値から集計値を計算します。
Type of aggregate to calculate.
Array with the items to aggregate.
Name of the property to aggregate on (in case the items are not simple values).
getElement(selector: any): HTMLElement
jQueryのセレクターから要素を取得します。
An element, a query selector string, or a jQuery object.
getElementRect(e: Element): Rect
要素の外接矩形（ページ座標単位）を取得します。
This is similar to the getBoundingClientRect function, except that uses viewport coordinates, which change when the document scrolls.
getTypes(arr: any[], limit?: number): IBindingInfo[]
配列内の項目の名前と項目の種類を含む配列を取得します。
Array containing data items.
Number of the array items to scan (1000 by default). Zero or negative value causes the function to scan all items.
getUniqueId(baseId: string): string
指定されたベースIDに連続する数値を付加して、要素の新しい一意IDを作成します。
String to use as a basis for generating the unique id.
glbz(...args: any[]): string
Tag function for use with template literals.
The glbz tag function allows you to specify formatting for variables in template literal expressions.
To format a variable in a template literal using glbz, add a colon and the format string after the name of the variable you want to format.
For example:
```typescript 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'!`; ```
hasItems(value: ICollectionView): boolean
Checks whether an ICollectionView is defined and not empty.
ICollectionView to check.
hidePopup(popup: HTMLElement, remove?: any, fadeOut?: boolean): any
Hides a popup element previously displayed with the showPopup method.
Popup element to hide.
Whether to remove the popup from the DOM or just to hide it. This parameter may be a boolean or a callback function that gets invoked after the popup has been removed from the DOM.
Whether to use a fade-out animation to make the popup disappear gradually.
httpRequest(url: string, options?: IHttpRequestOptions): XMLHttpRequest
HTTP要求を実行します。
Use the success method to obtain the result of the request which is provided in the callback's XMLHttpRequest parameter. For example, the code below uses the httpRequest method to retrieve a list of customers from an OData service:
```typescript 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; // do something with the customers... } }); ```
String containing the URL to which the request is sent.
An optional IHttpRequestOptions object used to configure the request.
isArray(value: any): value
オブジェクトが配列かどうかを判断します。
Value to test.
isBoolean(value: any): value
オブジェクトがブール値かどうかを判断します。
Value to test.
isDate(value: any): value
オブジェクトが日付かどうかを判断します。
Value to test.
isEmpty(obj: any): boolean
オブジェクトが空（列挙可能なプロパティが含まれない）であるかどうかを判定します。
Object to test.
isFunction(value: any): value
オブジェクトが関数かどうかを判断します。
Value to test.
isInt(value: any): value
オブジェクトが整数かどうかを判断します。
Value to test.
isNullOrWhiteSpace(value: string): boolean
文字列がnull、空、またはホワイトスペースのみかどうかを判断します。
Value to test.
isNumber(value: any): value
オブジェクトが数値かどうかを判断します。
Value to test.
isObject(value: any): boolean
オブジェクトが（値型または日付ではなく）オブジェクトであるかどうかを判断します。
Value to test.
isPrimitive(value: any): value
オブジェクトがプリミティブ型（string、number、Boolean、Date）かどうかを判断します。
Value to test.
isString(value: any): value
オブジェクトが文字列かどうかを判断します。
Value to test.
isUndefined(value: any): value
オブジェクトが未定義かどうかを判断します。
Value to test.
mouseToPage(e: any): Point
Converts mouse or touch event arguments into a Point in page coordinates.
moveFocus(parent: HTMLElement, offset: number): boolean
指定された親要素内の次/前/最初のフォーカス可能な子にフォーカスを移動します。
Parent element.
Offset to use when moving the focus (use zero to focus on the first focusable child).
removeChild(e: Node): Node
要素をDOMツリーから安全に削除します。
Element to remove from the DOM tree.
removeClass(e: Element, className: string): void
要素からクラスを削除します。
Element that will have the class removed.
Class (or space-separated list of classes) to remove from the element.
saveFile(content: string | Blob, fileName: string, type?: string): void
ファイルに内容を保存します。
A string or a Blob object to be saved to a file.
Name of the file to save, including extension.
Optional file MIME type, used if the **content** argument is a string.
The saveFile method can be used to create text files (txt, csv, html) as well as image files.
For example, this code saves the current selection of a FlexGrid to a CSV file:
```typescript import { saveFile } from '@grapecity/wijmo'; const clipString = theGrid.getClipString(null, true, true, false); saveFile(clipString, 'grid.csv', 'text/csv'); ```
And this code saves the content of a canvas element to a JPG file:
```typescript import { saveFile } from '@grapecity/wijmo';
canvas.toBlob(blob => { saveFile(blob, 'image.jpg'); }, 'image/jpeg'); ```
setAriaLabel(e: Element, value?: string): void
Sets or clears an element's aria-label attribute.
Element that will be updated.
Value of the aria label, or null to remove the label from the element.
setAttribute(e: Element, name: string, value?: any, keep?: boolean): void
要素の属性を設定またはクリアします。
Element that will be updated.
Name of the attribute to add or remove.
Value of the attribute, or null to remove the attribute from the element.
Whether to keep original attribute if present.
setChecked(cb: HTMLInputElement, checked: boolean): void
Sets the checked and indeterminate properties of a checkbox input element.
Checkbox element.
True, false, or null for checked, unchecked, or indeterminate.
setCss(e: any, css: any): void
オブジェクトで指定されたプロパティを適用して、要素のスタイルを変更します。
Element or array of elements whose style will be modified.
Object containing the style properties to apply to the element.
setLicenseKey(licenseKey: string): void
ライセンス付きWijmoアプリケーションを識別するライセンスキーを設定します。
ライセンスキーが設定されていない場合は、Wijmoは評価モードで動作し、ページに透かしが追加されます。
Licensed users may obtain keys at the My Account section of the Wijmo site.
Note that Wijmo does not send keys or any licensing information to any servers. It only checks the internal consistency of the key provided.
String containing the license key to use in this application.
setSelectionRange(e: any, start: number, end?: number): boolean
テキストフィールド内の選択の開始位置と終了位置を設定します。
This method is similar to the native setSelectionRange method in HTMLInputElement objects, except it checks for conditions that may cause exceptions (element not in the DOM, disabled, or hidden).
HTMLInputElement or HTMLTextAreaElement to select.
Offset into the text field for the start of the selection.
Offset into the text field for the end of the selection.
setText(e: HTMLElement, text: string): void
要素のテキストの内容を設定します。
Element that will have its content updated.
Plain text to be assigned to the element.
showPopup(popup: HTMLElement, ref?: any, position?: PopupPosition | Boolean, fadeIn?: boolean, copyStyles?: any, hideOnScroll?: Function): any
要素をポップアップとして表示します。
The popup element becomes a child of the body element, and is positioned with respect to reference rectangle according to the given PopupPosition.
The reference rectangle may be specified as one of the following:
Call the hidePopup method to hide the popup.
Element to show as a popup.
Reference element or rectangle used to position the popup.
Position of the popup with respect to the reference element.
Use a fade-in animation to make the popup appear gradually.
Whether to copy font and color styles from the reference element, or an element to use as the style source.
An optional function called when the popup is hidden as a result of a parent element scrolling.
toFixed(value: number, prec: number, truncate: boolean): number
数値を指定した精度に切り上げまたは切り捨てます。
Value to round or truncate.
Number of decimal digits for the result.
Whether to truncate or round the original value.
toggleClass(e: Element, className: string, addOrRemove?: boolean): void
要素にクラスを追加、または要素からクラスを削除します。
Element that will have the class added.
Class to add or remove.
Whether to add or remove the class. If not provided, toggle the class.
toHeaderCase(text: string): string
キャメルケースの文字列をヘッダタイプの文字列に変換します。最初の文字を大文字にし、小文字の後に大文字が続いている場合に大文字の前にスペースを追加します。
たとえば、'somePropertyName'は'Some Property Name'になります。
String to convert to header case.
toPlainText(html: string): string
HTML文字列をプレーンテキストに変換します。
HTML string to convert to plain text.
tryCast(value: any, type: any): any
可能な場合、値を型にキャストします。
Value to cast.
Type or interface name to cast to.
Wijmoライブラリ内のすべてのローカライズ可能な文字列を含むオブジェクトを取得または設定します。
The culture selector is a two-letter string that represents an ISO 639 culture.