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`	形状的x位置
`top?`	`number`	形状的y位置
`width?`	`number`	形状的宽度
`height?`	`number`	形状的高度

Overrides

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

Gets or sets the resize mode of the shape.

代码示例

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(); // Get whether the shape is printable, defaulat value is true.
workbook.print(); // The heart shape is printed.
heart.canPrint(false);
workbook.print(); // The heart shape is not printed.

参数

属性名	类型	说明
`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");//返回 "=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

通过路径从形状返回公式字符串

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

如果未设置任何值，则返回形状的高度

继承自

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

如果未设置值，则返回形状的当前超链接设置

继承自

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

Overrides

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

如果未设置任何值，则返回形状的文本

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

参数

Overrides

方法

adjustments

参数

返回值

allowMove

参数

返回值

继承自

allowResize

参数

返回值

继承自

allowRotate

参数

返回值

继承自

alt

参数

返回值

继承自

canPrint

参数

返回值

继承自

dynamicMove

参数

返回值

继承自

dynamicSize

参数

返回值

继承自

endColumn

参数

返回值

继承自

endColumnOffset

参数

返回值

继承自

endRow

参数

返回值

继承自

endRowOffset

参数

返回值

继承自

getFormula

参数

返回值

Overrides

height

参数

返回值

继承自

hyperlink

参数

返回值

继承自

isLocked

参数

返回值

继承自

isSelected

参数

返回值

继承自

isTextBox

参数