ワークブック

このトピックでは、表ドキュメントのワークブックオブジェクトに関連する API 操作について説明します。

Workbook

作業中のウィンドウでアクティブなワークブックを取得します。

重要

JS-SDK V1.1.10 以降でのみ、この機能がサポートされています。

構文
expression.ActiveWorkbook
expression: ドキュメントタイプのアプリケーションオブジェクト。

例

async function example() {
  await instance.ready();

  const app = instance.Application;
  
  // アクティブなワークブックを取得します。
  const activeWorkbook = await app.ActiveWorkbook;
}

メソッド

ActiveWorkbook.CopySheetFromBook()

CopySheetFromBook() メソッドを使用して、アクティブなワークブックのアクティブなワークシートを現在のワークブックにコピーできます。

重要

JS-SDK V1.1.10 以降でのみ、この機能がサポートされています。

構文
expression.ActiveWorkbook.CopySheetFromBook({ FromBookFileId, FromBookFileName, FromeSheetName, DestSheetName })
expression: ドキュメントタイプのアプリケーションオブジェクト。

パラメータ

プロパティ	タイプ	必須	説明
FromBookFileId	String	はい	ターゲットのアクティブなワークブックの ID。
FromBookFileName	String	いいえ	ターゲットのアクティブなワークブックの名前。
FromeSheetName	String	いいえ	ターゲットのアクティブなワークブックのアクティブなワークシートの名前。
DestSheetName	String	いいえ	現在のアクティブなワークブックにコピーされるアクティブなワークシートの名前。

例

async function example() {
  await instance.ready();

  const app = instance.Application;
  
  // アクティブなワークブックを取得します。
  const activeWorkbook = await app.ActiveWorkbook;

  // ID が「100161090439」で名前が「Workbook」のアクティブなワークブックの「Sheet」という名前のアクティブなワークシートを、現在のアクティブなワークブックの「Sheet6」という名前のアクティブなワークシートにコピーします。
  const result=await activeWorkbook.CopySheetFromBook('100161090439', 'Workbook', 'Sheet1', 'Sheet6');
  console.log(result);
}

ActiveWorkbook.ExportAsFixedFormat()

ExportAsFixedFormat() メソッドを使用して、現在のアクティブなワークブックを PDF ファイルまたは IMG イメージとしてエクスポートし、ファイルの URL を取得できます。

重要

JS-SDK V1.1.10 以降でのみ、この機能がサポートされています。

構文
expression.ActiveWorkbook.ExportAsFixedFormat({ Type })
expression: ドキュメントタイプのアプリケーションオブジェクト。

パラメータ

プロパティ	タイプ	必須	説明
Type	Enum	いいえ	エクスポートされるファイルの形式。イメージと PDF のみがサポートされています。詳細については、「XlFixedFormatType」をご参照ください。

戻り値
プロパティ
タイプ
説明
url
String
エクスポートされたファイルの URL。

例

PDF としてエクスポート

async function example() {
  await instance.ready();

  const app = instance.Application;
  
  // PDF ファイルとしてエクスポートし、エクスポートされたファイルの URL を取得します。
  const workbookPdfUrl = await app.ActiveWorkbook.ExportAsFixedFormat();
  console.log(workbookPdfUrl);
}

イメージとしてエクスポート

async function example() {
  await instance.ready();

  const app = instance.Application;
  
  // イメージとしてエクスポートし、エクスポートされたファイルの URL を取得します。
  const workbookImgUrl = await app.ActiveWorkbook.ExportAsFixedFormat({
    Type: app.Enum.XlFixedFormatType.xlTypeIMG,
  });
  console.log(workbookImgUrl);
}

ActiveWorkbook.GetOperatorsInfo()

GetOperatorsInfo() メソッドを使用して、現在のオペレーターに関する情報を取得できます。

重要

JS-SDK V1.1.10 以降でのみ、この機能がサポートされています。

構文
expression.ActiveWorkbook.GetOperatorsInfo()
expression: ドキュメントタイプのアプリケーションオブジェクト。

戻り値

Object オブジェクト
プロパティ
タイプ
説明
type
String
リクエストのタイプ。
response
Object
オペレータに関する情報。

response の構造

プロパティ	タイプ	説明
id	String	ユーザーの ID。
avatar_url	String	ユーザーのプロフィール画像。
logined	String	ユーザーのログインステータス。
name	String	ユーザーの名前。

例

async function example() {
  await instance.ready();

  const app = instance.Application;
  
  // 現在のオペレータに関する情報を取得します。
  const operatorsInfo = await app.ActiveWorkbook.GetOperatorsInfo();
  console.log(operatorsInfo);
}

ActiveWorkbook.SetFilterShared()

SetFilterShared() メソッドを使用して、複数人同時フィルタリング機能を有効または無効にできます。

重要

JS-SDK V1.1.10 以降でのみ、この機能がサポートされています。

構文
expression.ActiveWorkbook.SetFilterShared({ Checked })
expression: ドキュメントタイプのアプリケーションオブジェクト。
パラメータ
プロパティ
タイプ
必須
説明
Checked
Boolean
はい
複数人同時フィルタリング機能を有効にするかどうかを指定します。有効な値:
true
false

例

async function example() {
  await instance.ready();

  const app = instance.Application;
  
  // アクティブなワークブックを取得します。
  const activeWorkbook = await app.ActiveWorkbook;

  // 複数人同時フィルタリングを有効にします。
  const result = await activeWorkbook.SetFilterShared(true);
}

ActiveWorkbook.Save()

Save() メソッドを使用して、アクティブなワークブックへの変更を保存できます。

重要

JS-SDK V1.1.10 以降でのみ、この機能がサポートされています。

構文
expression.ActiveWorkbook.Save()
expression: ドキュメントタイプのアプリケーションオブジェクト。

戻り値

プロパティ	タイプ	説明
result	String	保存ステータス。有効な値: ok: バージョンが保存されました。バージョン履歴でバージョンを表示できます。 nochange: 保存する更新はありません。 SavedEmptyFile: 空のファイルを保存することはできません。シナリオ: カーネル保存後、ファイルが空です。 SpaceFull: 空き容量がありません。 QueneFull: 保存中は頻繁な操作を実行しないでください。シナリオ: サーバー処理および保存キューがいっぱいで、保存操作がキューに入れられています。 fail: ファイルを保存できませんでした。
size	Number	ファイルのサイズ。単位: バイト。
version	Number	バージョン番号。

例

async function example() {
  await instance.ready();

  const app = instance.Application;
  
  // アクティブなワークブックへの変更を保存します。
  const saveResult = await app.ActiveWorkbook.Save();
  console.log(saveResult);
}

ActiveWorkbook.SwitchCardView()

SwitchCardView() メソッドを使用して、カードビューパネルを開いたり閉じたりできます。

重要

JS-SDK V1.1.10 以降でのみ、この機能がサポートされています。

構文
expression.ActiveWorkbook.SwitchCardView()
expression: ドキュメントタイプのアプリケーションオブジェクト。
パラメータ
プロパティ
タイプ
必須
説明
Status
Boolean
はい
カードビューパネルを開くか閉じるかを指定します。有効な値:
true
false (サポートされていません)

例

async function example() {
  await instance.ready();

  const app = instance.Application;
  
  // カードビューパネルを開きます
  await app.ActiveWorkbook.SwitchCardView(true);
}

ActiveWorkbook.QuitCellEdit()

QuitCellEdit() メソッドを使用して、セル編集モードを終了できます。

重要

JS-SDK V1.1.10 以降でのみ、この機能がサポートされています。

構文
expression.ActiveWorkbook.QuitCellEdit()
expression: ドキュメントタイプのアプリケーションオブジェクト。

例

async function example() {
  await instance.ready();

  const app = instance.Application;
  
  // セル編集モードを終了します。
  await app.ActiveWorkbook.QuitCellEdit();
}

ActiveWorkbook.CloseDropdownPanels()

CloseDropdownPanels() メソッドを使用して、すべてのドロップダウンパネルを閉じることができます。

重要

JS-SDK V1.1.10 以降でのみ、この機能がサポートされています。

構文
expression.ActiveWorkbook.CloseDropdownPanels()
expression: ドキュメントタイプのアプリケーションオブジェクト。

例

async function example() {
  await instance.ready();

  const app = instance.Application;
  
  // すべてのドロップダウンパネルを閉じます。
  await app.ActiveWorkbook.CloseDropdownPanels();
}

ActiveWorkbook.CloseHyperLink()

CloseHyperLink() メソッドを使用して、ハイパーリンクを無効にできます。

重要

JS-SDK V1.1.10 以降でのみ、この機能がサポートされています。

構文
expression.ActiveWorkbook.CloseHyperLink()
expression: ドキュメントタイプのアプリケーションオブジェクト。

例

async function example() {
  await instance.ready();

  const app = instance.Application;
  
  // ハイパーリンクを無効にします。
  await app.ActiveWorkbook.CloseHyperLink();
}

ActiveWorkbook.CloseFilterTips()

CloseFilterTips() メソッドを使用して、フィルターホバーチップを閉じることができます。

重要

JS-SDK V1.1.10 以降でのみ、この機能がサポートされています。

構文
expression.ActiveWorkbook.CloseFilterTips()
expression: ドキュメントタイプのアプリケーションオブジェクト。

例

async function example() {
  await instance.ready();

  const app = instance.Application;
  
  // フィルターホバーチップを閉じます。
  await app.ActiveWorkbook.CloseFilterTips();
}

ActiveWorkbook.SetCalcOptions()

SetCalcOptions() メソッドを使用して、反復計算を設定できます。

重要

JS-SDK V1.1.10 以降でのみ、この機能がサポートされています。

構文
expression.ActiveWorkbook.SetCalcOptions()
expression: ドキュメントタイプのアプリケーションオブジェクト。

パラメータ

プロパティ	タイプ	必須	説明
EnableIterate	Boolean	いいえ	反復計算を有効にするかどうかを指定します。有効な値: true false (デフォルト値)
IterateCount	Number	いいえ	最大反復回数。有効な値: 1 ～ 32767。デフォルト値: 100。
IterateDelta	Number	いいえ	最大誤差。値は 0 以上でなければなりません。デフォルト値: 0.001。
FullPrecision	Boolean	いいえ	表示されている精度に基づいて計算を行うかどうかを指定します。有効な値: true false (デフォルト値)
CalcMode	Enum	いいえ	反復計算のモード。詳細については、「XlCalcModeType」をご参照ください。
Callback	Function	いいえ	コールバック関数。

例

async function example() {
  await instance.ready();

  const app = instance.Application;
  
  // 反復計算を設定します。
  await app.ActiveWorkbook.SetCalcOptions({
    EnableIterate: false, 
    IterateCount: 300,
    IterateDelta: 0.1, 
    FullPrecision: false, 
    CalcMode: 'automatic', // 自動計算
    Callback:(res)=>console.error ('Callback 関数',res) // コールバック関数
  })
}

ActiveWorkbook.ClearTransactions()

ClearTransactions() メソッドを使用して、元に戻すレコードをクリアできます。

重要

JS-SDK V1.1.12 以降でのみ、この機能がサポートされています。

構文
expression.ActiveWorkbook.ClearTransactions()
expression: ドキュメントタイプのアプリケーションオブジェクト。

例

async function example() {
  await instance.ready();

  const app = instance.Application;
  
  // 元に戻すレコードをクリアします。
  await app.ActiveWorkbook.ClearTransactions()
}

ActiveWorkbook.HasTransactions()

HasTransactions() メソッドを使用して、元に戻すレコードが存在するかどうかを確認できます。

重要

JS-SDK V1.1.12 以降でのみ、この機能がサポートされています。

構文
expression.ActiveWorkbook.HasTransactions()
expression: ドキュメントタイプのアプリケーションオブジェクト。

例

async function example() {
  await instance.ready();

  const app = instance.Application;
  
  // 元に戻すレコードが存在するかどうかを確認します。
  await app.ActiveWorkbook.HasTransactions()
}

ActiveWorkbook.GetComments()

アクティブなワークブックからすべてのコメントを取得するには、GetComments() メソッドを使用します。

重要

JS-SDK V1.1.12 以降でのみ、この機能がサポートされています。

構文
expression.ActiveWorkbook.GetComments()
expression: ドキュメントタイプのアプリケーションオブジェクト。

戻り値

プロパティ	タイプ	説明
CellComments	Array<Object>	コメント情報のコレクション。
PosInfo	String	セル情報。
SheetName	String	ワークシートの名前。
UserIds	Array<String>	ユーザー ID のコレクション。

コメント情報のコレクションには以下が含まれます

プロパティ	タイプ	説明
DateTime	String	コメントが作成された時刻を示すタイムスタンプ。
Text	String	コメントのテキスト。
Time	String	コメントが作成された時刻。Time の形式は変換されています。
UserId	String	ユーザーの ID。

例

async function example() {
  await instance.ready();

  const app = instance.Application;
  
  // アクティブなワークブックからすべてのコメントを取得します。
  const comments = await app.ActiveWorkbook.GetComments();
  console.log(comments);
}

ActiveWorkbook.SkipAtCell()

SkipAtCell() メソッドを使用すると、アットマーク（@）を含むセルにジャンプできます。

重要

JS-SDK V1.1.12 以降でのみ、この機能がサポートされています。

構文
expression.ActiveWorkbook.SkipAtCell()
expression: ドキュメントタイプのアプリケーションオブジェクト。
パラメータ
プロパティ
タイプ
必須
説明
AtId
String
はい
アットマーク (@) の ID。

例

async function example() {
  await instance.ready();

  const app = instance.Application;
  
  // アットマーク (@) が含まれるセルにジャンプします。
  await app.ActiveWorkbook.SkipAtCell(AtId)
}

ActiveWorkbook.SetWatermark()

SetWatermark() メソッドを使用して、ウォーターマークを追加できます。

構文
expression.ActiveWorkbook.SetWatermark()
expression: ドキュメントタイプのアプリケーションオブジェクト。

パラメータ

プロパティ	タイプ	必須	説明
Type	Number	はい	ウォーターマークを追加するかどうかを指定します。有効な値: 1: はい。 0: いいえ。
Value	String	はい	ウォーターマークのテキスト。
FillStyle	String	はい	塗りつぶしのスタイル。
Font	String	はい	ウォーターマークのフォント。
Rotate	Number	はい	回転角度。
Horizontal	Number	はい	水平方向のページの余白
Vertical	Number	はい	垂直方向のページの余白

例

async function example() {
  await instance.ready();

  const app = instance.Application;

  // ウォーターマークを追加します。
  await app.ActiveWorkbook.SetWatermark({
    Type: 1,
    Value: "テスト ウォーターマーク",
    FillStyle: 'rgba(192, 192, 192, 0.6)',
    Font: "bold 20px Serif",
    Rotate: -45 * Math.PI / 180,
    Horizontal: 50,
    Vertical: 100,
  });
}

ActiveWorkbook.GetWatermark()

GetWatermark() メソッドを使用してウォーターマークを取得できます。

構文
expression.ActiveWorkbook.GetWatermark()
expression: ドキュメントタイプのアプリケーションオブジェクト。

例

async function example() {
  await instance.ready();

  const app = instance.Application;

  // ウォーターマークを取得します。
  await app.ActiveWorkbook.GetWatermark();
}

ActiveWorkbook.BuiltinDocumentProperties()

アクティブなワークブックの組み込みドキュメントプロパティは、BuiltinDocumentProperties() メソッドを使用して取得できます。

構文
expression.ActiveWorkbook.BuiltinDocumentProperties({ Name })
expression: ドキュメントタイプのアプリケーションオブジェクト。
パラメータ
プロパティ
タイプ
必須
説明
Name
String
はい
組み込みドキュメントプロパティ名:
Title
Security
Size
作成者。
CorpId: 企業の ID。
Guid: 安全なドキュメントの ID。

例

async function example() {
  await instance.ready();

  const app = instance.Application;

  // アクティブなワークブックの組み込みドキュメントプロパティを取得します。
  const title = await app.ActiveWorkbook.BuiltinDocumentProperties('Title').Value;
  console.log('title: ', title);
}

ActiveWorkbook.CustomDocumentProperties()

アクティブなブックのカスタムドキュメントプロパティは、CustomDocumentProperties() プロパティを使用して取得できます。

構文
expression.ActiveWorkbook.CustomDocumentProperties({ Name })
expression: ドキュメントタイプのアプリケーションオブジェクト。

例

async function example() {
  await instance.ready();

  const app = instance.Application;

  // アクティブなワークブックのカスタムドキュメントプロパティを取得します。
  const txt = await app.ActiveWorkbook.CustomDocumentProperties('AT_txt').Value;
  console.log('txt: ', txt);
}

プロパティ

ActiveWorkbook.ActiveSheet

ActiveSheet プロパティを使用して、アクティブなブックのアクティブなワークシートを取得します。詳細については、「ActiveSheet」をご参照ください。

重要

この機能は JS-SDK V1.1.10 以降でサポートされています。

構文
expression.ActiveWorkbook.ActiveSheet
expression: ドキュメントタイプのアプリケーションオブジェクトです。

例

async function example() {
  await instance.ready();

  const app = instance.Application;
  
  // アクティブなワークブックを取得します。
  const activeWorkbook = await app.ActiveWorkbook;

  // アクティブなワークシートを取得します。
  const activeSheet = await activeWorkbook.ActiveSheet;
}

ActiveWorkbook.Names

Names プロパティを使用すると、アクティブなブックの名前を表すコレクションを取得できます。

構文
expression.ActiveWorkbook.Names
expression: ドキュメントタイプのアプリケーションオブジェクト。

例

async function example() {
  await instance.ready();

  const app = instance.Application;
  
  // アクティブなワークブックを取得します。
  const activeWorkbook = await app.ActiveWorkbook;

  // ワークブック名のコレクションを取得します。
  const names = await activeWorkbook.Names;
}

ActiveWorkbook.Sheets

アクティブなブック内のすべてのワークシートは、Sheets メソッドを使用して取得できます。

構文
expression.ActiveWorkbook.Sheets
expression: ドキュメントタイプのアプリケーションオブジェクト。

例

async function example() {
  await instance.ready();

  const app = instance.Application;
  
  // すべてのワークシートを取得します。
  const sheets = await app.ActiveWorkbook.Sheets;
}

ActiveWorkbook.ReadOnly

ReadOnly プロパティを使用すると、アクティブなワークブックが読み取り専用かどうかを確認できます。

重要

JS-SDK V1.1.12 以降でのみ、この機能がサポートされています。

構文
expression.ActiveWorkbook.ReadOnly
expression: ドキュメントタイプのアプリケーションオブジェクト。

例

async function example() {
  await instance.ready();

  const app = instance.Application;

  // アクティブなワークブックが読み取り専用かどうかを確認します。
  const ReadOnly = await app.ActiveWorkbook.ReadOnly;
}

ActiveWorkbook.ReadOnlyComment

アクティブなワークシートが読み取り専用でコメント可能かどうかを、ReadOnlyComment プロパティを使用して確認できます。

重要

JS-SDK V1.1.15 以降でのみ、この機能がサポートされています。

構文
expression.ActiveWorkbook.ReadOnlyComment
expression: ドキュメントタイプのアプリケーションオブジェクト。

例

async function example() {
  await instance.ready();

  const app = instance.Application;

  // アクティブなワークブックが読み取り専用でコメント可能かどうかを確認します。
  const ReadOnlyComment = await app.ActiveWorkbook.ReadOnlyComment;
}

ActiveWorkbook.SupportReadOnlyComment

SupportReadOnlyComment プロパティを使用すると、アクティブなワークブックが読み取り専用およびコメント可能モードをサポートしているかどうかを確認できます。このプロパティは読み取り専用のプロパティです。

重要

JS-SDK V1.1.15 以降でのみ、この機能がサポートされています。

構文
expression.ActiveWorkbook.SupportReadOnlyComment
expression: ドキュメントタイプのアプリケーションオブジェクト。

例

async function example() {
  await instance.ready();

  const app = instance.Application;

  // アクティブなワークブックが読み取り専用およびコメント可能モードをサポートしているかどうかを確認します。
  const SupportReadOnlyComment = await app.ActiveWorkbook.SupportReadOnlyComment;
}