GC.Spread.Sheets.Shapes.GroupShape

クラス: GroupShape

Sheets.Shapes.GroupShape

Hierarchy

ShapeBase

↳ GroupShape

コンストラクタ

constructor

メソッド

コンストラクタ

constructor

• new GroupShape(worksheet, name?)

groupShapeを表します。

パラメータ

名前	型	説明
`worksheet`	`Worksheet`	groupShapeのホストシート。
`name?`	`string`	-

Overrides

ShapeBase.constructor

メソッド

add

▸ add(value?): void

groupShapeにシェイプを追加します。

パラメータ

名前	型
`value?`	`Shape`

戻り値

void

all

▸ all(): Shape[]

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

実例

// 次のサンプルコードは、グループシェイプに含まれるすべてのシェイプを取得する方法を示します。
var shape1 = sheet.shapes.add("myShape1", GC.Spread.Sheets.Shapes.AutoShapeType.rectangle, 62 * 9, 0, 200, 200);
var shape2 = sheet.shapes.add("myShape2", GC.Spread.Sheets.Shapes.AutoShapeType.rectangle, 20, 20, 200, 200);
var groupShape = sheet.shapes.group([shape1, shape2]);
var shapes = groupShape.all();

戻り値

Shape[]

すべてのシェイプ

allowMove

▸ allowMove(value?): any

シェイプの移動を無効にするかどうかを取得または設定します。

実例

var heart = sheet.shapes.add("Shape1", GC.Spread.Sheets.Shapes.AutoShapeType.heart, 100, 60, 200, 160);
var state = heart.allowMove();
heart.allowMove(!state);

パラメータ

名前	型	説明
`value?`	`boolean`	シェイプの移動を無効にするかどうかの設定。

戻り値

any

値が設定されていない場合、シェイプの移動を無効にするかどうかの設定を返します。

Inherited from

ShapeBase.allowMove

allowResize

▸ allowResize(value?): any

シェイプのサイズ変更モードを取得または設定します。

実例

var heart = sheet.shapes.add("Shape1", GC.Spread.Sheets.Shapes.AutoShapeType.heart, 100, 60, 200, 160);
var state = heart.allowResize();
heart.allowResize(GC.Spread.Sheets.Shapes.ResizeMode.aspect);

パラメータ

名前	型	説明
`value?`	`boolean` \| `ResizeMode`	シェイプのサイズ変更を無効にするかどうかの設定。

戻り値

any

値が設定されていない場合、シェイプのサイズ変更を無効にするかどうかの設定を返します。

Inherited from

ShapeBase.allowResize

allowRotate

▸ allowRotate(value?): any

シェイプの回転を無効にするかどうかを取得または設定します。

実例

var heart = sheet.shapes.add("Shape1", GC.Spread.Sheets.Shapes.AutoShapeType.heart, 100, 60, 200, 160);
var state = heart.allowRotate();
heart.allowRotate(!state);

パラメータ

名前	型	説明
`value?`	`boolean`	シェイプの回転を無効にするかどうかの設定。

戻り値

any

値が設定されていない場合、シェイプの回転を無効にするかどうかの設定を返します。

Inherited from

ShapeBase.allowRotate

alt

▸ alt(value?): string | void

スクリーンリーダーのシェイプの代替テキストを取得または設定します。

パラメータ

名前	型	説明
`value?`	`string`	シェイプの代替テキスト。

戻り値

string | void

シェイプの代替テキスト。

Inherited from

ShapeBase.alt

canPrint

▸ canPrint(value?): any

このシェイプが印刷可能かどうかを取得または設定します。

実例

var heart = sheet.shapes.add("Shape1", GC.Spread.Sheets.Shapes.AutoShapeType.heart, 100, 60, 200, 160);
var state = heart.canPrint();
heart.canPrint(!state);

パラメータ

名前	型	説明
`value?`	`boolean`	このシェイプが印刷可能かどうかを示す値。

戻り値

any

値が設定されていない場合、このシェイプが印刷可能かどうかを返します。

Inherited from

ShapeBase.canPrint

dynamicMove

▸ dynamicMove(value?): any

行または列を表示/非表示にするとき、サイズ変更するとき、または移動するときにシェイプが移動するかどうかを取得または設定します。

実例

var heart = sheet.shapes.add("Shape1", GC.Spread.Sheets.Shapes.AutoShapeType.heart, 100, 60, 200, 160);
var state = heart.dynamicMove();
heart.dynamicMove(!state);

パラメータ

名前	型	説明
`value?`	`boolean`	行または列を表示/非表示にするとき、サイズ変更するとき、または移動するときにシェイプが移動するかどうかを示す値。

戻り値

any

値が設定されていない場合、このシェイプが動的に移動するかどうかを返します。

Inherited from

ShapeBase.dynamicMove

dynamicSize

▸ dynamicSize(value?): any

行または列を表示/非表示にするとき、サイズ変更するとき、または移動するときにシェイプのサイズが変更されるかどうかを取得または設定します。

実例

var heart = sheet.shapes.add("Shape1", GC.Spread.Sheets.Shapes.AutoShapeType.heart, 100, 60, 200, 160);
var state = heart.dynamicSize();
heart.dynamicSize(!state);

パラメータ

名前	型	説明
`value?`	`boolean`	行または列を表示/非表示にするとき、サイズ変更するとき、または移動するときにシェイプのサイズが変更されるかどうかを示す値。

戻り値

any

値が設定されていない場合、このシェイプのサイズが動的に変更されるかどうかを返します。

Inherited from

ShapeBase.dynamicSize

endColumn

▸ endColumn(value?): any

シェイプの位置の終了列インデックスを取得または設定します。

実例

var heart = sheet.shapes.add("Shape1", GC.Spread.Sheets.Shapes.AutoShapeType.heart, 100, 60, 200, 160);
var n = heart.endColumn();
heart.endColumn(n + 1);

パラメータ

名前	型	説明
`value?`	`number`	シェイプの位置の終了列インデックス。

戻り値

any

値が設定されていない場合、シェイプの位置の終了列インデックスを返します。

Inherited from

ShapeBase.endColumn

endColumnOffset

▸ endColumnOffset(value?): any

シェイプの終了列に対するオフセットを取得または設定します。

実例

var heart = sheet.shapes.add("Shape1", GC.Spread.Sheets.Shapes.AutoShapeType.heart, 100, 60, 200, 160);
var n = heart.endColumnOffset();
heart.endColumnOffset(0);

パラメータ

名前	型	説明
`value?`	`number`	シェイプの終了列に対するオフセット。

戻り値

any

値が設定されていない場合、シェイプの終了列に対するオフセットを返します。

Inherited from

ShapeBase.endColumnOffset

endRow

▸ endRow(value?): any

シェイプの位置の終了行インデックスを取得または設定します。

実例

var heart = sheet.shapes.add("Shape1", GC.Spread.Sheets.Shapes.AutoShapeType.heart, 100, 60, 200, 160);
var n = heart.endRow();
heart.endRow(n + 2);

パラメータ

名前	型	説明
`value?`	`number`	シェイプの位置の終了行インデックス。

戻り値

any

値が設定されていない場合、シェイプの位置の終了行インデックスを返します。

Inherited from

ShapeBase.endRow

endRowOffset

▸ endRowOffset(value?): any

シェイプの終了行に対するオフセットを取得または設定します。

実例

var heart = sheet.shapes.add("Shape1", GC.Spread.Sheets.Shapes.AutoShapeType.heart, 100, 60, 200, 160);
var n = heart.endRowOffset();
heart.endRowOffset(0);

パラメータ

名前	型	説明
`value?`	`number`	シェイプの終了行に対するオフセット。

戻り値

any

値が設定されていない場合、シェイプの終了行に対するオフセットを返します。

Inherited from

ShapeBase.endRowOffset

find

▸ find(name?): Shape

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

パラメータ

名前	型	説明
`name?`	`string`	groupShapeに含まれるシェイプの名前。

戻り値

Shape

指定した名前がグループシェイプ内のいずれかのシェイプと一致する場合はそのShapeインスタンス。それ以外の場合は<c>null</c>。

getFormula

▸ getFormula(path): string

パスによってシェイプから数式の文字列を取得します。

実例

sheet.name("Sheet1");
sheet.setValue(0, 1, 30);
var shape1 = sheet.shapes.add("myShape1", GC.Spread.Sheets.Shapes.AutoShapeType.rectangle, 62 * 9, 0, 200, 200);
var shape2 = sheet.shapes.add("myShape2", GC.Spread.Sheets.Shapes.AutoShapeType.rectangle, 20, 20, 200, 200);
var shape = sheet.shapes.group([shape1, shape2]);
shape.setFormula("rotate", "=Sheet1!B1");
shape.getFormula("rotate");//returns "=Sheet1!B1"

パラメータ

名前	型	説明
`path`	`string`	数式の文字列を受け入れることができるパス。「x」、「y」、「width」、「height」、「rotate」のいずれかに設定できます。

戻り値

string

パスによってシェイプから数式の文字列を返します。

Overrides

ShapeBase.getFormula

height

▸ height(value?): any

シェイプの高さを取得または設定します。

実例

var heart = sheet.shapes.add("Shape1", GC.Spread.Sheets.Shapes.AutoShapeType.heart, 100, 60, 200, 160);
var n = heart.height();
heart.height(n + 50);

パラメータ

名前	型	説明
`value?`	`string` \| `number`	数値によって指定されたシェイプの高さ、または数値を取得できる数式（=で始まる）。

戻り値

any

値が設定されていない場合、シェイプの高さを返します。

Inherited from

ShapeBase.height

hyperlink

▸ hyperlink(value?): void | IHyperlink

シェイプのハイパーリンクを取得または設定します。

実例

var shape = sheet.shapes.add("myShape", GC.Spread.Sheets.Shapes.AutoShapeType.rectangle, 62 * 9, 0, 200, 200);
shape.hyperlink({url: "http://www.grapecity.com", target: 0, tooltip: 'goes to grapecity'});

パラメータ

名前	型
`value?`	`IHyperlink`

戻り値

void | IHyperlink

値が設定されていない場合は、シェイプの現在のハイパーリンク設定を返します。

Inherited from

ShapeBase.hyperlink

isLocked

▸ isLocked(value?): any

このシェイプがロックされているかどうかを取得または設定します。

実例

var heart = sheet.shapes.add("Shape1", GC.Spread.Sheets.Shapes.AutoShapeType.heart, 100, 60, 200, 160);
var state = heart.isLocked();
heart.isLocked(!state);

パラメータ

名前	型	説明
`value?`	`boolean`	このシェイプがロックされているかどうかを示す値。

戻り値

any

値が設定されていない場合、このシェイプがロックされているかどうかを返します。

Inherited from

ShapeBase.isLocked

isSelected

▸ isSelected(value?): any

このシェイプが選択されているかどうかを取得または設定します。

実例

var heart = sheet.shapes.add("Shape1", GC.Spread.Sheets.Shapes.AutoShapeType.heart, 100, 60, 200, 160);
var state = heart.isSelected();
heart.isSelected(!state);

パラメータ

名前	型	説明
`value?`	`boolean`	このシェイプが選択されているかどうかを示す値。

戻り値

any

値が設定されていない場合、このシェイプが選択されているかどうかを返します。

Inherited from

ShapeBase.isSelected

isVisible

▸ isVisible(value?): any

このシェイプが表示されるかどうかを取得または設定します。

実例

var heart = sheet.shapes.add("Shape1", GC.Spread.Sheets.Shapes.AutoShapeType.heart, 100, 60, 200, 160);
var state = heart.isVisible();
heart.isVisible(!state);

パラメータ

名前	型	説明
`value?`	`boolean`	このシェイプが表示されるかどうかを示す値。

戻り値

any

値が設定されていない場合、このシェイプが表示されるかどうかを返します。

Inherited from

ShapeBase.isVisible

name

▸ name(value?): any

シェイプの名前を取得または設定します。

実例

var shape1 = sheet.shapes.add("myShape1", GC.Spread.Sheets.Shapes.AutoShapeType.rectangle, 62 * 9, 0, 200, 200);
var shape2 = sheet.shapes.add("myShape2", GC.Spread.Sheets.Shapes.AutoShapeType.rectangle, 20, 20, 200, 200);
var shape = sheet.shapes.group([shape1, shape2]);
shape.name("myGroupShape");
var shapeName = shape.name();

パラメータ

名前	型	説明
`value?`	`string`	シェイプの名前。

戻り値

any

値が設定されていない場合、シェイプの名前を返します。

Inherited from

ShapeBase.name

remove

▸ remove(value?): void

groupShapeからシェイプを削除します。

パラメータ

名前	型
`value?`	`Shape`

戻り値

void

rotate

▸ rotate(value?): number | void

groupShapeの回転角度を取得または設定します。

実例

var shape1 = sheet.shapes.add("myShape1", GC.Spread.Sheets.Shapes.AutoShapeType.rectangle, 62 * 9, 0, 200, 200);
var shape2 = sheet.shapes.add("myShape2", GC.Spread.Sheets.Shapes.AutoShapeType.rectangle, 20, 20, 200, 200);
var shape = sheet.shapes.group([shape1, shape2]);
shape.rotate(60);
var angle = shape.rotate();

パラメータ

名前	型	説明
`value?`	`string` \| `number`	groupShapeの回転角度。単位は度です。

戻り値

number | void

パラメーター'value'がnullまたはundefinedの場合は、groupShapeの回転角度が返されます。

setFormula

▸ setFormula(path, formula): void

パスによってシェイプに数式の文字列を設定します。

実例

sheet.name("Sheet1");
sheet.setValue(0, 1, 30);
var shape1 = sheet.shapes.add("myShape1", GC.Spread.Sheets.Shapes.AutoShapeType.rectangle, 62 * 9, 0, 200, 200);
var shape2 = sheet.shapes.add("myShape2", GC.Spread.Sheets.Shapes.AutoShapeType.rectangle, 20, 20, 200, 200);
var shape = sheet.shapes.group([shape1, shape2]);
shape.setFormula("rotate", "=Sheet1!B1");

パラメータ

名前	型	説明
`path`	`string`	数式の文字列を受け入れることができるパス。「x」、「y」、「width」、「height」、「rotate」のいずれかに設定できます。
`formula`	`string`	数式文字列。

戻り値

void

Overrides

ShapeBase.setFormula

showHandle

▸ showHandle(value?): boolean | void

シェイプのハンドルを表示するかどうかを取得または設定します。

実例

var heart = sheet.shapes.add("Shape1", GC.Spread.Sheets.Shapes.AutoShapeType.heart, 100, 60, 200, 160);
var state = heart.showHandle();
heart.showHandle(!state);

パラメータ

名前	型	説明
`value?`	`boolean`	シェイプのハンドルを表示するかどうかの設定。

戻り値

boolean | void

値が設定されていない場合、シェイプのハンドルを表示するかどうかの設定を返します。

Inherited from

ShapeBase.showHandle

startColumn

▸ startColumn(value?): any

シェイプの位置の開始列インデックスを取得または設定します。

実例

var heart = sheet.shapes.add("Shape1", GC.Spread.Sheets.Shapes.AutoShapeType.heart, 100, 60, 200, 160);
var n = heart.startColumn();
heart.startColumn(n + 2);

パラメータ

名前	型	説明
`value?`	`number`	シェイプの位置の開始列インデックス。

戻り値

any

値が設定されていない場合、シェイプの位置の開始列インデックスを返します。

Inherited from

ShapeBase.startColumn

startColumnOffset

▸ startColumnOffset(value?): any

シェイプの開始列に対するオフセットを取得または設定します。

実例

var heart = sheet.shapes.add("Shape1", GC.Spread.Sheets.Shapes.AutoShapeType.heart, 100, 60, 200, 160);
var n = heart.startColumnOffset();
heart.startColumnOffset(0);

パラメータ

名前	型	説明
`value?`	`number`	シェイプの開始列に対するオフセット。

戻り値

any

値が設定されていない場合、シェイプの開始列に対するオフセットを返します。

Inherited from

ShapeBase.startColumnOffset

startRow

▸ startRow(value?): any

シェイプの位置の開始行インデックスを取得または設定します。

実例

var heart = sheet.shapes.add("Shape1", GC.Spread.Sheets.Shapes.AutoShapeType.heart, 100, 60, 200, 160);
var n = heart.startRow();
heart.startRow(n + 2);

パラメータ

名前	型	説明
`value?`	`number`	シェイプの位置の開始行インデックス。

戻り値

any

値が設定されていない場合、シェイプの位置の開始行インデックスを返します。

Inherited from

ShapeBase.startRow

startRowOffset

▸ startRowOffset(value?): any

シェイプの開始行に対するオフセットを取得または設定します。

実例

var heart = sheet.shapes.add("Shape1", GC.Spread.Sheets.Shapes.AutoShapeType.heart, 100, 60, 200, 160);
var n = heart.startRowOffset();
heart.startRowOffset(0);

パラメータ

名前	型	説明
`value?`	`number`	シェイプの開始行に対するオフセット。

戻り値

any

値が設定されていない場合、シェイプの開始行に対するオフセットを返します。

Inherited from

ShapeBase.startRowOffset

width

▸ width(value?): any

シェイプの幅を取得または設定します。

実例

var heart = sheet.shapes.add("Shape1", GC.Spread.Sheets.Shapes.AutoShapeType.heart, 100, 60, 200, 160);
var n = heart.width();
heart.width(n + 50);

パラメータ

名前	型	説明
`value?`	`string` \| `number`	数値によって指定されたシェイプの幅、または数値を取得できる数式（=で始まる）。

戻り値

any

値が設定されていない場合、シェイプの幅を返します。

Inherited from

ShapeBase.width

x

▸ x(value?): number | void

シェイプの水平位置を取得または設定します。

実例

var heart = sheet.shapes.add("Shape1", GC.Spread.Sheets.Shapes.AutoShapeType.heart, 100, 60, 200, 160);
var n = heart.x();
heart.x(n + 50);

パラメータ

名前	型	説明
`value?`	`string` \| `number`	数値によって指定されたシェイプの水平位置、または数値を取得できる数式（=で始まる）。

戻り値

number | void

値が設定されていない場合、シェイプの水平位置を返します。

Inherited from

ShapeBase.x

y

▸ y(value?): any

シェイプの垂直位置を取得または設定します。

実例

var heart = sheet.shapes.add("Shape1", GC.Spread.Sheets.Shapes.AutoShapeType.heart, 100, 60, 200, 160);
var n = heart.y();
heart.y(n + 50);

パラメータ

名前	型	説明
`value?`	`string` \| `number`	数値によって指定されたシェイプの垂直位置、または数値を取得できる数式（=で始まる）。

戻り値

any

値が設定されていない場合、シェイプの垂直位置を返します。

Inherited from

ShapeBase.y

zIndex

▸ zIndex(shapeName, zIndex?): any

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

実例

//これは、グループシェイプでZインデックスを使用する方法を示すサンプルです。
var shape1 = activeSheet.shapes.add("shape1", GC.Spread.Sheets.Shapes.AutoShapeType.heart, 100, 50, 100, 150);
var shape2 = activeSheet.shapes.add("shape2", GC.Spread.Sheets.Shapes.AutoShapeType.heart, 150, 50, 100, 150);
var style = shape1.style();
style.fill.color = "red";
shape1.style(style);
var myGroup = activeSheet.shapes.group([shape1, shape2]);
myGroup.zIndex("shape2"); // 1
myGroup.zIndex("shape2", 0);

パラメータ

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

戻り値

any

GC.Spread.Sheets.Shapes.GroupShape

クラス: GroupShape

Hierarchy

Table of contents

コンストラクタ

メソッド

コンストラクタ

constructor

パラメータ

Overrides

メソッド

add

パラメータ

戻り値

all

戻り値

allowMove

パラメータ

戻り値

Inherited from

allowResize

パラメータ

戻り値

Inherited from

allowRotate

パラメータ

戻り値

Inherited from

alt

パラメータ

戻り値

Inherited from

canPrint

パラメータ

戻り値

Inherited from

dynamicMove

パラメータ

戻り値

Inherited from

dynamicSize

パラメータ

戻り値

Inherited from

endColumn

パラメータ

戻り値

Inherited from

endColumnOffset

パラメータ

戻り値

Inherited from

endRow

パラメータ

戻り値

Inherited from

endRowOffset

パラメータ

戻り値

Inherited from

find

パラメータ

戻り値

getFormula

パラメータ

戻り値

Overrides

height

パラメータ

戻り値

Inherited from

hyperlink

パラメータ

戻り値

Inherited from

isLocked

パラメータ

戻り値

Inherited from

isSelected