GC.Spread.Sheets.Shapes.ShapeBase

类: ShapeBase

Sheets.Shapes.ShapeBase

继承关系

ShapeBase

↳ CameraShape

↳ ConnectorShape

↳ GroupShape

↳ PictureShape

↳ Shape

构造方法

constructor

方法

构造方法

constructor

• new ShapeBase()

Shape,GroupShape和ConnectorShape的基类

方法

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

如果未设置任何值，则返回是否禁用移动形状的设置

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

如果未设置任何值，则返回是否禁用调整形状大小的设置

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

如果未设置任何值，则返回是否禁用旋转形状的设置

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

形状的可选文本

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

如果未设置任何值，则返回此形状是否可打印

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

如果未设置任何值，则返回此形状是否动态移动

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

如果未设置任何值，则返回此形状是否动态更改大小

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

如果未设置任何值，则返回形状位置的结束列索引

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

如果未设置任何值，则返回相对于形状末端的偏移量

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

如果未设置任何值，则返回形状位置的末端行索引

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

如果未设置任何值，则返回相对于形状末端的偏移量

getFormula

▸ getFormula(path): string

通过路径从形状中获取公式字符串

代码示例

sheet.name("Sheet1");
sheet.setValue(0, 1, 150);
var shape1 = sheet.shapes.add("myShape1", GC.Spread.Sheets.Shapes.AutoShapeType.rectangle, 100, 100, 200, 200);
shape1.setFormula("x", "=Sheet1!B1");
shape1.getFormula("x");//返回 "=Sheet1!B1"

参数

属性名	类型	说明
`path`	`string`	可以接收公式字符串的路径，可以是"x","y","width","height"之一

返回值

string

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

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

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

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

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

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

如果未设置任何值，则返回此形状是否被锁定

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

如果未设置任何值，则返回是否选择此形状

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

如果未设置任何值，则返回此形状是否可见

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

如果未设置任何值，则返回形状的名称

setFormula

▸ setFormula(path, formula): void

通过路径将公式字符串设置为形状

代码示例

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

参数

属性名	类型	说明
`path`	`string`	可以接收公式字符串的路径，可以是"x","y","width","height"之一
`formula`	`string`	公式字符串

返回值

void

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

如果未设置任何值，则返回是否显示形状句柄的设置

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

如果未设置任何值，则返回形状位置的起始列索引

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

如果未设置任何值，则返回相对于图形起始列的偏移量

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

如果未设置任何值，则返回形状的起始行索引

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

如果未设置任何值，则返回相对于图形起始行的偏移量

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

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

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

如果未设置任何值，则返回形状的水平位置

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

如果未设置任何值，则返回形状的垂直位置

GC.Spread.Sheets.Shapes.ShapeBase

类: ShapeBase

继承关系

Table of contents

构造方法

方法

构造方法

constructor

方法

allowMove

参数

返回值

allowResize

参数

返回值

allowRotate

参数

返回值

alt

参数

返回值

canPrint

参数

返回值

dynamicMove

参数

返回值

dynamicSize

参数

返回值

endColumn

参数

返回值

endColumnOffset

参数

返回值

endRow

参数

返回值

endRowOffset

参数

返回值

getFormula

参数

返回值

height

参数

返回值

hyperlink

参数

返回值

isLocked

参数

返回值

isSelected

参数

返回值

isVisible

参数

返回值

name

参数

返回值

setFormula

参数

返回值

showHandle

参数

返回值

startColumn

参数

返回值

startColumnOffset

参数

返回值

startRow

参数

返回值

startRowOffset

参数