引数

• sheetName: string

  Sheet の名前。

• source: any

  Sheet の項目ソース。

• オプション pos: number

  sheets コレクション内の位置。

• オプション grid: FlexGrid

  Sheet に関連付けるFlexGrid インスタンス。 これを指定しない場合、新しいFlexGrid インスタンスが作成されます。

戻り値 Sheet

引数

• name: string

  カスタム関数の名前。

• func: Function

  カスタム関数。
  関数シグネチャは次のようになります。
  

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

  関数は可変数のパラメータをとり、各パラメータは関数の引数として渡される式に対応します。 関数の引数として渡される式が単一の値またはセル範囲に解決されるかどうかにかかわらず、 各パラメーター値は常に解決された値の2次元配列となります。 配列内の行数（ 第1のインデックス）および列数（第2のインデックス）は、指定されたセル範囲のサイズに対応します。 引数が単一の値に解決される式である場合、 その値はparam[0][0]インデクサを使用して取り出すことができる1対1の配列になります。 param[0][0] indexer.
  以下のコードでは、カスタムのSumproduct関数('customSumProduct')を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);

  上記の関数を追加した後は、以下のようなシートセル式で使用できます。

  =customSumProduct(A1:B5, B1:C5)

• オプション description: string

  カスタム関数の説明。FlexSheet の自動関数補完に表示されます。

• オプション minParamsCount: number

  関数が必要とするパラメータの最小数。

• オプション maxParamsCount: number

  関数が必要とするパラメータの最大数。カスタム関数のパラメータ数が任意である場合は、minParamsCountおよびmaxParamsCountをnullに設定する必要があります。

戻り値 void

引数

• オプション sheetName: string

  Sheetの名前。

• オプション rows: number

  Sheetの行数。

• オプション cols: number

  Sheetの列数。

• オプション pos: number

  sheets コレクション内の位置。

• オプション grid: FlexGrid

  Sheet に関連付けるFlexGrid インスタンス。 これを指定しない場合、新しいFlexGrid インスタンスが作成されます。

戻り値 Sheet

引数

• index: number

• type: FrozenRowCol

• オプション delta: number

戻り値 void

引数

• cellStyle: ICellStyle

  適用するICellStyle オブジェクト。

• オプション cells: CellRange[]

  スタイルを適用するCellRange オブジェクトの配列。 これを指定しない場合、現在選択されているセルにスタイルが適用されます。

• オプション isPreview: boolean

  適用するスタイルがプレビュー用かどうかを示します。

戻り値 void

戻り値 void

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

引数

• classNames: string

• template: string

• parts: Object

• オプション namePart: string

戻り値 HTMLElement

引数

• c: number

  サイズ変更する列のインデックス。

• オプション header: boolean

  列インデックスの参照先が通常の列であるか、ヘッダ列であるか。

• オプション extra: number

  追加の間隔（ピクセル単位）。

戻り値 void

引数

• オプション firstColumn: number

  サイズ変更する最初の列のインデックス（デフォルトは最初の列）。

• オプション lastColumn: number

  サイズ変更する最後の列のインデックス（デフォルトは最後の列）。

• オプション header: boolean

  列インデックスの参照先が通常の列であるか、ヘッダ列であるか。

• オプション extra: number

  追加の間隔（ピクセル単位）。

戻り値 void

引数

• r: number

  サイズ変更する行のインデックス。

• オプション header: boolean

  行インデックスがヘッダ行を参照していることを示す場合はtrue。通常のデータ行を参照している場合はfalse。フッタ行を参照している場合はnull。

• オプション extra: number

  追加の間隔（ピクセル単位）。

戻り値 void

引数

• オプション firstRow: number

  サイズ変更する最初の行のインデックス。

• オプション lastRow: number

  サイズ変更する最初の行のインデックスす。

• オプション header: boolean

  行インデックスの参照先が通常の行であるか、ヘッダ行であるか。

• オプション extra: number

  追加の間隔（ピクセル単位）。

戻り値 void

戻り値 void

引数

• r: number

  セルを含む行のインデックス。

• c: number

  セルを含む列のインデックス。

戻り値 boolean

戻り値 void

引数

• level: number

  表示する最大のグループレベル。

戻り値 void

引数

• fn: Function

  実行する関数。

戻り値 void

引数

• オプション index: number

  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

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

戻り値 void

引数

• ranges: CellRange[]

  削除する列を決定する CellRange インスタンスの配列。

戻り値 void

引数

• オプション index: number

  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

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

戻り値 void

引数

• ranges: CellRange[]

  削除する行を決定する CellRange インスタンスの配列。

戻り値 void

引数

• オプション shouldInvalidate: boolean

  コントロールを無効にする必要があります。このパラメータのデフォルト値は true です。

戻り値 void

引数

• formula: string

  評価する式。この式の先頭には、オプションで等号（'='）を付けることができます。

• オプション format: string

  指定する場合、評価された値に適用する.NET書式を定義します。

• オプション sheet: Sheet

  評価に使用されるデータを含むSheet。 指定されていない場合は、現在のシートが使用されます。

• オプション getPrimitiveResult: boolean

  プリミティブ型以外の結果をプリミティブ型の結果に変換する必要があるかどうかを示します。

戻り値 any

引数

• オプション cancel: boolean

  保留中の編集をキャンセルするかコミットするか。

戻り値 boolean

編集操作が正常に終了した場合は True です。

戻り値 void

引数

• styleName: string

  組み込みテーブルスタイルの名前。

戻り値 TableStyle

引数

• r: number

  セルを含む行のインデックス。

• c: number | string

  セルを含む列のインデックス、名前、またはバインディング。

• オプション raw: boolean

  返される矩形の単位をビューポート座標ではなく生のパネル座標にするかどうか。

戻り値 Rect

引数

• r: number

  セルを含む行のインデックス。

• c: number | string

  セルを含む列のインデックス、名前、またはバインディング。

• formatted: boolean

  値を表示用に書式設定するかどうか。

戻り値 any

引数

• rowIndex: number

  セルの行インデックス。

• colIndex: number

  セルの列インデックス。

• オプション formatted: boolean

  セルの元の値または書式設定された値のどちらを返すかを示します。

• オプション sheet: Sheet

  評価に使用されるデータを含むSheet 。これを指定しない場合、現在のシートのデータが使用されます。

戻り値 any

引数

• name: string | number

  列の名前、バインディング、またはインデックス。

• オプション header: boolean

  検索操作に列グループを含めるかどうか。

戻り値 Column

指定された名前または連結を含む列。見つからない場合はnull。

戻り値 ColumnGroupCollection

引数

• r: number

  検査するセルの行インデックス。

• c: number

  検査するセルの列インデックス。

戻り値 SelectedState

戻り値 IFormatState

書式設定のプロパティを含むIFormatStateオブジェクト。

戻り値 string

引数

• v: PropertyKey

  プロパティの名前。

戻り値 boolean

戻り値 void

// ユーザーがグリッドをクリックしたときに、ポイントをヒットテストします
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 | Point | MouseEvent | HTMLElement

  調べるPoint （ページ座標単位）、MouseEventオブジェクト、またはポイントのX座標。

• オプション y: number | boolean

  ポイントのY座標（ページ座標単位、最初のパラメーターが数値の場合）。

戻り値 HitTestInfo

ポイントに関する情報を含むwijmo.grid.HitTestInfoオブジェクト。

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

  初期化データを含むオブジェクト。

戻り値 void

引数

• オプション index: number

  新しい列を追加する位置。 これを指定しない場合、現在選択されている範囲の一番左の列の前に列が追加されます。

• オプション count: number

  追加する列数。これを指定しない場合、1列が追加されます。

戻り値 void

引数

• オプション index: number

  新しい行を追加する位置。 これを指定しない場合、現在選択されている範囲の最初の行の前に行が追加されます。

• オプション count: number

  追加する行数。これを指定しない場合、1行が追加されます。

戻り値 void

引数

• オプション fullUpdate: boolean

  内容だけでなくコントロールのレイアウトも更新するかどうか。

戻り値 void

引数

• v: Object

  プロトタイプチェーンが判定される別のオブジェクト。

戻り値 boolean

引数

• rng: CellRange

  チェックする範囲。

戻り値 boolean

// このサンプルは、［ファイルを開く］ダイアログで選択したxlsxファイルを開き、
// 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 | mXlsx.Workbook

  xlsxファイルコンテンツを含む wijmo.xlsx.Workbook、 Blob、base-64文字列、またはArrayBuffer。

戻り値 void

引数

• workbook: string | ArrayBuffer | Blob | mXlsx.Workbook

  xlsxファイルコンテンツを含む wijmo.xlsx.Workbook、 Blob、base-64文字列、またはArrayBuffer。

• オプション onLoaded: Object

  このコールバックは、ロードされたワークブックインスタンスをアクセスする方法を提供します。 このメソッドは非同期メソッドであるため、ユーザーはロードされたワークブックインスタンスを直ちに取得することができません。 このコールバックには、単一のパラメータ、ロードされたワークブックインスタンスが含まれます。

• オプション onError: Object

  このコールバックは、ワークブックがロードされるときにエラー情報を捕捉します。 コールバックのパラメータには、失敗理由が含まれます。 次に例を示します。

  flexsheet.loadAsync(blob, function (workbook) {
       // このコールバックで、ユーザーはロードされたワークブックインスタンスにアクセスできます。
       var app = worksheet.application ;
       ...
  }, function (reason) {
       // このコールバックで、ユーザーは失敗理由を確認できます。
       console.log('The reason of load failure is ' + reason);
  });
  

戻り値 void

引数

• オプション cells: CellRange

  結合する CellRange。

• オプション isCopyMergeCell: boolean

  このパラメータは、結合操作が結合セルのコピー/ペーストで行われたかどうかを示します。

戻り値 void

引数

• e: AutoFillingEventArgs

戻り値 void

引数

• e: AutoFillingEventArgs

戻り値 void

引数

• e: CellRangeEventArgs

  イベントデータを含むCellRangeEventArgs 。

戻り値 void

引数

• e: CellRangeEventArgs

  イベントデータを含むCellRangeEventArgs 。

戻り値 void

引数

• e: CellRangeEventArgs

  イベントデータを含むCellRangeEventArgs 。

戻り値 boolean

イベントがキャンセルされなかった場合は True です。

引数

• e: CellRangeEventArgs

  イベントデータを含むCellRangeEventArgs 。

戻り値 boolean

イベントがキャンセルされなかった場合は True です。

引数

• e: DroppingRowColumnEventArgs

戻り値 void

引数

• e: CellRangeEventArgs

  イベントデータを含むCellRangeEventArgs 。

戻り値 boolean

イベントがキャンセルされなかった場合は True です。

引数

• e: CellRangeEventArgs

  イベントデータを含むCellRangeEventArgs 。

戻り値 void

引数

• e: CellEditEndingEventArgs

  イベントデータを含むCellEditEndingEventArgs 。

戻り値 boolean

イベントがキャンセルされなかった場合は True です。

引数

• e: RowColumnChangedEventArgs

戻り値 void

引数

• e: CellRangeEventArgs

  イベントデータを含むCellRangeEventArgs 。

戻り値 void

引数

• e: CellRangeEventArgs

  イベントデータを含むCellRangeEventArgs 。

戻り値 boolean

イベントがキャンセルされなかった場合は True です。

引数

• e: CellRangeEventArgs

  イベントデータを含むCellRangeEventArgs 。

戻り値 void

引数

• e: CellRangeEventArgs

  イベントデータを含むCellRangeEventArgs 。

戻り値 boolean

イベントがキャンセルされなかった場合は True です。

引数

• e: CellRangeEventArgs

  イベントデータを含むCellRangeEventArgs 。

戻り値 void

引数

• e: CellRangeEventArgs

  イベントデータを含むCellRangeEventArgs 。

戻り値 boolean

イベントがキャンセルされなかった場合は True です。

引数

• e: CellRangeEventArgs

  イベントデータを含むCellRangeEventArgs 。

戻り値 void

引数

• e: CellRangeEventArgs

  イベントデータを含むCellRangeEventArgs 。

戻り値 void

引数

• e: CellRangeEventArgs

  イベントデータを含むCellRangeEventArgs 。

戻り値 boolean

イベントがキャンセルされなかった場合は True です。

引数

• e: CellRangeEventArgs

  イベントデータを含むCellRangeEventArgs 。

戻り値 boolean

イベントがキャンセルされなかった場合は True です。

引数

• e: CellRangeEventArgs

  イベントデータを含むCellRangeEventArgs 。

戻り値 boolean

イベントがキャンセルされなかった場合は True です。

引数

• e: DraggingRowColumnEventArgs

戻り値 void

引数

• e: CellRangeEventArgs

  イベントデータを含むCellRangeEventArgs 。

戻り値 boolean

イベントがキャンセルされなかった場合は True です。

引数

• オプション e: EventArgs

戻り値 void

引数

• e: CancelEventArgs

戻り値 void

引数

• e: FormatItemEventArgs

  イベントデータを含むFormatItemEventArgs 。

戻り値 void

引数

• オプション e: EventArgs

戻り値 void

引数

• e: CellRangeEventArgs

  イベントデータを含むCellRangeEventArgs 。

戻り値 void

引数

• e: CellRangeEventArgs

  イベントデータを含むCellRangeEventArgs 。

戻り値 boolean

イベントがキャンセルされなかった場合は True です。

引数

• e: CancelEventArgs

戻り値 boolean

引数

• オプション e: EventArgs

戻り値 void

引数

• e: CancelEventArgs

  イベントデータを含むCancelEventArgs 。

戻り値 boolean

イベントがキャンセルされなかった場合は True です。

引数

• オプション e: EventArgs

戻り値 void

引数

• オプション e: EventArgs

戻り値 void

引数

• e: CancelEventArgs

  イベントデータを含むCancelEventArgs 。

戻り値 boolean

イベントがキャンセルされなかった場合は True です。

引数

• オプション e: EventArgs