- GC
- GC.Data
- GC.Pivot
- GC.Spread.Pivot
- GC.Spread.Slicers
- GC.Spread.CalcEngine
- GC.Spread.Commands
- GC.Spread.Common
- GC.Spread.Formatter
- GC.Spread.Report
- GC.Spread.Sheets
- GC.Spread.Sheets.AutoMerge
- GC.Spread.Sheets.Barcode
- GC.Spread.Sheets.IO
- GC.Spread.Sheets.Bindings
- GC.Spread.Sheets.CalcEngine
- GC.Spread.Sheets.Search
- GC.Spread.Sheets.CellState
- GC.Spread.Sheets.CellTypes
- GC.Spread.Sheets.Charts
- GC.Spread.Sheets.DataCharts
- GC.Spread.Sheets.Commands
- GC.Spread.Sheets.Comments
- GC.Spread.Sheets.ConditionalFormatting
- GC.Spread.Sheets.ContextMenu
- GC.Spread.Sheets.DataValidation
- GC.Spread.Sheets.DataRange
- GC.Spread.Sheets.Fill
- GC.Spread.Sheets.Filter
- GC.Spread.Sheets.FloatingObjects
- GC.Spread.Sheets.FormulaTextBox
- GC.Spread.Sheets.Hyperlink
- GC.Spread.Sheets.OutlineColumn
- GC.Spread.Sheets.Outlines
- GC.Spread.Sheets.FormulaPanel
- GC.Spread.Sheets.PDF
- GC.Spread.Sheets.InputMask
- GC.Spread.Sheets.Print
- GC.Spread.Sheets.NameBox
- GC.Spread.Sheets.Shapes
- GC.Spread.Sheets.Slicers
- GC.Spread.Sheets.Sparklines
- GC.Spread.Sheets.StatusBar
- GC.Spread.Sheets.Tables
- GC.Spread.Sheets.TableSheet
- GC.Spread.Sheets.Touch
- GC.Spread.Sheets.Designer
- GC.Spread.Sheets.GanttSheet
- Collaboration
- GC.Spread.Excel
GC.Spread.Sheets.Shapes.ShapeBase
Class: ShapeBase
Hierarchy
ShapeBase↳
Shape
Table of contents
Constructors
Methods
- allowMove
- allowResize
- allowRotate
- alt
- canPrint
- dynamicMove
- dynamicSize
- endColumn
- endColumnOffset
- endRow
- endRowOffset
- getFormula
- height
- hyperlink
- isLocked
- isSelected
- isVisible
- name
- setFormula
- showHandle
- startColumn
- startColumnOffset
- startRow
- startRowOffset
- toImageSrc
- toImageSrcAsync
- width
- x
- y
Constructors
constructor
• new ShapeBase()
Represents the base class for Shape, GroupShape and ConnectorShape.
Methods
allowMove
▸ 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);
Parameters
| Name | Type | Description |
|---|---|---|
value? |
boolean |
The setting for whether to disable moving the shape. |
Returns
any
If no value is set, returns the setting for whether to disable moving the shape.
allowResize
▸ 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);
Parameters
| Name | Type | Description |
|---|---|---|
value? |
boolean | ResizeMode |
The setting for whether to disable resizing the shape. |
Returns
any
If no value is set, returns the setting for whether to disable resizing the shape.
allowRotate
▸ 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);
Parameters
| Name | Type | Description |
|---|---|---|
value? |
boolean |
The setting for whether to disable rotating the shape. |
Returns
any
If no value is set, returns the setting for whether to disable rotating the shape.
alt
▸ 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");
Parameters
| Name | Type |
|---|---|
value? |
string |
Returns
any
The alternative text of the shape.
canPrint
▸ 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.
Parameters
| Name | Type |
|---|---|
value? |
boolean |
Returns
any
If no value is set, returns whether this shape is printable.
dynamicMove
▸ 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);
Parameters
| Name | Type | Description |
|---|---|---|
value? |
boolean |
The value indicates whether the shape moves when hiding or showing, resizing, or moving rows or columns. |
Returns
any
If no value is set, returns whether this shape dynamically moves.
dynamicSize
▸ 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);
Parameters
| 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. |
Returns
any
If no value is set, returns whether this shape dynamically changes size.
endColumn
▸ 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);
Parameters
| Name | Type | Description |
|---|---|---|
value? |
number |
The end column index of the shape position. |
Returns
any
If no value is set, returns the end column index of the shape position.
endColumnOffset
▸ 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);
Parameters
| Name | Type | Description |
|---|---|---|
value? |
number |
The offset relative to the end column of the shape. |
Returns
any
If no value is set, returns the offset relative to the end column of the shape.
endRow
▸ 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);
Parameters
| Name | Type | Description |
|---|---|---|
value? |
number |
The end row index of the shape position. |
Returns
any
If no value is set, returns the end row index of the shape position.
endRowOffset
▸ 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);
Parameters
| Name | Type | Description |
|---|---|---|
value? |
number |
The offset relative to the end row of the shape. |
Returns
any
If no value is set, returns the offset relative to the end row of the shape.
getFormula
▸ getFormula(path): string
Gets the formula string from the shape by the path.
example
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");//returns "=Sheet1!B1"
Parameters
| Name | Type | Description |
|---|---|---|
path |
string |
The path which can accept a formula string, it could be one of "x", "y", "width", "height". |
Returns
string
Returns the formula string from the shape by the path.
height
▸ 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);
Parameters
| Name | Type | Description |
|---|---|---|
value? |
string | number |
The height of the shape specified by a number or formula (starts with =) can get a number value. |
Returns
any
If no value is set, returns the height of the shape.
hyperlink
▸ 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'});
Parameters
| Name | Type |
|---|---|
value? |
IHyperlink |
Returns
void | IHyperlink
If no value is set, returns the current hyperlink settings of the shape.
isLocked
▸ 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);
Parameters
| Name | Type | Description |
|---|---|---|
value? |
boolean |
The value that indicates whether this shape is locked. |
Returns
any
If no value is set, returns whether this shape is locked.
isSelected
▸ 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);
Parameters
| Name | Type | Description |
|---|---|---|
value? |
boolean |
The value that indicates whether this shape is selected. |
Returns
any
If no value is set, returns whether this shape is selected.
isVisible
▸ 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);
Parameters
| Name | Type | Description |
|---|---|---|
value? |
boolean |
The value that indicates whether this shape is visible. |
Returns
any
If no value is set, returns whether this shape is visible.
name
▸ 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();
Parameters
| Name | Type | Description |
|---|---|---|
value? |
string |
The name of the shape. |
Returns
any
If no value is set, returns the name of the shape.
setFormula
▸ setFormula(path, formula): void
Sets the formula string to the shape by the path.
example
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");
Parameters
| Name | Type | Description |
|---|---|---|
path |
string |
The path which can accept a formula string, it could be one of "x", "y", "width", "height". |
formula |
string |
The formula string. |
Returns
void
showHandle
▸ 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);
Parameters
| Name | Type | Description |
|---|---|---|
value? |
boolean |
The setting for whether to show handle of shape. |
Returns
any
If no value is set, returns the setting for whether to show handle of shape.
startColumn
▸ 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);
Parameters
| Name | Type | Description |
|---|---|---|
value? |
number |
The starting column index of the shape position. |
Returns
any
If no value is set, returns the starting column index of the shape position.
startColumnOffset
▸ 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);
Parameters
| Name | Type | Description |
|---|---|---|
value? |
number |
The offset relative to the start column of the shape. |
Returns
any
If no value is set, returns the offset relative to the start column of the shape.
startRow
▸ 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);
Parameters
| Name | Type | Description |
|---|---|---|
value? |
number |
The starting row index of the shape position. |
Returns
any
If no value is set, returns the starting row index of the shape.
startRowOffset
▸ 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);
Parameters
| Name | Type | Description |
|---|---|---|
value? |
number |
The offset relative to the start row of the shape. |
Returns
any
If no value is set, returns the offset relative to the start row of the shape.
toImageSrc
▸ toImageSrc(): string
Get the shape Image src of type Base64 string.
example
let shapeImageSrc = sheet.shapes.all()[0].toImageSrc();
Returns
string
return the shape Image Base64 src string.
toImageSrcAsync
▸ toImageSrcAsync(): Promise<string>
Get the shape Image src of type Base64 string.
example
let shapeImageSrc = await sheet.shapes.all()[0].toImageSrcAsync();
Returns
Promise<string>
return the shape Image Base64 src string.
width
▸ 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);
Parameters
| Name | Type | Description |
|---|---|---|
value? |
string | number |
The width of the shape specified by a number or formula (starts with =) can get a number value. |
Returns
any
If no value is set, returns the width of the shape.
x
▸ 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);
Parameters
| 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. |
Returns
any
If no value is set, returns the horizontal location of the shape.
y
▸ 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);
Parameters
| 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. |
Returns
any
If no value is set, returns the vertical location of the shape.