ASP.NET MVC コントロールヘルプ
FlexSheet クラス
ファイル
wijmo.grid.sheet.js
モジュール
wijmo.grid.sheet
基本クラス
FlexGrid
派生クラス
FlexSheet
Show
   

FlexSheet コントロールを定義します。

The FlexSheet control extends the FlexGrid control to provide Excel-like features such as a calculation engine, multiple sheets, undo/redo, and XLSX import/export.

A complete list of the functions supported by the FlexSheet's calculation engine can be found here: FlexSheet Functions.

{@sample Grid/FlexSheet/Bound/purejs デモ}

コンストラクタ

プロパティ

メソッド

イベント

コンストラクタ

constructor

constructor(element: any, options?: any): FlexSheet

FlexSheetクラスの新しいインスタンスを初期化します。

パラメーター
戻り値
FlexSheet

プロパティ

activeCell

Gets the **HTMLElement** that represents the currently active cell element.

If no cell is currently selected, or if the selected cell is not currently within view, this property returns null.

継承元
FlexGrid
HTMLElement

activeEditor

Gets the **HTMLInputElement** that represents the currently active cell editor.

If no cell is currently being edited, this property returns null.

継承元
FlexGrid
HTMLInputElement

allowAddNew

ユーザーがソースコレクションに項目を追加できるようにグリッドに新規行テンプレートを表示するかどうかを示す値を取得または設定します。

isReadOnly プロパティがtrueに設定されている場合、新規行テンプレートは表示されません。

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

継承元
FlexGrid
boolean

allowAutoFill

オートフィル機能を有効にするかどうかを示す値を取得または設定します。 オートフィルは、セルの右下隅をドラッグするパターンでセルにデータを自動入力する機能です。

boolean

allowDelete

ユーザーが[Delete]キーを押したときにグリッドの選択されている行を削除するかどうかを示す値を取得または設定します。

isReadOnly プロパティがtrueに設定されている場合、選択されている行は削除されません。

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

継承元
FlexGrid
boolean

allowDragging

ユーザーがマウスを使用して行、列、またはその両方をドラッグできるかどうかを決定する値を取得または設定します。

autoScroll プロパティがtrueに設定されている場合、ユーザーが行または列を新しい位置にドラッグするときにグリッドの内容が自動的にスクロールされます。

グリッドでは、列のドラッグがデフォルトで有効になっています。

グリッドが連結モードでは、行をドラッグするには特別な 考慮が必要になります。

When you drag rows on bound grids, the rows will get out of sync with the data source (row 4 may refer to item 6 for example). To avoid this, you should handle the draggedRow event and synchronize the data with the new row positions.

また、allowSorting プロパティをfalseに設定する必要があります。そうしないと、行の順序がデータによって決定され、行をドラッグするのは無意味になります。

次のフィドルでは、連結グリッドでの行のドラッグを実行していますBound Row Dragging

The default value for this property is **AllowDragging.Columns** for the FlexGrid control and **AllowDragging.None** for the **PivotGrid** control.

This property does not apply to the **MultiRow** control.

継承元
FlexGrid
AllowDragging

allowMerging

グリッドのどの部分のセル結合を許可するかを取得または設定します。

The default value for this property is **AllowMerging.None** for the FlexGrid control and **AllowMerging.All** for the **PivotGrid** control.

This property does not apply to the **MultiRow** control.

継承元
FlexGrid
AllowMerging

allowPinning

Gets or sets a value that determines whether the grid should add pin buttons to the column headers and how the pin buttons behave.

The pin buttons allow users to pin (freeze) columns so they remain in view as the user scrolls the grid horizontally.

The default value for this property is **AllowPinning.None**.

継承元
FlexGrid
AllowPinning

allowResizing

ユーザーがマウスを使用して行、列、またはその両方をサイズ変更できるかどうかを決定する値を取得または設定します。

サイズ変更が可能な場合は、列ヘッダーセルの右端をドラッグして列を、行ヘッダーセルの下端をドラッグして行をサイズ変更できます。

Users may also double-click the edge of the header cells to automatically resize rows and columns to fit their content. The auto-size behavior can be customized using the autoSizeMode property.

このプロパティのデフォルト値は**AllowResizing.Columns**です。

継承元
FlexGrid
AllowResizing

allowSorting

ユーザーが列ヘッダーセルをクリックして列をソートできるかどうかを決定する値を取得または設定します。

The default value for this property is **AllowSorting.SingleColumn**.

継承元
FlexGrid
AllowSorting

alternatingRowStep

Gets or sets a value that determines the number of regular rows between 'alternating' rows.

The default value for this property is **1** for the FlexGrid. Set it to zero to disable alternating rows, or to a number greater than one to insert multiple regular rows between alternating rows.

The default value for this property is **1** for the FlexGrid control and **0** for the **PivotGrid** control.

継承元
FlexGrid
number

anchorCursor

Gets or sets a value that determines whether extending selections with the mouse or keyboard should change the start (cursor) or the end of the current selection.

The default value for this property is **false**, which causes the grid to move the cursor and keep the selection end anchored.

Setting this property to **true** causes the grid to move the selection end and keep the cursor anchored. This is Excel's behavior.

継承元
FlexGrid
boolean

autoClipboard

グリッドがクリップボードショートカットを処理するかどうかを決定する値を取得または設定します。

次のクリップボードショートカットがあります。

ctrl+C, ctrl+Ins
Copy grid selection to clipboard.
ctrl+V, shift+Ins
Paste clipboard text to grid selection.

Only visible rows and columns are included in clipboard operations.

Read-only cells are not affected by paste operations.

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

継承元
FlexGrid
boolean

autoGenerateColumns

グリッドがitemsSource に基づいて行を自動的に生成するかどうかを 決定する値を取得または設定します。

The column generation depends on the itemsSource property containing at least one item. This data item is inspected and a column is created and bound to each property that contains a primitive value (number, string, Boolean, or Date).

Properties set to null do not generate columns, because the grid would have no way of guessing the appropriate type. In this type of scenario, you should set the autoGenerateColumns property to false and create the columns explicitly. For example:

```typescript import { FlexGrid } from '@grapecity/wijmo.grid'; let grid = new FlexGrid('#theGrid', { autoGenerateColumns: false, // データ項目にnull値が含まれる場合があります columns: [ // そのため、列を明示的に定義します { binding: 'name', header: 'Name', dataType: 'String' }, { binding: 'amount', header: 'Amount', dataType: 'Number' }, { binding: 'date', header: 'Date', dataType: 'Date' }, { binding: 'active', header: 'Active', dataType: 'Boolean' } ], itemsSource: customers }); ```

The default value for this property is **true** for the FlexGrid control and **false** for the **PivotGrid** control.

継承元
FlexGrid
boolean

autoRowHeights

Gets or sets a value that determines whether the grid should automatically resize the rows when the data or grid layout change.

This property is especially useful when the grid has columns configured to word-wrap their content (see wordWrap), and when the grid has a relatively small number of rows (auto-sizing is an expensive operation).

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

継承元
FlexGrid
boolean

autoScroll

ユーザーが行または列を新しい位置にドラッグするときにグリッドの内容が自動的にスクロールされるかどうかを決定する値を取得または設定します。

行と列のドラッグは、allowDragging プロパティによって制御されます。

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

継承元
FlexGrid
boolean

autoSearch

ユーザーが読み取り専用セルに入力するに伴ってグリッドでセルを検索するかどうかを決定する値を取得または設定します。

検索が現在選択されている列(編集不可能な場合)で行われます。検索は現在選択されている行から始まり、大文字と小文字を区別されません。

See also the caseSensitiveSearch property.

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

継承元
FlexGrid
boolean

autoSizeMode

行または列のサイズを自動設定するときにどのセルを考慮に入れるかを取得または設定します。

このプロパティは、ユーザーが列ヘッダの端をダブルクリックしたときの動作を制御します。

By default, the grid will automatically set the column width based on the content of the header and data cells in the column. This property allows you to change that to include only the headers or only the data.

このプロパティのデフォルト値は**AutoSizeMode.Both**です。

継承元
FlexGrid
AutoSizeMode

bigCheckboxes

Gets or sets a value that determines whether the checkboxes used to edit boolean columns should extend to cover the whole cell width.

Big checkboxes are easier to toggle with the mouse, since the user may click anywhere in the cell to toggle them.

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

継承元
FlexGrid
boolean

bottomLeftCells

左下のセルを含むGridPanel を取得します。

bottomLeftCells パネルは、行ヘッダの下、columnFooters パネルの左に表示されます。

継承元
FlexGrid
GridPanel

calculationPrecision

Gets or sets the number of digits after the decimal point to round to when calculating formulas.

Negative value means that no rounding is performed.

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

number

caseSensitiveSearch

検索するときに大文字と小文字を区別するかどうかを決定する値を取得または設定します。

The searches include searching for regular text (see the autoSearch property) as well as searching for items while editing data-mapped cells (see the Column.dataMap property).

The default value for this property is **false** (searches are not case-sensitive by default).

継承元
FlexGrid
boolean

cellFactory

このグリッドのセルを作成および更新するCellFactory を取得または設定します。

継承元
FlexGrid
CellFactory

cells

データセルを含むGridPanel を取得します。

継承元
FlexGrid
GridPanel

childItemsPath

階層グリッドで子の行の生成に使用される1つ以上のプロパティの名前を取得または設定します。

このプロパティには、項目の子項目を含むプロパティの名前を指定する文字列を設定します(たとえば、childItemsPath = 'items';)。

項目の異なるレベルに異なる名前を持つ子項目がある場合は、このプロパティに、各レベルの子項目を含むプロパティの名前から成る配列を設定します。(たとえば、childItemsPath = ['checks','earnings'];)。

{@sample Grid/TreeGrid/ChildItems/purejs デモ}

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

This property does not apply to the **MultiRow** control.

継承元
FlexGrid
string

clientSize

コントロールのクライアントサイズを取得します(コントロールのサイズからヘッダーとスクロールバーを引いた値)。

継承元
FlexGrid
Size

cloneFrozenCells

Gets or sets a value that determines whether the FlexGrid should clone frozen cells and show then in a separate element to reduce flicker while scrolling.

このプロパティのデフォルト値はnullであり、ブラウザーによって一番適当な設定が選択されます。

継承元
FlexGrid
boolean

collectionView

グリッドのデータを含むICollectionView を取得します。

If the itemsSource property was set to an ICollectionView, this property returns that value.

If the itemsSource property was set to an array of data items, this property returns the internal CollectionView created by the grid to support currency, editing, and sorting.

継承元
FlexGrid
ICollectionView

columnFooters

列フッターセルを保持するGridPanelを取得します。

The columnFooters panel appears below the grid cells, to the right of the bottomLeftCells panel. It can be used to display summary information below the grid data.

以下の例では、columnFootersパネルに1行を追加して、aggregate プロパティが設定された列にサマリーデータを表示する方法を示します。

```typescript function addFooterRow(flex) {

// create a GroupRow to show aggregates let row = new wijmo.grid.GroupRow();

// add the row to the column footer panel flex.columnFooters.rows.push(row);

// show a sigma on the header flex.bottomLeftCells.setCellData(0, 0, '\u03A3'); } ```

継承元
FlexGrid
GridPanel

columnGroups

Gets or sets an array used to define hierarchical column groups.

The items in the array should be JSON objects with properties of Column objects, plus three optional members:

* 'columns' array containing an array of child columns, * 'collapseTo' string containing the binding of the child column that should remain visible when the group is collapsed. * 'isCollapsed' boolean that determines if the group should be initially collapsed.

For example, the code below generates a grid with two column groups, both initially collapsed:

```typescript new FlexGrid('#theGrid', { autoGenerateColumns: false, columnGroups: [ { header: 'Group 1', align: 'center', collapseTo: 'country', isCollapsed: true, columns: [ { binding: 'id', header: 'ID' }, { binding: 'date', header: 'Date', dataType: 'Date' }, { binding: 'country', header: 'Country', dataType: 'String' }, { binding: 'active', header: 'Active', dataType: 'Boolean' }, ]}, { header: 'Group 2', align: 'center', collapseTo: 'sales', isCollapsed: true, columns: [ { binding: 'sales', header: 'Sales', dataType: 'Number' }, { binding: 'expenses', header: 'Expenses', dataType: 'Number' }, ]} ], itemsSource: getData(20) }); ```

継承元
FlexGrid
any[]

columnHeaders

Gets the GridPanel that contains the column header cells.

継承元
FlexGrid
GridPanel

columnLayout

現在の列レイアウトを定義するJSON文字列を取得または設定します。

The column layout string represents an array with the columns and their properties. It can be used to persist column layouts defined by users so they are preserved across sessions, and can also be used to implement undo/redo functionality in applications that allow users to modify the column layout.

The column layout string does not include properties that cannot be converted to JSON, such as dataMap and editor.

If you want to save and restore column layouts and don't require the layouts to be serializable, you can clone the content of the columns property and restore it later using array methods. This is not as convenient as using the columnLayout property, but it does allow you to save and restore data maps and editors.

継承元
FlexGrid
string

columns

グリッドの列コレクションを取得します。

継承元
FlexGrid
ColumnCollection

controlRect

コントロールの外接矩形(ページ座標単位)を取得します。

継承元
FlexGrid
Rect

Static controlTemplate

Overrides the template used to instantiate FlexSheet control.

any

copyHeaders

Gets or sets a value that determines whether the grid should include the content of header cells when copying data to the clipboard.

This property is especially useful in read-only grids, because the header information typically should not be included when pasting data into the grid.

The default value for this property is **HeadersVisibility.None** for the FlexGrid control and **HeadersVisibility.All** for the **PivotGrid** control.

継承元
FlexGrid
HeadersVisibility

Static defaultTypeWidth

Gets a reference to a static object that defines the default width for auto-generated grid columns based on their types.

The object keys are DataType values. The object values are either numbers (widths in pixels) or star-size strings (multiples of the default width defined by the columns defaultSize property).

For example:

```typescript import { FlexGrid } from '@grapecity/wijmo.grid'; import { DataType } from '@grapecity/wijmo';

// make boolean columns on all grids 100px wide by default FlexGrid.defaultTypeWidth[DataType.Boolean] = 100;

// make numeric columns on all grids 75% as wide as the columns defaultSize FlexGrid.defaultTypeWidth[DataType.Number] = '0.75*'; ```

継承元
FlexGrid
object

deferResizing

ユーザーがマウスボタンを放すまで、行および列のサイズ変更を遅らせるかどうかを決定する値を取得または設定します。

By default, deferResizing is set to false, causing rows and columns to be resized as the user drags the mouse. Setting this property to true causes the grid to show a resizing marker and to resize the row or column only when the user releases the mouse button.

The default value for this property is **false** for the FlexGrid control and **true** for the **PivotGrid** control.

継承元
FlexGrid
boolean

definedNames

Gets an array the DefinedName objects representing named ranges/expressions defined in the FlexSheet.

ObservableArray

editableCollectionView

Gets the IEditableCollectionView that contains the grid data.

継承元
FlexGrid
IEditableCollectionView

editColumnIndex

Gets or sets the index of column in the row header panel that shows whether items are being edited.

The default value for this property is **null**, which causes the grid to show the edit glyph on the last column of the rowHeaders panel.

継承元
FlexGrid
number

editRange

Gets a CellRange that identifies the cell currently being edited.

継承元
FlexGrid
CellRange

enableDragDrop

シートで行または列のドラッグアンドドロップを有効にするかどうかを示す値を取得または設定します。

boolean

enableFormulas

シートで数式を有効にするかどうかを示す値を取得または設定します。

boolean

errorTip

Gets or sets the Tooltip object used to show validation errors detected by the grid when the showErrors property is set to true.

By default, this property is set to a tooltip with zero show delay (so it appears immediately when hovering over invalid cells), no HTML content, and a "wj-error-tip" class which can be used to customize the tooltip's appearance.

Setting this property to **null** causes the control to use the cell's "title" attribute to show validation errors.

継承元
FlexGrid
Tooltip

expandSelectionOnCopyPaste

Gets or sets a value that determines whether the grid should automatically expand the selection to include cells in merged ranges when copying or pasting content to/from the clipboard.

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

継承元
FlexGrid
boolean

filter

Gets the FlexSheetFilter instance that controls FlexSheet filtering.

FlexSheetFilter

frozenColumns

固定列の数を取得または設定します。

固定された列は水平方向にスクロールできませんが、セルは選択および編集できます。

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

継承元
FlexGrid
number

frozenRows

固定行の数を取得または設定します。

固定された行は垂直方向にスクロールできませんが、セルは選択および編集できます。

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

継承元
FlexGrid
number

groupHeaderFormat

Gets or sets the format string used to create the group header content.

この文字列は、任意のテキストと次の置換文字列を含むことができます。

  • {name}: The name of the property being grouped on.
  • {value}: The value of the property being grouped on.
  • {level}: The group level.
  • {count}: The total number of items in this group.

If a column is bound to the grouping property, the column header is used to replace the {name} parameter, and the column's format and data maps are used to calculate the {value} parameter. If no column is available, the group information is used instead.

グループプロパティに連結された非表示の列を追加して、グループヘッダーセルの書式設定をカスタマイズすることもできます。

The default value for this property is **null**, which causes the grid to use a culture-specific version of the string ```typescript '{name}: <b>{value}</b>({count:n0} items)' ```

This default format string creates group headers similar to

```typescript 'Country: <b>UK</b> (12 items)' 'Country: <b>Japan</b> (8 items)' ```

継承元
FlexGrid
string

headersVisibility

行ヘッダおよび列ヘッダが表示されるかどうかを決定する値を取得または設定します。

The default value for this property is **HeadersVisibility.All**.

継承元
FlexGrid
HeadersVisibility

hostElement

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

継承元
Control
HTMLElement

imeEnabled

編集モードでないときに、グリッドがIME(Input Method Editor)をサポートするかどうかを決定する値を取得または設定します。

このプロパティは、日本語、中国語、韓国語など、IMEサポートを必要とする言語のサイト/アプリケーションにのみ関係します。

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

継承元
FlexGrid
boolean

isDisabled

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

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

継承元
FlexGrid
boolean

isFunctionListOpen

関数リストが開いているかどうかを示す値を取得します。

boolean

isReadOnly

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

The default value for this property is **false** for the FlexGrid control and **true** for the **PivotGrid** control.

継承元
FlexGrid
boolean

isTabHolderVisible

TabHolderが表示されているかどうかを示す値を取得または設定します。

boolean

isTouching

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

継承元
Control
boolean

isUpdating

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

継承元
Control
boolean

itemFormatter

このグリッドのセルのカスタマイズに使用されるフォーマッター関数を取得または設定します。

The formatter function can add any content to any cell. It provides complete flexibility over the appearance and behavior of grid cells.

If specified, the function should take four parameters: the GridPanel that contains the cell, the row and column indices of the cell, and the HTML element that represents the cell. The function will typically change the **innerHTML** property of the cell element.

For example: ```typescript flex.itemFormatter = (panel, r, c, cell) => { if (panel.cellType == CellType.Cell) {

// draw sparklines in the cell let col = panel.columns[c]; if (col.name == 'sparklines') { cell.innerHTML = getSparkline(panel, r, c); } } } ```

Note that the FlexGrid recycles cells, so if your itemFormatter modifies the cell's style attributes, you must make sure that it resets these attributes for cells that should not have them. For example: ```typescript flex.itemFormatter = (panel, r, c, cell) => {

// reset attributes we are about to customize let s = cell.style; s.color = ''; s.backgroundColor = ''; // customize color and backgroundColor attributes for this cell ... } ```

If you have a scenario where multiple clients may want to customize the grid rendering (for example when creating directives or re-usable libraries), consider using the formatItem event instead. The event allows multiple clients to attach their own handlers.

継承元
FlexGrid
IItemFormatter

itemsSource

Gets or sets the array or ICollectionView that contains items shown on the grid.

継承元
FlexGrid
any

itemValidator

セルに有効なデータが含まれているかどうかを決定するバリデータ関数を取得または設定します。

If specified, the validator function should take parameters containing the cell's row and column indices and a parsing parameter that describes whether the data has already been parsed and applied to the data item (parsing == false), or whether the user was trying to edit the value and entered a value that could not be parsed into the data type expected (parsing == true).

このメソッドは、エラーメッセージを含む文字列を返します。エラーが検出されなかった場合はnullを返します。

次に例を示します。

```typescript grid.itemValidator = (row: number, col: number, parsing: boolean) => { let item = grid.rows[row].dataItem, prop = grid.columns[col].binding;

// parsing failed, show message if (parsing) { if (prop == 'date') { return 'Please enter a valid date in the format "MM/dd/yyyy"'; } else if (prop == 'id') { return 'Please enter a positive number'; } }

// check that stored (parsed) data is valid if (prop == 'date' && item.date < minDate) { return 'Please enter a date after ' + Globalize.formatDate(minDate, 'd'); } else if (prop == 'id' && item.id < 0) { return 'Please enter a positive number'; } }); ```</>>

See also the getError method.

継承元
FlexGrid
IItemValidator

keyActionEnter

[ENTER]キーが押されたときに実行されるアクションを取得または設定します。

The default setting for this property is MoveDown, which causes the control to move the selection to the next row. This is the standard Excel behavior.

継承元
FlexGrid
KeyAction

keyActionTab

[Tab]キーが押されたときに実行されるアクションを取得または設定します。

The default setting for this property is None, which causes the browser to select the next or previous controls on the page when the TAB key is pressed. This is the recommended setting to improve page accessibility.

In previous versions, the default was set to Cycle, which caused the control to move the selection across and down the grid. This is the standard Excel behavior, but is not good for accessibility.

There is also a CycleOut setting that causes the selection to move through the cells (as Cycle), and then on to the next/previous control on the page when the last or first cells are selected.

継承元
FlexGrid
KeyAction

lazyRender

Gets or sets a value that determines whether the grid should skip rendering cells that were updated in the last render cycle.

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

継承元
FlexGrid
boolean

mergeManager

Gets or sets the MergeManager object responsible for determining how cells should be merged.

継承元
FlexGrid
MergeManager

newRowAtTop

新しい行テンプレートをグリッドの上部に配置するか、下部に配置するかを示す値を取得または設定します。

If you set the newRowAtTop property to true, and you want the new row template to remain visible at all times, set the frozenRows property to one. This will freeze the new row template at the top so it won't scroll off the view.

The new row template will be displayed only if the allowAddNew property is set to true and if the itemsSource object supports adding new items.

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

継承元
FlexGrid
boolean

preserveOutlineState

データがリフレッシュされたときに、グリッドがノードの展開/折りたたみ状態を保持するかどうかを決定する値を取得または設定します。

The preserveOutlineState property implementation is based on JavaScript's Map object, which is not available in IE 9 or 10.

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

継承元
FlexGrid
boolean

preserveSelectedState

データがリフレッシュされたときに、グリッドが行の選択状態を保持するかどうかを決定する値を取得または設定します。

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

継承元
FlexGrid
boolean

preserveWhiteSpace

Gets or sets a value that determines whether the grid should keep whitespace in cells as they appear in the data (white-space: pre) or whether it should collapse the whitespace into a single space character (white-space: normal).

This property allows you to specify how the grid should handle white space without changing any CSS rules. You choose to use CSS rules instead, however, since they provide better control over scope.

For example, you could create CSS rules that apply to all grids in the application, to specific grids, or to specific columns.

Be aware that setting this property to **true** may have undesired effects in applications that use interop cell templates (Vue templates especially).

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

継承元
FlexGrid
boolean

quickAutoSize

グリッドが列のサイズを自動調整するときに精度よりもパフォーマンスを最適化するかどうかを決定する値を取得または設定します。

Setting this property to **false** disables quick auto-sizing. Setting it to **true** enables the feature, subject to the value of each column's quickAutoSize property.

The default value for this property is **null**, which enables quick auto-sizing for grids that don't have a custom itemFormatter or handlers attached to the formatItem event.

Quick auto-sizing uses different strategies when auto-sizing rows or columns.

When auto-sizing columns, it uses a temporary canvas element to locate the row with the widest entry for a column. When the row is located, its contents are measured precisely. The limitation with this approach is that the canvas only renders plain text, so if cells contain HTML the auto-sizing may miss the widest column.

When auto-sizing rows, it uses a cache to store the row heights based on the cell content, and skips measuring numeric cells. The limitation with this approach is that it only improves performance if many cells have the same content, or if many columns are numeric.

If you find that auto-sizing is slowing down your application, it is probably worth setting quickAutoSize to true and checking the results to see if it works correctly and improves performance for your app.

継承元
FlexGrid
boolean

refreshOnEdit

Gets or sets a value that determines whether the grid should refresh all cells after a cell is edited.

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

継承元
FlexGrid
boolean

rightToLeft

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

継承元
Control
boolean

rowHeaderPath

行ヘッダーセルを作成するために使用されるプロパティの名前を取得または設定します。

Row header cells are not visible or selectable. They are meant for use with accessibility tools.

継承元
FlexGrid
string

rowHeaders

Gets the GridPanel that contains the row header cells.

継承元
FlexGrid
GridPanel

rows

グリッドの行コレクションを取得します。

継承元
FlexGrid
RowCollection

scrollPosition

Gets or sets a Point that represents the value of the grid's scrollbars.

継承元
FlexGrid
Point

scrollSize

グリッド内容のサイズ(ピクセル単位)を取得します。

継承元
FlexGrid
Size

selectedItems

現在選択されているデータ項目を含む配列を取得または設定します。

Note: this property can be read in all selection modes, but it can be set only when selectionMode is set to **SelectionMode.ListBox**.

継承元
FlexGrid
any[]

selectedRanges

Gets or sets an array with CellRange objects that represent the current selection.

The first element in the array is the current selection. If the grid's selectionMode property is set to MultiRange, the array may contain additional ranges that represent the extended selection.

Note that ranges in the selectedRanges array may contain overlapping areas, which may be important when performing actions like aggregating over the extended selection.

継承元
FlexGrid
CellRange[]

selectedRows

現在選択されている行を含む配列を取得または設定します。

Note: this property can be read in all selection modes, but it can be set only when selectionMode is set to **SelectionMode.ListBox**.

継承元
FlexGrid
Row[]

selectedSheet

Gets the current Sheet in the FlexSheet.

Sheet

selectedSheetIndex

Gets or sets the index of the current sheet in the FlexSheet.

number

selection

現在の選択を取得または設定します。

継承元
FlexGrid
CellRange

selectionMode

現在の選択モードを取得または設定します。

継承元
FlexGrid
SelectionMode

sheets

Gets the collection of Sheet objects representing workbook sheets.

SheetCollection

showDropDown

Gets or sets a value that indicates whether the grid should add drop-down buttons to data-mapped cells.

The drop-down buttons are shown on columns that have a Column.dataMap and are editable.

Clicking on the drop-down buttons causes the grid to show a drop-down list from which users can select the cell value.

This setting may be overridden on specific columns using the column's dataMapEditor property.

Cell drop-downs require the **wijmo.input module** to be loaded.

継承元
FlexGrid
boolean

showErrors

Gets or sets a value that determines whether the grid should add the 'wj-state-invalid' class to cells that contain validation errors and tooltips with error descriptions.

The grid detects validation errors using the itemValidator property and the getError property on the grid's itemsSource.

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

継承元
FlexGrid
boolean

showFilterIcons

フィルタアイコンの表示/非表示を取得または設定します。

boolean

showGroups

Gets or sets a value that determines whether the FlexGrid should insert group rows to delimit data groups.

データグループを作成するには、itemsSource として使用されるICollectionView オブジェクトのgroupDescriptions プロパティを変更します。

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

継承元
FlexGrid
boolean

showMarquee

Gets or sets a value that indicates whether the grid should display an Excel-style marquee around the current selection.

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

If you choose to show the marquee, you may want to improve accessibility by using some simple CSS to make the marquee fully opaque only when the grid has the focus:

```css .wj-flexgrid:not(.wj-state-focused) .wj-marquee { opacity: 0.2; } ```

継承元
FlexGrid
boolean

showPlaceholders

Gets or sets a value that determines whether the grid should use the column headers as placeholders when editing cells.

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

This property is especially useful in grids that have multiple rows per data item (like the MultiRow grid) and in grids that allow adding new items (see the allowAddNew property).

This property only works with the grid's built-in editor. If you are using custom editors (see the Column.editor property), then you are responsible for setting the placeholder property on those.

The Internet Explorer browser does not show input placeholders on focused input elements, so this property is not useful in IE.

継承元
FlexGrid
boolean

showSelectedHeaders

選択されているヘッダセルを示すためにクラス名を追加するかどうかを示す値を取得または設定します。

The default value for this property is **HeadersVisibility.None**.

継承元
FlexGrid
HeadersVisibility

showSort

グリッドで、列ヘッダーにソートインジケータを 表示するかどうかを決定する値を取得または設定します。

Sorting is controlled by the sortDescriptions property of the ICollectionView object used as a the grid's itemsSource.

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

継承元
FlexGrid
boolean

sortManager

Gets the SortManager instance that controls FlexSheet sorting.

SortManager

sortRowIndex

ソートインジケーターを表示する列ヘッダパネルの行のインデックスを取得または設定します。

The default value for this property is **null**, which causes the bottom row in the columnHeaders panel to act as the sort row.

継承元
FlexGrid
number

stickyHeaders

ユーザーがドキュメントをスクロールしたときに、列ヘッダーを表示したままにするかどうかを決定する値を取得または設定します。

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

継承元
FlexGrid
boolean

tabOrder

Gets or sets a value of the **tabindex** attribute associated with the control.

**tabindex** attribute value can be defined statically for a Wijmo control by specifying it on the control's host HTML element. But this value can't be changed later during application lifecycle, because Wijmo controls have complex structure, and the control may need to propagate this attribute value to its internal element to work properly.

Because of this, to read or change control's **tabindex** dynamically, you should do it using this property.

継承元
Control
number

topLeftCells

Gets the GridPanel that contains the top left cells (to the left of the column headers).

継承元
FlexGrid
GridPanel

treeIndent

異なるレベルの行グループをオフセットするインデントを取得または設定します。

The default value for this property is **14** pixels for the FlexGrid control, and **32** pixels for the **PivotGrid**.

継承元
FlexGrid
number

undoStack

Gets the UndoStack instance that controls undo and redo operations of the FlexSheet.

UndoStack

validateEdits

検証に失敗した編集をユーザーがコミットしようとしたときに、グリッドを編集モードのままにするかどうかを指定する値を取得または設定します。

The grid detects validation errors by calling the getError method on the grid's itemsSource.

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

継承元
FlexGrid
boolean

viewRange

現在表示されているセルの範囲を取得します。

継承元
FlexGrid
CellRange

virtualizationThreshold

仮想化を有効にするために必要な最小行数、最小列数、またはその両方を取得または設定します。

This property is set to zero by default, meaning virtualization is always enabled. This improves binding performance and memory requirements, at the expense of a small performance decrease while scrolling.

If your grid has a small number of rows (about 50 to 100), you may be able to improve scrolling performance by setting this property to a slightly higher value (like 150). This will disable virtualization and will slow down binding, but may improve perceived scroll performance. For example, the code below sets causes the grid to virtualize cells when the data source has more than 150 items:

```typescript // virtualize grid when there are more than 150 items theGrid.virtualizationThreshold = 150; ```

Setting this property to values higher than 200 is not recommended. Loading times will become too long; the grid will freeze for a few seconds while creating cells for all rows, and the browser will become slow because of the large number of elements on the page.

If you want to set separate virtualization thresholds for rows and columns, you may set the virtualizationThreshold property to an array with two numbers. In this case, the first number will be used as the row threshold and the second as the column threshold. For example, the code below sets causes the grid to virtualize rows but not columns:

```typescript // virtualize rows (threshold 0) but not columns (threshold 10,000) theGrid.virtualizationThreshold = [0, 10000]; ```

The default value for this property is **0**, which causes the grid to virtualize all rows and columns.

継承元
FlexGrid
number

メソッド

addBoundSheet

addBoundSheet(sheetName: string, source: any, pos?: number, grid?: FlexGrid): Sheet

Add a bound Sheet to the FlexSheet.

パラメーター
  • sheetName: string

    The name of the Sheet.

  • source: any

    The items source for the Sheet.

  • pos: number Optional

    The position in the sheets collection.

  • grid: FlexGrid Optional

    The FlexGrid instance associated with the Sheet. If not specified then new FlexGrid instance will be created.

戻り値
Sheet

addEventListener

addEventListener(target: EventTarget, type: string, fn: any, capture?: boolean, passive?: boolean): void

このControl が所有する要素にイベントリスナーを追加します。

コントロールは、アタッチされているリスナーとそのハンドラのリストを保持し、コントロールが破棄されているときにそれらを簡単に削除すること ができます(disposeremoveEventListener メソッドを参照してください)。

イベントリスナーを削除しないと、メモリリークが発生する可能があります。

デフォルトでは passive パラメータはfalseに設定されています。これはイベントハンドラが event.preventDefault() を呼び出すことを意味します。タッチイベントまたはマウスホイールイベントにpassiveハンドラを追加する場合は、このパラメータをtrueに設定するとアプリケーションのパフォーマンスが向上します。

passive イベントリスナーの詳細については、「&lt;a target="_blank" href="https://developer.mozilla.org/en-US/docs/Web/API/EventTarget/addEventListener#Improving_scrolling_performance_with_passive_listeners"&gt;Improving scrolling performance with passive listeners&lt;/a&gt;」を参考してください。

パラメーター
  • target: EventTarget

    Target element for the event.

  • type: string

    String that specifies the event.

  • fn: any

    Function to execute when the event occurs.

  • capture: boolean Optional

    Whether the listener should be handled by the control before it is handled by the target element.

  • passive: boolean Optional

    Indicates that the handler will never call preventDefault().

継承元
Control
戻り値
void

addFunction

addFunction(name: string, func: Function, description?: string, minParamsCount?: number, maxParamsCount?: number): void

Add custom function in FlexSheet.

パラメーター
  • name: string

    the name of the custom function.

  • func: Function

    the custom function.
    The function signature looks as follows:

    function (...params: any[][][]): any;
    

    The function takes a variable number of parameters, each parameter corresponds to an expression passed as a function argument. Independently of whether the expression passed as a function argument resolves to a single value or to a cell range, each parameter value is always a two dimensional array of resolved values. The number of rows (first index) and columns (second index) in the array corresponds to the size of the specified cell range. In case where argument is an expression that resolves to a single value, it will be a one-to-one array where its value can be retrieved using the param[0][0] indexer.
    The sample below adds a custom Sum Product function ('customSumProduct') to the FlexSheet:

    flexSheet.addFunction('customSumProduct', (...params: any[][][]) => {
       let result = 0,
           range1 = params[0],
           range2 = params[1];
    
       if (range1.length > 0 && range1.length === range2.length && range1[0].length === range2[0].length) {
           for (let i = 0; i < range1.length; i++) {
               for (let j = 0; j < range1[0].length; j++) {
                   result += range1[i][j] * range2[i][j];
               }
           }
       }
       return result;
    }, 'Custom SumProduct Function', 2, 2);
    

    After adding this function, it can be used it in sheet cell expressions, like here:

    =customSumProduct(A1:B5, B1:C5)
    
  • description: string Optional

    the description of the custom function, it will be shown in the function autocompletion of the FlexSheet.

  • minParamsCount: number Optional

    the minimum count of the parameter that the function need.

  • maxParamsCount: number Optional

    the maximum count of the parameter that the function need. If the count of the parameters in the custom function is arbitrary, the minParamsCount and maxParamsCount should be set to null.

戻り値
void

addUnboundSheet

addUnboundSheet(sheetName?: string, rows?: number, cols?: number, pos?: number, grid?: FlexGrid): Sheet

Add an unbound Sheet to the FlexSheet.

パラメーター
  • sheetName: string Optional

    The name of the Sheet.

  • rows: number Optional

    The row count of the Sheet.

  • cols: number Optional

    The column count of the Sheet.

  • pos: number Optional

    The position in the sheets collection.

  • grid: FlexGrid Optional

    The FlexGrid instance associated with the Sheet. If not specified then new FlexGrid instance will be created.

戻り値
Sheet

applyCellsStyle

applyCellsStyle(cellStyle: ICellStyle, cells?: CellRange[], isPreview?: boolean): void

セルの範囲にスタイルを適用します。

パラメーター
  • cellStyle: ICellStyle

    The ICellStyle object to apply.

  • cells: CellRange[] Optional

    An array of CellRange objects to apply the style to. If not specified then style is applied to the currently selected cells.

  • isPreview: boolean Optional

    Indicates whether the applied style is just for preview.

戻り値
void

applyFunctionToCell

applyFunctionToCell(): void

関数リストで選択されている関数をセル値エディタに挿入します。

戻り値
void

applyTemplate

applyTemplate(classNames: string, template: string, parts: Object, namePart?: string): HTMLElement

コントロールの新しいインスタンスにテンプレートを適用し、ルート要素を返します。

このメソッドはテンプレート化されたコントロールのコンストラクターによって呼び出される必要があります。テンプレートのパーツを対応するコントロールメンバにバインドする役割を持ちます。

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

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

パラメーター
  • classNames: string

    Names of classes to add to the control's host element.

  • template: string

    An HTML string that defines the control template.

  • parts: Object

    A dictionary of part variables and their names.

  • namePart: string Optional

    Name of the part to be named after the host element. This determines how the control submits data when used in forms.

継承元
Control
戻り値
HTMLElement

autoSizeColumn

autoSizeColumn(c: number, header?: boolean, extra?: number): void

列をその内容がちょうど収まるようにサイズ変更します。

This method only works if the grid is visible. If its host element has not been added to the DOM, or if any of the grid's ancestor elements is hidden, the grid will not be able to measure the cells and therefore will not be able to auto-size the columns.

パラメーター
  • c: number

    Index of the column to resize.

  • header: boolean Optional

    Whether the column index refers to a regular or a header row.

  • extra: number Optional

    Extra spacing, in pixels.

継承元
FlexGrid
戻り値
void

autoSizeColumns

autoSizeColumns(firstColumn?: number, lastColumn?: number, header?: boolean, extra?: number): void

列の範囲をその内容がちょうど収まるようにサイズ変更します。

The grid will always measure all rows in the current view range, plus up to 2,000 rows not currently in view. If the grid contains a large amount of data (say 50,000 rows), then not all rows will be measured since that could take a long time.

This method only works if the grid is visible. If its host element has not been added to the DOM, or if any of the grid's ancestor elements is hidden, the grid will not be able to measure the cells and therefore will not be able to auto-size the columns.

パラメーター
  • firstColumn: number Optional

    Index of the first column to resize (defaults to the first column).

  • lastColumn: number Optional

    Index of the last column to resize (defaults to the last column).

  • header: boolean Optional

    Whether the column indices refer to regular or header columns.

  • extra: number Optional

    Extra spacing, in pixels.

継承元
FlexGrid
戻り値
void

autoSizeRow

autoSizeRow(r: number, header?: boolean, extra?: number): void

行をその内容がちょうど収まるようにサイズ変更します。

This method only works if the grid is visible. If its host element has not been added to the DOM, or if any of the grid's ancestor elements are hidden, the grid will not be able to measure the cells and therefore will not be able to auto-size the rows.

パラメーター
  • r: number

    Index of the row to resize.

  • header: boolean Optional

    True to indicate the row index refers to a header row, false to indicate it refers to a regular data row, or null to indicate it refers to a footer row.

  • extra: number Optional

    Extra spacing, in pixels.

継承元
FlexGrid
戻り値
void

autoSizeRows

autoSizeRows(firstRow?: number, lastRow?: number, header?: boolean, extra?: number): void

行の範囲をその内容がちょうど収まるようにサイズ変更します。

This method only works if the grid is visible. If its host element has not been added to the DOM, or if any of the grid's ancestor elements is hidden, the grid will not be able to measure the cells and therefore will not be able to auto-size the rows.

パラメーター
  • firstRow: number Optional

    Index of the first row to resize.

  • lastRow: number Optional

    Index of the last row to resize.

  • header: boolean Optional

    Whether the row indices refer to regular or header rows.

  • extra: number Optional

    Extra spacing, in pixels.

継承元
FlexGrid
戻り値
void

beginUpdate

beginUpdate(): void

次に endUpdate が呼び出されるまで通知を中断します。

継承元
Control
戻り値
void

canEditCell

canEditCell(r: number, c: number): boolean

指定されたセルが編集可能かどうかを示す値を取得します。

パラメーター
  • r: number

    Index of the row that contains the cell.

  • c: number

    Index of the column that contains the cell.

継承元
FlexGrid
戻り値
boolean

clear

clear(): void

Clears the content of the FlexSheet control.

戻り値
void

collapseGroupsToLevel

collapseGroupsToLevel(level: number): void

すべてのグループ行を指定したレベルに折りたたみます。

パラメーター
  • level: number

    Maximum group level to show.

継承元
FlexGrid
戻り値
void

containsFocus

containsFocus(): boolean

関数リストを考慮に入れて、基本クラスのメソッドをオーバーライドします。

戻り値
boolean

Static convertNumberToAlpha

convertNumberToAlpha(c: number): string

数値をその対応するアルファベットに変換します。たとえば、0、1、2...をa、b、c...に変換します。

パラメーター
  • c: number

    The number value need to be converted.

戻り値
string

deferUpdate

deferUpdate(fn: Function): void

beginUpdate/endUpdateブロック内で関数を実行します。

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

パラメーター
継承元
Control
戻り値
void

deleteColumns

deleteColumns(ranges: CellRange[]): void

Deletes columns from the current Sheet of the FlexSheet control.

パラメーター
  • ranges: CellRange[]

    An array of CellRange instances that determines the deleting columns.

戻り値
void

deleteColumns

deleteColumns(index?: number, count?: number): void

Deletes columns from the current Sheet of the FlexSheet control.

パラメーター
  • index: number Optional

    The starting index of the deleting columns. If not specified then columns will be deleted starting from the first column of the current selection.

  • count: number Optional

    The numbers of columns to delete. If not specified then one column will be deleted.

戻り値
void

deleteRows

deleteRows(ranges: CellRange[]): void

Deletes rows from the current Sheet of the FlexSheet control.

パラメーター
戻り値
void

deleteRows

deleteRows(index?: number, count?: number): void

Deletes rows from the current Sheet of the FlexSheet control.

パラメーター
  • index: number Optional

    The starting index of the deleting rows. If not specified then rows will be deleted starting from the first row of the current selection.

  • count: number Optional

    The numbers of rows to delete. If not specified then one row will be deleted.

戻り値
void

dispose

dispose(): void

ホスト要素との関連付けを解除することによってコントロールを破棄します。

戻り値
void

Static disposeAll

disposeAll(e?: HTMLElement): void

HTML要素に含まれるすべてのWijmoコントロールを破棄します。

パラメーター
継承元
Control
戻り値
void

endUpdate

endUpdate(): void

beginUpdate の呼び出しによって中断された通知を再開します。

継承元
Control
戻り値
void

evaluate

evaluate(formula: string, format?: string, sheet?: Sheet, getPrimitiveResult?: boolean): any

式を評価します。

FlexSheet formulas follow the Excel syntax, including a large subset of the functions supported by Excel. A complete list of the functions supported by FlexSheet can be found here: FlexSheet Functions.

パラメーター
  • formula: string

    The formula to evaluate. The formula may start with an optional equals sign ('=').

  • format: string Optional

    If specified, defines the .Net format that will be applied to the evaluated value.

  • sheet: Sheet Optional

    The Sheet whose data will be used for evaluation. If not specified then the current sheet is used.

  • getPrimitiveResult: boolean Optional

    Indicates whether need convert the non-primitive result to primitive type.

戻り値
any

finishEditing

finishEditing(cancel?: boolean): boolean

保留中の編集をすべてコミットし、編集モードを終了します。

パラメーター
  • cancel: boolean Optional

    Whether pending edits should be canceled or committed.

継承元
FlexGrid
戻り値
boolean

focus

focus(force?: boolean): void

Overridden to set the focus to the grid without scrolling the whole grid into view.

パラメーター
  • force: boolean Optional

    Whether to perform the focus operation even if the grid already contains the focus.

継承元
FlexGrid
戻り値
void

freezeAtCursor

freezeAtCursor(): void

Freeze or unfreeze the columns and rows of the FlexSheet control.

戻り値
void

getBuiltInTableStyle

getBuiltInTableStyle(styleName: string): TableStyle

組み込みテーブルスタイルを取得します。

パラメーター
  • styleName: string

    The name of the built-in table style.

戻り値
TableStyle

getCellBoundingRect

getCellBoundingRect(r: number, c: number | string, raw?: boolean): Rect

セル要素の範囲(ビューポート座標単位)を取得します。

This method returns the bounds of cells in the cells panel (scrollable data cells). To get the bounds of cells in other panels, use the getCellBoundingRect method in the appropriate GridPanel object.

The returned value is a Rect object which contains the position and dimensions of the cell in viewport coordinates. The viewport coordinates are the same used by the getBoundingClientRect method.

パラメーター
  • r: number

    Index of the row that contains the cell.

  • c: number | string

    Index, name, or binding of the column that contains the cell.

  • raw: boolean Optional

    Whether to return the rectangle in raw panel coordinates as opposed to viewport coordinates.

継承元
FlexGrid
戻り値
Rect

getCellData

getCellData(r: number, c: number | string, formatted: boolean): any

グリッドのスクロール可能領域内のセルに格納された値を取得します。

パラメーター
  • r: number

    Index of the row that contains the cell.

  • c: number | string

    Index, name, or binding of the column that contains the cell.

  • formatted: boolean

    Whether to format the value for display.

継承元
FlexGrid
戻り値
any

getCellValue

getCellValue(rowIndex: number, colIndex: number, formatted?: boolean, sheet?: Sheet): any

評価されたセル値を取得します。

Unlike the getCellData method that returns a raw data that can be a value or a formula, the getCellValue method always returns an evaluated value, that is if the cell contains a formula then it will be evaluated first and the resulting value will be returned.

パラメーター
  • rowIndex: number

    The row index of the cell.

  • colIndex: number

    The column index of the cell.

  • formatted: boolean Optional

    Indicates whether to return an original or a formatted value of the cell.

  • sheet: Sheet Optional

    The Sheet whose value to evaluate. If not specified then the data from current sheet is used.

戻り値
any

getClipString

getClipString(rng?: CellRange): string

Gets the content of a CellRange as a string suitable for copying to the clipboard.

FlexSheet overrides this method to support multiple rows or columns selection in FlexSheet.

非表示の行および列はクリップボード文字列に含まれません。

パラメーター
戻り値
string

getColumn

getColumn(name: string | number, header?: boolean): Column

Gets a column by name or by binding.

このメソッドは、名前で列を検索します。指定された名前を持つ列が見つからない場合は、 バインディングによって検索します。検索では大文字と小文字が区別されます。

パラメーター
  • name: string | number

    The column name, binding, or index.

  • header: boolean Optional

    Whether to include column groups in search.

継承元
FlexGrid
戻り値
Column

getColumnGroups

getColumnGroups(): ColumnGroupCollection

Get the collection of column groups.

継承元
FlexGrid
戻り値
ColumnGroupCollection

Static getControl

getControl(element: any): Control

指定したDOM要素でホストされているコントロールを取得します。

パラメーター
  • element: any

    The DOM element that hosts the control, or a CSS selector for the host element (e.g. '#theCtrl').

継承元
Control
戻り値
Control

getMergedRange

getMergedRange(panel: GridPanel, r: number, c: number, clip?: boolean): CellRange

Gets a CellRange that specifies the merged extent of a cell in a GridPanel. This method overrides the getMergedRange method of its parent class FlexGrid

パラメーター
  • panel: GridPanel

    GridPanel that contains the range.

  • r: number

    Index of the row that contains the cell.

  • c: number

    Index of the column that contains the cell.

  • clip: boolean Optional

    Whether to clip the merged range to the grid's current view range.

戻り値
CellRange

getSelectedState

getSelectedState(r: number, c: number): SelectedState

セルの選択状態を示すSelectedState 値を取得します。

パラメーター
  • r: number

    Row index of the cell to inspect.

  • c: number

    Column index of the cell to inspect.

継承元
FlexGrid
戻り値
SelectedState

getSelectionFormatState

getSelectionFormatState(): IFormatState

Gets the IFormatState object describing formatting of the selected cells.

戻り値
IFormatState

getTemplate

getTemplate(): string

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

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

継承元
Control
戻り値
string

hideFunctionList

hideFunctionList(): void

関数リストを閉じます。

戻り値
void

hitTest

hitTest(pt: number | wijmo.Point | MouseEvent | HTMLElement, y?: number | boolean): HitTestInfo

Gets a HitTestInfo object with information about a given point.

For example:

```typescript // hit test a point when the user clicks on the grid flex.hostElement.addEventListener('click', (e) => { let ht = flex.hitTest(e.pageX, e.pageY); console.log('you clicked a cell of type "' + wijmo.grid.CellType[ht.cellType] + '".'); }); ```

パラメーター
  • pt: number | wijmo.Point | MouseEvent | HTMLElement

    Point to investigate, in page coordinates, or a MouseEvent object, or x coordinate of the point.

  • y: number | boolean Optional

    Y coordinate of the point in page coordinates (if the first parameter is a number).

継承元
FlexGrid
戻り値
HitTestInfo

initialize

initialize(options: any): void

指定したオブジェクトからプロパティをコピーしてコントロールを初期化します。

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

For example:

```typescript 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

    Object that contains the initialization data.

継承元
Control
戻り値
void

insertColumns

insertColumns(index?: number, count?: number): void

Inserts columns in the current Sheet of the FlexSheet control.

パラメーター
  • index: number Optional

    The position where new columns should be added. If not specified then columns will be added before the left column of the current selection.

  • count: number Optional

    The numbers of columns to add. If not specified then one column will be added.

戻り値
void

insertRows

insertRows(index?: number, count?: number): void

Inserts rows in the current Sheet of the FlexSheet control.

パラメーター
  • index: number Optional

    The position where new rows should be added. If not specified then rows will be added before the first row of the current selection.

  • count: number Optional

    The numbers of rows to add. If not specified then one row will be added.

戻り値
void

invalidate

invalidate(fullUpdate?: boolean): void

非同期更新を発生させるため、コントロールを無効にします。

パラメーター
  • fullUpdate: boolean Optional

    Whether to update the control layout as well as the content.

継承元
Control
戻り値
void

Static invalidateAll

invalidateAll(e?: HTMLElement): void

指定したHTML要素に含まれるすべてのWijmoコントロールを無効化します。

このメソッドは、コントロールの表示状態やサイズを変更する動的なパネルをアプリケーションで使用している場合に使用します。たとえば、スプリッタ、アコーディオン、およびタブコントロールは通常、その中の要素の表示状態を変更します。この場合、その要素に含まれるコントロールに通知しないと、それらのコントロールが適切に機能しなくなる可能性があります。

これが起こる場合は、動的コンテナーで適切なイベントを処理し、invalidateAllメソッドを呼び出してコンテナー内のWijmoコントロールのレイアウト情報が適切に更新されるようにする必要があります。

パラメーター
  • e: HTMLElement Optional

    Container element. If set to null, all Wijmo controls on the page will be invalidated.

継承元
Control
戻り値
void

isRangeValid

isRangeValid(rng: CellRange): boolean

指定したCellRangeがこのグリッドの行および列コレクションに対して有効かどうかをチェックします。

パラメーター
継承元
FlexGrid
戻り値
boolean

load

load(workbook: string | ArrayBuffer | Blob | wijmo.xlsx.Workbook): void

Loads the workbook into FlexSheet. This method works with JSZip 2.5.

For example:

// This sample opens an xlsx file chosen through Open File
// dialog and fills FlexSheet
 

// HTML
<input type="file" 
    id="importFile" 
    accept="application/vnd.openxmlformats-officedocument.spreadsheetml.sheet" 
/>
<div id="flexHost"></>
 

// JavaScript
var flexSheet = new wijmo.grid.FlexSheet("#flexHost"),
    importFile = document.getElementById('importFile');
 
importFile.addEventListener('change', function () {
    loadWorkbook();
});
 
function loadWorkbook() {
    var reader,
        file = importFile.files[0];
    if (file) {
        reader = new FileReader();
        reader.onload = function (e) {
            flexSheet.load(reader.result);
        };
        reader.readAsArrayBuffer(file);
    }
}
パラメーター
  • workbook: string | ArrayBuffer | Blob | wijmo.xlsx.Workbook

    A Workbook, Blob, base-64 string, or ArrayBuffer containing the xlsx file content.

戻り値
void

loadAsync

loadAsync(workbook: string | ArrayBuffer | Blob | wijmo.xlsx.Workbook, onLoaded?: (workbook: wijmo.xlsx.Workbook), onError?: (reason?: any)): void

Loads the workbook into FlexSheet asynchronously. This method works with JSZip 3.0.

パラメーター
  • workbook: string | ArrayBuffer | Blob | wijmo.xlsx.Workbook

    A Workbook, Blob, base-64 string, or ArrayBuffer containing the xlsx file content.

  • onLoaded: (workbook: wijmo.xlsx.Workbook) Optional

    This callback provides access to the loaded workbook instance. Since this method is asynchronous, users cannot get the loaded workbook instance immediately. This callback has a single parameter, the loaded workbook instance.

  • onError: (reason?: any) Optional

    This callback catches errors when loading workbooks. It has a single parameter, the failure reason.

    For example:

    flexsheet.loadAsync(blob, function (workbook) {
    
         // user can access the loaded workbook instance in this callback.
         var app = worksheet.application ;
         ...
    }, function (reason) {
    
         // User can catch the failure reason in this callback.
         console.log('The reason of load failure is ' + reason);
    });
    
戻り値
void

mergeRange

mergeRange(cells?: CellRange, isCopyMergeCell?: boolean): void

Merges the selected CellRange into one cell.

パラメーター
  • cells: CellRange Optional

    The CellRange to merge.

  • isCopyMergeCell: boolean Optional

    This parameter indicates that merge operation is done by copy\paste merge cell or not.

戻り値
void

onAutoFilled

onAutoFilled(e: AutoFillingEventArgs): void

autoFilledイベントを発生させます。

パラメーター
戻り値
void

onAutoFilling

onAutoFilling(e: AutoFillingEventArgs): void

autoFillingイベントを発生させます。

パラメーター
戻り値
void

onAutoSizedColumn

onAutoSizedColumn(e: CellRangeEventArgs): void

Raises the autoSizedColumn event.

パラメーター
継承元
FlexGrid
戻り値
void

onAutoSizedRow

onAutoSizedRow(e: CellRangeEventArgs): void

Raises the autoSizedRow event.

パラメーター
継承元
FlexGrid
戻り値
void

onAutoSizingColumn

onAutoSizingColumn(e: CellRangeEventArgs): boolean

Raises the autoSizingColumn event.

パラメーター
継承元
FlexGrid
戻り値
boolean

onAutoSizingRow

onAutoSizingRow(e: CellRangeEventArgs): boolean

Raises the autoSizingRow event.

パラメーター
継承元
FlexGrid
戻り値
boolean

onBeginDroppingRowColumn

onBeginDroppingRowColumn(e: DroppingRowColumnEventArgs): void

beginDroppingRowColumnイベントを発生させます。

パラメーター
戻り値
void

onBeginningEdit

onBeginningEdit(e: CellRangeEventArgs): boolean

Raises the beginningEdit event.

パラメーター
継承元
FlexGrid
戻り値
boolean

onCellEditEnded

onCellEditEnded(e: CellRangeEventArgs): void

Raises the cellEditEnded event.

パラメーター
継承元
FlexGrid
戻り値
void

onCellEditEnding

onCellEditEnding(e: CellEditEndingEventArgs): boolean

Raises the cellEditEnding event.

パラメーター
継承元
FlexGrid
戻り値
boolean

onColumnChanged

onColumnChanged(e: RowColumnChangedEventArgs): void

columnChangedイベントを発生させます。

パラメーター
戻り値
void

onColumnGroupCollapsedChanged

onColumnGroupCollapsedChanged(e: CellRangeEventArgs): void

Raises the columnGroupCollapsedChanged event.

パラメーター
継承元
FlexGrid
戻り値
void

onColumnGroupCollapsedChanging

onColumnGroupCollapsedChanging(e: CellRangeEventArgs): boolean

Raises the columnGroupCollapsedChanging event.

パラメーター
継承元
FlexGrid
戻り値
boolean

onCopied

onCopied(e: CellRangeEventArgs): void

Raises the copied event.

パラメーター
継承元
FlexGrid
戻り値
void

onCopying

onCopying(e: CellRangeEventArgs): boolean

Raises the copying event.

パラメーター
継承元
FlexGrid
戻り値
boolean

onDeletedRow

onDeletedRow(e: CellRangeEventArgs): void

Raises the deletedRow event.

パラメーター
継承元
FlexGrid
戻り値
void

onDeletingRow

onDeletingRow(e: CellRangeEventArgs): boolean

Raises the deletingRow event.

パラメーター
継承元
FlexGrid
戻り値
boolean

onDraggedColumn

onDraggedColumn(e: CellRangeEventArgs): void

Raises the draggedColumn event.

パラメーター
継承元
FlexGrid
戻り値
void

onDraggedRow

onDraggedRow(e: CellRangeEventArgs): void

Raises the draggedRow event.

パラメーター
継承元
FlexGrid
戻り値
void

onDraggingColumn

onDraggingColumn(e: CellRangeEventArgs): boolean

Raises the draggingColumn event.

パラメーター
継承元
FlexGrid
戻り値
boolean

onDraggingColumnOver

onDraggingColumnOver(e: CellRangeEventArgs): boolean

Raises the draggingColumnOver event.

パラメーター
継承元
FlexGrid
戻り値
boolean

onDraggingRow

onDraggingRow(e: CellRangeEventArgs): boolean

Raises the draggingRow event.

パラメーター
継承元
FlexGrid
戻り値
boolean

onDraggingRowColumn

onDraggingRowColumn(e: DraggingRowColumnEventArgs): void

draggingRowColumnイベントを発生させます。

パラメーター
戻り値
void

onDraggingRowOver

onDraggingRowOver(e: CellRangeEventArgs): boolean

Raises the draggingRowOver event.

パラメーター
継承元
FlexGrid
戻り値
boolean

onDroppingRowColumn

onDroppingRowColumn(e?: EventArgs): void

droppingRowColumnイベントを発生させます。

パラメーター
戻り値
void

onEndDroppingRowColumn

onEndDroppingRowColumn(e: CancelEventArgs): void

endDroppingRowColumnイベントを発生させます。

パラメーター
戻り値
void

onFormatItem

onFormatItem(e: FormatItemEventArgs): void

formatItem イベントを発生させます。

パラメーター
継承元
FlexGrid
戻り値
void

onGotFocus

onGotFocus(e?: EventArgs): void

gotFocus イベントを発生させます。

パラメーター
継承元
Control
戻り値
void

onGroupCollapsedChanged

onGroupCollapsedChanged(e: CellRangeEventArgs): void

Raises the groupCollapsedChanged event.

パラメーター
継承元
FlexGrid
戻り値
void

onGroupCollapsedChanging

onGroupCollapsedChanging(e: CellRangeEventArgs): boolean

Raises the groupCollapsedChanging event.

パラメーター
継承元
FlexGrid
戻り値
boolean

onInvalidInput

onInvalidInput(e: CancelEventArgs): void

invalidInput イベントを発生させます。

イベントハンドラがイベントをキャンセルした場合、コントロールは無効な入力とフォーカスを保持します。

パラメーター
継承元
Control
戻り値
void

onItemsSourceChanged

onItemsSourceChanged(e?: EventArgs): void

itemsSourceChanged イベントを発生させます。

パラメーター
継承元
FlexGrid
戻り値
void

onItemsSourceChanging

onItemsSourceChanging(e: CancelEventArgs): boolean

itemsSourceChanging イベントを発生させます。

パラメーター
継承元
FlexGrid
戻り値
boolean

onLoaded

onLoaded(e?: EventArgs): void

loadedイベントを発生させます。

パラメーター
戻り値
void

onLoadedRows

onLoadedRows(e?: EventArgs): void

Raises the loadedRows event.

パラメーター
継承元
FlexGrid
戻り値
void

onLoadingRows

onLoadingRows(e: CancelEventArgs): boolean

Raises the loadingRows event.

パラメーター
継承元
FlexGrid
戻り値
boolean

onLostFocus

onLostFocus(e?: EventArgs): void

lostFocus イベントを発生させます。

パラメーター
継承元
Control
戻り値
void

onPasted

onPasted(e: CellRangeEventArgs): void

Raises the pasted event.

パラメーター
継承元
FlexGrid
戻り値
void

onPastedCell

onPastedCell(e: CellRangeEventArgs): void

Raises the pastedCell event.

パラメーター
継承元
FlexGrid
戻り値
void

onPasting

onPasting(e: CellRangeEventArgs): boolean

Raises the pasting event.

パラメーター
継承元
FlexGrid
戻り値
boolean

onPastingCell

onPastingCell(e: CellRangeEventArgs): boolean

Raises the pastingCell event.

パラメーター
継承元
FlexGrid
戻り値
boolean

onPinnedColumn

onPinnedColumn(e: CellRangeEventArgs): void

Raises the pinnedColumn event.

パラメーター
継承元
FlexGrid
戻り値
void

onPinningColumn

onPinningColumn(e: CellRangeEventArgs): boolean

Raises the pinningColumn event.

パラメーター
継承元
FlexGrid
戻り値
boolean

onPrepareCellForEdit

onPrepareCellForEdit(e: CellRangeEventArgs): void

Raises the prepareCellForEdit event.

パラメーター
継承元
FlexGrid
戻り値
void

onPrepareChangingColumn

onPrepareChangingColumn(e: RowColumnChangedEventArgs): void

prepareChangingColumnイベントを発生させます。

パラメーター
戻り値
void

onPrepareChangingRow

onPrepareChangingRow(e: RowColumnChangedEventArgs): void

prepareChangingRowイベントを発生させます。

パラメーター
戻り値
void

onRefreshed

onRefreshed(e?: EventArgs): void

refreshedイベントを発生させます。

パラメーター
継承元
Control
戻り値
void

onRefreshing

onRefreshing(e?: EventArgs): void

refreshingイベントを発生させます。

パラメーター
継承元
Control
戻り値
void

onResizedColumn

onResizedColumn(e: CellRangeEventArgs): void

Raises the resizedColumn event.

パラメーター
継承元
FlexGrid
戻り値
void

onResizedRow

onResizedRow(e: CellRangeEventArgs): void

Raises the resizedRow event.

パラメーター
継承元
FlexGrid
戻り値
void

onResizingColumn

onResizingColumn(e: CellRangeEventArgs): boolean

Raises the resizingColumn event.

パラメーター
継承元
FlexGrid
戻り値
boolean

onResizingRow

onResizingRow(e: CellRangeEventArgs): boolean

Raises the resizingRow event.

パラメーター
継承元
FlexGrid
戻り値
boolean

onRowAdded

onRowAdded(e: CellRangeEventArgs): boolean

Raises the rowAdded event.

パラメーター
継承元
FlexGrid
戻り値
boolean

onRowChanged

onRowChanged(e: RowColumnChangedEventArgs): void

rowChangedイベントを発生します。

パラメーター
戻り値
void

onRowEditEnded

onRowEditEnded(e: CellRangeEventArgs): void

Raises the rowEditEnded event.

パラメーター
継承元
FlexGrid
戻り値
void

onRowEditEnding

onRowEditEnding(e: CellRangeEventArgs): void

Raises the rowEditEnding event.

パラメーター
継承元
FlexGrid
戻り値
void

onRowEditStarted

onRowEditStarted(e: CellRangeEventArgs): void

Raises the rowEditStarted event.

パラメーター
継承元
FlexGrid
戻り値
void

onRowEditStarting

onRowEditStarting(e: CellRangeEventArgs): void

Raises the rowEditStarting event.

パラメーター
継承元
FlexGrid
戻り値
void

onScrollPositionChanged

onScrollPositionChanged(e?: EventArgs): void

Raises the scrollPositionChanged event.

パラメーター
継承元
FlexGrid
戻り値
void

onSelectedSheetChanged

onSelectedSheetChanged(e: PropertyChangedEventArgs): void

currentSheetChangedイベントを発生させます。

パラメーター
戻り値
void

onSelectionChanged

onSelectionChanged(e: CellRangeEventArgs): void

selectionChanged イベントを発生させます。

パラメーター
継承元
FlexGrid
戻り値
void

onSelectionChanging

onSelectionChanging(e: CellRangeEventArgs): boolean

Raises the selectionChanging event.

パラメーター
継承元
FlexGrid
戻り値
boolean

onSheetCleared

onSheetCleared(e?: EventArgs): void

sheetClearedイベントを発生させます。

パラメーター
戻り値
void

onSortedColumn

onSortedColumn(e: CellRangeEventArgs): void

Raises the sortedColumn event.

パラメーター
継承元
FlexGrid
戻り値
void

onSortingColumn

onSortingColumn(e: CellRangeEventArgs): boolean

Raises the sortingColumn event.

パラメーター
継承元
FlexGrid
戻り値
boolean

onStarSizedColumns

onStarSizedColumns(e?: EventArgs): void

Raises the starSizedColumns event.

パラメーター
継承元
FlexGrid
戻り値
void

onUnknownFunction

onUnknownFunction(e: UnknownFunctionEventArgs): void

unknownFunctionイベントを発生させます。

パラメーター
戻り値
void

onUpdatedLayout

onUpdatedLayout(e?: EventArgs): void

Raises the updatedLayout event.

パラメーター
継承元
FlexGrid
戻り値
void

onUpdatedView

onUpdatedView(e?: EventArgs): void

updatedView イベントを発生させます。

パラメーター
継承元
FlexGrid
戻り値
void

onUpdatingLayout

onUpdatingLayout(e: CancelEventArgs): boolean

Raises the updatingLayout event.

パラメーター
継承元
FlexGrid
戻り値
boolean

onUpdatingView

onUpdatingView(e: CancelEventArgs): boolean

updatingView イベントを発生させます。

パラメーター
継承元
FlexGrid
戻り値
boolean

redo

redo(): void

最後のユーザー操作をやり直します。

戻り値
void

refresh

refresh(fullUpdate?: boolean): void

シートとTabHolderをリフレッシュするためにオーバーライドされます。

パラメーター
  • fullUpdate: boolean Optional

    Whether to update the control layout as well as the content.

戻り値
void

Static refreshAll

refreshAll(e?: HTMLElement): void

HTML要素で存在するすべてのWijmoコントロールを更新する。

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

パラメーター
  • e: HTMLElement Optional

    Container element. If set to null, all Wijmo controls on the page will be invalidated.

継承元
Control
戻り値
void

refreshCells

refreshCells(fullUpdate: boolean, recycle?: boolean, state?: boolean): void

グリッドの表示を更新します。

パラメーター
  • fullUpdate: boolean

    Whether to update the grid layout and content, or just the content.

  • recycle: boolean Optional

    Whether to recycle existing elements.

  • state: boolean Optional

    Whether to keep existing elements and update their state.

継承元
FlexGrid
戻り値
void

refreshRange

refreshRange(rng: CellRange): void

Refreshes the cells in a range, updating their content and styles.

Unlike the refreshCells method, which updates all the cells, refreshRange allows you to specify which cells should be refreshed, which in some cases can improve performance.

パラメーター
継承元
FlexGrid
戻り値
void

removeEventListener

removeEventListener(target?: EventTarget, type?: string, fn?: any, capture?: boolean): number

このControl が所有する要素にアタッチされている1つまたは複数のイベントリスナーを解除します。

パラメーター
  • target: EventTarget Optional

    Target element for the event. If null, removes listeners attached to all targets.

  • type: string Optional

    String that specifies the event. If null, removes listeners attached to all events.

  • fn: any Optional

    Handler to remove. If null, removes all handlers.

  • capture: boolean Optional

    Whether the listener is capturing. If null, removes capturing and non-capturing listeners.

継承元
Control
戻り値
number

save

save(fileName?: string, options?: IFlexSheetXlsxOptions): Workbook

Saves FlexSheet to xlsx file. This method works with JSZip 2.5.

For example:

// This sample exports FlexSheet content to an xlsx file.  
// click.
 

// HTML
<button 
    onclick="saveXlsx('FlexSheet.xlsx')">
    Save
</button>
 

// JavaScript
function saveXlsx(fileName) {

    // Save the flexGrid to xlsx file.
    flexsheet.save(fileName);
}
パラメーター
戻り値
Workbook

saveAsync

saveAsync(fileName?: string, onSaved?: (base64?: string), onError?: (reason?: any), options?: IFlexSheetXlsxOptions): void

Saves the FlexSheet to xlsx file asynchronously. This method works with JSZip 3.0.

パラメーター
  • fileName: string Optional

    Name of the file that is generated.

  • onSaved: (base64?: string) Optional

    This callback provides an approach to get the base-64 string that represents the content of the saved FlexSheet. Since this method is an asynchronous method, user is not able to get the base-64 string immediately. User has to get the base-64 string through this callback. This has a single parameter, the base64 string of the saved flexsheet. It is passed to user.

  • onError: (reason?: any) Optional

    This callback catches error information when saving. This has a single parameter, the failure reason. The return value is passed to user if he wants to catch the save failure reason.

    For example:

    flexsheet.saveAsync('', function (base64) {
    
         // user can access the base64 string in this callback.
         document.getElementByID('export').href = 'data:application/vnd.openxmlformats-officedocument.spreadsheetml.sheet;' + 'base64,' + base64;
    }, function (reason) {
    
         // User can catch the failure reason in this callback.
         console.log('The reason of save failure is ' + reason);
    });
    
  • options: IFlexSheetXlsxOptions Optional

    IFlexSheetXlsxOptions object specifying the save options.

戻り値
void

scrollIntoView

scrollIntoView(r: number, c: number | string, refresh?: boolean): boolean

指定したセルが画面に入るようにグリッドをスクロールします。

Negative row and column indices are ignored, so if you call

```typescript grid.scrollIntoView(200, -1); ```

The grid will scroll vertically to show row 200, and will not scroll horizontally.

パラメーター
  • r: number

    Index of the row to scroll into view.

  • c: number | string

    Index, name, or binding of the column to scroll into view.

  • refresh: boolean Optional

    Optional parameter that determines whether the grid should refresh to show the new scroll position immediately.

継承元
FlexGrid
戻り値
boolean

select

select(rng: any, show?: any): boolean

セルの範囲を選択し、オプションで選択範囲を表示範囲までスクロールします。

FlexSheet overrides this method to adjust the selection cell range for the merged cells in the FlexSheet.

パラメーター
  • rng: any

    The cell range to select.

  • show: any Optional

    Indicates whether to scroll the new selection into view.

戻り値
boolean

selectAll

selectAll(): void

グリッド内のすべてのセルを選択します。

継承元
FlexGrid
戻り値
void

selectNextFunction

selectNextFunction(): void

関数リスト内の次の関数を選択します。

戻り値
void

selectPreviousFunction

selectPreviousFunction(): void

関数リスト内の前の関数を選択します。

戻り値
void

setCellData

setCellData(r: number, c: any, value: any, coerce?: boolean, invalidate?: boolean): boolean

基本クラスのsetCellData関数をオーバーライドします。

パラメーター
  • r: number

    Index of the row that contains the cell.

  • c: any

    Index, name, or binding of the column that contains the cell.

  • value: any

    Value to store in the cell.

  • coerce: boolean Optional

    Whether to change the value automatically to match the column's data type.

  • invalidate: boolean Optional

    Whether to invalidate the FlexSheet to show the change.

戻り値
boolean

setClipString

setClipString(text: string, rng?: CellRange): void

Parses a string into rows and columns and applies the content to a given range.

Override the setClipString method of FlexGrid.

パラメーター
  • text: string

    Tab and newline delimited text to parse into the grid.

  • rng: CellRange Optional

    CellRange to copy. If omitted, the current selection is used.

戻り値
void

showColumnFilter

showColumnFilter(): void

フィルタエディタを表示します。

戻り値
void

showFunctionList

showFunctionList(target: HTMLElement): void

関数リストを開きます。

パラメーター
  • target: HTMLElement

    The DOM element that toggle the function list.

戻り値
void

startEditing

startEditing(fullEdit?: boolean, r?: number, c?: number | string, focus?: boolean, evt?: any): boolean

指定されたセルの編集を開始します。

Editing in the FlexGrid is similar to editing in Excel: Pressing F2 or double-clicking a cell puts the grid in **full-edit** mode. In this mode, the cell editor remains active until the user presses Enter, Tab, or Escape, or until he moves the selection with the mouse. In full-edit mode, pressing the cursor keys does not cause the grid to exit edit mode.

Typing text directly into a cell puts the grid in **quick-edit mode**. In this mode, the cell editor remains active until the user presses Enter, Tab, or Escape, or any arrow keys.

Full-edit mode is normally used to make changes to existing values. Quick-edit mode is normally used for entering new data quickly.

編集中に[F2]キーを押すことで、完全編集モードとクイック編集モードを切り替えることができます。

パラメーター
  • fullEdit: boolean Optional

    Whether to stay in edit mode when the user presses the cursor keys. Defaults to true.

  • r: number Optional

    Index of the row to be edited. Defaults to the currently selected row.

  • c: number | string Optional

    Index, name, or binding of the column to be edited. Defaults to the currently selected column.

  • focus: boolean Optional

    Whether to give the editor the focus when editing starts. Defaults to true.

  • evt: any Optional

    Event that triggered this action (usually a keypress or keydown).

継承元
FlexGrid
戻り値
boolean

toggleDropDownList

toggleDropDownList(): boolean

Toggles the visibility of the drop-down list box associated with the currently selected cell.

The drop-down list is created automatically based on the column's Column.dataMap property.

このメソッドでは、セルが編集モードに入ったとき、またはユーザが特定のキーを押したときに、ドロップダウンリストを自動的に表示することができます。

For example, this code causes the grid to show the drop-down list whenever the grid enters edit mode:

```typescript // show the drop-down list when the grid enters edit mode theGrid.beginningEdit.addHandler(() => { theGrid.toggleDropDownList(); }); ```

This code causes the grid to show the drop-down list when the grid enters edit mode after the user presses the space bar:

```typescript // show the drop-down list when the user presses the space bar theGrid.hostElement.addEventListener('keydown', (e) => { if (e.keyCode == 32) { e.preventDefault(); theGrid.toggleDropDownList(); } }, true); ```

継承元
FlexGrid
戻り値
boolean

undo

undo(): void

最後のユーザー操作を元に戻します。

戻り値
void

イベント

autoFilled

Occurs after the FlexSheet has performed the auto-fill operation.

引数
AutoFillingEventArgs

autoFilling

Occurs before the FlexSheet performs the auto-fill operation.

引数
AutoFillingEventArgs

autoSizedColumn

ユーザーが列ヘッダセルの右端をダブルクリックして列のサイズを自動設定した後に発生します。

継承元
FlexGrid
引数
CellRangeEventArgs

autoSizedRow

ユーザーが行ヘッダセルの下端をダブルクリックして行のサイズを自動設定した後に発生します。

継承元
FlexGrid
引数
CellRangeEventArgs

autoSizingColumn

ユーザーが列ヘッダセルの右端をダブルクリックして列のサイズを自動設定する前に発生します。

継承元
FlexGrid
引数
CellRangeEventArgs

autoSizingRow

ユーザーが行ヘッダセルの下端をダブルクリックして行のサイズを自動設定する前に発生します。

継承元
FlexGrid
引数
CellRangeEventArgs

beginDroppingRowColumn

Occurs when begin dropping the rows or the columns of the FlexSheet.

引数
DroppingRowColumnEventArgs

beginningEdit

セルが編集モードに入る前に発生します。

The 'data' property of the handler parameters contains a reference to the DOM event that caused the grid to enter edit mode.

The event handler may cancel the edit operation.

継承元
FlexGrid
引数
CellRangeEventArgs

cellEditEnded

セル編集がコミットまたはキャンセルされたときに発生します。

継承元
FlexGrid
引数
CellRangeEventArgs

cellEditEnding

セル編集が終了するときに発生します。

You can use this event to perform validation and prevent invalid edits. For example, the code below prevents users from entering values that do not contain the letter 'a'. The code demonstrates how you can obtain the old and new values before the edits are applied.

```typescript function cellEditEnding(flex, e) {

// get old and new values let oldVal = flex.getCellData(e.row, e.col), newVal = flex.activeEditor.value;

// cancel edits if newVal doesn't contain 'a' e.cancel = newVal.indexOf('a') < 0; } ```</>>

Setting the cancel parameter to true causes the grid to discard the edited value and keep the cell's original value.

If you also set the stayInEditMode parameter to true, the grid will remain in edit mode so the user can correct invalid entries before committing the edits.

継承元
FlexGrid
引数
CellEditEndingEventArgs

columnChanged

Occurs after the FlexSheet inserted or deleted columns.

引数
RowColumnChangedEventArgs

columnGroupCollapsedChanged

Occurs after a column group has been expanded or collapsed.

The 'data' property of the handler parameters contains a reference to the ColumnGroup that is about to change.

継承元
FlexGrid
引数
CellRangeEventArgs

columnGroupCollapsedChanging

Occurs when a column group is about to be expanded or collapsed.

The 'data' property of the handler parameters contains a reference to the ColumnGroup that is about to change.

継承元
FlexGrid
引数
CellRangeEventArgs

copied

Occurs after the user has copied the selection content to the clipboard by pressing one of the clipboard shortcut keys (see the autoClipboard property).

継承元
FlexGrid
引数
CellRangeEventArgs

copying

Occurs when the user is copying the selection content to the clipboard by pressing one of the clipboard shortcut keys (see the autoClipboard property).

イベントハンドラでコピー操作をキャンセルできます。

継承元
FlexGrid
引数
CellRangeEventArgs

deletedRow

Occurs after the user has deleted a row by pressing the Delete key (see the allowDelete property).

継承元
FlexGrid
引数
CellRangeEventArgs

deletingRow

Occurs when the user is deleting a selected row by pressing the Delete key (see the allowDelete property).

イベントハンドラで行の削除をキャンセルできます。

継承元
FlexGrid
引数
CellRangeEventArgs

draggedColumn

ユーザーが列のドラッグを終了したときに発生します。

継承元
FlexGrid
引数
CellRangeEventArgs

draggedRow

ユーザーが行のドラッグを終了したときに発生します。

継承元
FlexGrid
引数
CellRangeEventArgs

draggingColumn

ユーザーが列のドラッグを開始したときに発生します。

継承元
FlexGrid
引数
CellRangeEventArgs

draggingColumnOver

ユーザーが列を別の位置にドラッグするときに発生します。

The handler may cancel the event to prevent users from dropping columns at certain positions. For example:

```typescript // remember column being dragged flex.draggingColumn.addHandler((s, e) => { theColumn = s.columns[e.col].binding; });

// prevent 'sales' column from being dragged to index 0 s.draggingColumnOver.addHandler((s, e) => { if (theColumn == 'sales' && e.col == 0) { e.cancel = true; } }); ```

継承元
FlexGrid
引数
CellRangeEventArgs

draggingRow

ユーザーが行のドラッグを開始したときに発生します。

継承元
FlexGrid
引数
CellRangeEventArgs

draggingRowColumn

Occurs when dragging the rows or the columns of the FlexSheet.

引数
DraggingRowColumnEventArgs

draggingRowOver

ユーザーが行を別の位置にドラッグするときに発生します。

継承元
FlexGrid
引数
CellRangeEventArgs

droppingRowColumn

Occurs when dropping the rows or the columns of the FlexSheet. This event has been deprecated. Please use beginDroppingRowColumn and endDroppingRowColumn event instead.

引数
EventArgs

endDroppingRowColumn

Occurs when end dropping the rows or the columns of the FlexSheet.

引数
CancelEventArgs

formatItem

セルを表す要素が作成されたときに発生します。

This event can be used to format cells for display. It is similar in purpose to the itemFormatter property, but has the advantage of allowing multiple independent handlers.

以下のサンプルコードは、グループ行のセルから'wj-wrap'クラスを削除します。

```typescript flex.formatItem.addHandler((flex, e) => { if (flex.rows[e.row] instanceof GroupRow) { wijmo.removeClass(e.cell, 'wj-wrap'); } }); ```

継承元
FlexGrid
引数
FormatItemEventArgs

gotFocus

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

継承元
Control
引数
EventArgs

groupCollapsedChanged

グループが展開または折りたたまれた後に発生します。

継承元
FlexGrid
引数
CellRangeEventArgs

groupCollapsedChanging

グループが展開または折りたたまれるときに発生します。

継承元
FlexGrid
引数
CellRangeEventArgs

invalidInput

無効な入力値が検出された場合に発生します。

ユーザーが適切な型に変換できない値、または有効な範囲外の値を入力または貼り付けると、無効な入力が発生する可能性があります。

イベントハンドラがイベントをキャンセルした場合、コントロールは無効なコンテンツとフォーカスを保持するため、ユーザーはエラーを修正できます。

イベントがキャンセルされない場合、コントロールは無効な入力を無視し、元のコンテンツを保持します。

継承元
Control
引数
CancelEventArgs

itemsSourceChanged

グリッドが新しい項目ソースに連結された後に発生します。

継承元
FlexGrid
引数
EventArgs

itemsSourceChanging

グリッドが新しい項目ソースにバインドされれ前に発生します。

継承元
FlexGrid
引数
CancelEventArgs

loaded

Occurs after the FlexSheet loads the Workbook instance

引数
EventArgs

loadedRows

グリッド行がデータソースの項目に連結された後に発生します。

継承元
FlexGrid
引数
EventArgs

loadingRows

グリッド行がデータソースの項目に連結される前に発生します。

継承元
FlexGrid
引数
CancelEventArgs

lostFocus

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

継承元
Control
引数
EventArgs

pasted

Occurs after the user has pasted content from the clipboard by pressing one of the clipboard shortcut keys (see the autoClipboard property).

継承元
FlexGrid
引数
CellRangeEventArgs

pastedCell

Occurs after the user has pasted content from the clipboard into a cell (see the autoClipboard property).

The 'data' property of the handler parameters contains the cell's original value (before the new value was pasted).

継承元
FlexGrid
引数
CellRangeEventArgs

pasting

Occurs when the user is pasting content from the clipboard by pressing one of the clipboard shortcut keys (see the autoClipboard property).

The 'data' property of the handler parameters contains a copy of the text being pasted into the grid.

イベントハンドラで貼り付け操作をキャンセルできます。

継承元
FlexGrid
引数
CellRangeEventArgs

pastingCell

Occurs when the user is pasting content from the clipboard into a cell (see the autoClipboard property).

The 'data' property of the handler parameters contains the text being pasted into the cell.

イベントハンドラで貼り付け操作をキャンセルできます。

継承元
FlexGrid
引数
CellRangeEventArgs

pinnedColumn

Occurs after one or more columns are pinned (or unpinned).

継承元
FlexGrid
引数
CellRangeEventArgs

pinningColumn

Occurs before one or more columns are pinned (or unpinned).

継承元
FlexGrid
引数
CellRangeEventArgs

prepareCellForEdit

エディタセルが作成されてからアクティブになる前に発生します。

The event handler can access the editor element using the grid's activeEditor property.

継承元
FlexGrid
引数
CellRangeEventArgs

prepareChangingColumn

Occurs before the FlexSheet inserts or deletes columns.

引数
RowColumnChangedEventArgs

prepareChangingRow

Occurs before the FlexSheet insert\delete rows.

引数
RowColumnChangedEventArgs

refreshed

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

継承元
Control
引数
EventArgs

refreshing

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

継承元
Control
引数
EventArgs

resizedColumn

ユーザーが列のサイズ変更を終了すると発生します。

継承元
FlexGrid
引数
CellRangeEventArgs

resizedRow

ユーザーが行のサイズ変更を終了すると発生します。

継承元
FlexGrid
引数
CellRangeEventArgs

resizingColumn

列がサイズ変更されるときに発生します。

継承元
FlexGrid
引数
CellRangeEventArgs

resizingRow

行がサイズ変更されるときに発生します。

継承元
FlexGrid
引数
CellRangeEventArgs

rowAdded

Occurs when the user creates a new item by editing the new row template (see the allowAddNew property).

イベントハンドラで新しい項目の内容をカスタマイズしたり、新しい項目の作成をキャンセルしたりできます。

継承元
FlexGrid
引数
CellRangeEventArgs

rowChanged

Occurs after the FlexSheet insert\delete rows.

引数
RowColumnChangedEventArgs

rowEditEnded

行の編集がコミットまたはキャンセルされたときに発生します。

継承元
FlexGrid
引数
CellRangeEventArgs

rowEditEnding

行編集が終了するとき、変更が確定またはキャンセルされる前に発生します。

This event can be used in conjunction with the rowEditStarted event to implement deep-binding edit undos. For example:

```typescript // save deep bound values when editing starts let itemData = {}; s.rowEditStarted.addHandler((s, e) => { let item = s.collectionView.currentEditItem; itemData = {}; s.columns.forEach(function (col) { if (col.binding.indexOf('.') > -1) { // deep binding let binding = new wijmo.Binding(col.binding); itemData[col.binding] = binding.getValue(item); } }) });

// restore deep bound values when edits are canceled s.rowEditEnded.addHandler((s, e) => { if (e.cancel) { // edits were canceled by the user let item = s.collectionView.currentEditItem; for (let k in itemData) { let binding = new wijmo.Binding(k); binding.setValue(item, itemData[k]); } } itemData = {}; }); ```

継承元
FlexGrid
引数
CellRangeEventArgs

rowEditStarted

行が編集モードに入った後に発生します。

継承元
FlexGrid
引数
CellRangeEventArgs

rowEditStarting

行が編集モードに入る前に発生します。

継承元
FlexGrid
引数
CellRangeEventArgs

scrollPositionChanged

コントロールがスクロールされた後に発生します。

継承元
FlexGrid
引数
EventArgs

selectedSheetChanged

現在のシートインデックスが変更されると発生します。

引数
PropertyChangedEventArgs

selectionChanged

選択範囲が変更された後に発生します。

継承元
FlexGrid
引数
CellRangeEventArgs

selectionChanging

選択範囲が変更される前に発生します。

継承元
FlexGrid
引数
CellRangeEventArgs

sheetCleared

Occurs when the FlexSheet is cleared.

引数
EventArgs

sortedColumn

ユーザーが列ヘッダーをクリックしてソートを適用した後に発生します。

継承元
FlexGrid
引数
CellRangeEventArgs

sortingColumn

ユーザーが列ヘッダをクリックしてソートを適用する前に発生します。

The 'data' property of the handler parameters contains a reference to the DOM event that caused the sort.

The event handler may cancel the sort action.

継承元
FlexGrid
引数
CellRangeEventArgs

starSizedColumns

スター サイズにより1つ以上の列のサイズが変更されたとき。

継承元
FlexGrid
引数
EventArgs

unknownFunction

Occurs when the FlexSheet meets the unknown formula.

引数
UnknownFunctionEventArgs

updatedLayout

グリッドで内部レイアウトが更新された後に発生します。

継承元
FlexGrid
引数
EventArgs

updatedView

グリッドが現在のビューを構成する要素の作成/更新を完了したときに発生します。

グリッドのビューは以下のような操作に応じて更新されます。

  • Refreshing the grid or its data source,
  • Adding, removing, or changing rows or columns,
  • Resizing or scrolling the grid,
  • Changing the selection.

継承元
FlexGrid
引数
EventArgs

updatingLayout

グリッドで内部レイアウトが更新される前に発生します。

継承元
FlexGrid
引数
CancelEventArgs

updatingView

現在のビューを構成する要素の作成/更新をグリッドが開始したときに発生します。

継承元
FlexGrid
引数
CancelEventArgs