このトピックでは、スプレッドシートドキュメントの図形オブジェクトに関連するAPI操作について説明します。
図形
ActiveWorkbook.ActiveSheet.Shapes
アクティブなワークシート内のすべての図形オブジェクトを取得します。
構文
expression.ActiveWorkbook.ActiveSheet.Shapesexpression: アプリケーションオブジェクト。
例
async function example() { await instance.ready(); const app = instance.Application; // アクティブなブックのアクティブなワークシートを取得します。 const activeSheet = await app.ActiveWorkbook.ActiveSheet; // アクティブなワークシート内のすべての図形オブジェクトを取得します。 const shapes = await activeSheet.Shapes; }
メソッド
ActiveWorkbook.ActiveSheet.Shapes.AddChart2()
グラフを追加します。
構文
expression.ActiveWorkbook.ActiveSheet.Shapes.AddChart2({ Style, XlChartType, Left, Top, Width, Height })expression: アプリケーションオブジェクト。
パラメーター
パラメーター
タイプ
必須
説明
Style
String
いいえ
グラフのスタイル。
XlChartType
Enum
いいえ
グラフのタイプ。
Left
Number
いいえ
グラフの左端の位置。単位:ピクセル。
Top
Number
いいえ
グラフの上端の位置。単位:ピクセル。
Width
Number
いいえ
グラフの幅。単位:ピクセル。
Height
Number
いいえ
グラフの高さ。単位:ピクセル。
例
async function example() { await instance.ready(); const app = instance.Application; // アクティブなブックのアクティブなワークシートを取得します。 const activeSheet = await app.ActiveWorkbook.ActiveSheet; // アクティブなワークシート内のすべての図形オブジェクトを取得します。 const shapes = await activeSheet.Shapes; // 集計縦棒グラフを追加します。 await shapes.AddChart2(340, 51, 0, 0, 300, 300); }
ActiveWorkbook.ActiveSheet.Shapes.AddPicture()
画像を追加します。
JavaScript V1.1.19 以降の SDK のみでこのメソッドがサポートされています。
構文
expression.ActiveWorkbook.ActiveSheet.Shapes.AddPicture({ FileName, LinkToFile, SaveWithDocument, Left, Top, Width, Height, Scale })expression: アプリケーションオブジェクト。
パラメーター
パラメーター
タイプ
必須
説明
FileName
String
はい
画像の作成元となるファイル。値はURLまたはBase64エンコードされた文字列である必要があります。
LinkToFile
Enum
はい
画像を、画像の作成元ファイルにリンクするかどうかを指定します。FileNameパラメーターの値がURLの場合は、このパラメーターを-1に設定します。
SaveWithDocument
Enum
はい
画像をドキュメントと一緒に保存するかどうかを指定します。 LinkToFileがmsoFalseに設定されている場合、このパラメーターはmsoTrueに設定する必要があります。
Left
Number
いいえ
ワークシートの左端を基準とした画像の左端の位置。単位:ピクセル。
Top
Number
いいえ
ワークシートの上端を基準とした画像の上端の位置。単位:ピクセル。
Width
Number
いいえ
画像の幅。単位:ピクセル。
Height
Number
いいえ
画像の高さ。単位:ピクセル。
Scale
Boolean
いいえ
ワークシートのスケールに基づいて画像の幅と高さの座標を計算するかどうかを指定します。
例
async function example() { await instance.ready(); const app = instance.Application; // アクティブなブックのアクティブなワークシートを取得します。 const activeSheet = await app.ActiveWorkbook.ActiveSheet; // 現在のワークシートのすべての図形オブジェクトを取得します。 const shapes = await activeSheet.Shapes; // 画像を追加します。 await shapes.AddPicture('Image URL', -1, 0); }
ActiveWorkbook.ActiveSheet.Shapes.Item(Index)
描画レイヤー内の単一のオブジェクト(オートシェイプ、フリーフォーム、OLEオブジェクト、画像など)を取得します。
JavaScript V1.1.4 以降の SDK のみでこのメソッドがサポートされています。
構文
expression.ActiveWorkbook.ActiveSheet.Shapes.Item(Index)expression: アプリケーションオブジェクト。
パラメーター
パラメーター
タイプ
必須
説明
Index
numberはい
図形のインデックス番号。
例
async function example() { await instance.ready(); const app = instance.Application; // アクティブなブックのアクティブなワークシートを取得します。 const activeSheet = await app.ActiveWorkbook.ActiveSheet; // 現在のワークシートのすべての図形オブジェクトを取得します。 const shapes = await activeSheet.Shapes; // 最初の図形を取得します。 const shape = await shapes.Item(1) }
プロパティ
ActiveWorkbook.ActiveSheet.Shapes.Count
アクティブなワークシート内の図形オブジェクトの数を返します。
構文
expression.ActiveWorkbook.ActiveSheet.Shapes.Countexpression: アプリケーションオブジェクト。
例
async function example() { await instance.ready(); const app = instance.Application; // アクティブなブックのアクティブなワークシートを取得します。 const activeSheet = await app.ActiveWorkbook.ActiveSheet; // アクティブなワークシート内のすべての図形オブジェクトを取得します。 const shapes = await activeSheet.Shapes; // アクティブなワークシート内の図形の数をクエリします。 const count = await shapes.Count; console.log(count); }
図形
ActiveWorkbook.ActiveSheet.Shapes.Item(Index)
単一の図形オブジェクトを取得します。
構文
expression.ActiveWorkbook.ActiveSheet.Shapes.Item(Index)expression: アプリケーションオブジェクト。
例
async function example() { await instance.ready(); const app = instance.Application; // アクティブなブックのアクティブなワークシートを取得します。 const activeSheet = await app.ActiveWorkbook.ActiveSheet; // アクティブなワークシート内のすべての図形オブジェクトを取得します。 const shapes = await activeSheet.Shapes; // 集計縦棒グラフを追加します。 await shapes.AddChart2(340, 51, 0, 0, 300, 300); // アクティブなワークシート内のすべての図形オブジェクトを取得します。 const newShapes = await activeSheet.Shapes; // 単一の図形オブジェクトを取得します。 const shape = await newShapes.Item(1); }
メソッド
ActiveWorkbook.ActiveSheet.Shapes.Item(Index).Delete()
図形オブジェクトを削除します。
構文
expression.ActiveWorkbook.ActiveSheet.Shapes.Item(Index).Delete()expression: アプリケーションオブジェクト。
例
async function example() { await instance.ready(); const app = instance.Application; // アクティブなブックのアクティブなワークシートを取得します。 const activeSheet = await app.ActiveWorkbook.ActiveSheet; // アクティブなワークシート内のすべての図形オブジェクトを取得します。 const shapes = await activeSheet.Shapes; // 集計縦棒グラフを追加します。 await shapes.AddChart2(340, 51, 0, 0, 300, 300); // 図形のデータソースを取得します。 const source = await activeSheet.Range('A1:B4'); // 図形のデータソースを設定します。 await shape.Chart.SetSourceData(source, 1); // 3,000ミリ秒後に図形を削除します。 setTimeout(async () => { await shape.Delete(); }, 3000); }
ActiveWorkbook.ActiveSheet.Shapes.Item(Index).Select()
図形オブジェクトを選択します。
構文
expression.ActiveWorkbook.ActiveSheet.Shapes.Item(Index).Select()expression: アプリケーションオブジェクト。
例
async function example() { await instance.ready(); const app = instance.Application; // アクティブなブックのアクティブなワークシートを取得します。 const activeSheet = await app.ActiveWorkbook.ActiveSheet; // activeSheet = await app.ActiveSheet; を使用することもできます。 // アクティブなワークシート内のすべての図形オブジェクトを取得します。 const shapes = await activeSheet.Shapes; // グラフを追加します。 const shape = await shapes.AddChart2(340, 51, 0, 0, 300, 300); // 図形のデータソースを取得します。 const source = await activeSheet.Range('A1:B4'); // 図形のデータソースを設定します。 await shape.Chart.SetSourceData(source, 1); // 単一の図形を選択します。 setTimeout(async () => { await shape.Select(); }, 3000); }
ActiveWorkbook.ActiveSheet.Shapes.Item(Index).SelectedModel()
図形を選択します。
構文
expression.ActiveWorkbook.ActiveSheet.Shapes.Item(Index).SelectedModel()expression: アプリケーションオブジェクト。
例
async function example() { await instance.ready(); const app = instance.Application; // アクティブなブックのアクティブなワークシートを取得します。 const activeSheet = await app.ActiveWorkbook.ActiveSheet; // activeSheet = await app.ActiveSheet; を使用することもできます。 // アクティブなワークシート内のすべての図形オブジェクトを取得します。 const shapes = await activeSheet.Shapes; // グラフを追加します。 const shape = await shapes.AddChart2(340, 51, 0, 0, 300, 300); await shape.SelectedModel(); }
ActiveWorkbook.ActiveSheet.Shapes.Item(Index).SelectedModels()
コレクションを選択します。
構文
expression.ActiveWorkbook.ActiveSheet.Shapes.Item(Index).SelectedModels()expression: アプリケーションオブジェクト。
例
async function example() { await instance.ready(); const app = instance.Application; // アクティブなブックのアクティブなワークシートを取得します。 const activeSheet = await app.ActiveWorkbook.ActiveSheet; // activeSheet = await app.ActiveSheet; を使用することもできます。 // アクティブなワークシート内のすべての図形オブジェクトを取得します。 const shapes = await activeSheet.Shapes; // グラフを追加します。 const shape = await shapes.AddChart2(340, 51, 0, 0, 300, 300); await shape.SelectedModels(); }
プロパティ
ActiveWorkbook.ActiveSheet.Shapes.Item(Index).ID
特定の図形のIDを返します。
構文
expression.ActiveWorkbook.ActiveSheet.Shapes.Item(Index).IDexpression: アプリケーションオブジェクト。
例
async function example() { await instance.ready(); const app = instance.Application; // アクティブなブックのアクティブなワークシートを取得します。 const activeSheet = await app.ActiveWorkbook.ActiveSheet; // アクティブなワークシート内のすべての図形オブジェクトを取得します。 const shapes = await activeSheet.Shapes; // 集計縦棒グラフを追加します。 await shapes.AddChart2(340, 51, 0, 0, 300, 300); // 図形のIDを取得します。 const id = await shape.ID; console.log(id);
ActiveWorkbook.ActiveSheet.Shapes.Item(Index).Name
特定の図形オブジェクトの名前を返します。
構文
expression.ActiveWorkbook.ActiveSheet.Shapes.Item(Index).Nameexpression: アプリケーションオブジェクト。
例
async function example() { await instance.ready(); const app = instance.Application; // アクティブなブックのアクティブなワークシートを取得します。 const activeSheet = await app.ActiveWorkbook.ActiveSheet; // アクティブなワークシート内のすべての図形オブジェクトを取得します。 const shapes = await activeSheet.Shapes; // 集計縦棒グラフを追加します。 await shapes.AddChart2(340, 51, 0, 0, 300, 300); // 図形の名前を取得します。 const name = await shape.Name; console.log(name);
ActiveWorkbook.ActiveSheet.Shapes.Item(Index).Title
図形オブジェクトのタイトルを設定します。
構文
expression.ActiveWorkbook.ActiveSheet.Shapes.Item(Index).Titleexpression: アプリケーションオブジェクト。
例
async function example() { await instance.ready(); const app = instance.Application; // アクティブなブックのアクティブなワークシートを取得します。 const activeSheet = await app.ActiveWorkbook.ActiveSheet; // アクティブなワークシート内のすべての図形オブジェクトを取得します。 const shapes = await activeSheet.Shapes; // 集計縦棒グラフを追加します。 await shapes.AddChart2(340, 51, 0, 0, 300, 300); // 図形のタイトルを指定します。 shape.Title = 'Aliyun';
ActiveWorkbook.ActiveSheet.Shapes.Item(Index).Chart
特定のグラフを返します。
構文
expression.ActiveWorkbook.ActiveSheet.Shapes.Item(Index).Chartexpression: アプリケーションオブジェクト。
例
async function example() { await instance.ready(); const app = instance.Application; // アクティブなブックのアクティブなワークシートを取得します。 const activeSheet = await app.ActiveWorkbook.ActiveSheet; // アクティブなワークシート内のすべての図形オブジェクトを取得します。 const shapes = await activeSheet.Shapes; // 集計縦棒グラフを追加します。 await shapes.AddChart2(340, 51, 0, 0, 300, 300); // グラフオブジェクトを取得します。 const chart = await shape.Chart;
ActiveWorkbook.ActiveSheet.Shapes.Item(Index).ImageUrl
特定の図形オブジェクトの画像へのダウンロードリンクを返します。
JS-SDK V1.1.15 以降でのみ、このメソッドがサポートされています。
構文
expression.ActiveWorkbook.ActiveSheet.Shapes.Item(Index).ImageUrlexpression: アプリケーションオブジェクト。
例
async function example() { await instance.ready(); const app = instance.Application; // アクティブなブックのアクティブなワークシートを取得します。 const activeSheet = await app.ActiveWorkbook.ActiveSheet; // アクティブなワークシート内のすべての図形オブジェクトを取得します。 const shapes = await activeSheet.Shapes; // 集計縦棒グラフを追加します。 await shapes.AddChart2(340, 51, 0, 0, 300, 300); // 画像へのダウンロードリンクを取得します。 const ImageUrl = await shape.ImageUrl;