[]
↳ GroupShape
• new GroupShape(worksheet
, name?
)
Represents a groupShape.
Name | Type | Description |
---|---|---|
worksheet |
Worksheet |
The host sheet of the groupShape. |
name? |
string |
- |
▸ add(shape
): void
add a shape to the group shape.
example
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, 260, 50, 100, 150);
var groupShape = activeSheet.shapes.group([shape1, shape2]);
var shape3 = activeSheet.shapes.add("shape3", GC.Spread.Sheets.Shapes.AutoShapeType.heart, 100, 260, 100, 150);
// add shape3 to groupShape.
groupShape.add(shape3);
Name | Type | Description |
---|---|---|
shape |
Shape |
The shape which added to the group shape. |
void
▸ all(): Shape
[]
get all shapes of group shape.
example
// This sample shows how to get all shapes in group 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
[]
all shapes
▸ allowMove(value?
): any
Gets or sets whether to disable moving the shape.
example
var heart = sheet.shapes.add("Shape1", GC.Spread.Sheets.Shapes.AutoShapeType.heart, 100, 60, 200, 160);
var state = heart.allowMove();
heart.allowMove(!state);
Name | Type | Description |
---|---|---|
value? |
boolean |
The setting for whether to disable moving the shape. |
any
If no value is set, returns the setting for whether to disable moving the shape.
▸ allowResize(value?
): any
Gets or sets the resize mode of the shape.
example
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);
Name | Type | Description |
---|---|---|
value? |
boolean | ResizeMode |
The setting for whether to disable resizing the shape. |
any
If no value is set, returns the setting for whether to disable resizing the shape.
▸ allowRotate(value?
): any
Gets or sets whether to disable rotating the shape.
example
var heart = sheet.shapes.add("Shape1", GC.Spread.Sheets.Shapes.AutoShapeType.heart, 100, 60, 200, 160);
var state = heart.allowRotate();
heart.allowRotate(!state);
Name | Type | Description |
---|---|---|
value? |
boolean |
The setting for whether to disable rotating the shape. |
any
If no value is set, returns the setting for whether to disable rotating the shape.
▸ alt(value?
): any
Gets or sets the alternative text of the shape for screen readers.
example
var heart = sheet.shapes.add("Shape1", GC.Spread.Sheets.Shapes.AutoShapeType.heart, 100, 60, 200, 160);
heart.alt("A heart shape");
Name | Type |
---|---|
value? |
string |
any
The alternative text of the shape.
▸ canPrint(value?
): any
Gets or sets whether this shape is printable.
example
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.
Name | Type |
---|---|
value? |
boolean |
any
If no value is set, returns whether this shape is printable.
▸ dynamicMove(value?
): any
Gets or sets whether the shape moves when hiding or showing, resizing, or moving rows or columns.
example
var heart = sheet.shapes.add("Shape1", GC.Spread.Sheets.Shapes.AutoShapeType.heart, 100, 60, 200, 160);
var state = heart.dynamicMove();
heart.dynamicMove(!state);
Name | Type | Description |
---|---|---|
value? |
boolean |
The value indicates whether the shape moves when hiding or showing, resizing, or moving rows or columns. |
any
If no value is set, returns whether this shape dynamically moves.
▸ dynamicSize(value?
): any
Gets or sets whether the size of the shape changes when hiding or showing, resizing, or moving rows or columns.
example
var heart = sheet.shapes.add("Shape1", GC.Spread.Sheets.Shapes.AutoShapeType.heart, 100, 60, 200, 160);
var state = heart.dynamicSize();
heart.dynamicSize(!state);
Name | Type | Description |
---|---|---|
value? |
boolean |
The value indicates whether the size of the shape changes when hiding or showing, resizing, or moving rows or columns. |
any
If no value is set, returns whether this shape dynamically changes size.
▸ endColumn(value?
): any
Gets or sets the end column index of the shape position.
example
var heart = sheet.shapes.add("Shape1", GC.Spread.Sheets.Shapes.AutoShapeType.heart, 100, 60, 200, 160);
var n = heart.endColumn();
heart.endColumn(n + 1);
Name | Type | Description |
---|---|---|
value? |
number |
The end column index of the shape position. |
any
If no value is set, returns the end column index of the shape position.
▸ endColumnOffset(value?
): any
Gets or sets the offset relative to the end column of the shape.
example
var heart = sheet.shapes.add("Shape1", GC.Spread.Sheets.Shapes.AutoShapeType.heart, 100, 60, 200, 160);
var n = heart.endColumnOffset();
heart.endColumnOffset(0);
Name | Type | Description |
---|---|---|
value? |
number |
The offset relative to the end column of the shape. |
any
If no value is set, returns the offset relative to the end column of the shape.
▸ endRow(value?
): any
Gets or sets the end row index of the shape position.
example
var heart = sheet.shapes.add("Shape1", GC.Spread.Sheets.Shapes.AutoShapeType.heart, 100, 60, 200, 160);
var n = heart.endRow();
heart.endRow(n + 2);
Name | Type | Description |
---|---|---|
value? |
number |
The end row index of the shape position. |
any
If no value is set, returns the end row index of the shape position.
▸ endRowOffset(value?
): any
Gets or sets the offset relative to the end row of the shape.
example
var heart = sheet.shapes.add("Shape1", GC.Spread.Sheets.Shapes.AutoShapeType.heart, 100, 60, 200, 160);
var n = heart.endRowOffset();
heart.endRowOffset(0);
Name | Type | Description |
---|---|---|
value? |
number |
The offset relative to the end row of the shape. |
any
If no value is set, returns the offset relative to the end row of the shape.
▸ find(name
): Shape
Get shape by name in group shape.
example
var shape1 = activeSheet.shapes.add("heart1", GC.Spread.Sheets.Shapes.AutoShapeType.heart, 100, 50, 100, 150);
var shape2 = activeSheet.shapes.add("heart2", GC.Spread.Sheets.Shapes.AutoShapeType.heart, 260, 50, 100, 150);
var groupShape = activeSheet.shapes.group([shape1, shape2]);
var heart1 = groupShape.find("heart1"); // heart1 is equal to shape1.
Name | Type | Description |
---|---|---|
name |
string |
The name of shape in groupShape. |
The Shape instance if the name belongs to a shape of group shapes; otherwise,
▸ getFormula(path
): string
Gets the formula string from the shape by the path.
example
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"
Name | Type | Description |
---|---|---|
path |
string |
The path which can accept a formula string, it could be one of "x", "y", "width", "height", "rotate". |
string
Returns the formula string from the shape by the path.
▸ height(value?
): any
Gets or sets the height of the shape.
example
var heart = sheet.shapes.add("Shape1", GC.Spread.Sheets.Shapes.AutoShapeType.heart, 100, 60, 200, 160);
var n = heart.height();
heart.height(n + 50);
Name | Type | Description |
---|---|---|
value? |
string | number |
The height of the shape specified by a number or formula (starts with =) can get a number value. |
any
If no value is set, returns the height of the shape.
▸ hyperlink(value?
): void
| IHyperlink
Gets or sets the hyperlink of the shape.
example
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'});
Name | Type |
---|---|
value? |
IHyperlink |
void
| IHyperlink
If no value is set, returns the current hyperlink settings of the shape.
▸ isLocked(value?
): any
Gets or sets whether this shape is locked.
example
var heart = sheet.shapes.add("Shape1", GC.Spread.Sheets.Shapes.AutoShapeType.heart, 100, 60, 200, 160);
var state = heart.isLocked();
heart.isLocked(!state);
Name | Type | Description |
---|---|---|
value? |
boolean |
The value that indicates whether this shape is locked. |
any
If no value is set, returns whether this shape is locked.
▸ isSelected(value?
): any
Gets or sets whether this shape is selected.
example
var heart = sheet.shapes.add("Shape1", GC.Spread.Sheets.Shapes.AutoShapeType.heart, 100, 60, 200, 160);
var state = heart.isSelected();
heart.isSelected(!state);
Name | Type | Description |
---|---|---|
value? |
boolean |
The value that indicates whether this shape is selected. |
any
If no value is set, returns whether this shape is selected.
▸ isVisible(value?
): any
Gets or sets whether this shape is visible.
example
var heart = sheet.shapes.add("Shape1", GC.Spread.Sheets.Shapes.AutoShapeType.heart, 100, 60, 200, 160);
var state = heart.isVisible();
heart.isVisible(!state);
Name | Type | Description |
---|---|---|
value? |
boolean |
The value that indicates whether this shape is visible. |
any
If no value is set, returns whether this shape is visible.
▸ name(value?
): any
Gets or sets the name of the shape.
example
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();
Name | Type | Description |
---|---|---|
value? |
string |
The name of the shape. |
any
If no value is set, returns the name of the shape.
▸ remove(shape
): void
remove a shape from group shape.
example
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, 260, 50, 100, 150);
var shape3 = activeSheet.shapes.add("shape3", GC.Spread.Sheets.Shapes.AutoShapeType.heart, 100, 260, 100, 150);
var groupShape = activeSheet.shapes.group([shape1, shape2, shape3]);
// remove shape3 from groupShape.
groupShape.remove(shape3);
Name | Type | Description |
---|---|---|
shape |
Shape |
The shape to be removed from the group shape. |
void
▸ rotate(value?
): number
| void
Gets or sets the rotate of groupShape.
example
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();
Name | Type | Description |
---|---|---|
value? |
string | number |
The rotate of the groupShape.The unit of measurement is the angle. |
number
| void
If the parameter 'value' is null or undefined,it will return the rotate of the groupShape.
▸ setFormula(path
, formula
): void
Sets the formula string to the shape by the path.
example
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");
Name | Type | Description |
---|---|---|
path |
string |
The path which can accept a formula string, it could be one of "x", "y", "width", "height", "rotate". |
formula |
string |
The formula string. |
void
▸ showHandle(value?
): any
Gets or sets whether to show handle of shape.
example
var heart = sheet.shapes.add("Shape1", GC.Spread.Sheets.Shapes.AutoShapeType.heart, 100, 60, 200, 160);
var state = heart.showHandle();
heart.showHandle(!state);
Name | Type | Description |
---|---|---|
value? |
boolean |
The setting for whether to show handle of shape. |
any
If no value is set, returns the setting for whether to show handle of shape.
▸ startColumn(value?
): any
Gets or sets the starting column index of the shape position.
example
var heart = sheet.shapes.add("Shape1", GC.Spread.Sheets.Shapes.AutoShapeType.heart, 100, 60, 200, 160);
var n = heart.startColumn();
heart.startColumn(n + 2);
Name | Type | Description |
---|---|---|
value? |
number |
The starting column index of the shape position. |
any
If no value is set, returns the starting column index of the shape position.
▸ startColumnOffset(value?
): any
Gets or sets the offset relative to the start column of the shape.
example
var heart = sheet.shapes.add("Shape1", GC.Spread.Sheets.Shapes.AutoShapeType.heart, 100, 60, 200, 160);
var n = heart.startColumnOffset();
heart.startColumnOffset(0);
Name | Type | Description |
---|---|---|
value? |
number |
The offset relative to the start column of the shape. |
any
If no value is set, returns the offset relative to the start column of the shape.
▸ startRow(value?
): any
Gets or sets the starting row index of the shape position.
example
var heart = sheet.shapes.add("Shape1", GC.Spread.Sheets.Shapes.AutoShapeType.heart, 100, 60, 200, 160);
var n = heart.startRow();
heart.startRow(n + 2);
Name | Type | Description |
---|---|---|
value? |
number |
The starting row index of the shape position. |
any
If no value is set, returns the starting row index of the shape.
▸ startRowOffset(value?
): any
Gets or sets the offset relative to the start row of the shape.
example
var heart = sheet.shapes.add("Shape1", GC.Spread.Sheets.Shapes.AutoShapeType.heart, 100, 60, 200, 160);
var n = heart.startRowOffset();
heart.startRowOffset(0);
Name | Type | Description |
---|---|---|
value? |
number |
The offset relative to the start row of the shape. |
any
If no value is set, returns the offset relative to the start row of the shape.
▸ toImageSrc(): string
Get the shape Image src of type Base64 string.
example
let shapeImageSrc = sheet.shapes.all()[0].toImageSrc();
string
return the shape Image Base64 src string.
▸ width(value?
): any
Gets or sets the width of the shape.
example
var heart = sheet.shapes.add("Shape1", GC.Spread.Sheets.Shapes.AutoShapeType.heart, 100, 60, 200, 160);
var n = heart.width();
heart.width(n + 50);
Name | Type | Description |
---|---|---|
value? |
string | number |
The width of the shape specified by a number or formula (starts with =) can get a number value. |
any
If no value is set, returns the width of the shape.
▸ x(value?
): any
Gets or sets the horizontal location of the shape.
example
var heart = sheet.shapes.add("Shape1", GC.Spread.Sheets.Shapes.AutoShapeType.heart, 100, 60, 200, 160);
var n = heart.x();
heart.x(n + 50);
Name | Type | Description |
---|---|---|
value? |
string | number |
The horizontal location of the shape specified by a number or formula (starts with =) can get a number value. |
any
If no value is set, returns the horizontal location of the shape.
▸ y(value?
): any
Gets or sets the vertical location of the shape.
example
var heart = sheet.shapes.add("Shape1", GC.Spread.Sheets.Shapes.AutoShapeType.heart, 100, 60, 200, 160);
var n = heart.y();
heart.y(n + 50);
Name | Type | Description |
---|---|---|
value? |
string | number |
The vertical location of the shape specified by a number or formula (starts with =) can get a number value. |
any
If no value is set, returns the vertical location of the shape.
▸ zIndex(shapeName
, zIndex?
): any
Get or set the z-index for a shape in a groupShape.
example
//This is a sample shows how to use zIndex in groupShape.
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);
Name | Type | Description |
---|---|---|
shapeName |
string |
The name of the shape. |
zIndex? |
number |
The z-index for the shape. The zIndex should be between 0 to all shapes length(not contains). A shape with greater zIndex is always in front of a shape with a lower zIndex. |
any