Skip to content

Update ShapeCollection.AddGeometricShape #1

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
donlvMSFT wants to merge 3 commits into
base: ExcelJs_OpenSpec
Choose a base branch
from
Open

Update ShapeCollection.AddGeometricShape #1

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
d0ab48c
Update ShapeCollection.AddGeometricShape
donlvMSFT Jan 9, 2019
e7cc21f
Update shape.md
donlvMSFT Jan 9, 2019
f7b44a5
Update textframe.md
donlvMSFT Jan 9, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions reference/excel/shape.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,12 +11,12 @@ Represents a generic shape object in the worksheet.
|height|double|Represents the height, in points, of the shape.|[beta](../requirement-sets/excel-api-requirement-sets.md)|
|id|string|Represents the shape identifier. Read-only.|[beta](../requirement-sets/excel-api-requirement-sets.md)|
|left|double|The distance, in points, from the left side of the shape to the left of the worksheet.|[beta](../requirement-sets/excel-api-requirement-sets.md)|
|level{|int|Represents the level of the specified shape. Level 0 means the shape is not part of any group, level 1 means the shape is part of a top-level group, etc. Read-only.|[beta](../requirement-sets/excel-api-requirement-sets.md)|
|level|int|Represents the level of the specified shape. Level 0 means the shape is not part of any group, level 1 means the shape is part of a top-level group, etc. Read-only.|[beta](../requirement-sets/excel-api-requirement-sets.md)|
|lockAspectRatio|bool|Represents if the aspect ratio locked, in boolean, of the shape.|[beta](../requirement-sets/excel-api-requirement-sets.md)|
|name|string|Represents the name of the shape.|[beta](../requirement-sets/excel-api-requirement-sets.md)|
|rotation|int|Represents the rotation, in degrees, of the shape.|[beta](../requirement-sets/excel-api-requirement-sets.md)|
|top|double|The distance, in points, from the top edge of the shape to the top of the worksheet.|[beta](../requirement-sets/excel-api-requirement-sets.md)|
|visible{|bool|Represents the visibility, in boolean, of the specified shape.|[beta](../requirement-sets/excel-api-requirement-sets.md)|
|visible|bool|Represents the visibility, in boolean, of the specified shape.|[beta](../requirement-sets/excel-api-requirement-sets.md)|
|width|double|Represents the width, in points, of the shape.|[beta](../requirement-sets/excel-api-requirement-sets.md)|
|zOrderPosition|int|Returns the position of the specified shape in the z-order, the very bottom shape's z-order value is 0. Read-only.|[beta](../requirement-sets/excel-api-requirement-sets.md)|

Expand All @@ -32,7 +32,7 @@ _See property access [examples.](#property-access-examples)_
|image|[Image](image.md)|Returns the image for the shape object. Error will be thrown, if the shape object is other shape type (Like, GeometricShape, SmartArt, etc.) rather than Image. Read-only.|[beta](../requirement-sets/excel-api-requirement-sets.md)|
|line|[Line](line.md)|Returns the line object for the shape object. Error will be thrown, if the shape object is other shape type (Like, GeometricShape, SmartArt, etc.) rather than Image. Read-only.|[beta](../requirement-sets/excel-api-requirement-sets.md)|
|lineFormat|[ShapeLineFormat](shapelineformat.md)|Returns the line formatting of the shape object. Read-only.|[beta](../requirement-sets/excel-api-requirement-sets.md)|
|parentGroup{|[Shape](shape.md)|Represents the parent group of the specified shape. Read-only.|[beta](../requirement-sets/excel-api-requirement-sets.md)|
|parentGroup|[Shape](shape.md)|Represents the parent group of the specified shape. Read-only.|[beta](../requirement-sets/excel-api-requirement-sets.md)|
|placement|[Placement](placement.md)|Represents the placment, value that represents the way the object is attached to the cells below it.|[beta](../requirement-sets/excel-api-requirement-sets.md)|
|textFrame|[TextFrame](textframe.md)|Returns the textFrame object of a shape. Read only. Read-only.|[beta](../requirement-sets/excel-api-requirement-sets.md)|
|type|string|Returns the type of the specified shape. Read-only.|[beta](../requirement-sets/excel-api-requirement-sets.md)|
Expand Down
10 changes: 3 additions & 7 deletions reference/excel/shapecollection.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ None

| Method | Return Type |Description| Req. Set|
|:---------------|:--------|:----------|:----|
|[addGeometricShape(geometricShapeType: string, left: double, top: double, width: double, height: double)](#addgeometricshapegeometricshapetype-string-left-double-top-double-width-double-height-double)|[Shape](shape.md)|Adds a geometric shape to worksheet. Returns a Shape object that represents the new shape.|[beta](../requirement-sets/excel-api-requirement-sets.md)|
|[addGeometricShape(geometricShapeType: string)](#addgeometricshapegeometricshapetype-string)|[Shape](shape.md)|Adds a geometric shape to worksheet. Returns a Shape object that represents the new shape.|[beta](../requirement-sets/excel-api-requirement-sets.md)|
|[addGroup(values: ()[])](#addgroupvalues-)|[Shape](shape.md)|Group a subset of shapes in a worksheet. Returns a Shape object that represents the new group of shapes.|[beta](../requirement-sets/excel-api-requirement-sets.md)|
|[addImage(base64ImageString: string)](#addimagebase64imagestring-string)|[Shape](shape.md)|Creates an image from a base64 string and adds it to worksheet. Returns the Shape object that represents the new Image.|[beta](../requirement-sets/excel-api-requirement-sets.md)|
|[addLine(startLeft: double, startTop: double, endLeft: double, endTop: double, connectorType: string)](#addlinestartleft-double-starttop-double-endleft-double-endtop-double-connectortype-string)|[Shape](shape.md)|Adds a line to worksheet. Returns a Shape object that represents the new line.|[beta](../requirement-sets/excel-api-requirement-sets.md)|
Expand All @@ -32,22 +32,18 @@ None
## Method Details


### addGeometricShape(geometricShapeType: string, left: double, top: double, width: double, height: double)
### addGeometricShape(geometricShapeType: string)
Adds a geometric shape to worksheet. Returns a Shape object that represents the new shape.

#### Syntax
```js
shapeCollectionObject.addGeometricShape(geometricShapeType, left, top, width, height);
shapeCollectionObject.addGeometricShape(geometricShapeType);
```

#### Parameters
| Parameter | Type |Description|
|:---------------|:--------|:----------|
|geometricShapeType|string|Represents the geometric type of the shape.|
|left|double|The distance, in points, from the left side of the shape to the left side of the worksheet.|
|top|double| The distance, in points, from the top edge of the shape to the top of the worksheet.|
|width|double|The width, in points, of the shape.|
|height|double|The height, in points, of the shape.|

#### Returns
[Shape](shape.md)
Expand Down
2 changes: 1 addition & 1 deletion reference/excel/textframe.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ _See property access [examples.](#property-access-examples)_
|horizontalOverflow|[ShapeTextHorzOverflowType](shapetexthorzoverflowtype.md)|Represents the horizontal overflow type of the text frame.|[beta](../requirement-sets/excel-api-requirement-sets.md)|
|orientation|[ShapeTextOrientationType](shapetextorientationtype.md)|Represents the text orientation of the text frame.|[beta](../requirement-sets/excel-api-requirement-sets.md)|
|readingOrder|[ShapeTextReadingOrder](shapetextreadingorder.md)|Represents the reading order of the text frame, RTL or LTR.|[beta](../requirement-sets/excel-api-requirement-sets.md)|
|textRange|[TextRange](textrange.md)|Returns or sets the degree of transparency of the specified fill as a value from 0.0 (opaque) through 1.0 (clear). For API not supported shape types or special fill type with inconsistent transparencies, return null. For example, gradient fill type could have inconsistent transparencies. Read-only.|[beta](../requirement-sets/excel-api-requirement-sets.md)|
|textRange|[TextRange](textrange.md)|Represents the text range in the text frame.|[beta](../requirement-sets/excel-api-requirement-sets.md)|
|verticalAlignment|[ShapeTextVerticalAlignType](shapetextverticalaligntype.md)|Represents the vertical alignment of the text frame.|[beta](../requirement-sets/excel-api-requirement-sets.md)|
|verticalOverflow|[ShapeTextVertOverflowType](shapetextvertoverflowtype.md)|Represents the vertical overflow type of the text frame.|[beta](../requirement-sets/excel-api-requirement-sets.md)|

Expand Down