クラス: ShapeCollection

Sheets.Shapes.ShapeCollection

Table of contents

コンストラクタ

• constructor

メソッド

• add
• addCameraShape
• addConnector
• addFormControl
• addPictureShape
• all
• clear
• get
• group
• remove
• snapMode
• ungroup
• zIndex

コンストラクタ

constructor

• new ShapeCollection(sheet)

シート上のすべてのシェイプを管理するシェイプマネージャを表します。

パラメータ

名前	型	説明
sheet	Worksheet	ワークシート。

メソッド

add

▸ add(name, autoShapeTypeOrModel, left?, top?, width?, height?): Shape

シェイプコレクションに新しいシェイプを追加します。

実例

// 次のサンプルコードは、新しいシェイプの追加方法を示します。
var shape = activeSheet.shapes.add("shape1", GC.Spread.Sheets.Shapes.AutoShapeType.heart, 100, 50, 100, 150);

パラメータ

名前	型	説明
name	string	シェイプの名前。空白のままにすると、一意の名前が生成されます。
autoShapeTypeOrModel	IShapeModel | AutoShapeType	シェイプのタイプ（組み込みタイプのいずれか）、またはカスタムシェイプのモデル。
left?	number	シェイプのx位置。
top?	number	シェイプのy位置。
width?	number	シェイプの幅。
height?	number	シェイプの高さ。

戻り値

Shape

シートに追加されたシェイプ。

---

addCameraShape

▸ addCameraShape(name, range, left?, top?, width?, height?): CameraShape

シェイプコレクションに新しいカメラシェイプを追加します。

実例

// 次のサンプルコードは、新しいカメラシェイプを追加する方法を示しています。
var shape = activeSheet.shapes.addCameraShape("camera shape 1", 'Sheet1!A1:A8', 100, 50, 100, 150);

パラメータ

名前	型	説明
name	string	カメラシェイプの名前。 空白のままにすると、一意の名前が生成します。
range	string	生成されたシェイプの範囲。 「Sheet1!A1:A8」のような範囲数式である必要があります。
left?	number	-
top?	number	-
width?	number	-
height?	number	-

戻り値

CameraShape

シートに追加されたシェイプ。

---

addConnector

▸ addConnector(name, connectorType, beginX?, beginY?, endX?, endY?): ConnectorShape

シェイプコレクションにコネクターシェイプを追加します。

実例

// 次のサンプルコードは、コネクターシェイプの追加方法を示します。
var shape1 = activeSheet.shapes.addConnector("shape1", GC.Spread.Sheets.Shapes.ConnectorType.elbow, 200, 50, 300, 200);

パラメータ

名前	型	説明
name	string	シェイプの名前。空白のままにすると、一意の名前が生成されます。
connectorType	ConnectorType	コネクターのタイプ。
beginX?	number	コネクターシェイプの始点の<i>x</i>位置。
beginY?	number	コネクターシェイプの始点の<i>y</i>位置。
endX?	number	コネクターシェイプの終点の<i>x</i>位置。
endY?	number	コネクターシェイプの終点の<i>y</i>位置。

戻り値

ConnectorShape

シートに追加されたコネクターシェイプ。

---

addFormControl

▸ addFormControl(name, formControlType, left?, top?, width?, height?): FormControlShape

シェイプコレクションに新しいフォームコントロールシェイプを追加します。

実例

// 次のサンプルコードは、フォームコントロールシェイプの追加方法を示します。
var shape = activeSheet.shapes.addFormControl("spinButton", GC.Spread.Sheets.Shapes.FormControlType.spinButton, 100, 50, 100, 50);

パラメータ

名前	型	説明
name	string	シェイプの名前。空白のままにすると、一意の名前が生成されます。
formControlType	FormControlType	フォームコントロールシェイプの種類。
left?	number	フォームコントロールシェイプのx位置。
top?	number	フォームコントロールシェイプのy位置。
width?	number	フォームコントロールシェイプの幅。
height?	number	フォームコントロールシェイプの高さ。

戻り値

FormControlShape

シートに追加されたフォームコントロールシェイプ。

---

addPictureShape

▸ addPictureShape(name, src, left?, top?, width?, height?): PictureShape

シェイプコレクションに新しいピクチャシェイプを追加します。

実例

// 次のサンプルコードは、新しいピクチャシェイプを追加する方法を示しています。
var shape = activeSheet.shapes.addPictureShape("Picture 1", "data:image/svg+xml;base64.....", 100, 50, 100, 100);

パラメータ

名前	型	説明
name	string	シェイプの名前。空白のままにすると、一意の名前が生成されます。
src	string	ピクチャのソース。
left?	number	ピクチャシェイプのx位置。
top?	number	ピクチャシェイプのy位置。
width?	number	ピクチャシェイプの幅。
height?	number	ピクチャシェイプの高さ。

戻り値

PictureShape

シートに追加されたピクチャシェイプ。

---

all

▸ all(): Shape[]

すべてのシェイプを取得します。

実例

// 次のサンプルコードは、シェイプコレクションに含まれるすべてのシェイプを取得する方法を示します。
activeSheet.shapes.add("shape1", GC.Spread.Sheets.Shapes.AutoShapeType.heart, 100, 50, 100, 150);
activeSheet.shapes.addConnector("shape2", GC.Spread.Sheets.Shapes.ConnectorType.elbow, 200, 50, 300, 200);
var shapes = activeSheet.shapes.all();

戻り値

Shape[]

すべてのシェイプ

---

clear

▸ clear(): void

すべてのシェイプをクリアします。

実例

//次のサンプルコードは、シェイプコレクションに含まれるすべてのシェイプをクリアする方法を示します。
activeSheet.shapes.add("shape1", GC.Spread.Sheets.Shapes.AutoShapeType.heart, 100, 50, 100, 150);
activeSheet.shapes.addConnector("shape2", GC.Spread.Sheets.Shapes.ConnectorType.elbow, 200, 50, 300, 200);
activeSheet.shapes.clear();

戻り値

void

---

get

▸ get(name): Shape

名前によってシェイプを取得します。

実例

// 次のサンプルコードは、名前によってシェイプを取得する方法を示します。
activeSheet.shapes.add("shape1", GC.Spread.Sheets.Shapes.AutoShapeType.heart, 100, 50, 100, 150);
activeSheet.shapes.get("shape1");

パラメータ

名前	型	説明
name	string	シェイプの名前。

戻り値

Shape

Shape

---

group

▸ group(shapes): GroupShape

シェイプをグループ化します。

実例

// このサンプルはいくつかの図形をグループ化する方法を示します。
var shape1 = activeSheet.shapes.add("shape1", GC.Spread.Sheets.Shapes.AutoShapeType.heart, 100, 50, 100, 150);
var shape2 = activeSheet.shapes.addConnector("shape2", GC.Spread.Sheets.Shapes.ConnectorType.elbow, 200, 50, 300, 200);
var shapes = [shape1, shape2];
var groupShape = activeSheet.shapes.group(shapes)

パラメータ

名前	型	説明
shapes	Shape[]	グループ化するシェイプ。

戻り値

GroupShape

シェイプグループ。

---

remove

▸ remove(name): void

シェイプを削除します。

実例

// 次のサンプルコードは、シェイプの削除方法を示します。
activeSheet.shapes.add("shape1", GC.Spread.Sheets.Shapes.AutoShapeType.heart, 100, 50, 100, 150);
activeSheet.shapes.remove("shape1");

パラメータ

名前	型	説明
name	string	シェイプの名前。

戻り値

void

---

snapMode

▸ snapMode(value?): void | SnapMode

シェイプをグリッド線または他のシェイプに位置合わせするかどうかを取得または設定します。

実例

sheet1.shapes.SnapMode(GC.Spread.Sheets.Shapes.SnapMode.grid);
var snapMode = sheet1.shapes.snapMode();

パラメータ

名前	型	説明
value?	SnapMode	シェイプをグリッド線または他のシェイプにスナップするかどうか。

戻り値

void | SnapMode

値が設定されていない場合は、どのsnapModeを使用するかを返します。

---

ungroup

▸ ungroup(groupShape): void

groupShapeのグループ化を解除します。

実例

// 次のサンプルコードは、groupShapeのグループ化を解除する方法を示します。
var shape1 = activeSheet.shapes.add("shape1", GC.Spread.Sheets.Shapes.AutoShapeType.heart, 100, 50, 100, 150);
var shape2 = activeSheet.shapes.addConnector("shape2", GC.Spread.Sheets.Shapes.ConnectorType.elbow, 200, 50, 300, 200);
var shapes = [shape1, shape2];
var groupShape = activeSheet.shapes.group(shapes);
activeSheet.shapes.ungroup(groupShape);

パラメータ

名前	型	説明
groupShape	GroupShape	グループ化を解除するgroupShape。

戻り値

void

---

zIndex

▸ zIndex(shapeName, zIndex): number

シェイプのZインデックス値を設定または参照します。

実例

// これは、Zインデックスの使用方法を示すサンプルです。
var shape1 = activeSheet.shapes.add("shape1", GC.Spread.Sheets.Shapes.AutoShapeType.heart, 100, 50, 100, 150);
var style = shape1.style();
style.fill.color = "red";
shape1.style(style);
var shape2 = activeSheet.shapes.addConnector("shape2", GC.Spread.Sheets.Shapes.ConnectorType.elbow, 100, 50, 200, 200);
activeSheet.shapes.zIndex("shape2"); // 1
activeSheet.shapes.zIndex("shape2", 0);

パラメータ

名前	型	説明
shapeName	string	シェイプの名前。
zIndex	number	シェイプのZインデックス。 Zインデックスの値は、0～シェイプ数-1までの間でなければなりません。Zインデックス値が大きいシェイプは、Zインデックス値が小さいシェイプの前面に表示されます。

戻り値

number