ASP.NET MVC コントロールヘルプ
Workbook クラス
ファイル
wijmo.xlsx.js
モジュール
wijmo.xlsx
インターフェイス
IWorkbook

Excelワークブックを表します。

コンストラクタ

プロパティ

メソッド

コンストラクタ

constructor

constructor(): void

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

戻り値
void

プロパティ

activeWorksheet

xlsxファイル内のアクティブなシートのインデックスを取得または設定します。

number

application

ファイルプロパティに表示される、このファイルを生成したアプリケーションの名前を取得または設定します。

string

colorThemes

ワークブックのテーマの色を取得します。

string[]

company

ファイルプロパティに表示される、このファイルを生成した会社の名前を取得または設定します。

string

created

xlsxファイルの作成時刻を取得または設定します。

Date

creator

xlsxファイルの作成者を取得または設定します。

string

definedNames

ワークブックで定義された名前項目を取得します。

DefinedName[]

lastModifiedBy

xlsxファイルの最終変更者を取得または設定します。

string

modified

xlsxファイルの最終変更時刻を取得または設定します。

Date

reservedContent

flexgridまたはflexsheetがまだサポートしていないxlsxファイルの保留コンテンツを取得または設定します。

any

sheets

ワークブックのワークシート配列を取得します。

WorkSheet[]

styles

ワークブックのスタイルテーブルを取得します。

WorkbookStyle[]

メソッド

cancelAsync

cancelAsync(done?: ()): void

saveAsyncメソッドによって開始されたエクスポートをキャンセルします。

パラメーター
  • done: () Optional

    Callback invoked when the method finishes executing.

戻り値
void

Static fromXlsxFormat

fromXlsxFormat(xlsxFormat: string): string[]

xlsxのマルチセクション書式文字列をwijmoの対応する書式の配列に変換します。

パラメーター
  • xlsxFormat: string

    The Excel format string, that may contain multiple format sections separated by a semicolon.

戻り値
string[]

load

load(data: string | ArrayBuffer, includeStyles?: boolean): void

ArrayBuffer、base-64文字列またはデータURLからロードします。このメソッドは、JSZip 2で機能します。

次に例を示します。

// このサンプルは、[ファイルを開く]ダイアログで選択したxlsxファイルを開き、
// ワークブックインスタンスを作成してそのファイルをロードします。
 

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

// JavaScript
var workbook, // インポートされたIWorkbookを受け取ります
    importFile = document.getElementById('importFile');
 
importFile.addEventListener('change', function () {
    loadWorkbook();
});
 
function loadWorkbook() {
    var reader,
        workbook,
        file = importFile.files[0];
    if (file) {
        reader = new FileReader();
        reader.onload = function (e) {
           workbook = new wijmo.xlsx.Workbook(),
           workbook.load(reader.result);
        };
        reader.readAsDataURL(file);
    }
}
パラメーター
  • data: string | ArrayBuffer

    ArrayBuffer or base-64 string that contains the xlsx file content.

  • includeStyles: boolean Optional

    Indicates whether styles should be imported from xlsx file. The default value is **true**.

戻り値
void

loadAsync

loadAsync(data: string | ArrayBuffer, onLoaded?: (workbook: Workbook), onError?: (reason?: any), includeStyles?: boolean): void

ArrayBufferまたはbase-64文字列またはデータURLから非同期にロードします。このメソッドは、JSZip 3で機能します。

パラメーター
  • data: string | ArrayBuffer

    ArrayBuffer or base-64 string that contains the xlsx file content.

  • onLoaded: (workbook: Workbook) Optional

    This callback provides an approach to get an instance of the loaded workbook. Since this method is an asynchronous method, user is not able to get instance of the loaded workbook immediately. User has to get the instance through this callback. This has a single parameter, instance of the loaded workbook. It will be passed to user.

  • onError: (reason?: any) Optional

    This callback catches error information when loading. This has a single parameter, the failure reason. Return value is be passed to user, if he wants to catch the load failure reason.

    For example:

    workbook.loadAsync(base64, 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);
    });
    
  • includeStyles: boolean Optional

    Indicates whether styles should be imported from xlsx file. The default value is **true**.

戻り値
void

save

save(fileName?: string): string

ブックをファイルに保存し、ブックのbase-64文字列表現を返します。 このメソッドはJSZip 2を使用します。

たとえば、次のサンプルは、1つのセルを使用してxlsxファイルを作成します。

function exportXlsx(fileName) {
    var book = new wijmo.xlsx.Workbook(),
        sheet = new wijmo.xlsx.WorkSheet(),
        bookRow = new wijmo.xlsx.WorkbookRow(),
        bookCell = new wijmo.xlsx.WorkbookCell();
    bookCell.value = 'Hello, Excel!';
    bookRow.cells.push(bookCell);
    sheet.rows.push(bookRow);
    book.sheets.push(sheet);
    book.save(fileName);
}

ファイル名はオプションです。指定しない場合でも、メソッドはブックを表すbase64文字列を返します。この文字列を使用して、クライアントやサーバーでその後の処理を行うことができます。

パラメーター
  • fileName: string Optional

    Name of the xlsx file to save.

戻り値
string

saveAsync

saveAsync(fileName?: string, onSaved?: (base64?: string), onError?: (reason?: any), onProgress?: (value: number)): void

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

パラメーター
  • fileName: string Optional

    Name of the xlsx file to save.

  • onSaved: (base64?: string) Optional

    This callback provides an approach to get the base-64 string that represents the content of the saved workbook. Since this method is an asynchronous method, user does not get the base-64 string immediately. User has to get the base-64 string via this callback. This has a single parameter, the base-64 string of the saved workbook. It will be passed to user.

  • onError: (reason?: any) Optional

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

  • onProgress: (value: number) Optional

    Callback function that gives feedback about the progress of a task. The function accepts a single argument, the current progress as a number between 0 and 100.

    For example:

    workbook.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);
    });
    
戻り値
void

Static tableAddress

tableAddress(xlsxIndex: string): ITableAddress

Excelの英数字のセル、行、または列のインデックスを0から始まる行/列インデックスのペアに変換します。

パラメーター
  • xlsxIndex: string

    The alphanumeric Excel index that may include alphabetic A-based column index and/or numeric 1-based row index, like "D15", "D" or "15". The alphabetic column index can be in lower or upper case.

戻り値
ITableAddress

Static toXlsxDateFormat

toXlsxDateFormat(format: string): string

wijmoの日付書式をExcelの書式に変換します。

パラメーター
  • format: string

    The wijmo date format.

戻り値
string

Static toXlsxNumberFormat

toXlsxNumberFormat(format: string): string

wijmoの数値書式をxlsxの書式に変換します。

パラメーター
  • format: string

    The wijmo number format.

戻り値
string

Static xlsxAddress

xlsxAddress(row: number, col: number, absolute?: boolean, absoluteCol?: boolean, isWholeRow?: boolean): string

0から始まるセルの行インデックスまたは列インデックスをExcelの英数字表現に変換します。

パラメーター
  • row: number

    The zero-based row index or a null value if only column index is to be converted.

  • col: number

    The zero-based column index or a null value if only row index is to be converted.

  • absolute: boolean Optional

    True value indicates that absolute indices is to be returned for both, row and column (like $D$7). The absoluteCol parameter allows to redefine this value for the column index.

  • absoluteCol: boolean Optional

    True value indicates that column index is absolute.

  • isWholeRow: boolean Optional

    Indicates whether the Cell reference is whole row, whole column or specific cell range. If isWholeRow is true means the cell reference is whole row. If isWholeRow is false means the cell reference is whole column. If isWholeRow is null means the cell reference is specific cell range.

戻り値
string