addBoundSheet

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

• バインドされたSheet をFlexSheetに追加します。

  引数

  • sheetName: string

    Sheet の名前。

  • source: any

    Sheet の項目ソース。

  • オプション pos: number

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

  • オプション grid: FlexGrid

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

  戻り値 Sheet

addFunction

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

• FlexSheet にカスタム関数を追加します。

  引数

  • 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

addUnboundSheet

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

• バインドされていないSheet をFlexSheetに追加します。

  引数

  • オプション sheetName: string

    Sheetの名前。

  • オプション rows: number

    Sheetの行数。

  • オプション cols: number

    Sheetの列数。

  • オプション pos: number

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

  • オプション grid: FlexGrid

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

  戻り値 Sheet

applyCellsStyle

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

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

  引数

  • cellStyle: ICellStyle

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

  • オプション cells: CellRange[]

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

  • オプション isPreview: boolean

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

  戻り値 void

applyFunctionToCell

• applyFunctionToCell(): void

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

  戻り値 void

clear

• clear(): void

• FlexSheetコントロールの内容をクリアします。

  戻り値 void

deleteColumns

• deleteColumns(index?: number, count?: number): void
• deleteColumns(ranges: CellRange[]): void

• FlexSheetコントロールの現在のSheet に列を削除します。

  引数

  • オプション 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

• FlexSheetコントロールの現在のSheet に列を削除します。

  引数

  • ranges: CellRange[]

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

  戻り値 void

deleteRows

• deleteRows(index?: number, count?: number): void
• deleteRows(ranges: CellRange[]): void

• FlexSheetコントロールの現在のSheet に行を削除します。

  引数

  • オプション 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

• FlexSheetコントロールの現在のSheet に行を削除します。

  引数

  • ranges: CellRange[]

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

  戻り値 void

evaluate

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

• 式を評価します。

  FlexSheet の式はExcelの構文に従い、Excelでサポートされている関数の大部分を含みます。 FlexSheet によってサポートされる関数の完全なリストについては、 「FlexSheetの関数」を参照してください。

  引数

  • formula: string

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

  • オプション format: string

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

  • オプション sheet: Sheet

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

  • オプション getPrimitiveResult: boolean

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

  戻り値 any

freezeAtCursor

• freezeAtCursor(): void

• FlexSheetコントロールの列および行を固定または固定解除します。

  戻り値 void

getBuiltInTableStyle

• getBuiltInTableStyle(styleName: string): TableStyle

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

  引数

  • styleName: string

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

  戻り値 TableStyle

getCellValue

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

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

  getCellDataメソッドは生のデータ（値または数式のどちらか）を返しますが、 getCellValueメソッドはそれとは異なり、常に評価された値を返します。すなわち、セルに数式が含まれている場合は、 まず数式を評価してから結果の値が返されます。

  引数

  • rowIndex: number

    セルの行インデックス。

  • colIndex: number

    セルの列インデックス。

  • オプション formatted: boolean

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

  • オプション sheet: Sheet

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

  戻り値 any

getSelectionFormatState

• getSelectionFormatState(): IFormatState

• 選択されているセルの書式設定を記述するIFormatState オブジェクトを取得します。

  戻り値 IFormatState

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

hideFunctionList

• hideFunctionList(): void

• 関数リストを閉じます。

  戻り値 void

insertColumns

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

• FlexSheetコントロールの現在のSheet に列を挿入します。

  引数

  • オプション index: number

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

  • オプション count: number

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

  戻り値 void

insertRows

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

• FlexSheetコントロールの現在のSheet に行を挿入します。

  引数

  • オプション index: number

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

  • オプション count: number

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

  戻り値 void

load

• load(workbook: string | ArrayBuffer | Blob | mXlsx.Workbook): void

• ワークブックをFlexSheet に非同期にロードします。 このメソッドはJSZip 2.5を使用します。

  次に例を示します。

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

loadAsync

• loadAsync(workbook: string | ArrayBuffer | Blob | mXlsx.Workbook, onLoaded?: Object, onError?: Object): void

• ワークブックをFlexSheet に非同期にロードします。 このメソッドはJSZip 3.0を使用します。

  引数

  • 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

mergeRange

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

• 選択されているCellRange を1つのセルに結合します。

  引数

  • オプション cells: CellRange

    結合する CellRange。

  • オプション isCopyMergeCell: boolean

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

  戻り値 void

onAutoFilled

• onAutoFilled(e: AutoFillingEventArgs): void

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

  引数

  • e: AutoFillingEventArgs

  戻り値 void

onAutoFilling

• onAutoFilling(e: AutoFillingEventArgs): void

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

  引数

  • e: AutoFillingEventArgs

  戻り値 void

onBeginDroppingRowColumn

• onBeginDroppingRowColumn(e: DroppingRowColumnEventArgs): void

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

  引数

  • e: DroppingRowColumnEventArgs

  戻り値 void

onColumnChanged

• onColumnChanged(e: RowColumnChangedEventArgs): void

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

  引数

  • e: RowColumnChangedEventArgs

  戻り値 void

onDraggingRowColumn

• onDraggingRowColumn(e: DraggingRowColumnEventArgs): void

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

  引数

  • e: DraggingRowColumnEventArgs

  戻り値 void

onDroppingRowColumn

• onDroppingRowColumn(e?: EventArgs): void

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

  引数

  • オプション e: EventArgs

  戻り値 void

onEndDroppingRowColumn

• onEndDroppingRowColumn(e: CancelEventArgs): void

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

  引数

  • e: CancelEventArgs

  戻り値 void

onLoaded

• onLoaded(e?: EventArgs): void

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

  引数

  • オプション e: EventArgs

  戻り値 void

onPrepareChangingColumn

• onPrepareChangingColumn(e: RowColumnChangedEventArgs): void

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

  引数

  • e: RowColumnChangedEventArgs

  戻り値 void

onPrepareChangingRow

• onPrepareChangingRow(e: RowColumnChangedEventArgs): void

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

  引数

  • e: RowColumnChangedEventArgs

  戻り値 void

onRowChanged

• onRowChanged(e: RowColumnChangedEventArgs): void

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

  引数

  • e: RowColumnChangedEventArgs

  戻り値 void

onSelectedSheetChanged

• onSelectedSheetChanged(e: PropertyChangedEventArgs): void

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

  引数

  • e: PropertyChangedEventArgs

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

  戻り値 void

onSheetCleared

• onSheetCleared(e?: EventArgs): void

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

  引数

  • オプション e: EventArgs

  戻り値 void

onUnknownFunction

• onUnknownFunction(e: UnknownFunctionEventArgs): void

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

  引数

  • e: UnknownFunctionEventArgs

  戻り値 void

redo

• redo(): void

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

  戻り値 void

save

• save(fileName?: string, options?: IFlexSheetXlsxOptions): mXlsx.Workbook

• FlexSheet をxlsxファイルに非同期に保存します。 このメソッドはJSZip 2.5を使用します。

  次に例を示します。

  // このサンプルは、ボタンのクリックで、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

  生成されたxlsxファイルコンテンツを含むワークブックのインスタンス。

saveAsync

• saveAsync(fileName?: string, onSaved?: Object, onError?: Object, options?: IFlexSheetXlsxOptions): Workbook

• FlexSheet をxlsxファイルに非同期に保存します。 このメソッドはJSZip 3.0を使用します。

  引数

  • オプション 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

  生成されたxlsxファイルコンテンツを含むワークブックのインスタンス。

selectNextFunction