[]
【重要】2024年1月公開のアップデート「未適用」のお客様へ デモ ヘルプ APIリファレンス
トライアル版
(Showing Draft Content)

Wijmo_Xlsx.Workbook

Workbook クラス

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

階層

  • Workbook

コンストラクタ

プロパティ

メソッド

コンストラクタ

constructor

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

    戻り値 Workbook

プロパティ

activeWorksheet

activeWorksheet: number

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

application

application: string

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

colorThemes

colorThemes: string[]

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

company

company: string

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

created

created: Date

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

creator

creator: string

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

definedNames

definedNames: DefinedName[]

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

lastModifiedBy

lastModifiedBy: string

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

modified

modified: Date

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

reservedContent

reservedContent: any

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

sheets

sheets: WorkSheet[]

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

styles

styles: WorkbookStyle[]

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

メソッド

load

  • load(base64: string): void

  • base-64文字列またはデータURLからロードします。 このメソッドは、JSZip 2.5で動作します。

    次に例を示します。

    // このサンプルは、［ファイルを開く］ダイアログで選択したxlsxファイルを開き、
// ワークブックインスタンスを作成してそのファイルをロードします。
 
// HTML
<input type="file"
    id="importFile"
    accept="application/vnd.openxmlformats-officedocument.spreadsheetml.sheet"
/>
 
// JavaScript
var workbook, // receives imported 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);
    }
}

    引数

    • base64: string

      xlsxファイルコンテンツを含むbase-64文字列。

    戻り値 void

loadAsync

  • loadAsync(base64: string, onLoaded: Object, onError?: Object): void

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

    引数

    • base64: string

      xlsxファイルコンテンツを含むbase64文字列。

    • onLoaded: Object

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

    • オプション onError: Object

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

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

    戻り値 void

save

  • save(fileName?: string): string

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

    ブックをファイルに保存し、ブックのbase64文字列表現を返します。たとえば、次のサンプルは、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

      保存するxlsxファイルの名前。

    戻り値 string

saveAsync

  • saveAsync(fileName?: string, onSaved?: Object, onError?: Object): void

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

    引数

    • オプション fileName: string

      保存するxlsxファイルの名前。

    • オプション onSaved: Object

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

    • オプション onError: Object

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

      workbook.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);
});

    戻り値 void

静的 fromXlsxFormat

  • fromXlsxFormat(xlsxFormat: string): string[]

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

    引数

    • xlsxFormat: string

      Excel書式文字列。複数の書式セクションをセミコロンで区切って含めることができます。

    戻り値 string[]

静的 tableAddress

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

    引数

    • xlsxIndex: string

      Aから始まる英字の列インデックス、１から始まる数字の行インデックス、 またはその両方を含む英数字のExcelインデックス（例："D15"、"D"、"15"）。 英字の列インデックスは大文字と小文字のどちらでもかまいません。

    戻り値 ITableAddress

静的 toXlsxDateFormat

  • toXlsxDateFormat(format: string): string

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

    引数

    • format: string

      wijmoの日付書式。

    戻り値 string

静的 toXlsxNumberFormat

  • toXlsxNumberFormat(format: string): string

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

    引数

    • format: string

      wijmoの数値書式。

    戻り値 string

静的 xlsxAddress

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

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

    引数

    • row: number

      ０から始まる行インデックス。列インデックスだけを変換する場合は、null値。

    • col: number

      ０から始まる列インデックス。行インデックスだけを変換する場合は、null値。

    • オプション absolute: boolean

      True値は、行インデックスと列インデックスの両方に対して絶対インデックス（例：$D$7）が返されることを示します。 absoluteCol パラメータを使用すると、 この値を列インデックスに対して再定義できます。

    • オプション absoluteCol: boolean

      列インデックスを絶対インデックスで返す場合、trueを指定します。

    • オプション isWholeRow: boolean

      セル参照が行全体、列全体、または特定のセル範囲のいずれであるかを示します。 isWholeRowがtrueの場合は、セル参照は行全体であることを意味します。 isWholeRowがfalseの場合は、セル参照は列全体であることを意味します。 isWholeRowがnullの場合は、セル参照は特定のセル範囲であることを意味します。

    戻り値 string