引数

• 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

引数

• cellStyle: ICellStyle

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

• オプション cells: CellRange[]

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

• オプション isPreview: boolean

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

戻り値 void

戻り値 void

戻り値 void

戻り値 boolean

引数

• オプション index: number

  削除する列の開始インデックス。 これを指定しない場合、現在選択されている範囲の最初の列から列が削除されます。

• オプション count: number

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

戻り値 void

引数

• オプション index: number

  削除する行の開始インデックス。 これを指定しない場合、現在選択されている範囲の最初の行から行が削除されます。

• オプション count: number

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

戻り値 void

戻り値 void

引数

• formula: string

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

• オプション format: string

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

• オプション sheet: Sheet

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

• オプション getPrimitiveResult: boolean

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

戻り値 any

戻り値 void

引数

• styleName: string

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

戻り値 TableStyle

引数

• rowIndex: number

  セルの行インデックス。

• colIndex: number

  セルの列インデックス。

• オプション formatted: boolean

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

• オプション sheet: Sheet

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

戻り値 any

引数

• オプション rng: CellRange

  コピーするCellRange 。 省略した場合、現在の選択範囲が使用されます。

戻り値 string

引数

• panel: GridPanel

  範囲を含むGridPanel。

• r: number

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

• c: number

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

• オプション clip: boolean

  結合範囲をグリッドの現在のビュー範囲にクリップするかどうか。

戻り値 CellRange

A CellRange that specifies the merged range, or null if the cell is not merged.

戻り値 IFormatState

The IFormatState object containing formatting properties.

戻り値 void

引数

• オプション index: number

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

• オプション count: number

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

戻り値 void

引数

• オプション index: number

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

• オプション count: number

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

戻り値 void

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

  xlsxファイルコンテンツを含むワークブックインスタンス、 Blobインスタンス、base64文字列、またはArrayBuffer。

戻り値 void

引数

• workbook: any

  xlsxファイルコンテンツを含むワークブックインスタンス、 Blobインスタンス、base64文字列、または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: DroppingRowColumnEventArgs

戻り値 void

引数

• e: RowColumnChangedEventArgs

戻り値 void

引数

• e: DraggingRowColumnEventArgs

戻り値 void

引数

• オプション e: EventArgs

戻り値 void

引数

• e: CancelEventArgs

戻り値 void

引数

• オプション e: EventArgs

戻り値 void

引数

• e: RowColumnChangedEventArgs

戻り値 void

引数

• e: RowColumnChangedEventArgs

戻り値 void

引数

• e: RowColumnChangedEventArgs

戻り値 void

引数

• e: PropertyChangedEventArgs

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

戻り値 void

引数

• オプション e: EventArgs

戻り値 void

引数

• e: UnknownFunctionEventArgs

戻り値 void

戻り値 void

引数

• オプション fullUpdate: boolean

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

戻り値 void

// このサンプルは、ボタンのクリックで、FlexSheetのコンテンツをxlsxファイルにエクスポートします。
// クリック。
 
// HTML
<button
    onclick="saveXlsx('FlexSheet.xlsx')">
    Save
</button>
 
// JavaScript
function saveXlsx(fileName) {
    // FlexSheetをxlsxファイルに保存します。
    flexsheet.save(fileName);
}

引数

• オプション fileName: string

  生成されるファイル名。

• オプション options: IFlexSheetXlsxOptions

  保存オプションを指定するIFlexSheetXlsxOptions オブジェクト。

戻り値 mXlsx.Workbook

A workbook instance containing the generated xlsx file content.

引数

• オプション fileName: string

  生成されるファイル名。

• オプション onSaved: Object

  このコールバックは、保存されたFlexSheetのコンテンツを表すbase64文字列を取得する方法を提供します。 このメソッドは非同期メソッドであるため、 ユーザーはbase64文字列を直ちに取得することができません。このコールバックを通じて base64文字列を取得する必要があります。 コールバックのパラメータには、保存されたflexsheetのbase64文字列が含まれます。 それがユーザーに渡されます。

• オプション onError: Object

  このコールバックは、保存時のエラー情報を捕捉します。 コールバックのパラメータには、失敗理由が含まれます。 保存失敗の理由を確認したい場合は、この戻り値がユーザーに渡されます。 次に例を示します。

  flexsheet.saveAsync('', function (base64) {
       // このコールバックで、ユーザーはロードされたワークブックインスタンスにアクセスできます。
       document.getElementByID('export').href = 'data:application/vnd.openxmlformats-officedocument.spreadsheetml.sheet;' + 'base64,' + base64;
  }, function (reason) {
       // このコールバックで、ユーザーは失敗理由を確認できます。
       console.log('The reason of save failure is ' + reason);
  });
  

• オプション options: IFlexSheetXlsxOptions

  保存オプションを指定するIFlexSheetXlsxOptions オブジェクト。

戻り値 Workbook

A workbook instance containing the generated xlsx file content.

引数

• rng: any

  選択するセル範囲。

• オプション show: any

  新しい選択範囲が画面に入るようにスクロールするかどうかを示します。

戻り値 void

戻り値 void

戻り値 void

引数

• r: number

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

• c: any

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

• value: any

  セルに格納する値。

• オプション coerce: boolean

  列のデータ型に合わせて値を自動的に変更するかどうか。

• オプション invalidate: boolean

  FlexSheetを無効にして変更を表示するかどうか。

戻り値 boolean

True if the value was stored successfully, false otherwise.

引数

• text: string

  グリッドに解析する、タブと改行で区切られたテキスト。

• オプション rng: CellRange

  コピーするCellRange 。 省略した場合、現在の選択範囲が使用されます。

戻り値 boolean

戻り値 void

引数

• target: HTMLElement

  関数リストの表示/非表示を切り替えるDOM要素。

戻り値 void

戻り値 void