GC.Spread.Sheets.Shapes.Shape

クラス: Shape

Sheets.Shapes.Shape

階層

ShapeBase

↳ Shape

↳↳ FormControlShape

コンストラクタ

constructor

メソッド

コンストラクタ

constructor

• new Shape(worksheet, name, autoShapeTypeOrModel, left?, top?, width?, height?)

パラメータ

名前	型	説明
`worksheet`	`Worksheet`	シェイプのホストワークシート。
`name`	`string`	シェイプの名前。名前が空の文字列の場合、一意の名前が生成します。
`autoShapeTypeOrModel`	`IShapeModel` \| `AutoShapeType`	シェイプのタイプ（組み込みタイプのいずれか）、またはカスタムシェイプのモデル。
`left?`	`number`	-
`top?`	`number`	-
`width?`	`number`	-
`height?`	`number`	-

オーバーライド

ShapeBase.constructor

メソッド

adjustments

▸ adjustments(arrayValue?): void | number[]

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

実例

var blockArc = sheet.shapes.add("", GC.Spread.Sheets.Shapes.AutoShapeType.blockArc, 100, 60, 200, 160);
var adjustments = blockArc.adjustments();
console.log(adjustments);
adjustments[0] = 150;
adjustments[1] = 15;
adjustments[2] = 0.35;
blockArc.adjustments(adjustments);
blockArc.isSelected(true);

パラメータ

名前	型	説明
`arrayValue?`	`number`[]	配列に格納された調整値。

戻り値

void | number[]

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

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

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

継承元

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

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

継承元

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

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

継承元

ShapeBase.allowRotate

alt

▸ alt(value?): any

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

実例

var heart = sheet.shapes.add("Shape1", GC.Spread.Sheets.Shapes.AutoShapeType.heart, 100, 60, 200, 160);
heart.alt("A heart shape");

パラメータ

名前	型
`value?`	`string`

戻り値

any

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

継承元

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(); // シェイプが印刷可能かどうかを取得します。デフォルト値は true です。
workbook.print(); // ハートシェイプが印刷されます。
heart.canPrint(false);
workbook.print(); // ハートシェイプが印刷されません。

パラメータ

名前	型
`value?`	`boolean`

戻り値

any

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

継承元

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

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

継承元

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

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

継承元

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

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

継承元

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

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

継承元

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

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

継承元

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

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

継承元

ShapeBase.endRowOffset

getFormula

▸ getFormula(path): string

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

実例

sheet.name("Sheet1");
sheet.setValue(0, 1, "This is a rectangle.");
var shape1 = sheet.shapes.add("myShape1", GC.Spread.Sheets.Shapes.AutoShapeType.rectangle, 100, 100, 200, 200);
shape1.setFormula("text", "=Sheet1!B1");
shape1.getFormula("text");//returns "=Sheet1!B1"

パラメータ

名前	型	説明
`path`	`string`	数式の文字列を受け入れることができるパス。「x」、「y」、「width」、「height」、「rotate」、「text」、「style.fill.color」、「style.fill.transparency」、「style.fill.src」、「style.fill.tilePictureAsTexture」、「style.fill.offsetLeft」、「style.fill.offsetRight」、「style.fill.offsetTop」、「style.fill.offsetBottom」、「style.fill.offsetX」、「style.fill.offsetY」、「style.fill.scaleX」、「style.fill.scaleY」、「style.fill.alignment」、「style.fill.mirrorType」、「style.fill.type」、「style.fill.angle」、「style.fill.direction」、「style.fill.stops.0.color」、「style.fill.stops.0.position」、「style.fill.stops.0.transparency」、「style.fill.stops.0.brightness」、「style.line.color」、「style.line.lineStyle」、「style.line.width」、「style.line.capType」、「style.line.joinType」、「style.line.compoundType」、「style .line.transparency 」、「style.textEffect.color」、「style.textEffect.transparency」、「style.textEffect.font」、「style.textFrame.vAlign」、「style.textFrame.hAlign」のいずれかに設定できます。

戻り値

string

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

オーバーライド

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

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

継承元

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.spreadjs.com", target: 0, tooltip: 'goes to SpreadJS'});

パラメータ

名前	型
`value?`	`IHyperlink`

戻り値

void | IHyperlink

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

継承元

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

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

継承元

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

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

継承元

ShapeBase.isSelected

isTextBox

▸ isTextBox(value?): boolean | void

テキストボックスシェイプを取得または設定します。

実例

var rectangle = sheet.shapes.add("Shape1", GC.Spread.Sheets.Shapes.AutoShapeType.rectangle, 100, 60, 200, 160);
rectangle.isTextBox(true);

パラメータ

名前	型
`value?`	`boolean`

戻り値

boolean | void

値が設定されていない場合は、シェイプがテキストボックスであるかどうかを返します。

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

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

継承元

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

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

継承元

ShapeBase.name

rotate

▸ rotate(value?): number | void

シェイプの回転角度（度単位）を取得または設定します。

実例

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

パラメータ

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

戻り値

number | void

値が設定されていない場合、シェイプの回転角度（度単位）を返します。

setFormula

▸ setFormula(path, formula): void

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

実例

sheet.name("Sheet1");
sheet.setValue(0, 1, "This is a rectangle.");
var shape1 = sheet.shapes.add("myShape1", GC.Spread.Sheets.Shapes.AutoShapeType.rectangle, 100, 100, 200, 200);
shape1.setFormula("text", "=Sheet1!B1");

パラメータ

名前	型	説明
`path`	`string`	数式の文字列を受け入れることができるパス。「x」、「y」、「width」、「height」、「rotate」、「text」、「style.fill.color」、「style.fill.transparency」、「style.fill.src」、「style.fill.tilePictureAsTexture」、「style.fill.offsetLeft」、「style.fill.offsetRight」、「style.fill.offsetTop」、「style.fill.offsetBottom」、「style.fill.offsetX」、「style.fill.offsetY」、「style.fill.scaleX」、「style.fill.scaleY」、「style.fill.alignment」、「style.fill.mirrorType」、「style.fill.type」、「style.fill.angle」、「style.fill.direction」、「style.fill.stops.0.color」、「style.fill.stops.0.position」、「style.fill.stops.0.transparency」、「style.fill.stops.0.brightness」、「style.line.color」、「style.line.lineStyle」、「style.line.width」、「style.line.capType」、「style.line.joinType」、「style.line.compoundType」、「style .line.transparency 」、「style.textEffect.color」、「style.textEffect.transparency」、「style.textEffect.font」、「style.textFrame.vAlign」、「style.textFrame.hAlign」のいずれかに設定できます。
`formula`	`string`	数式文字列。

戻り値

void

オーバーライド

ShapeBase.setFormula

showHandle

▸ showHandle(value?): any

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

実例

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`	シェイプのハンドルを表示するかどうかの設定。

戻り値

any

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

継承元

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

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

継承元

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

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

継承元

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

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

継承元

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

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

継承元

ShapeBase.startRowOffset

style

▸ style(value?): any

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

実例

// 次のサンプルコードは、シェイプのスタイルを設定します。
var heart = sheet.shapes.add("Shape1", GC.Spread.Sheets.Shapes.AutoShapeType.heart, 100, 60, 200, 160);
var oldStyle = heart.style();
oldStyle.fill.color = "red";
oldStyle.fill.transparency = 0.5;
oldStyle.line.color = "green";
oldStyle.line.lineStyle = GC.Spread.Sheets.Shapes.PresetLineDashStyle.dashDot;
oldStyle.line.width = 5;
oldStyle.line.capType = GC.Spread.Sheets.Shapes.LineCapStyle.square;
oldStyle.line.joinType = GC.Spread.Sheets.Shapes.LineJoinStyle.miter;
oldStyle.line.compoundType = GC.Spread.Sheets.Shapes.CompoundType.double;
oldStyle.line.transparency = 0.5;
oldStyle.textEffect.color = "yellow";
oldStyle.textEffect.transparency = 0.5;
oldStyle.textEffect.font = "20px Arial";
oldStyle.textFrame.vAlign = GC.Spread.Sheets.VerticalAlign.center;
oldStyle.textFrame.hAlign = GC.Spread.Sheets.HorizontalAlign.center;
heart.style(oldStyle);
heart.text("Heart");

パラメータ

名前	型	説明
`value?`	`ShapeStyle`	シェイプのスタイル。

戻り値

any

値が設定されていない場合、シェイプの現在のスタイルを返します。

text

▸ text(value?): any

シェイプのテキストを取得または設定します。

実例

var heart = sheet.shapes.add("Shape1", GC.Spread.Sheets.Shapes.AutoShapeType.heart, 100, 60, 200, 160);
heart.text("My Shape");
var s = heart.text();

パラメータ

名前	型	説明
`value?`	`string`	文字列によって指定されたシェイプのテキスト、または文字列を取得できる数式（=で始まる）。

戻り値

any

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

toImageSrc

▸ toImageSrc(): string

Base64 文字列タイプのシェイプ画像の src を取得します。

実例

let shapeImageSrc = sheet.shapes.all()[0].toImageSrc();

戻り値

string

シェイプ画像の Base64 src 文字列を返します。

継承元

ShapeBase.toImageSrc

type

▸ type(value?): any

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

実例

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

パラメータ

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

戻り値

any

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

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

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

継承元

ShapeBase.width

x

▸ x(value?): any

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

実例

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`	数値によって指定されたシェイプの水平位置、または数値を取得できる数式（=で始まる）。

戻り値

any

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

継承元

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

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

継承元

ShapeBase.y

GC.Spread.Sheets.Shapes.Shape

クラス: Shape

階層

Table of contents

コンストラクタ

メソッド

コンストラクタ

constructor

パラメータ

オーバーライド

メソッド

adjustments

パラメータ

戻り値

allowMove

パラメータ

戻り値

継承元

allowResize

パラメータ

戻り値

継承元

allowRotate

パラメータ

戻り値

継承元

alt

パラメータ

戻り値

継承元

canPrint

パラメータ

戻り値

継承元

dynamicMove

パラメータ

戻り値

継承元

dynamicSize

パラメータ

戻り値

継承元

endColumn

パラメータ

戻り値

継承元

endColumnOffset

パラメータ

戻り値

継承元

endRow

パラメータ

戻り値

継承元

endRowOffset

パラメータ

戻り値

継承元

getFormula

パラメータ

戻り値

オーバーライド

height

パラメータ

戻り値

継承元

hyperlink

パラメータ

戻り値

継承元

isLocked

パラメータ

戻り値

継承元

isSelected

パラメータ

戻り値

継承元

isTextBox

パラメータ